Menu
Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource Types Reference » AWS::Redshift::ClusterSecurityGroup

AWS::Redshift::ClusterSecurityGroup

Creates an Amazon Redshift security group. You use security groups to control access to Amazon Redshift clusters that are not in a VPC.

Topics

Syntax

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

JSON

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

YAML

Copy
Type: "AWS::Redshift::ClusterSecurityGroup"
Properties: 
  Description: String
  Tags:
    - Resource Tag

Properties

Description

A description of the security group.

Required: Yes

Type: String

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: AWS CloudFormation Resource Tags

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: 

Copy
{ "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.

Example

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

JSON

Copy
"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

Copy
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

See Also