AWS::DMS::ReplicationSubnetGroup - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also
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::ReplicationSubnetGroup

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

Note

Resource creation fails if the dms-vpc-role Amazon Identity and Access Management (IAM) role doesn't already exist. For more information, see Creating the IAM Roles to Use With the Amazon CLI and Amazon DMS API in the Amazon Database Migration Service User Guide.

Syntax

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

JSON

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

YAML

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

Properties

ReplicationSubnetGroupDescription

The description for the subnet group.

Required: Yes

Type: String

Update requires: No interruption

ReplicationSubnetGroupIdentifier

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

Required: No

Type: String

Update requires: Replacement

SubnetIds

One or more subnet IDs to be assigned to the subnet group.

Required: Yes

Type: List of String

Update requires: No interruption

Tags

One or more tags to be assigned to the subnet group.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the name of the replication subnet group, such as mystack-myrepsubnetgroup-0a12bc456789de0fg.

For more information about using the Reffunction, see Ref.

Examples

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: 
    Properties: 
      ReplicationSubnetGroupDescription: description
      ReplicationSubnetGroupIdentifier: identifier
      SubnetIds: 
        - subnet-7b5b4112
        - subnet-7b5b4115
      Tags: 
        - 
          Key: String
          Value: String
    Type: "AWS::DMS::ReplicationSubnetGroup"

See also