AWS CDK Reference

Appearance

v2.276.0

CfnMigrationProjectProps Struct ​

Properties for defining a CfnMigrationProject.

Source
Generated code
Type last changed
v2.275.0 · 26 Oct 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const cfnMigrationProjectProps: dms.CfnMigrationProjectProps = {
  description: 'description',
  instanceProfileIdentifier: 'instanceProfileIdentifier',
  migrationProjectIdentifier: 'migrationProjectIdentifier',
  migrationProjectName: 'migrationProjectName',
  schemaConversionApplicationAttributes: {
    s3BucketPath: 's3BucketPath',
    s3BucketRoleArn: 's3BucketRoleArn',
  },
  sourceDataProviderDescriptors: [{
    dataProviderArn: 'dataProviderArn',
    dataProviderIdentifier: 'dataProviderIdentifier',
    dataProviderName: 'dataProviderName',
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetDataProviderDescriptors: [{
    dataProviderArn: 'dataProviderArn',
    dataProviderIdentifier: 'dataProviderIdentifier',
    dataProviderName: 'dataProviderName',
    secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
    secretsManagerSecretId: 'secretsManagerSecretId',
  }],
  transformationRules: 'transformationRules',
};
python
from aws_cdk import CfnTag
# 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_identifier="instanceProfileIdentifier",
    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"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.dms.*;

CfnMigrationProjectProps cfnMigrationProjectProps = CfnMigrationProjectProps.builder()
        .description("description")
        .instanceProfileIdentifier("instanceProfileIdentifier")
        .migrationProjectIdentifier("migrationProjectIdentifier")
        .migrationProjectName("migrationProjectName")
        .schemaConversionApplicationAttributes(SchemaConversionApplicationAttributesProperty.builder()
                .s3BucketPath("s3BucketPath")
                .s3BucketRoleArn("s3BucketRoleArn")
                .build())
        .sourceDataProviderDescriptors(List.of(DataProviderDescriptorProperty.builder()
                .dataProviderArn("dataProviderArn")
                .dataProviderIdentifier("dataProviderIdentifier")
                .dataProviderName("dataProviderName")
                .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                .secretsManagerSecretId("secretsManagerSecretId")
                .build()))
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .targetDataProviderDescriptors(List.of(DataProviderDescriptorProperty.builder()
                .dataProviderArn("dataProviderArn")
                .dataProviderIdentifier("dataProviderIdentifier")
                .dataProviderName("dataProviderName")
                .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                .secretsManagerSecretId("secretsManagerSecretId")
                .build()))
        .transformationRules("transformationRules")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;

var cfnMigrationProjectProps = new CfnMigrationProjectProps {
    Description = "description",
    InstanceProfileIdentifier = "instanceProfileIdentifier",
    MigrationProjectIdentifier = "migrationProjectIdentifier",
    MigrationProjectName = "migrationProjectName",
    SchemaConversionApplicationAttributes = new SchemaConversionApplicationAttributesProperty {
        S3BucketPath = "s3BucketPath",
        S3BucketRoleArn = "s3BucketRoleArn"
    },
    SourceDataProviderDescriptors = new [] { new DataProviderDescriptorProperty {
        DataProviderArn = "dataProviderArn",
        DataProviderIdentifier = "dataProviderIdentifier",
        DataProviderName = "dataProviderName",
        SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
        SecretsManagerSecretId = "secretsManagerSecretId"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TargetDataProviderDescriptors = new [] { new DataProviderDescriptorProperty {
        DataProviderArn = "dataProviderArn",
        DataProviderIdentifier = "dataProviderIdentifier",
        DataProviderName = "dataProviderName",
        SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
        SecretsManagerSecretId = "secretsManagerSecretId"
    } },
    TransformationRules = "transformationRules"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnMigrationProjectProps := &CfnMigrationProjectProps{
	Description: jsii.String("description"),
	InstanceProfileIdentifier: jsii.String("instanceProfileIdentifier"),
	MigrationProjectIdentifier: jsii.String("migrationProjectIdentifier"),
	MigrationProjectName: jsii.String("migrationProjectName"),
	SchemaConversionApplicationAttributes: &SchemaConversionApplicationAttributesProperty{
		S3BucketPath: jsii.String("s3BucketPath"),
		S3BucketRoleArn: jsii.String("s3BucketRoleArn"),
	},
	SourceDataProviderDescriptors: []interface{}{
		&DataProviderDescriptorProperty{
			DataProviderArn: jsii.String("dataProviderArn"),
			DataProviderIdentifier: jsii.String("dataProviderIdentifier"),
			DataProviderName: jsii.String("dataProviderName"),
			SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
			SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TargetDataProviderDescriptors: []interface{}{
		&DataProviderDescriptorProperty{
			DataProviderArn: jsii.String("dataProviderArn"),
			DataProviderIdentifier: jsii.String("dataProviderIdentifier"),
			DataProviderName: jsii.String("dataProviderName"),
			SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
			SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
		},
	},
	TransformationRules: jsii.String("transformationRules"),
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A user-friendly description of the migration project.
instanceProfileIdentifieroptionalstringinstance_profile_identifieroptionalstrinstanceProfileIdentifieroptionalStringInstanceProfileIdentifieroptionalstringInstanceProfileIdentifieroptional*string#
The identifier of the instance profile for your migration project.
migrationProjectIdentifieroptionalstringmigration_project_identifieroptionalstrmigrationProjectIdentifieroptionalStringMigrationProjectIdentifieroptionalstringMigrationProjectIdentifieroptional*stringdeprecated#
this property has been deprecated

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.

migrationProjectNameoptionalstringmigration_project_nameoptionalstrmigrationProjectNameoptionalStringMigrationProjectNameoptionalstringMigrationProjectNameoptional*string#
The name of the migration project.
schemaConversionApplicationAttributesoptionalIResolvable | CfnMigrationProject.SchemaConversionApplicationAttributesPropertyschema_conversion_application_attributesoptionaltyping.Union[IResolvable, SchemaConversionApplicationAttributesProperty]schemaConversionApplicationAttributesoptionalIResolvableSchemaConversionApplicationAttributesoptionalIResolvableSchemaConversionApplicationAttributesoptionalinterface{}#
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
sourceDataProviderDescriptorsoptionalIResolvable | IResolvable | CfnMigrationProject.DataProviderDescriptorProperty[]source_data_provider_descriptorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataProviderDescriptorProperty]]]sourceDataProviderDescriptorsoptionalIResolvableSourceDataProviderDescriptorsoptionalIResolvableSourceDataProviderDescriptorsoptionalinterface{}#
Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.
targetDataProviderDescriptorsoptionalIResolvable | IResolvable | CfnMigrationProject.DataProviderDescriptorProperty[]target_data_provider_descriptorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataProviderDescriptorProperty]]]targetDataProviderDescriptorsoptionalIResolvableTargetDataProviderDescriptorsoptionalIResolvableTargetDataProviderDescriptorsoptionalinterface{}#
Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.
transformationRulesoptionalstringtransformation_rulesoptionalstrtransformationRulesoptionalStringTransformationRulesoptionalstringTransformationRulesoptional*string#
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.