Class ReplicationInstance
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReplicationInstance.Builder,
ReplicationInstance>
Provides information that defines a replication instance.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The amount of storage (in gigabytes) that is allocated for the replication instance.final Boolean
Boolean value indicating if minor version upgrades will be automatically applied to the instance.final String
The Availability Zone for the instance.static ReplicationInstance.Builder
builder()
final String
The DNS name servers supported for the replication instance to access your on-premise source or target database.final String
The engine version number of the replication instance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Instant
The expiration date of the free replication instance that is part of the Free DMS program.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReplicationInstanceIpv6Addresses property.final boolean
For responses, this returns true if the service returned a value for the ReplicationInstancePrivateIpAddresses property.final boolean
For responses, this returns true if the service returned a value for the ReplicationInstancePublicIpAddresses property.final boolean
For responses, this returns true if the service returned a value for the VpcSecurityGroups property.final Instant
The time the replication instance was created.final String
kmsKeyId()
An KMS key identifier that is used to encrypt the data on the replication instance.final Boolean
multiAZ()
Specifies whether the replication instance is a Multi-AZ deployment.final String
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing.The pending modification values.final String
The maintenance window times for the replication instance.final Boolean
Specifies the accessibility options for the replication instance.final String
The Amazon Resource Name (ARN) of the replication instance.final String
The compute and memory capacity of the replication instance as defined for the specified replication instance class.final String
The replication instance identifier is a required parameter.One or more IPv6 addresses for the replication instance.final String
Deprecated.One or more private IP addresses for the replication instance.final String
Deprecated.One or more public IP addresses for the replication instance.final String
The status of the replication instance.final ReplicationSubnetGroup
The subnet group for the replication instance.final String
The Availability Zone of the standby replication instance in a Multi-AZ deployment.static Class
<? extends ReplicationInstance.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<VpcSecurityGroupMembership> The VPC security group for the instance.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
replicationInstanceIdentifier
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
-
Must contain 1-63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example:
myrepinstance
- Returns:
- The replication instance identifier is a required parameter. This parameter is stored as a lowercase
string.
Constraints:
-
Must contain 1-63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Example:
myrepinstance
-
-
-
replicationInstanceClass
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
- Returns:
- The compute and memory capacity of the replication instance as defined for the specified replication
instance class. It is a required parameter, although a default value is pre-selected in the DMS
console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
-
replicationInstanceStatus
The status of the replication instance. The possible return values include:
-
"available"
-
"creating"
-
"deleted"
-
"deleting"
-
"failed"
-
"modifying"
-
"upgrading"
-
"rebooting"
-
"resetting-master-credentials"
-
"storage-full"
-
"incompatible-credentials"
-
"incompatible-network"
-
"maintenance"
- Returns:
- The status of the replication instance. The possible return values include:
-
"available"
-
"creating"
-
"deleted"
-
"deleting"
-
"failed"
-
"modifying"
-
"upgrading"
-
"rebooting"
-
"resetting-master-credentials"
-
"storage-full"
-
"incompatible-credentials"
-
"incompatible-network"
-
"maintenance"
-
-
-
allocatedStorage
The amount of storage (in gigabytes) that is allocated for the replication instance.
- Returns:
- The amount of storage (in gigabytes) that is allocated for the replication instance.
-
instanceCreateTime
The time the replication instance was created.
- Returns:
- The time the replication instance was created.
-
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 theisEmpty()
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
The VPC security group for the instance.
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 group for the instance.
-
availabilityZone
The Availability Zone for the instance.
- Returns:
- The Availability Zone for the instance.
-
replicationSubnetGroup
The subnet group for the replication instance.
- Returns:
- The subnet group for the replication instance.
-
preferredMaintenanceWindow
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
- Returns:
- The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
-
pendingModifiedValues
The pending modification values.
- Returns:
- The pending modification values.
-
multiAZ
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the Multi-AZ parameter is set totrue
.- Returns:
- Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the Multi-AZ parameter is set totrue
.
-
engineVersion
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgrade
totrue
.- Returns:
- The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgrade
totrue
.
-
autoMinorVersionUpgrade
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
- Returns:
- Boolean value indicating if minor version upgrades will be automatically applied to the instance.
-
kmsKeyId
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the
KmsKeyId
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:
- An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the
KmsKeyId
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.
-
replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance.
- Returns:
- The Amazon Resource Name (ARN) of the replication instance.
-
replicationInstancePublicIpAddress
Deprecated.The public IP address of the replication instance.
- Returns:
- The public IP address of the replication instance.
-
replicationInstancePrivateIpAddress
Deprecated.The private IP address of the replication instance.
- Returns:
- The private IP address of the replication instance.
-
hasReplicationInstancePublicIpAddresses
public final boolean hasReplicationInstancePublicIpAddresses()For responses, this returns true if the service returned a value for the ReplicationInstancePublicIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
replicationInstancePublicIpAddresses
One or more public IP addresses for the replication instance.
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
hasReplicationInstancePublicIpAddresses()
method.- Returns:
- One or more public IP addresses for the replication instance.
-
hasReplicationInstancePrivateIpAddresses
public final boolean hasReplicationInstancePrivateIpAddresses()For responses, this returns true if the service returned a value for the ReplicationInstancePrivateIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
replicationInstancePrivateIpAddresses
One or more private IP addresses for the replication instance.
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
hasReplicationInstancePrivateIpAddresses()
method.- Returns:
- One or more private IP addresses for the replication instance.
-
hasReplicationInstanceIpv6Addresses
public final boolean hasReplicationInstanceIpv6Addresses()For responses, this returns true if the service returned a value for the ReplicationInstanceIpv6Addresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
replicationInstanceIpv6Addresses
One or more IPv6 addresses for the replication instance.
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
hasReplicationInstanceIpv6Addresses()
method.- Returns:
- One or more IPv6 addresses for the replication instance.
-
publiclyAccessible
Specifies the accessibility options for the replication instance. A value of
true
represents an instance with a public IP address. A value offalse
represents an instance with a private IP address. The default value istrue
.- Returns:
- Specifies the accessibility options for the replication instance. A value of
true
represents an instance with a public IP address. A value offalse
represents an instance with a private IP address. The default value istrue
.
-
secondaryAvailabilityZone
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
- Returns:
- The Availability Zone of the standby replication instance in a Multi-AZ deployment.
-
freeUntil
The expiration date of the free replication instance that is part of the Free DMS program.
- Returns:
- The expiration date of the free replication instance that is part of the Free DMS program.
-
dnsNameServers
The DNS name servers supported for the replication instance to access your on-premise source or target database.
- Returns:
- The DNS name servers supported for the replication instance to access your on-premise source or target database.
-
networkType
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
- Returns:
- The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
-
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 interfaceToCopyableBuilder<ReplicationInstance.Builder,
ReplicationInstance> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-