[ aws . elasticache ]
Modifies an existing cache subnet group.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
modify-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>]
--cache-subnet-group-name
(string)
The 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 of the cache subnet group.
--subnet-ids
(list)
The EC2 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.
See ‘aws help’ for descriptions of global parameters.
To modify a cache subnet group
The following modify-cache-subnet-group
example modifies the specified cache subnet group.
aws elasticache modify-cache-subnet-group \
--cache-subnet-group-name kxkxk \
--cache-subnet-group-description "mygroup"
Output:
{
"CacheSubnetGroup": {
"CacheSubnetGroupName": "kxkxk",
"CacheSubnetGroupDescription": "mygroup",
"VpcId": "vpc-xxxxcdb",
"Subnets": [
{
"SubnetIdentifier": "subnet-xxxxbff",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
}
}
]
}
}
For more information, see Modifying a Subnet Group in the Elasticache User Guide.
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.
SubnetOutpost -> (structure)
The outpost ARN of the subnet.
SubnetOutpostArn -> (string)
The outpost ARN of the subnet.
ARN -> (string)
The ARN (Amazon Resource Name) of the cache subnet group.