CfnDataMigration

class aws_cdk.aws_dms.CfnDataMigration(scope, id, *, data_migration_type, migration_project_identifier, service_access_role_arn, data_migration_identifier=None, data_migration_name=None, data_migration_settings=None, source_data_settings=None, tags=None)

Bases: CfnResource

This object provides information about a AWS DMS data migration.

See:

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

CloudformationResource:

AWS::DMS::DataMigration

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 import aws_dms as dms

cfn_data_migration = dms.CfnDataMigration(self, "MyCfnDataMigration",
    data_migration_type="dataMigrationType",
    migration_project_identifier="migrationProjectIdentifier",
    service_access_role_arn="serviceAccessRoleArn",

    # the properties below are optional
    data_migration_identifier="dataMigrationIdentifier",
    data_migration_name="dataMigrationName",
    data_migration_settings=dms.CfnDataMigration.DataMigrationSettingsProperty(
        cloudwatch_logs_enabled=False,
        number_of_jobs=123,
        selection_rules="selectionRules"
    ),
    source_data_settings=[dms.CfnDataMigration.SourceDataSettingsProperty(
        cdc_start_position="cdcStartPosition",
        cdc_start_time="cdcStartTime",
        cdc_stop_time="cdcStopTime",
        slot_name="slotName"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • data_migration_type (str) – Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

  • migration_project_identifier (str) – The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn

  • service_access_role_arn (str) – The IAM role that the data migration uses to access AWS resources.

  • data_migration_identifier (Optional[str]) – The property describes an ARN of the data migration.

  • data_migration_name (Optional[str]) – The user-friendly name for the data migration.

  • data_migration_settings (Union[IResolvable, DataMigrationSettingsProperty, Dict[str, Any], None]) – Specifies CloudWatch settings and selection rules for the data migration.

  • source_data_settings (Union[IResolvable, Sequence[Union[IResolvable, SourceDataSettingsProperty, Dict[str, Any]]], None]) – Specifies information about the data migration’s source data provider.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

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.

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

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 resource, please consult that specific resource’s documentation.

See:

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

Return type:

None

get_att(attribute_name, type_hint=None)

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.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

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

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

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

Return type:

List[CfnResource]

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

remove_dependency(target)

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.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
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::DataMigration'
attr_data_migration_arn

The Amazon Resource Name (ARN) that identifies this replication.

CloudformationAttribute:

DataMigrationArn

attr_data_migration_create_time

The UTC time when DMS created the data migration.

CloudformationAttribute:

DataMigrationCreateTime

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

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

cfn_resource_type

AWS resource type.

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.

data_migration_identifier

The property describes an ARN of the data migration.

data_migration_name

The user-friendly name for the data migration.

data_migration_settings

Specifies CloudWatch settings and selection rules for the data migration.

data_migration_type

Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

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

Returns:

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

migration_project_identifier

The property describes an identifier for the migration project.

node

The tree node.

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

service_access_role_arn

The IAM role that the data migration uses to access AWS resources.

source_data_settings

Specifies information about the data migration’s source data provider.

stack

The stack in which this element is defined.

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

tags

An array of key-value pairs to apply to this resource.

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

DataMigrationSettingsProperty

class CfnDataMigration.DataMigrationSettingsProperty(*, cloudwatch_logs_enabled=None, number_of_jobs=None, selection_rules=None)

Bases: object

Options for configuring a data migration, including whether to enable CloudWatch logs, and the selection rules to use to include or exclude database objects from the migration.

Parameters:
  • cloudwatch_logs_enabled (Union[bool, IResolvable, None]) – Whether to enable CloudWatch logging for the data migration.

  • number_of_jobs (Union[int, float, None]) – The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

  • selection_rules (Optional[str]) – A JSON-formatted string that defines what objects to include and exclude from the migration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-datamigrationsettings.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 import aws_dms as dms

data_migration_settings_property = dms.CfnDataMigration.DataMigrationSettingsProperty(
    cloudwatch_logs_enabled=False,
    number_of_jobs=123,
    selection_rules="selectionRules"
)

Attributes

cloudwatch_logs_enabled

Whether to enable CloudWatch logging for the data migration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-datamigrationsettings.html#cfn-dms-datamigration-datamigrationsettings-cloudwatchlogsenabled

number_of_jobs

The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-datamigrationsettings.html#cfn-dms-datamigration-datamigrationsettings-numberofjobs

selection_rules

A JSON-formatted string that defines what objects to include and exclude from the migration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-datamigrationsettings.html#cfn-dms-datamigration-datamigrationsettings-selectionrules

SourceDataSettingsProperty

class CfnDataMigration.SourceDataSettingsProperty(*, cdc_start_position=None, cdc_start_time=None, cdc_stop_time=None, slot_name=None)

Bases: object

Parameters:
  • cdc_start_position (Optional[str]) – The property is a point in the database engine’s log that defines a time where you can begin CDC.

  • cdc_start_time (Optional[str]) – The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format.

  • cdc_stop_time (Optional[str]) – The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format.

  • slot_name (Optional[str]) – The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.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 import aws_dms as dms

source_data_settings_property = dms.CfnDataMigration.SourceDataSettingsProperty(
    cdc_start_position="cdcStartPosition",
    cdc_start_time="cdcStartTime",
    cdc_stop_time="cdcStopTime",
    slot_name="slotName"
)

Attributes

cdc_start_position

The property is a point in the database engine’s log that defines a time where you can begin CDC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html#cfn-dms-datamigration-sourcedatasettings-cdcstartposition

cdc_start_time

The property indicates the start time for a change data capture (CDC) operation.

The value is server time in UTC format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html#cfn-dms-datamigration-sourcedatasettings-cdcstarttime

cdc_stop_time

The property indicates the stop time for a change data capture (CDC) operation.

The value is server time in UTC format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html#cfn-dms-datamigration-sourcedatasettings-cdcstoptime

slot_name

The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-datamigration-sourcedatasettings.html#cfn-dms-datamigration-sourcedatasettings-slotname