AWS::DMS::ReplicationSubnetGroup - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

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 AWS Region.

Note

Resource creation fails if the dms-vpc-role AWS Identity and Access Management (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" : {
      "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, AWS 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: Array of String

Update requires: No interruption

Tags

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

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 the name of the replication subnet group, such as mystack-myrepsubnetgroup-0a12bc456789de0fg.

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

Fn::GetAtt

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