CfnReplicationConfigPropsMixin

class aws_cdk.mixins_preview.aws_dms.mixins.CfnReplicationConfigPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:

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

CloudformationResource:

AWS::DMS::ReplicationConfig

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

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

# replication_settings: Any
# supplemental_settings: Any
# table_mappings: Any

cfn_replication_config_props_mixin = dms_mixins.CfnReplicationConfigPropsMixin(dms_mixins.CfnReplicationConfigMixinProps(
    compute_config=dms_mixins.CfnReplicationConfigPropsMixin.ComputeConfigProperty(
        availability_zone="availabilityZone",
        dns_name_servers="dnsNameServers",
        kms_key_id="kmsKeyId",
        max_capacity_units=123,
        min_capacity_units=123,
        multi_az=False,
        preferred_maintenance_window="preferredMaintenanceWindow",
        replication_subnet_group_id="replicationSubnetGroupId",
        vpc_security_group_ids=["vpcSecurityGroupIds"]
    ),
    replication_config_identifier="replicationConfigIdentifier",
    replication_settings=replication_settings,
    replication_type="replicationType",
    resource_identifier="resourceIdentifier",
    source_endpoint_arn="sourceEndpointArn",
    supplemental_settings=supplemental_settings,
    table_mappings=table_mappings,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_endpoint_arn="targetEndpointArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DMS::ReplicationConfig.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['computeConfig', 'replicationConfigIdentifier', 'replicationSettings', 'replicationType', 'resourceIdentifier', 'sourceEndpointArn', 'supplementalSettings', 'tableMappings', 'tags', 'targetEndpointArn']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

ComputeConfigProperty

class CfnReplicationConfigPropsMixin.ComputeConfigProperty(*, availability_zone=None, dns_name_servers=None, kms_key_id=None, max_capacity_units=None, min_capacity_units=None, multi_az=None, preferred_maintenance_window=None, replication_subnet_group_id=None, vpc_security_group_ids=None)

Bases: object

Configuration parameters for provisioning an AWS DMS Serverless replication.

Parameters:
  • availability_zone (Optional[str]) – The Availability Zone where the AWS DMS Serverless replication using this configuration will run. The default value is a random, system-chosen Availability Zone in the configuration’s AWS Region , for example, "us-west-2" . You can’t set this parameter if the MultiAZ parameter is set to true .

  • dns_name_servers (Optional[str]) – A list of custom DNS name servers supported for the AWS DMS Serverless replication to access your source or target database. This list overrides the default name servers supported by the AWS DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"

  • kms_key_id (Optional[str]) – An AWS Key Management Service ( AWS ) key Amazon Resource Name (ARN) that is used to encrypt the data during AWS DMS Serverless replication. If you don’t specify a value for the KmsKeyId parameter, AWS DMS uses your default encryption key. AWS creates the default encryption key for your Amazon Web Services account. Your AWS account has a different default encryption key for each AWS Region .

  • max_capacity_units (Union[int, float, None]) – Specifies the maximum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for AWS DMS Serverless is 384. The MaxCapacityUnits parameter is the only DCU parameter you are required to specify.

  • min_capacity_units (Union[int, float, None]) – Specifies the minimum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for AWS DMS Serverless is 1. If you don’t set this value, AWS DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, AWS DMS scales down your replication until it reaches the value specified in MinCapacityUnits .

  • multi_az (Union[bool, IResolvable, None]) – Specifies whether the AWS DMS Serverless replication is a Multi-AZ deployment. You can’t set the AvailabilityZone parameter if the MultiAZ parameter is set to true .

  • preferred_maintenance_window (Optional[str]) – The weekly time range during which system maintenance can occur for the AWS DMS Serverless replication, in Universal Coordinated Time (UTC). The format is ddd:hh24:mi-ddd:hh24:mi . The default is a 30-minute window selected at random from an 8-hour block of time per AWS Region . This maintenance occurs on a random day of the week. Valid values for days of the week include Mon , Tue , Wed , Thu , Fri , Sat , and Sun . Constraints include a minimum 30-minute window.

  • replication_subnet_group_id (Optional[str]) – Specifies a subnet group identifier to associate with the AWS DMS Serverless replication.

  • vpc_security_group_ids (Optional[Sequence[str]]) – Specifies the virtual private cloud (VPC) security group to use with the AWS DMS Serverless replication. The VPC security group must work with the VPC containing the replication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html

ExampleMetadata:

fixture=_generated

Example:

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

compute_config_property = dms_mixins.CfnReplicationConfigPropsMixin.ComputeConfigProperty(
    availability_zone="availabilityZone",
    dns_name_servers="dnsNameServers",
    kms_key_id="kmsKeyId",
    max_capacity_units=123,
    min_capacity_units=123,
    multi_az=False,
    preferred_maintenance_window="preferredMaintenanceWindow",
    replication_subnet_group_id="replicationSubnetGroupId",
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Attributes

availability_zone

The Availability Zone where the AWS DMS Serverless replication using this configuration will run.

The default value is a random, system-chosen Availability Zone in the configuration’s AWS Region , for example, "us-west-2" . You can’t set this parameter if the MultiAZ parameter is set to true .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-availabilityzone

dns_name_servers

A list of custom DNS name servers supported for the AWS DMS Serverless replication to access your source or target database.

This list overrides the default name servers supported by the AWS DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-dnsnameservers

kms_key_id

An AWS Key Management Service ( AWS ) key Amazon Resource Name (ARN) that is used to encrypt the data during AWS DMS Serverless replication.

If you don’t specify a value for the KmsKeyId parameter, AWS DMS uses your default encryption key.

AWS creates the default encryption key for your Amazon Web Services account. Your AWS account has a different default encryption key for each AWS Region .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-kmskeyid

max_capacity_units

Specifies the maximum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned.

A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for AWS DMS Serverless is 384. The MaxCapacityUnits parameter is the only DCU parameter you are required to specify.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-maxcapacityunits

min_capacity_units

Specifies the minimum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned.

A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for AWS DMS Serverless is 1. If you don’t set this value, AWS DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, AWS DMS scales down your replication until it reaches the value specified in MinCapacityUnits .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-mincapacityunits

multi_az

Specifies whether the AWS DMS Serverless replication is a Multi-AZ deployment.

You can’t set the AvailabilityZone parameter if the MultiAZ parameter is set to true .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-multiaz

preferred_maintenance_window

The weekly time range during which system maintenance can occur for the AWS DMS Serverless replication, in Universal Coordinated Time (UTC).

The format is ddd:hh24:mi-ddd:hh24:mi .

The default is a 30-minute window selected at random from an 8-hour block of time per AWS Region . This maintenance occurs on a random day of the week. Valid values for days of the week include Mon , Tue , Wed , Thu , Fri , Sat , and Sun .

Constraints include a minimum 30-minute window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-preferredmaintenancewindow

replication_subnet_group_id

Specifies a subnet group identifier to associate with the AWS DMS Serverless replication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-replicationsubnetgroupid

vpc_security_group_ids

Specifies the virtual private cloud (VPC) security group to use with the AWS DMS Serverless replication.

The VPC security group must work with the VPC containing the replication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-replicationconfig-computeconfig.html#cfn-dms-replicationconfig-computeconfig-vpcsecuritygroupids