[ aws . elasticache ]

create-cache-subnet-group

Description

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-cache-subnet-group
--cache-subnet-group-name <value>
--cache-subnet-group-description <value>
--subnet-ids <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--cache-subnet-group-name (string)

A name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

--cache-subnet-group-description (string)

A description for the cache subnet group.

--subnet-ids (list)

A list of VPC subnet IDs for the cache subnet group.

(string)

Syntax:

"string" "string" ...

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a cache subnet group

The following create-cache-subnet-group example creates a new cache subnet group.

aws elasticache create-cache-subnet-group \
    --cache-subnet-group-name "mygroup" \
    --cache-subnet-group-description "my subnet group" \
    --subnet-ids "subnet-xxxxec4f"

Output:

{
    "CacheSubnetGroup": {
        "CacheSubnetGroupName": "mygroup",
        "CacheSubnetGroupDescription": "my subnet group",
        "VpcId": "vpc-a3e97cdb",
        "Subnets": [
            {
                "SubnetIdentifier": "subnet-xxxxec4f",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2d"
                }
            }
        ]
    }
}

For more information, see Creating a Cache Subnet Group in the Elasticache User Guide.

Output

CacheSubnetGroup -> (structure)

Represents the output of one of the following operations:

• CreateCacheSubnetGroup

• ModifyCacheSubnetGroup

CacheSubnetGroupName -> (string)

The name of the cache subnet group.

CacheSubnetGroupDescription -> (string)

The description of the cache subnet group.

VpcId -> (string)

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

Subnets -> (list)

A list of subnets associated with the cache subnet group.

(structure)

Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

SubnetIdentifier -> (string)

The unique identifier for the subnet.

SubnetAvailabilityZone -> (structure)

The Availability Zone associated with the subnet.

Name -> (string)

The name of the Availability Zone.

ARN -> (string)

The ARN (Amazon Resource Name) of the cache subnet group.