[ aws . elasticache ]
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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--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. 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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
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 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.SupportedNetworkTypes -> (list)
Either
ipv4
|ipv6
|dual_stack
. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .(string)
ARN -> (string)
The ARN (Amazon Resource Name) of the cache subnet group.SupportedNetworkTypes -> (list)
Either
ipv4
|ipv6
|dual_stack
. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .(string)