CfnDataMigrationPropsMixin

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

Bases: Mixin

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

cfn_data_migration_props_mixin = dms_mixins.CfnDataMigrationPropsMixin(dms_mixins.CfnDataMigrationMixinProps(
    data_migration_identifier="dataMigrationIdentifier",
    data_migration_name="dataMigrationName",
    data_migration_settings=dms_mixins.CfnDataMigrationPropsMixin.DataMigrationSettingsProperty(
        cloudwatch_logs_enabled=False,
        number_of_jobs=123,
        selection_rules="selectionRules"
    ),
    data_migration_type="dataMigrationType",
    migration_project_identifier="migrationProjectIdentifier",
    service_access_role_arn="serviceAccessRoleArn",
    source_data_settings=[dms_mixins.CfnDataMigrationPropsMixin.SourceDataSettingsProperty(
        cdc_start_position="cdcStartPosition",
        cdc_start_time="cdcStartTime",
        cdc_stop_time="cdcStopTime",
        slot_name="slotName"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnDataMigrationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

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 = ['dataMigrationIdentifier', 'dataMigrationName', 'dataMigrationSettings', 'dataMigrationType', 'migrationProjectIdentifier', 'serviceAccessRoleArn', 'sourceDataSettings', 'tags']

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

DataMigrationSettingsProperty

class CfnDataMigrationPropsMixin.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.mixins_preview.aws_dms import mixins as dms_mixins

data_migration_settings_property = dms_mixins.CfnDataMigrationPropsMixin.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 CfnDataMigrationPropsMixin.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.mixins_preview.aws_dms import mixins as dms_mixins

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