software.amazon.awssdk.services.databasemigration.model

Interface CreateReplicationInstanceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateReplicationInstanceRequest.Builder,CreateReplicationInstanceRequest>, DatabaseMigrationRequest.Builder, SdkBuilder<CreateReplicationInstanceRequest.Builder,CreateReplicationInstanceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateReplicationInstanceRequest

public static interface CreateReplicationInstanceRequest.Builder
extends DatabaseMigrationRequest.Builder, SdkPojo, CopyableBuilder<CreateReplicationInstanceRequest.Builder,CreateReplicationInstanceRequest>

Method Summary

Modifier and Type	Method and Description
CreateReplicationInstanceRequest.Builder	allocatedStorage(Integer allocatedStorage) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
CreateReplicationInstanceRequest.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
CreateReplicationInstanceRequest.Builder	availabilityZone(String availabilityZone) The Availability Zone where the replication instance will be created.
CreateReplicationInstanceRequest.Builder	dnsNameServers(String dnsNameServers) A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database.
CreateReplicationInstanceRequest.Builder	engineVersion(String engineVersion) The engine version number of the replication instance.
CreateReplicationInstanceRequest.Builder	kmsKeyId(String kmsKeyId) An KMS key identifier that is used to encrypt the data on the replication instance.
CreateReplicationInstanceRequest.Builder	multiAZ(Boolean multiAZ) Specifies whether the replication instance is a Multi-AZ deployment.
CreateReplicationInstanceRequest.Builder	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.
CreateReplicationInstanceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateReplicationInstanceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateReplicationInstanceRequest.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
CreateReplicationInstanceRequest.Builder	publiclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for the replication instance.
CreateReplicationInstanceRequest.Builder	replicationInstanceClass(String replicationInstanceClass) The compute and memory capacity of the replication instance as defined for the specified replication instance class.
CreateReplicationInstanceRequest.Builder	replicationInstanceIdentifier(String replicationInstanceIdentifier) The replication instance identifier.
CreateReplicationInstanceRequest.Builder	replicationSubnetGroupIdentifier(String replicationSubnetGroupIdentifier) A subnet group to associate with the replication instance.
CreateReplicationInstanceRequest.Builder	resourceIdentifier(String resourceIdentifier) A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
CreateReplicationInstanceRequest.Builder	tags(Collection<Tag> tags) One or more tags to be assigned to the replication instance.
CreateReplicationInstanceRequest.Builder	tags(Consumer<Tag.Builder>... tags) One or more tags to be assigned to the replication instance.
CreateReplicationInstanceRequest.Builder	tags(Tag... tags) One or more tags to be assigned to the replication instance.
CreateReplicationInstanceRequest.Builder	vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) Specifies the VPC security group to be used with the replication instance.
CreateReplicationInstanceRequest.Builder	vpcSecurityGroupIds(String... vpcSecurityGroupIds) Specifies the VPC security group to be used with the replication instance.

Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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

CreateReplicationInstanceRequest.Builder allocatedStorage(Integer 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

CreateReplicationInstanceRequest.Builder replicationInstanceClass(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.

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

CreateReplicationInstanceRequest.Builder vpcSecurityGroupIds(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.

availabilityZone

CreateReplicationInstanceRequest.Builder availabilityZone(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.

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

CreateReplicationInstanceRequest.Builder multiAZ(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

engineVersion

CreateReplicationInstanceRequest.Builder engineVersion(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.

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

CreateReplicationInstanceRequest.Builder autoMinorVersionUpgrade(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tags

CreateReplicationInstanceRequest.Builder tags(Collection<Tag> 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

CreateReplicationInstanceRequest.Builder tags(Tag... 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

CreateReplicationInstanceRequest.Builder tags(Consumer<Tag.Builder>... tags)

One or more tags to be assigned to the replication instance.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

kmsKeyId

CreateReplicationInstanceRequest.Builder kmsKeyId(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 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

CreateReplicationInstanceRequest.Builder publiclyAccessible(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

dnsNameServers

CreateReplicationInstanceRequest.Builder dnsNameServers(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"

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

CreateReplicationInstanceRequest.Builder resourceIdentifier(String resourceIdentifier)

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint 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 as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

Parameters:

resourceIdentifier - A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint 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 as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkType

CreateReplicationInstanceRequest.Builder 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. 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateReplicationInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder