AWS::DMS::DataMigration - AWS CloudFormation
SyntaxPropertiesReturn values

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

This object provides information about a AWS DMS data migration.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DMS::DataMigration",
  "Properties" : {
      "DataMigrationIdentifier" : String,
      "DataMigrationName" : String,
      "DataMigrationSettings" : DataMigrationSettings,
      "DataMigrationType" : String,
      "MigrationProjectIdentifier" : String,
      "ServiceAccessRoleArn" : String,
      "SourceDataSettings" : [ SourceDataSettings, ... ],
      "Tags" : [ Tag, ... ]
    }
}

Properties

DataMigrationIdentifier

Property description not available.

Required: No

Type: String

Minimum: 1

Maximum: 300

Update requires: No interruption

DataMigrationName

The user-friendly name for the data migration.

Required: No

Type: String

Minimum: 1

Maximum: 300

Update requires: No interruption

DataMigrationSettings

Specifies CloudWatch settings and selection rules for the data migration.

Required: No

Type: DataMigrationSettings

Update requires: No interruption

DataMigrationType

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

Required: Yes

Type: String

Allowed values: full-load | cdc | full-load-and-cdc

Update requires: No interruption

MigrationProjectIdentifier

Property description not available.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

ServiceAccessRoleArn

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

Required: Yes

Type: String

Minimum: 1

Maximum: 300

Update requires: No interruption

SourceDataSettings

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

Required: No

Type: Array of SourceDataSettings

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

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.

DataMigrationArn

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

DataMigrationCreateTime

The UTC time when DMS created the data migration.