Class InstanceProfile

java.lang.Object
software.amazon.awssdk.services.databasemigration.model.InstanceProfile
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceProfile.Builder,InstanceProfile>
@Generated("software.amazon.awssdk:codegen") public final class InstanceProfile extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceProfile.Builder,InstanceProfile>

Provides information that defines an instance profile.

See Also:

  • Method Details

    • instanceProfileArn

      public final String instanceProfileArn()

      The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.

      Returns:
      The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone where the instance profile runs.

      Returns:
      The Availability Zone where the instance profile runs.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.

      If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.

      KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.

      If you don't specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.

      KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.

      Returns:
      Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.

    • networkType

      public final String networkType()

      Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.

      Returns:
      Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.

    • instanceProfileName

      public final String instanceProfileName()

      The user-friendly name for the instance profile.

      Returns:
      The user-friendly name for the instance profile.

    • description

      public final String description()

      A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

      Returns:
      A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

    • instanceProfileCreationTime

      public final Instant instanceProfileCreationTime()

      The time the instance profile was created.

      Returns:
      The time the instance profile was created.

    • subnetGroupIdentifier

      public final String subnetGroupIdentifier()

      The identifier of the subnet group that is associated with the instance profile.

      Returns:
      The identifier of the subnet group that is associated with the instance profile.

    • hasVpcSecurityGroups

      public final boolean hasVpcSecurityGroups()
      For responses, this returns true if the service returned a value for the VpcSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • vpcSecurityGroups

      public final List<String> vpcSecurityGroups()

      The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroups() method.

      Returns:
      The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

    • toBuilder

      public InstanceProfile.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstanceProfile.Builder,InstanceProfile>
      Returns:
      a builder for type T

    • builder

      public static InstanceProfile.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceProfile.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.