CfnReplicationInstance

class aws_cdk.aws_dms.CfnReplicationInstance(scope, id, *, replication_instance_class, allocated_storage=None, allow_major_version_upgrade=None, auto_minor_version_upgrade=None, availability_zone=None, engine_version=None, kms_key_id=None, multi_az=None, preferred_maintenance_window=None, publicly_accessible=None, replication_instance_identifier=None, replication_subnet_group_identifier=None, resource_identifier=None, tags=None, vpc_security_group_ids=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::DMS::ReplicationInstance.

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

CloudformationResource

AWS::DMS::ReplicationInstance

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_dms as dms

cfn_replication_instance = dms.CfnReplicationInstance(self, "MyCfnReplicationInstance",
    replication_instance_class="replicationInstanceClass",

    # the properties below are optional
    allocated_storage=123,
    allow_major_version_upgrade=False,
    auto_minor_version_upgrade=False,
    availability_zone="availabilityZone",
    engine_version="engineVersion",
    kms_key_id="kmsKeyId",
    multi_az=False,
    preferred_maintenance_window="preferredMaintenanceWindow",
    publicly_accessible=False,
    replication_instance_identifier="replicationInstanceIdentifier",
    replication_subnet_group_identifier="replicationSubnetGroupIdentifier",
    resource_identifier="resourceIdentifier",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Create a new AWS::DMS::ReplicationInstance.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • replication_instance_class (str) – 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 .

  • allocated_storage (Union[int, float, None]) – The amount of storage (in gigabytes) to be initially allocated for the replication instance.

  • allow_major_version_upgrade (Union[bool, IResolvable, None]) – 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.

  • auto_minor_version_upgrade (Union[bool, IResolvable, None]) – 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

  • availability_zone (Optional[str]) – 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 .

  • engine_version (Optional[str]) – 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.

  • kms_key_id (Optional[str]) – 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 .

  • multi_az (Union[bool, IResolvable, None]) – 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 .

  • preferred_maintenance_window (Optional[str]) – 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.

  • publicly_accessible (Union[bool, IResolvable, None]) – 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 .

  • replication_instance_identifier (Optional[str]) – 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

  • replication_subnet_group_identifier (Optional[str]) – A subnet group to associate with the replication instance.

  • resource_identifier (Optional[str]) – 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 .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – One or more tags to be assigned to the replication instance.

  • vpc_security_group_ids (Optional[Sequence[str]]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

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.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

add_override(path, 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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"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.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

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

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DMS::ReplicationInstance'
allocated_storage

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

Link

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

Return type

Union[int, float, None]

allow_major_version_upgrade

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.

Link

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

Return type

Union[bool, IResolvable, None]

attr_replication_instance_private_ip_addresses

One or more private IP addresses for the replication instance.

CloudformationAttribute

ReplicationInstancePrivateIpAddresses

Return type

str

attr_replication_instance_public_ip_addresses

One or more public IP addresses for the replication instance.

CloudformationAttribute

ReplicationInstancePublicIpAddresses

Return type

str

auto_minor_version_upgrade

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

Link

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

Return type

Union[bool, IResolvable, None]

availability_zone

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 .

Link

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

Return type

Optional[str]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

engine_version

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.

Link

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

Return type

Optional[str]

kms_key_id

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 .

Link

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

Return type

Optional[str]

logical_id

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

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

multi_az

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 .

Link

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

Return type

Union[bool, IResolvable, None]

node

The construct tree node associated with this construct.

Return type

ConstructNode

preferred_maintenance_window

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.

Link

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

Return type

Optional[str]

publicly_accessible

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 .

Link

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

Return type

Union[bool, IResolvable, None]

ref

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 }).

Return type

str

replication_instance_class

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 .

Link

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

Return type

str

replication_instance_identifier

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

Link

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

Return type

Optional[str]

replication_subnet_group_identifier

A subnet group to associate with the replication instance.

Link

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

Return type

Optional[str]

resource_identifier

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 .

Link

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

Return type

Optional[str]

stack

The stack in which this element is defined.

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

Return type

Stack

tags

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

Link

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

Return type

TagManager

vpc_security_group_ids

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.

Link

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

Return type

Optional[List[str]]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool