AuthorizeClusterSecurityGroupIngress - Amazon Redshift
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.

AuthorizeClusterSecurityGroupIngress

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.

If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same Amazon Web Services Region.

If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ClusterSecurityGroupName

The name of the security group to which the ingress rule is added.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

CIDRIP

The IP range to be added the Amazon Redshift security group.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

EC2SecurityGroupName

The EC2 security group to be added the Amazon Redshift security group.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

EC2SecurityGroupOwnerId

The Amazon Web Services account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The Amazon Access Key ID is not an acceptable value.

Example: 111122223333

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Response Elements

The following element is returned by the service.

ClusterSecurityGroup

Describes a security group.

Type: ClusterSecurityGroup object

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationAlreadyExists

The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.

HTTP Status Code: 400

AuthorizationQuotaExceeded

The authorization quota for the cluster security group has been reached.

HTTP Status Code: 400

ClusterSecurityGroupNotFound

The cluster security group name does not refer to an existing cluster security group.

HTTP Status Code: 404

InvalidClusterSecurityGroupState

The state of the cluster security group is not available.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of AuthorizeClusterSecurityGroupIngress.

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=AuthorizeClusterSecurityGroupIngress &CIDRIP=10.24.34.0/24 &ClusterSecurityGroupName=example-security-group &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20150817/us-east-2/redshift/aws4_request &X-Amz-Date=20150825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<AuthorizeClusterSecurityGroupIngressResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <AuthorizeClusterSecurityGroupIngressResult> <ClusterSecurityGroup> <Tags/> <EC2SecurityGroups/> <IPRanges> <IPRange> <CIDRIP>10.24.34.0/24</CIDRIP> <Status>authorized</Status> </IPRange> </IPRanges> <Description>Example security group</Description> <ClusterSecurityGroupName>example-security-group</ClusterSecurityGroupName> </ClusterSecurityGroup> </AuthorizeClusterSecurityGroupIngressResult> <ResponseMetadata> <RequestId>534d1bce-46ac-11e5-b673-31d855cc98c6</RequestId> </ResponseMetadata> </AuthorizeClusterSecurityGroupIngressResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: