This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::DMS::MigrationProject
Provides information that defines a migration project.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::DMS::MigrationProject", "Properties" : { "Description" :String, "InstanceProfileArn" :String, "InstanceProfileIdentifier" :String, "InstanceProfileName" :String, "MigrationProjectIdentifier" :String, "MigrationProjectName" :String, "SchemaConversionApplicationAttributes" :SchemaConversionApplicationAttributes, "SourceDataProviderDescriptors" :[ DataProviderDescriptor, ... ], "Tags" :[ Tag, ... ], "TargetDataProviderDescriptors" :[ DataProviderDescriptor, ... ], "TransformationRules" :String} }
YAML
Type: AWS::DMS::MigrationProject Properties: Description:StringInstanceProfileArn:StringInstanceProfileIdentifier:StringInstanceProfileName:StringMigrationProjectIdentifier:StringMigrationProjectName:StringSchemaConversionApplicationAttributes:SchemaConversionApplicationAttributesSourceDataProviderDescriptors:- DataProviderDescriptorTags:- TagTargetDataProviderDescriptors:- DataProviderDescriptorTransformationRules:String
Properties
Description-
A user-friendly description of the migration project.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
InstanceProfileArn-
The Amazon Resource Name (ARN) of the instance profile for your migration project.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
InstanceProfileIdentifierProperty description not available.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
InstanceProfileName-
The name of the associated instance profile.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
MigrationProjectIdentifierProperty description not available.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
MigrationProjectName-
The name of the migration project.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: No interruption
SchemaConversionApplicationAttributes-
The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
Required: No
Type: SchemaConversionApplicationAttributes
Update requires: No interruption
SourceDataProviderDescriptors-
Information about the source data provider, including the name or ARN, and AWS Secrets Manager parameters.
Required: No
Type: Array of DataProviderDescriptor
Update requires: No interruption
Property description not available.
Required: No
Type: Array of Tag
Update requires: No interruption
TargetDataProviderDescriptors-
Information about the target data provider, including the name or ARN, and AWS Secrets Manager parameters.
Required: No
Type: Array of DataProviderDescriptor
Update requires: No interruption
TransformationRules-
The transformation rules for the migration project in JSON format. Transformation rules let you customize how DMS Schema Conversion converts your source database objects, including renaming, adding prefixes or suffixes, and changing data types. For the transformation rule format and examples, see Transformation rules in DMS Schema Conversion.
Note
Homogeneous data migrations do not support transformation rules.
Required: No
Type: String
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
MigrationProjectArn-
The ARN string that uniquely identifies the migration project.
