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
Maximum:
2147483647
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: Array of String
Maximum:
20
Update requires: No interruption
-
Specifies an arbitrary set of tags (key–value pairs) to associate with this subnet group. Use tags to manage your resources.
Required: No
Type: Array of Tag
Maximum:
50
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
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
ClusterSubnetGroupName
-
The name of the cluster subnet group.
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