AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::Redshift::ClusterSubnetGroup

Specifies an Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.

Syntax

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

JSON

{ "Type" : "AWS::Redshift::ClusterSubnetGroup", "Properties" : { "Description" : String, "SubnetIds" : [ String, ... ], "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Redshift::ClusterSubnetGroup Properties: Description: String SubnetIds: - String Tags: - Tag

Properties

Description

A description for the subnet group.

Required: Yes

Type: String

Update requires: No interruption

SubnetIds

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

Required: Yes

Type: List of String

Update requires: No interruption

Tags

Specifies an arbitrary set of tags (key–value pairs) to associate with this subnet group. Use tags to manage your resources.

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 Ref function, Ref returns the resource name. For example:

{ "Ref": "myClusterSubnetGroup" }

For the Amazon Redshift subnet group myClusterSubnetGroup, Ref returns the name of the cluster subnet group.

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

Examples

Specify a Subnet

The following example specifies one subnet for an Amazon Redshift cluster subnet group.

JSON

"myClusterSubnetGroup": { "Type": "AWS::Redshift::ClusterSubnetGroup", "Properties": { "Description": "My ClusterSubnetGroup", "SubnetIds": [ "subnet-7fbc2813" ], "Tags": [ { "Key": "foo", "Value": "bar" } ] } }

YAML

myClusterSubnetGroup: Type: 'AWS::Redshift::ClusterSubnetGroup' Properties: Description: My ClusterSubnetGroup SubnetIds: - subnet-7fbc2813 Tags: - Key: foo Value: bar