CfnMigrationProjectProps

class aws_cdk.aws_dms.CfnMigrationProjectProps(*, description=None, instance_profile_arn=None, instance_profile_identifier=None, instance_profile_name=None, migration_project_creation_time=None, migration_project_identifier=None, migration_project_name=None, schema_conversion_application_attributes=None, source_data_provider_descriptors=None, tags=None, target_data_provider_descriptors=None, transformation_rules=None)

Bases: object

Properties for defining a CfnMigrationProject.

Parameters:
  • description (Optional[str]) – A user-friendly description of the migration project.

  • instance_profile_arn (Optional[str]) – The Amazon Resource Name (ARN) of the instance profile for your migration project.

  • instance_profile_identifier (Optional[str]) – The identifier of the instance profile for your migration project.

  • instance_profile_name (Optional[str]) – The name of the associated instance profile.

  • migration_project_creation_time (Optional[str]) – (deprecated) The property describes a creating time of the migration project.

  • migration_project_identifier (Optional[str]) – The identifier of the migration project. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can’t end with a hyphen, or contain two consecutive hyphens.

  • migration_project_name (Optional[str]) – The name of the migration project.

  • schema_conversion_application_attributes (Union[IResolvable, SchemaConversionApplicationAttributesProperty, Dict[str, Any], None]) – The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

  • source_data_provider_descriptors (Union[IResolvable, Sequence[Union[IResolvable, DataProviderDescriptorProperty, Dict[str, Any]]], None]) – Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.

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

  • target_data_provider_descriptors (Union[IResolvable, Sequence[Union[IResolvable, DataProviderDescriptorProperty, Dict[str, Any]]], None]) – Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.

  • transformation_rules (Optional[str]) – The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-migrationproject.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

cfn_migration_project_props = dms.CfnMigrationProjectProps(
    description="description",
    instance_profile_arn="instanceProfileArn",
    instance_profile_identifier="instanceProfileIdentifier",
    instance_profile_name="instanceProfileName",
    migration_project_creation_time="migrationProjectCreationTime",
    migration_project_identifier="migrationProjectIdentifier",
    migration_project_name="migrationProjectName",
    schema_conversion_application_attributes=dms.CfnMigrationProject.SchemaConversionApplicationAttributesProperty(
        s3_bucket_path="s3BucketPath",
        s3_bucket_role_arn="s3BucketRoleArn"
    ),
    source_data_provider_descriptors=[dms.CfnMigrationProject.DataProviderDescriptorProperty(
        data_provider_arn="dataProviderArn",
        data_provider_identifier="dataProviderIdentifier",
        data_provider_name="dataProviderName",
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_data_provider_descriptors=[dms.CfnMigrationProject.DataProviderDescriptorProperty(
        data_provider_arn="dataProviderArn",
        data_provider_identifier="dataProviderIdentifier",
        data_provider_name="dataProviderName",
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId"
    )],
    transformation_rules="transformationRules"
)

Attributes

description

A user-friendly description of the migration project.

See:

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

instance_profile_arn

The Amazon Resource Name (ARN) of the instance profile for your migration project.

See:

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

instance_profile_identifier

The identifier of the instance profile for your migration project.

See:

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

instance_profile_name

The name of the associated instance profile.

See:

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

migration_project_creation_time

(deprecated) The property describes a creating time of the migration project.

Deprecated:

this property has been deprecated

See:

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

Stability:

deprecated

migration_project_identifier

The identifier of the migration project.

Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can’t end with a hyphen, or contain two consecutive hyphens.

See:

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

migration_project_name

The name of the migration project.

See:

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

schema_conversion_application_attributes

The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.

See:

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

source_data_provider_descriptors

Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.

See:

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

tags

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

See:

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

target_data_provider_descriptors

Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.

See:

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

transformation_rules

The settings in JSON format for migration rules.

Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.

See:

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