software.amazon.awscdk.services.dms

Class CfnReplicationInstance

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.dms.CfnReplicationInstance

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.993Z")
 @Stability(value=Stable)
public class CfnReplicationInstance
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DMS::ReplicationInstance`.

The AWS::DMS::ReplicationInstance resource creates an AWS DMS replication instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 CfnReplicationInstance cfnReplicationInstance = CfnReplicationInstance.Builder.create(this, "MyCfnReplicationInstance")
         .replicationInstanceClass("replicationInstanceClass")
         // the properties below are optional
         .allocatedStorage(123)
         .allowMajorVersionUpgrade(false)
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .engineVersion("engineVersion")
         .kmsKeyId("kmsKeyId")
         .multiAz(false)
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .publiclyAccessible(false)
         .replicationInstanceIdentifier("replicationInstanceIdentifier")
         .replicationSubnetGroupIdentifier("replicationSubnetGroupIdentifier")
         .resourceIdentifier("resourceIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnReplicationInstance.Builder A fluent builder for CfnReplicationInstance.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnReplicationInstance(software.constructs.Construct scope, String id, CfnReplicationInstanceProps props) Create a new `AWS::DMS::ReplicationInstance`.
protected	CfnReplicationInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReplicationInstance(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Number	getAllocatedStorage() The amount of storage (in gigabytes) to be initially allocated for the replication instance.
Object	getAllowMajorVersionUpgrade() Indicates that major version upgrades are allowed.
String	getAttrReplicationInstancePrivateIpAddresses() One or more private IP addresses for the replication instance.
String	getAttrReplicationInstancePublicIpAddresses() One or more public IP addresses for the replication instance.
Object	getAutoMinorVersionUpgrade() A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
String	getAvailabilityZone() The Availability Zone that the replication instance will be created in.
protected Map<String,Object>	getCfnProperties()
String	getEngineVersion() The engine version number of the replication instance.
String	getKmsKeyId() An AWS KMS key identifier that is used to encrypt the data on the replication instance.
Object	getMultiAz() Specifies whether the replication instance is a Multi-AZ deployment.
String	getPreferredMaintenanceWindow() The weekly time range during which system maintenance can occur, in UTC.
Object	getPubliclyAccessible() Specifies the accessibility options for the replication instance.
String	getReplicationInstanceClass() The compute and memory capacity of the replication instance as defined for the specified replication instance class.
String	getReplicationInstanceIdentifier() The replication instance identifier.
String	getReplicationSubnetGroupIdentifier() A subnet group to associate with the replication instance.
String	getResourceIdentifier() A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
TagManager	getTags() One or more tags to be assigned to the replication instance.
List<String>	getVpcSecurityGroupIds() Specifies the virtual private cloud (VPC) security group to be used with the replication instance.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllocatedStorage(Number value) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
void	setAllowMajorVersionUpgrade(Boolean value) Indicates that major version upgrades are allowed.
void	setAllowMajorVersionUpgrade(IResolvable value) Indicates that major version upgrades are allowed.
void	setAutoMinorVersionUpgrade(Boolean value) A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
void	setAutoMinorVersionUpgrade(IResolvable value) A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
void	setAvailabilityZone(String value) The Availability Zone that the replication instance will be created in.
void	setEngineVersion(String value) The engine version number of the replication instance.
void	setKmsKeyId(String value) An AWS KMS key identifier that is used to encrypt the data on the replication instance.
void	setMultiAz(Boolean value) Specifies whether the replication instance is a Multi-AZ deployment.
void	setMultiAz(IResolvable value) Specifies whether the replication instance is a Multi-AZ deployment.
void	setPreferredMaintenanceWindow(String value) The weekly time range during which system maintenance can occur, in UTC.
void	setPubliclyAccessible(Boolean value) Specifies the accessibility options for the replication instance.
void	setPubliclyAccessible(IResolvable value) Specifies the accessibility options for the replication instance.
void	setReplicationInstanceClass(String value) The compute and memory capacity of the replication instance as defined for the specified replication instance class.
void	setReplicationInstanceIdentifier(String value) The replication instance identifier.
void	setReplicationSubnetGroupIdentifier(String value) A subnet group to associate with the replication instance.
void	setResourceIdentifier(String value) A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
void	setVpcSecurityGroupIds(List<String> value) Specifies the virtual private cloud (VPC) security group to be used with the replication instance.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnReplicationInstance

protected CfnReplicationInstance(software.amazon.jsii.JsiiObjectRef objRef)

CfnReplicationInstance

protected CfnReplicationInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnReplicationInstance

@Stability(value=Stable)
public CfnReplicationInstance(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id,
                                                       @NotNull
                                                       CfnReplicationInstanceProps props)

Create a new `AWS::DMS::ReplicationInstance`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrReplicationInstancePrivateIpAddresses

@Stability(value=Stable)
 @NotNull
public String getAttrReplicationInstancePrivateIpAddresses()

One or more private IP addresses for the replication instance.

getAttrReplicationInstancePublicIpAddresses

@Stability(value=Stable)
 @NotNull
public String getAttrReplicationInstancePublicIpAddresses()

One or more public IP addresses for the replication instance.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getReplicationInstanceClass

@Stability(value=Stable)
 @NotNull
public String getReplicationInstanceClass()

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 Selecting the right AWS DMS replication instance for your migration in the AWS Database Migration Service User Guide .

setReplicationInstanceClass

@Stability(value=Stable)
public void setReplicationInstanceClass(@NotNull
                                                                 String value)

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 Selecting the right AWS DMS replication instance for your migration in the AWS Database Migration Service User Guide .

getAllocatedStorage

@Stability(value=Stable)
 @Nullable
public Number getAllocatedStorage()

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

setAllocatedStorage

@Stability(value=Stable)
public void setAllocatedStorage(@Nullable
                                                         Number value)

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

getAllowMajorVersionUpgrade

@Stability(value=Stable)
 @Nullable
public Object getAllowMajorVersionUpgrade()

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.

setAllowMajorVersionUpgrade

@Stability(value=Stable)
public void setAllowMajorVersionUpgrade(@Nullable
                                                                 Boolean value)

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.

setAllowMajorVersionUpgrade

@Stability(value=Stable)
public void setAllowMajorVersionUpgrade(@Nullable
                                                                 IResolvable value)

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.

getAutoMinorVersionUpgrade

@Stability(value=Stable)
 @Nullable
public Object getAutoMinorVersionUpgrade()

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

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                Boolean value)

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

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                IResolvable value)

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

getAvailabilityZone

@Stability(value=Stable)
 @Nullable
public String getAvailabilityZone()

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 .

setAvailabilityZone

@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
                                                         String value)

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 .

getEngineVersion

@Stability(value=Stable)
 @Nullable
public String getEngineVersion()

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.

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)

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.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

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 .

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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 .

getMultiAz

@Stability(value=Stable)
 @Nullable
public Object getMultiAz()

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 .

setMultiAz

@Stability(value=Stable)
public void setMultiAz(@Nullable
                                                Boolean value)

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 .

setMultiAz

@Stability(value=Stable)
public void setMultiAz(@Nullable
                                                IResolvable value)

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 .

getPreferredMaintenanceWindow

@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()

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.

setPreferredMaintenanceWindow

@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)

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.

getPubliclyAccessible

@Stability(value=Stable)
 @Nullable
public Object getPubliclyAccessible()

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 .

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           Boolean value)

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 .

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           IResolvable value)

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 .

getReplicationInstanceIdentifier

@Stability(value=Stable)
 @Nullable
public String getReplicationInstanceIdentifier()

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

setReplicationInstanceIdentifier

@Stability(value=Stable)
public void setReplicationInstanceIdentifier(@Nullable
                                                                      String value)

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

getReplicationSubnetGroupIdentifier

@Stability(value=Stable)
 @Nullable
public String getReplicationSubnetGroupIdentifier()

A subnet group to associate with the replication instance.

setReplicationSubnetGroupIdentifier

@Stability(value=Stable)
public void setReplicationSubnetGroupIdentifier(@Nullable
                                                                         String value)

A subnet group to associate with the replication instance.

getResourceIdentifier

@Stability(value=Stable)
 @Nullable
public String getResourceIdentifier()

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 .

setResourceIdentifier

@Stability(value=Stable)
public void setResourceIdentifier(@Nullable
                                                           String value)

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 .

getVpcSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getVpcSecurityGroupIds()

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.

setVpcSecurityGroupIds

@Stability(value=Stable)
public void setVpcSecurityGroupIds(@Nullable
                                                            List<String> value)

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.