AWS::Redshift::ClusterSecurityGroup - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
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::Redshift::ClusterSecurityGroup

Specifies a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Syntax

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

JSON

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

YAML

Type: AWS::Redshift::ClusterSecurityGroup
Properties:
  Description: String
  Tags: 
    - Tag

Properties

Description

A description for the security group.

Required: Yes

Type: String

Maximum: 2147483647

Update requires: Replacement

Tags

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

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 resource name. For example:

{ "Ref": "myClusterSecurityGroup" }

For the Amazon Redshift cluster security group myClusterSecurityGroup, Ref returns the name of the cluster security 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.

Examples

Specify a Cluster Security Group

The following example describes an Amazon Redshift cluster security group that you can associate cluster security group ingress rules with.

JSON

"myClusterSecurityGroup": {
  "Type": "AWS::Redshift::ClusterSecurityGroup",
  "Properties": {
    "Description": "Security group to determine where connections to the Amazon Redshift cluster can come from",
    "Tags": [
      {
        "Key": "foo",
        "Value": "bar"
      }
    ]
  }
}

YAML

myClusterSecurityGroup:
  Type: "AWS::Redshift::ClusterSecurityGroup"
  Properties:
    Description: "Security group to determine where connections to the Amazon Redshift cluster can come from"
    Tags:
      - Key: foo
        Value: bar