ReplicationInstance (AWS Java SDK :: Services :: AWS Database Migration Service 2.16.60 API)

java.lang.Object
- software.amazon.awssdk.services.databasemigration.model.ReplicationInstance

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ReplicationInstance.Builder,ReplicationInstance>

@Generated(value="software.amazon.awssdk:codegen")
public final class ReplicationInstance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReplicationInstance.Builder,ReplicationInstance>

Provides information that defines a replication instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReplicationInstance.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ReplicationInstance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`allocatedStorage()` The amount of storage (in gigabytes) that is allocated for the replication instance.
`Boolean`	`autoMinorVersionUpgrade()` Boolean value indicating if minor version upgrades will be automatically applied to the instance.
`String`	`availabilityZone()` The Availability Zone for the instance.
`static ReplicationInstance.Builder`	`builder()`
`String`	`dnsNameServers()` The DNS name servers supported for the replication instance to access your on-premise source or target database.
`String`	`engineVersion()` The engine version number of the replication instance.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`freeUntil()` The expiration date of the free replication instance that is part of the Free DMS program.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReplicationInstancePrivateIpAddresses()` Returns true if the ReplicationInstancePrivateIpAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasReplicationInstancePublicIpAddresses()` Returns true if the ReplicationInstancePublicIpAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasVpcSecurityGroups()` Returns true if the VpcSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Instant`	`instanceCreateTime()` The time the replication instance was created.
`String`	`kmsKeyId()` An AWS KMS key identifier that is used to encrypt the data on the replication instance.
`Boolean`	`multiAZ()` Specifies whether the replication instance is a Multi-AZ deployment.
`ReplicationPendingModifiedValues`	`pendingModifiedValues()` The pending modification values.
`String`	`preferredMaintenanceWindow()` The maintenance window times for the replication instance.
`Boolean`	`publiclyAccessible()` Specifies the accessibility options for the replication instance.
`String`	`replicationInstanceArn()` The Amazon Resource Name (ARN) of the replication instance.
`String`	`replicationInstanceClass()` The compute and memory capacity of the replication instance as defined for the specified replication instance class.
`String`	`replicationInstanceIdentifier()` The replication instance identifier is a required parameter.
`String`	`replicationInstancePrivateIpAddress()` The private IP address of the replication instance.
`List<String>`	`replicationInstancePrivateIpAddresses()` One or more private IP addresses for the replication instance.
`String`	`replicationInstancePublicIpAddress()` The public IP address of the replication instance.
`List<String>`	`replicationInstancePublicIpAddresses()` One or more public IP addresses for the replication instance.
`String`	`replicationInstanceStatus()` The status of the replication instance.
`ReplicationSubnetGroup`	`replicationSubnetGroup()` The subnet group for the replication instance.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secondaryAvailabilityZone()` The Availability Zone of the standby replication instance in a Multi-AZ deployment.
`static Class<? extends ReplicationInstance.Builder>`	`serializableBuilderClass()`
`ReplicationInstance.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<VpcSecurityGroupMembership>`	`vpcSecurityGroups()` The VPC security group for the instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - replicationInstanceIdentifier
```
public final String 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
```
public final String 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 defualt 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 AWS 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 defualt 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 AWS DMS replication instance for your migration.
  - replicationInstanceStatus
```
public final String 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
```
public final Integer 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
```
public final Instant instanceCreateTime()
```
    The time the replication instance was created.
    
    Returns:
    
    The time the replication instance was created.
  - hasVpcSecurityGroups
```
public final boolean hasVpcSecurityGroups()
```
    Returns true if the VpcSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - vpcSecurityGroups
```
public final List<VpcSecurityGroupMembership> vpcSecurityGroups()
```
    The VPC security group for the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasVpcSecurityGroups() to see if a value was sent in this field.
    
    Returns:
    
    The VPC security group for the instance.
  - availabilityZone
```
public final String availabilityZone()
```
    The Availability Zone for the instance.
    
    Returns:
    
    The Availability Zone for the instance.
  - replicationSubnetGroup
```
public final ReplicationSubnetGroup replicationSubnetGroup()
```
    The subnet group for the replication instance.
    
    Returns:
    
    The subnet group for the replication instance.
  - preferredMaintenanceWindow
```
public final String 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
```
public final ReplicationPendingModifiedValues pendingModifiedValues()
```
    The pending modification values.
    
    Returns:
    
    The pending modification values.
  - multiAZ
```
public final Boolean 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 to true.
    
    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 to true.
  - engineVersion
```
public final String 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 to true.
    
    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 to true.
  - autoMinorVersionUpgrade
```
public final Boolean 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
```
public final String kmsKeyId()
```
    An AWS 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 AWS DMS uses your default encryption key.
    
    AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
    
    Returns:
    
    An AWS 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 AWS DMS uses your default encryption key.
    
    AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
  - replicationInstanceArn
```
public final String replicationInstanceArn()
```
    The Amazon Resource Name (ARN) of the replication instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the replication instance.
  - replicationInstancePublicIpAddress
```
public final String replicationInstancePublicIpAddress()
```
    The public IP address of the replication instance.
    
    Returns:
    
    The public IP address of the replication instance.
  - replicationInstancePrivateIpAddress
```
public final String replicationInstancePrivateIpAddress()
```
    The private IP address of the replication instance.
    
    Returns:
    
    The private IP address of the replication instance.
  - hasReplicationInstancePublicIpAddresses
```
public final boolean hasReplicationInstancePublicIpAddresses()
```
    Returns true if the ReplicationInstancePublicIpAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - replicationInstancePublicIpAddresses
```
public final List<String> 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.
    
    You can use hasReplicationInstancePublicIpAddresses() to see if a value was sent in this field.
    
    Returns:
    
    One or more public IP addresses for the replication instance.
  - hasReplicationInstancePrivateIpAddresses
```
public final boolean hasReplicationInstancePrivateIpAddresses()
```
    Returns true if the ReplicationInstancePrivateIpAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - replicationInstancePrivateIpAddresses
```
public final List<String> 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.
    
    You can use hasReplicationInstancePrivateIpAddresses() to see if a value was sent in this field.
    
    Returns:
    
    One or more private IP addresses for the replication instance.
  - publiclyAccessible
```
public final Boolean publiclyAccessible()
```
    Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
    
    Returns:
    
    Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
  - secondaryAvailabilityZone
```
public final String 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
```
public final Instant 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
```
public final String 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.
  - toBuilder
```
public ReplicationInstance.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReplicationInstance.Builder,ReplicationInstance>
  - builder
```
public static ReplicationInstance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReplicationInstance.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ReplicationInstance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

replicationInstanceIdentifier

replicationInstanceClass

replicationInstanceStatus

allocatedStorage

instanceCreateTime

hasVpcSecurityGroups

vpcSecurityGroups

availabilityZone

replicationSubnetGroup

preferredMaintenanceWindow

pendingModifiedValues

multiAZ

engineVersion

autoMinorVersionUpgrade

kmsKeyId

replicationInstanceArn

replicationInstancePublicIpAddress

replicationInstancePrivateIpAddress

hasReplicationInstancePublicIpAddresses

replicationInstancePublicIpAddresses

hasReplicationInstancePrivateIpAddresses

replicationInstancePrivateIpAddresses

publiclyAccessible

secondaryAvailabilityZone

freeUntil

dnsNameServers

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields