AWS::DMS::ReplicationConfig - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::DMS::ReplicationConfig

Syntax

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

JSON

{
  "Type" : "AWS::DMS::ReplicationConfig",
  "Properties" : {
      "ComputeConfig" : ComputeConfig,
      "ReplicationConfigIdentifier" : String,
      "ReplicationSettings" : Json,
      "ReplicationType" : String,
      "ResourceIdentifier" : String,
      "SourceEndpointArn" : String,
      "SupplementalSettings" : Json,
      "TableMappings" : Json,
      "Tags" : [ Tag, ... ],
      "TargetEndpointArn" : String
    }
}

YAML

Type: AWS::DMS::ReplicationConfig
Properties:
  ComputeConfig: 
    ComputeConfig
  ReplicationConfigIdentifier: String
  ReplicationSettings: Json
  ReplicationType: String
  ResourceIdentifier: String
  SourceEndpointArn: String
  SupplementalSettings: Json
  TableMappings: Json
  Tags: 
    - Tag
  TargetEndpointArn: String

Properties

ComputeConfig

Configuration parameters for provisioning an Amazon DMS Serverless replication.

Required: Yes

Type: ComputeConfig

Update requires: No interruption

ReplicationConfigIdentifier

A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action. You can then pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for other actions to identify both Amazon DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.

Required: Yes

Type: String

Update requires: No interruption

ReplicationSettings

Optional JSON settings for Amazon DMS Serverless replications that are provisioned using this replication configuration. For example, see Change processing tuning settings.

Required: No

Type: Json

Update requires: No interruption

ReplicationType

The type of Amazon DMS Serverless replication to provision using this replication configuration.

Possible values:

  • "full-load"

  • "cdc"

  • "full-load-and-cdc"

Required: Yes

Type: String

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

Update requires: No interruption

ResourceIdentifier

Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags.

Required: No

Type: String

Update requires: Replacement

SourceEndpointArn

The Amazon Resource Name (ARN) of the source endpoint for this Amazon DMS Serverless replication configuration.

Required: Yes

Type: String

Update requires: No interruption

SupplementalSettings

Optional JSON settings for specifying supplemental data. For more information, see Specifying supplemental data for task settings.

Required: No

Type: Json

Update requires: No interruption

TableMappings

JSON table mappings for Amazon DMS Serverless replications that are provisioned using this replication configuration. For more information, see Specifying table selection and transformations rules using JSON.

Required: Yes

Type: Json

Update requires: No interruption

Tags

One or more optional tags associated with resources used by the Amazon DMS Serverless replication. For more information, see Tagging resources in Amazon Database Migration Service.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update requires: No interruption

TargetEndpointArn

The Amazon Resource Name (ARN) of the target endpoint for this Amazon DMS serverless replication configuration.

Required: Yes

Type: String

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ReplicationConfigArn

The Amazon Resource Name (ARN) of this Amazon DMS Serverless replication configuration.