AWS::Redshift::ClusterSubnetGroup
Creates an Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon VPC when creating an Amazon Redshift subnet group.
Topics
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" : [Resource Tag, ...] } }
YAML
Type: "AWS::Redshift::ClusterSubnetGroup" Properties: Description:StringSubnetIds: -StringTags: -Resource Tag
Properties
Description-
A description of the subnet group.
Required: Yes
Type: String
Update requires: No interruption
SubnetIds-
A list of VPC subnet IDs. You can modify a maximum of 20 subnets.
Required: Yes
Type: List of String values
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: Resource Tag
Update requires: No interruption
Return Values
Ref
When the logical ID of this resource is provided to the Ref intrinsic
function, Ref returns the resource name. For example:
{ "Ref": "myClusterSubnetGroup" }
For the Amazon Redshift cluster subnet group myClusterSubnetGroup,
Ref returns the name of the cluster subnet group.
For more information about using the Ref function, see Ref.
Example
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
