elasticache-modify-cache-cluster(1) Modify a cache cluster

SYNOPSIS


 elasticache-modify-cache-cluster
     CacheClusterId [--apply-immediately  ] [--auto-minor-version-upgrade 
    value ] [--nodes-to-remove  value[,value...] ]
    [--cache-parameter-group-name  value ] [--cache-security-group-names 
    value[,value...] ] [--engine-version  value ] [--notification-topic-arn 
    value ] [--notification-topic-status  value ] [--num-cache-nodes  value ]
    [--preferred-maintenance-window  value ]  [General Options]

DESCRIPTION


    Changes the settings on an existing cache cluster.  Any combination of
 optional parameters may be included in call to this API.

ARGUMENTS


 CacheClusterId
    User-supplied cache cluster identifier, this is the unique key that
    identifies a cache cluster.  The identifier must be 1 to 20 alphanumeric
    characters or hyphens, is case insensitive, and is not case preserving.
    You can also set this value using "--cache-cluster-id". Required.

SPECIFIC OPTIONS


 --apply-immediately
    If this option is included, the modifications will be applied
    immediately.  If this option is omitted, the modifications will be
    applied during the preferred maintenance window. The default value is
    'false'.


 -au, --auto-minor-version-upgrade VALUE
    Whether minor version upgrades will automatically be applied to the cache
    cluster during its maintenance window.


 -n--num-cache-nodes VALUE
    Desired number of cache nodes. A decrease in the number of cache nodes
    requires also list of node Ids to be removed (parameter nodes-to-remove
    is required in this case).


 -pg, --cache-parameter-group-name VALUE
    The name of the Cache Parameter Group to apply to this cache.


 -r--nodes-to-remove VALUE1,VALUE2,VALUE3...
    Comma-separated list of node Ids to be removed from cache cluster. This
    is only required if a decrease in the number of nodes is desired
    (parameter num-cache-nodes is required in that case).


 -sg, --cache-security-group-names VALUE1,VALUE2,VALUE3...
    Comma-separated list of cache security group name(s) with which to
    associate the cache.


 -t--notification-topic-arn VALUE
    SNS Topic ARN that will be used to publish cache cluster related
    notifications.


 -ts, --notification-topic-status VALUE
    Status of SNS Topic ARN - active or inactive. Notifications are sent only
    if the status is active.


 -v--engine-version VALUE
    The version number of the cache engine to upgrade this cache cluster to.


 -w--preferred-maintenance-window VALUE
    Preferred Maintenance Window specifies the weekly time range during which
    maintenance on the cache cluster is performed.  It is specified as a
    range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).  The minimum maintenance
    window is a 30 minutes period.

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


 This shows how to associate the MyCoworkers security group with this cache
 cluster:


 $PROMPT>elasticache-modify-cache-cluster mycachecluster --cache-security-group-names mycoworkers   
             


 This shows how to increase the number of cache nodes from 3 to 5.


 $PROMPT>elasticache-modify-cache-cluster mycachecluster --num-cache-nodes 5
             


 This shows how to decrease the number of cache nodes from 5 to 3.


 $PROMPT>elasticache-modify-cache-cluster mycachecluster --num-cache-nodes 3 --nodes-to-remove 0001,0002
             


 This shows how to modify the sns notification topic. Note that              
   the aws customer account of SNS topic must be same as the account used to
 create cache cluster.


 $PROMPT>elasticache-modify-cache-cluster mycachecluster --notification-topic-arn arn:aws:sns:us-east-1:1234567890:TestSNS
             


 This shows how to change the status of the sns notification                
 topic associated with a cache cluster to inactive from active.              
   Please note that this operation will throw an error if no topic           
      is associated with the cache cluster.


 $PROMPT>elasticache-modify-cache-cluster mycachecluster --notification-topic-status inactive 
             


 This shows how to change the Auto Minor Version Upgrade preference


 $PROMPT>elasticache-modify-cache-cluster mycachecluster --auto-minor-version-upgrade true
             

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