DeleteCacheCluster - Amazon ElastiCache

Description

Deletes a previously provisioned Cache Cluster. A successful response from the web service indicates the request was received correctly. This action cannot be canceled or reverted. DeleteCacheCluster deletes all associated Cache Nodes, node endpoints and the Cache Cluster itself.

Request Parameters

For information about the common parameters that all actions use, see Common Parameters.

CacheClusterId

The Cache Cluster identifier for the Cache Cluster to be deleted. This parameter isn't case sensitive.

Type: String

Required: Yes

Response Elements

The following elements are returned in a CacheCluster structure.

AutoMinorVersionUpgrade

Indicates that minor version patches are applied automatically.

Type: Boolean

CacheClusterCreateTime

Provides the date and time the Cache Cluster was created.

Type: DateTime

CacheClusterId

Specifies a user-supplied identifier. This is the unique key that identifies a Cache Cluster.

Type: String

CacheClusterStatus

Specifies the current state of this Cache Cluster.

Type: String

CacheNodeType

Specifies the name of the compute and memory capacity node type for the Cache Cluster.

Type: String

CacheNodes

Specifies the list of Cache Nodes the Cache Cluster contains.

Type: CacheNode list

CacheParameterGroup

Provides the status of the Cache Parameter Group assigned to the Cache Cluster.

Type: CacheParameterGroupStatus

CacheSecurityGroups

Provides the list of Cache Security Group elements containing CacheSecurityGroup.Name and CacheSecurityGroup.Status sub-elements.

Type: CacheSecurityGroupMembership list

CacheSubnetGroupName

Specifies the name of the Cache Subnet Group associated with the Cache Cluster.

Type: String

ClientDownloadLandingPage

Provides the landing page to download the latest ElastiCache client library.

Type: String

ConfigurationEndpoint

Specifies a user-supplied identifier. This is the unique key that identifies a Cache Cluster.

Type: Endpoint

Engine

Provides the name of the cache engine to be used for this Cache Cluster.

Type: String

EngineVersion

Provides the cache engine version of the cache engine to be used for this Cache Cluster.

Type: String

NotificationConfiguration

Specifies the notification details the Cache Cluster contains.

Type: NotificationConfiguration

NumCacheNodes

Specifies the number of Cache Nodes the Cache Cluster contains.

Type: Integer

PendingModifiedValues

Specifies that changes to the Cache Cluster are pending. This element is only included when changes are pending. Specific changes are identified by sub-elements.

Type: PendingModifiedValues

PreferredAvailabilityZone

Specifies the name of the Availability Zone the Cache Cluster is located in.

Type: String

PreferredMaintenanceWindow

Specifies the weekly time range (in UTC) during which system maintenance can occur.

Type: String

SecurityGroups

Specifies the VPC Security Groups associated with the Cache Cluster.

Type: SecurityGroupMembership list

Errors

For information about the errors that are common to all actions, see Common Errors.

CacheClusterNotFound

CacheClusterId does not refer to an existing Cache Cluster.

HTTP Status Code: 404

InvalidCacheClusterState

The specified Cache Cluster is not in the available state.

HTTP Status Code: 400

InvalidParameterCombination

HTTP Status Code: 400

InvalidParameterValue

HTTP Status Code: 400

Examples

Sample Request

https://elasticache.us-east-1.amazonaws.com/
   ?Action=DeleteCacheCluster
   &CacheClusterId=simcoprod43&Version=2012-11-15
   &SignatureVersion=2
   &SignatureMethod=HmacSHA256
   &Timestamp=2011-07-27T02%3A46%3A46.129Z
   &AWSAccessKeyId=YOUR-ACCESS-KEY
   &Signature=YOUR-SIGNATURE

Sample Response

<DeleteCacheClusterResponse xmlns="http://elasticache.amazonaws.com/doc/2012-11-15/">
  <DeleteCacheClusterResult>
    <CacheCluster>
      <CacheParameterGroup>
        <ParameterApplyStatus>in-sync</ParameterApplyStatus>
        <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>
        <CacheNodeIdsToReboot/>
      </CacheParameterGroup>
      <CacheClusterId>simcoprod43</CacheClusterId>
      <CacheClusterStatus>deleting</CacheClusterStatus>
      <ConfigurationEndpoint>
        <Port>11211</Port>
        <Address>simcoprod43.m2st2p.cfg.cache.amazonaws.com</Address>
      </ConfigurationEndpoint>
      <CacheNodeType>cache.m1.large</CacheNodeType>
      <Engine>memcached</Engine>
      <PendingModifiedValues/>
      <PreferredAvailabilityZone>us-east-1b</PreferredAvailabilityZone>
      <CacheClusterCreateTime>2011-07-27T02:18:26.497Z</CacheClusterCreateTime>
      <EngineVersion>1.4.5</EngineVersion>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <PreferredMaintenanceWindow>mon:05:00-mon:05:30</PreferredMaintenanceWindow>
      <CacheSecurityGroups>
        <CacheSecurityGroup>
          <CacheSecurityGroupName>default</CacheSecurityGroupName>
          <Status>active</Status>
        </CacheSecurityGroup>
      </CacheSecurityGroups>
      <NumCacheNodes>3</NumCacheNodes>
    </CacheCluster>
  </DeleteCacheClusterResult>
  <ResponseMetadata>
    <RequestId>ab84aa7e-b7fa-11e0-9b0b-a9261be2b354</RequestId>
  </ResponseMetadata>
</DeleteCacheClusterResponse>

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...

AWS Documentation » Amazon ElastiCache » Amazon ElastiCache API Reference » Actions » DeleteCacheCluster	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...