SYNOPSIS
elasticache-delete-cache-cluster
CacheClusterId [General Options]
DESCRIPTION
This command will initiate the delete process for the cache cluster
'CacheClusterId'. Once this process is started, all the nodes in the cluster
will no longer be accessible.
ARGUMENTS
CacheClusterId
The to-be-deleted cache cluster's identifer. You can also set this value
using "--cache-cluster-id". Required.
SPECIFIC OPTIONS
-f, --force
Forces the delete to go through without prompting. By default, the delete
command will prompt.
GENERAL OPTIONS
--aws-credential-file VALUE
Location of the file with your AWS credentials. This value can be set by
using the environment variable 'AWS_CREDENTIAL_FILE'.
--connection-timeout VALUE
Specify a connection timeout VALUE (in seconds) for API calls. The
default value is '30'.
--debug
If an error occurs while --debug is used, it will display information
useful for debugging the problem. The default value is 'false'.
--delimiter VALUE
What delimiter to use when displaying delimited (long) results.
--headers
If you are displaying tabular or delimited results, it includes the
column headers. If you are showing xml results, it returns the HTTP
headers from the service request, if applicable. This is off by default.
-I, --access-key-id VALUE
Specify the AWS Access ID to use.
--region VALUE
Specify region VALUE as the web service region to use. This value can be
set by using the environment variable 'EC2_REGION'.
-S, --secret-key VALUE
Specify the AWS Secret Key to use.
--show-empty-fields
Show empty fields and rows, using a "(nil)" value. The default is to not
show empty fields or columns.
--show-request
Displays the URL used by the tools to call the AWS Service. The default
value is 'false'.
--show-table, --show-long, --show-xml, --quiet
Specify how the results are displayed: tabular, delimited (long), xml, or
no output (quiet). Tabular shows a subset of the data in fixed
column-width form, while long shows all of the returned values delimited
by a character. The xml is the raw return from the service, while quiet
suppresses all standard output. The default is tabular, or 'show-table'.
-U, --url VALUE
This option will override the URL for the service call with VALUE. This
value can be set by using the environment variable 'AWS_ELASTICACHE_URL'.
INPUT EXAMPLES
Delete a cache cluster
$PROMPT>elasticache-delete-cache-cluster cacheCluster1
OUTPUT
This command returns a table that contains the following:
* CacheClusterId - User-supplied cache cluster identifier, this is the
unique key that identifies a cache cluster.
* Created - The creation date of this cache cluster.
* Type - The compute and memory capacity of a cache node.
* Engine - Name of the cache engine to be used for this cache cluster.
* Status - The current status of the cluster.
* NumberOfNodes - The number of cache nodes within this cluster.
* PreferredAZ - The preferred availability zone of this cache cluster.
* Maintenance Window - The window during which patching and cluster
modifications will be performed. This column appears only in the --show-long
view.
* Version - The cache engine's version number.
* PendingNumberCacheNodes - The number of nodes the cache cluster will have
once any pending Add/Remove node actions are complete.
* PendingVersion - Version of the cache engine which will be deployed during
the next maintenance window, or which is currently being deployed if the
--apply-immdiately option was specified..
* Auto Minor Version Upgrade - Whether minor version upgrades will
automatically be applied to the cache cluster during its maintenance window.
This column appears only in the --show-long view.
* Name - Security Group name.
* Status - Status of authorization.
* Group Name - Name of cache parameter group applied to.
* Apply Status - Status of applying the parameter group. It can be either
in-sync or pending-reboot.
* Topic Arn - Arn for SNS topic used to publish notifications related to
cache clusters.
* Topic Status - Status of this SNS topic.
* Node ID - Node ID pending to be removed.
* Node ID - Node ID that needs to be rebooted to apply outstanding parameter
group changes.
OUTPUT EXAMPLES
Output with column headers