class CfnReplicationInstance (construct)

Language	Type name
.NET	Amazon.CDK.AWS.DMS.CfnReplicationInstance
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnReplicationInstance
Java	software.amazon.awscdk.services.dms.CfnReplicationInstance
Python	aws_cdk.aws_dms.CfnReplicationInstance
TypeScript	aws-cdk-lib » aws_dms » CfnReplicationInstance

Implements IConstruct, IDependable, IInspectable, ITaggable

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

To create a ReplicationInstance, you need permissions to create instances. You'll need similar permissions to terminate instances when you delete stacks with instances.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const cfnReplicationInstance = new dms.CfnReplicationInstance(this, 'MyCfnReplicationInstance', {
  replicationInstanceClass: 'replicationInstanceClass',

  // the properties below are optional
  allocatedStorage: 123,
  allowMajorVersionUpgrade: false,
  autoMinorVersionUpgrade: false,
  availabilityZone: 'availabilityZone',
  engineVersion: 'engineVersion',
  kmsKeyId: 'kmsKeyId',
  multiAz: false,
  networkType: 'networkType',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  publiclyAccessible: false,
  replicationInstanceIdentifier: 'replicationInstanceIdentifier',
  replicationSubnetGroupIdentifier: 'replicationSubnetGroupIdentifier',
  resourceIdentifier: 'resourceIdentifier',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
});

Initializer

new CfnReplicationInstance(scope: Construct, id: string, props: CfnReplicationInstanceProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnReplicationInstanceProps — Resource properties.

Construct Props

Name	Type	Description
replicationInstanceClass	string	The compute and memory capacity of the replication instance as defined for the specified replication instance class.
allocatedStorage?	number	The amount of storage (in gigabytes) to be initially allocated for the replication instance.
allowMajorVersionUpgrade?	boolean | IResolvable	Indicates that major version upgrades are allowed.
autoMinorVersionUpgrade?	boolean | IResolvable	A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
availabilityZone?	string	The Availability Zone that the replication instance will be created in.
engineVersion?	string	The engine version number of the replication instance.
kmsKeyId?	string	An AWS KMS key identifier that is used to encrypt the data on the replication instance.
multiAz?	boolean | IResolvable	Specifies whether the replication instance is a Multi-AZ deployment.
networkType?	string	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.
preferredMaintenanceWindow?	string	The weekly time range during which system maintenance can occur, in UTC.
publiclyAccessible?	boolean | IResolvable	Specifies the accessibility options for the replication instance.
replicationInstanceIdentifier?	string	The replication instance identifier. This parameter is stored as a lowercase string.
replicationSubnetGroupIdentifier?	string	A subnet group to associate with the replication instance.
resourceIdentifier?	string	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
tags?	CfnTag[]	One or more tags to be assigned to the replication instance.
vpcSecurityGroupIds?	string[]	Specifies the virtual private cloud (VPC) security group to be used with the replication instance.

---

replicationInstanceClass

Type: string

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceclass

---

allocatedStorage?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allocatedstorage

---

allowMajorVersionUpgrade?

Type: boolean | IResolvable (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allowmajorversionupgrade

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-autominorversionupgrade

---

availabilityZone?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-availabilityzone

---

engineVersion?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-engineversion

---

kmsKeyId?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-kmskeyid

---

multiAz?

Type: boolean | IResolvable (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-multiaz

---

networkType?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-networktype

---

preferredMaintenanceWindow?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-preferredmaintenancewindow

---

publiclyAccessible?

Type: boolean | IResolvable (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-publiclyaccessible

---

replicationInstanceIdentifier?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceidentifier

---

replicationSubnetGroupIdentifier?

Type: string (optional)

A subnet group to associate with the replication instance.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationsubnetgroupidentifier

---

resourceIdentifier?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-resourceidentifier

---

tags?

Type: CfnTag[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-tags

---

vpcSecurityGroupIds?

Type: string[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-vpcsecuritygroupids

Properties

Name	Type	Description
attrId	string
attrReplicationInstancePrivateIpAddresses	string	One or more private IP addresses for the replication instance.
attrReplicationInstancePublicIpAddresses	string	One or more public IP addresses for the replication instance.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
replicationInstanceClass	string	The compute and memory capacity of the replication instance as defined for the specified replication instance class.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
allocatedStorage?	number	The amount of storage (in gigabytes) to be initially allocated for the replication instance.
allowMajorVersionUpgrade?	boolean | IResolvable	Indicates that major version upgrades are allowed.
autoMinorVersionUpgrade?	boolean | IResolvable	A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
availabilityZone?	string	The Availability Zone that the replication instance will be created in.
engineVersion?	string	The engine version number of the replication instance.
kmsKeyId?	string	An AWS KMS key identifier that is used to encrypt the data on the replication instance.
multiAz?	boolean | IResolvable	Specifies whether the replication instance is a Multi-AZ deployment.
networkType?	string	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.
preferredMaintenanceWindow?	string	The weekly time range during which system maintenance can occur, in UTC.
publiclyAccessible?	boolean | IResolvable	Specifies the accessibility options for the replication instance.
replicationInstanceIdentifier?	string	The replication instance identifier.
replicationSubnetGroupIdentifier?	string	A subnet group to associate with the replication instance.
resourceIdentifier?	string	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
tagsRaw?	CfnTag[]	One or more tags to be assigned to the replication instance.
vpcSecurityGroupIds?	string[]	Specifies the virtual private cloud (VPC) security group to be used with the replication instance.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrId

Type: string

---

attrReplicationInstancePrivateIpAddresses

Type: string

One or more private IP addresses for the replication instance.

---

attrReplicationInstancePublicIpAddresses

Type: string

One or more public IP addresses for the replication instance.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

replicationInstanceClass

Type: string

The compute and memory capacity of the replication instance as defined for the specified replication instance class.

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

allocatedStorage?

Type: number (optional)

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

---

allowMajorVersionUpgrade?

Type: boolean | IResolvable (optional)

Indicates that major version upgrades are allowed.

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.

---

availabilityZone?

Type: string (optional)

The Availability Zone that the replication instance will be created in.

---

engineVersion?

Type: string (optional)

The engine version number of the replication instance.

---

kmsKeyId?

Type: string (optional)

An AWS KMS key identifier that is used to encrypt the data on the replication instance.

---

multiAz?

Type: boolean | IResolvable (optional)

Specifies whether the replication instance is a Multi-AZ deployment.

---

networkType?

Type: string (optional)

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.

---

preferredMaintenanceWindow?

Type: string (optional)

The weekly time range during which system maintenance can occur, in UTC.

---

publiclyAccessible?

Type: boolean | IResolvable (optional)

Specifies the accessibility options for the replication instance.

---

replicationInstanceIdentifier?

Type: string (optional)

The replication instance identifier.

This parameter is stored as a lowercase string.

---

replicationSubnetGroupIdentifier?

Type: string (optional)

A subnet group to associate with the replication instance.

---

resourceIdentifier?

Type: string (optional)

A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.

---

tagsRaw?

Type: CfnTag[] (optional)

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

---

vpcSecurityGroupIds?

Type: string[] (optional)

Specifies the virtual private cloud (VPC) security group to be used with the replication instance.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }