authorize-cache-security-group-ingress¶

Description¶

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

Note

You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

Synopsis¶

  authorize-cache-security-group-ingress
--cache-security-group-name <value>
--ec2-security-group-name <value>
--ec2-security-group-owner-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--cache-security-group-name (string)

The cache security group that allows network ingress.

--ec2-security-group-name (string)

The Amazon EC2 security group to be authorized for ingress to the cache security group.

--ec2-security-group-owner-id (string)

The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To authorize cache security group for ingress

The following authorize-cache-security-group-ingress example allows network ingress to a cache security group.

aws elasticache authorize-cache-security-group-ingress \
     --cache-security-group-name  "my-sec-grp" \
     --ec2-security-group-name "my-ec2-sec-grp" \
     --ec2-security-group-owner-id "1234567890"

The command produces no output.

For more information, see Self-Service Updates in Amazon ElastiCache in the Elasticache User Guide.

Output¶

CacheSecurityGroup -> (structure)

Represents the output of one of the following operations:

AuthorizeCacheSecurityGroupIngress

CreateCacheSecurityGroup

RevokeCacheSecurityGroupIngress

OwnerId -> (string)

The Amazon account ID of the cache security group owner.

CacheSecurityGroupName -> (string)

The name of the cache security group.

Description -> (string)

The description of the cache security group.

EC2SecurityGroups -> (list)

A list of Amazon EC2 security groups that are associated with this cache security group.

(structure)

Provides ownership and status information for an Amazon EC2 security group.

Status -> (string)

The status of the Amazon EC2 security group.

EC2SecurityGroupName -> (string)

The name of the Amazon EC2 security group.

EC2SecurityGroupOwnerId -> (string)

The Amazon account ID of the Amazon EC2 security group owner.

ARN -> (string)

The ARN of the cache security group,

Table of Contents

Feedback

User Guide