Package software.amazon.awscdk.services.dms

Class CfnReplicationInstanceProps.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnReplicationInstanceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnReplicationInstanceProps>

Enclosing interface:

CfnReplicationInstanceProps

@Stability(Stable)
public static final class CfnReplicationInstanceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnReplicationInstanceProps>

A builder for CfnReplicationInstanceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnReplicationInstanceProps.Builder	allocatedStorage(Number allocatedStorage)	Sets the value of CfnReplicationInstanceProps.getAllocatedStorage()
CfnReplicationInstanceProps.Builder	allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)	Sets the value of CfnReplicationInstanceProps.getAllowMajorVersionUpgrade()
CfnReplicationInstanceProps.Builder	allowMajorVersionUpgrade(IResolvable allowMajorVersionUpgrade)	Sets the value of CfnReplicationInstanceProps.getAllowMajorVersionUpgrade()
CfnReplicationInstanceProps.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Sets the value of CfnReplicationInstanceProps.getAutoMinorVersionUpgrade()
CfnReplicationInstanceProps.Builder	autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)	Sets the value of CfnReplicationInstanceProps.getAutoMinorVersionUpgrade()
CfnReplicationInstanceProps.Builder	availabilityZone(String availabilityZone)	Sets the value of CfnReplicationInstanceProps.getAvailabilityZone()
CfnReplicationInstanceProps	build()	Builds the configured instance.
CfnReplicationInstanceProps.Builder	engineVersion(String engineVersion)	Sets the value of CfnReplicationInstanceProps.getEngineVersion()
CfnReplicationInstanceProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnReplicationInstanceProps.getKmsKeyId()
CfnReplicationInstanceProps.Builder	multiAz(Boolean multiAz)	Sets the value of CfnReplicationInstanceProps.getMultiAz()
CfnReplicationInstanceProps.Builder	multiAz(IResolvable multiAz)	Sets the value of CfnReplicationInstanceProps.getMultiAz()
CfnReplicationInstanceProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Sets the value of CfnReplicationInstanceProps.getPreferredMaintenanceWindow()
CfnReplicationInstanceProps.Builder	publiclyAccessible(Boolean publiclyAccessible)	Sets the value of CfnReplicationInstanceProps.getPubliclyAccessible()
CfnReplicationInstanceProps.Builder	publiclyAccessible(IResolvable publiclyAccessible)	Sets the value of CfnReplicationInstanceProps.getPubliclyAccessible()
CfnReplicationInstanceProps.Builder	replicationInstanceClass(String replicationInstanceClass)	Sets the value of CfnReplicationInstanceProps.getReplicationInstanceClass()
CfnReplicationInstanceProps.Builder	replicationInstanceIdentifier(String replicationInstanceIdentifier)	Sets the value of CfnReplicationInstanceProps.getReplicationInstanceIdentifier()
CfnReplicationInstanceProps.Builder	replicationSubnetGroupIdentifier(String replicationSubnetGroupIdentifier)	Sets the value of CfnReplicationInstanceProps.getReplicationSubnetGroupIdentifier()
CfnReplicationInstanceProps.Builder	resourceIdentifier(String resourceIdentifier)	Sets the value of CfnReplicationInstanceProps.getResourceIdentifier()
CfnReplicationInstanceProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnReplicationInstanceProps.getTags()
CfnReplicationInstanceProps.Builder	vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)	Sets the value of CfnReplicationInstanceProps.getVpcSecurityGroupIds()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

replicationInstanceClass

@Stability(Stable)
public CfnReplicationInstanceProps.Builder replicationInstanceClass(String replicationInstanceClass)

Sets the value of CfnReplicationInstanceProps.getReplicationInstanceClass()

Parameters:

replicationInstanceClass - The compute and memory capacity of the replication instance as defined for the specified replication instance class. This parameter is required. 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 Selecting the right AWS DMS replication instance for your migration in the AWS Database Migration Service User Guide .

Returns:

this

allocatedStorage

@Stability(Stable)
public CfnReplicationInstanceProps.Builder allocatedStorage(Number allocatedStorage)

Sets the value of CfnReplicationInstanceProps.getAllocatedStorage()

Parameters:

allocatedStorage - The amount of storage (in gigabytes) to be initially allocated for the replication instance.

Returns:

this

allowMajorVersionUpgrade

@Stability(Stable)
public CfnReplicationInstanceProps.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

Sets the value of CfnReplicationInstanceProps.getAllowMajorVersionUpgrade()

Parameters:

allowMajorVersionUpgrade - Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.

This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.

Returns:

this

