Interface CreateReplicationInstanceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateReplicationInstanceRequest.Builder,
,CreateReplicationInstanceRequest> DatabaseMigrationRequest.Builder
,SdkBuilder<CreateReplicationInstanceRequest.Builder,
,CreateReplicationInstanceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateReplicationInstanceRequest
-
Method Summary
Modifier and TypeMethodDescriptionallocatedStorage
(Integer allocatedStorage) The amount of storage (in gigabytes) to be initially allocated for the replication instance.autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.availabilityZone
(String availabilityZone) The Availability Zone where the replication instance will be created.dnsNameServers
(String dnsNameServers) A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database.engineVersion
(String engineVersion) The engine version number of the replication instance.An KMS key identifier that is used to encrypt the data on the replication instance.Specifies whether the replication instance is a Multi-AZ deployment.networkType
(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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.preferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).publiclyAccessible
(Boolean publiclyAccessible) Specifies the accessibility options for the replication instance.replicationInstanceClass
(String replicationInstanceClass) The compute and memory capacity of the replication instance as defined for the specified replication instance class.replicationInstanceIdentifier
(String replicationInstanceIdentifier) The replication instance identifier.replicationSubnetGroupIdentifier
(String replicationSubnetGroupIdentifier) A subnet group to associate with the replication instance.resourceIdentifier
(String resourceIdentifier) A friendly name for the resource identifier at the end of theEndpointArn
response parameter that is returned in the createdEndpoint
object.tags
(Collection<Tag> tags) One or more tags to be assigned to the replication instance.tags
(Consumer<Tag.Builder>... tags) One or more tags to be assigned to the replication instance.One or more tags to be assigned to the replication instance.vpcSecurityGroupIds
(String... vpcSecurityGroupIds) Specifies the VPC security group to be used with the replication instance.vpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) Specifies the VPC security group to be used with the replication instance.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
replicationInstanceIdentifier
CreateReplicationInstanceRequest.Builder replicationInstanceIdentifier(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
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
allocatedStorage
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
- Parameters:
allocatedStorage
- The amount of storage (in gigabytes) to be initially allocated for the replication instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroupIds
CreateReplicationInstanceRequest.Builder vpcSecurityGroupIds(Collection<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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
replicationSubnetGroupIdentifier
CreateReplicationInstanceRequest.Builder replicationSubnetGroupIdentifier(String replicationSubnetGroupIdentifier) A subnet group to associate with the replication instance.
- Parameters:
replicationSubnetGroupIdentifier
- A subnet group to associate with the replication instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredMaintenanceWindow
CreateReplicationInstanceRequest.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: 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.
- Parameters:
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).Format:
ddd:hh24:mi-ddd:hh24:mi
Default: 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:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
multiAZ
- Specifies whether the replication instance is a Multi-AZ deployment. You can't set theAvailabilityZone
parameter if the Multi-AZ parameter is set totrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
autoMinorVersionUpgrade
- A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults totrue
.Default:
true
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the replication instance.
- Parameters:
tags
- One or more tags to be assigned to the replication instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the replication instance.
- Parameters:
tags
- One or more tags to be assigned to the replication instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the replication instance.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
publiclyAccessible
- Specifies the accessibility options for the replication instance. A value oftrue
represents an instance with a public IP address. A value offalse
represents an instance with a private IP address. The default value istrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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"
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
resourceIdentifier
A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the createdEndpoint
object. 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 theEndpointArn
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify aResourceIdentifier
value, DMS generates a default identifier value for the end ofEndpointArn
.- Parameters:
resourceIdentifier
- A friendly name for the resource identifier at the end of theEndpointArn
response parameter that is returned in the createdEndpoint
object. 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 theEndpointArn
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify aResourceIdentifier
value, DMS generates a default identifier value for the end ofEndpointArn
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateReplicationInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateReplicationInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-