Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS Database Migration Service Resource Types Reference » AWS::DMS::ReplicationSubnetGroup

AWS::DMS::ReplicationSubnetGroup

The AWS::DMS::ReplicationSubnetGroup resource creates an AWS DMS replication subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.

Note

Resource creation will fail if the dms-vpc-role IAM role doesn't already exist. For more information, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API in the AWS Database Migration Service User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::DMS::ReplicationSubnetGroup",
  "Properties" : {
    "ReplicationSubnetGroupIdentifier" : String,
    "ReplicationSubnetGroupDescription" : String,
    "SubnetIds" : [ String, ... ],
    "Tags" : [ Resource Tag, ... ]
  }
}

YAML

Type: AWS::DMS::ReplicationSubnetGroup
Properties: 
  ReplicationSubnetGroupIdentifier: String
  ReplicationSubnetGroupDescription: String
  SubnetIds:
    - String
  Tags:
    - Resource Tag

Properties

ReplicationSubnetGroupIdentifier

The identifier for the replication subnet group. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the identifier.

Required: No

Type: String

Update requires: Replacement

ReplicationSubnetGroupDescription

The description for the replication subnet group.

Required: Yes

Type: String

Update requires: No interruption

SubnetIds

The EC2 subnet IDs for the replication subnet group.

Required: Yes

Type: List of String values

Update requires: No interruption

Tags

The tags that you want to attach to the AWS DMS replication subnet group.

Required: No

Type: A list of resource tags in key-value format.

Update requires: Replacement

Return Value

Ref

When you pass the logical ID of an AWS::DMS::ReplicationSubnetGroup resource to the intrinsic Ref function, the function returns the name of the replication subnet group, such as mystack-myrepsubnetgroup-0a12bc456789de0fg.

For more information about using the Ref function, see Ref.

Example

JSON

{
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Resources" : {
      "myReplicationSubnetGroup" : {
         "Type" : "AWS::DMS::ReplicationSubnetGroup",
         "Properties" : {
            "ReplicationSubnetGroupIdentifier" : "identifier",
            "ReplicationSubnetGroupDescription" : "description",
            "SubnetIds" : [ "subnet-7b5b4112", "subnet-7b5b4115" ],
            "Tags" : [ {"Key" : "String", "Value" : "String"} ]
         }
      }
   }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Resources: 
  myReplicationSubnetGroup: 
    Type: AWS::DMS::ReplicationSubnetGroup
    Properties: 
      ReplicationSubnetGroupIdentifier: "identifier"
      ReplicationSubnetGroupDescription: "description"
      SubnetIds: 
        - "subnet-7b5b4112"
        - "subnet-7b5b4115"
      Tags: 
        - 
          Key: "String"
          Value: "String"

See Also