allowMajorVersionUpgrade

@Stability(Stable)
public CfnReplicationInstanceProps.Builder allowMajorVersionUpgrade(IResolvable allowMajorVersionUpgrade)

Sets the value of CfnReplicationInstanceProps.getAllowMajorVersionUpgrade()

Parameters:

allowMajorVersionUpgrade - Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.

This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.

Returns:

this

autoMinorVersionUpgrade

@Stability(Stable)
public CfnReplicationInstanceProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Sets the value of CfnReplicationInstanceProps.getAutoMinorVersionUpgrade()

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:

this

autoMinorVersionUpgrade

@Stability(Stable)
public CfnReplicationInstanceProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)

Sets the value of CfnReplicationInstanceProps.getAutoMinorVersionUpgrade()

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:

this

availabilityZone

@Stability(Stable)
public CfnReplicationInstanceProps.Builder availabilityZone(String availabilityZone)

Sets the value of CfnReplicationInstanceProps.getAvailabilityZone()

Parameters:

availabilityZone - The Availability Zone that the replication instance will be created in. The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region , for example us-east-1d .

Returns:

this

engineVersion

@Stability(Stable)
public CfnReplicationInstanceProps.Builder engineVersion(String engineVersion)

Sets the value of CfnReplicationInstanceProps.getEngineVersion()

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:

this

kmsKeyId

@Stability(Stable)
public CfnReplicationInstanceProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnReplicationInstanceProps.getKmsKeyId()

Parameters:

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, 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:

this

multiAz

@Stability(Stable)
public CfnReplicationInstanceProps.Builder multiAz(Boolean multiAz)

Sets the value of CfnReplicationInstanceProps.getMultiAz()

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:

this

multiAz

@Stability(Stable)
public CfnReplicationInstanceProps.Builder multiAz(IResolvable multiAz)

Sets the value of CfnReplicationInstanceProps.getMultiAz()

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:

this

preferredMaintenanceWindow

@Stability(Stable)
public CfnReplicationInstanceProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Sets the value of CfnReplicationInstanceProps.getPreferredMaintenanceWindow()

Parameters:

preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in UTC. Format : ddd:hh24:mi-ddd:hh24:mi

Default : A 30-minute window selected at random from an 8-hour block of time per AWS Region , occurring on a random day of the week.

Valid days ( ddd ): Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints : Minimum 30-minute window.

Returns:

this

publiclyAccessible

@Stability(Stable)
public CfnReplicationInstanceProps.Builder publiclyAccessible(Boolean publiclyAccessible)

Sets the value of CfnReplicationInstanceProps.getPubliclyAccessible()

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:

this

publiclyAccessible

@Stability(Stable)
public CfnReplicationInstanceProps.Builder publiclyAccessible(IResolvable publiclyAccessible)

Sets the value of CfnReplicationInstanceProps.getPubliclyAccessible()

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:

this

replicationInstanceIdentifier

@Stability(Stable)
public CfnReplicationInstanceProps.Builder replicationInstanceIdentifier(String replicationInstanceIdentifier)

Sets the value of CfnReplicationInstanceProps.getReplicationInstanceIdentifier()

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:

this

replicationSubnetGroupIdentifier

@Stability(Stable)
public CfnReplicationInstanceProps.Builder replicationSubnetGroupIdentifier(String replicationSubnetGroupIdentifier)

Sets the value of CfnReplicationInstanceProps.getReplicationSubnetGroupIdentifier()

Parameters:

replicationSubnetGroupIdentifier - A subnet group to associate with the replication instance.

Returns:

this

resourceIdentifier

@Stability(Stable)
public CfnReplicationInstanceProps.Builder resourceIdentifier(String resourceIdentifier)

Sets the value of CfnReplicationInstanceProps.getResourceIdentifier()

Parameters:

resourceIdentifier - A display 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, AWS DMS generates a default identifier value for the end of EndpointArn .

Returns:

this

tags

@Stability(Stable)
public CfnReplicationInstanceProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnReplicationInstanceProps.getTags()

Parameters:

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

Returns:

this

vpcSecurityGroupIds

@Stability(Stable)
public CfnReplicationInstanceProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)

Sets the value of CfnReplicationInstanceProps.getVpcSecurityGroupIds()

Parameters:

vpcSecurityGroupIds - Specifies the virtual private cloud (VPC) security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

Returns:

this

build

@Stability(Stable)
public CfnReplicationInstanceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnReplicationInstanceProps>

Returns:

a new instance of CfnReplicationInstanceProps

Throws:

NullPointerException - if any required attribute was not provided