Class CreateReplicationInstanceRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest
-
- software.amazon.awssdk.services.databasemigration.model.CreateReplicationInstanceRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateReplicationInstanceRequest.Builder,CreateReplicationInstanceRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateReplicationInstanceRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<CreateReplicationInstanceRequest.Builder,CreateReplicationInstanceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateReplicationInstanceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegerallocatedStorage()The amount of storage (in gigabytes) to be initially allocated for the replication instance.BooleanautoMinorVersionUpgrade()A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.StringavailabilityZone()The Availability Zone where the replication instance will be created.static CreateReplicationInstanceRequest.Builderbuilder()StringdnsNameServers()A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database.StringengineVersion()The engine version number of the replication instance.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.booleanhasVpcSecurityGroupIds()For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.StringkmsKeyId()An KMS key identifier that is used to encrypt the data on the replication instance.BooleanmultiAZ()Specifies whether the replication instance is a Multi-AZ deployment.StringnetworkType()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.StringpreferredMaintenanceWindow()The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).BooleanpubliclyAccessible()Specifies the accessibility options for the replication instance.StringreplicationInstanceClass()The compute and memory capacity of the replication instance as defined for the specified replication instance class.StringreplicationInstanceIdentifier()The replication instance identifier.StringreplicationSubnetGroupIdentifier()A subnet group to associate with the replication instance.StringresourceIdentifier()A friendly name for the resource identifier at the end of theEndpointArnresponse parameter that is returned in the createdEndpointobject.List<SdkField<?>>sdkFields()static Class<? extends CreateReplicationInstanceRequest.Builder>serializableBuilderClass()List<Tag>tags()One or more tags to be assigned to the replication instance.CreateReplicationInstanceRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<String>vpcSecurityGroupIds()Specifies the VPC security group to be used with the replication instance.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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. This parameter is stored as a lowercase string.
Constraints:
-
Must contain 1-63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
myrepinstance- Returns:
- The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must contain 1-63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
myrepinstance -
-
-
allocatedStorage
public final Integer allocatedStorage()
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
- Returns:
- The amount of storage (in gigabytes) to be initially allocated for the replication instance.
-
replicationInstanceClass
public final String replicationInstanceClass()
The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to
"dms.c4.large".For more information on the settings and capacities for the available replication instance classes, see Choosing the right DMS replication instance; and, Selecting the best size for a replication instance.
- Returns:
- The compute and memory capacity of the replication instance as defined for the specified replication
instance class. For example to specify the instance class dms.c4.large, set this parameter to
"dms.c4.large".For more information on the settings and capacities for the available replication instance classes, see Choosing the right DMS replication instance; and, Selecting the best size for a replication instance.
-
hasVpcSecurityGroupIds
public final boolean hasVpcSecurityGroupIds()
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds 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.
-
vpcSecurityGroupIds
public final List<String> vpcSecurityGroupIds()
Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing 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
hasVpcSecurityGroupIds()method.- Returns:
- Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
-
availabilityZone
public final String availabilityZone()
The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example:
us-east-1d.- Returns:
- The Availability Zone where the replication instance will be created. The default value is a random,
system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example:
us-east-1d.
-
replicationSubnetGroupIdentifier
public final String replicationSubnetGroupIdentifier()
A subnet group to associate with the replication instance.
- Returns:
- A subnet group to associate with the replication instance.
-
preferredMaintenanceWindow
public final String preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miDefault: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
- Returns:
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miDefault: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
-
multiAZ
public final Boolean multiAZ()
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZoneparameter if the Multi-AZ parameter is set totrue.- Returns:
- Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZoneparameter if the Multi-AZ parameter is set totrue.
-
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.
- 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.
-
autoMinorVersionUpgrade
public final Boolean autoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to
true.Default:
true- Returns:
- A value that indicates whether minor engine upgrades are applied automatically to the replication
instance during the maintenance window. This parameter defaults to
true.Default:
true
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
One or more tags to be assigned to 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
hasTags()method.- Returns:
- One or more tags to be assigned to the replication instance.
-
kmsKeyId
public final String 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
KmsKeyIdparameter, 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
KmsKeyIdparameter, 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 replication instance. A value of
truerepresents an instance with a public IP address. A value offalserepresents an instance with a private IP address. The default value istrue.- Returns:
- Specifies the accessibility options for the replication instance. A value of
truerepresents an instance with a public IP address. A value offalserepresents an instance with a private IP address. The default value istrue.
-
dnsNameServers
public final String dnsNameServers()
A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example:
"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"- Returns:
- A list of custom DNS name servers supported for the replication instance to access your on-premise source
or target database. This list overrides the default name servers supported by the replication instance.
You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers.
For example:
"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
-
resourceIdentifier
public final String resourceIdentifier()
A friendly name for the resource identifier at the end of the
EndpointArnresponse parameter that is returned in the createdEndpointobject. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such asExample-App-ARN1. For example, this value might result in theEndpointArnvaluearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify aResourceIdentifiervalue, DMS generates a default identifier value for the end ofEndpointArn.- Returns:
- A friendly name for the resource identifier at the end of the
EndpointArnresponse parameter that is returned in the createdEndpointobject. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such asExample-App-ARN1. For example, this value might result in theEndpointArnvaluearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify aResourceIdentifiervalue, DMS generates a default identifier value for the end ofEndpointArn.
-
networkType
public final String 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
public CreateReplicationInstanceRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateReplicationInstanceRequest.Builder,CreateReplicationInstanceRequest>- Specified by:
toBuilderin classDatabaseMigrationRequest
-
builder
public static CreateReplicationInstanceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateReplicationInstanceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-