AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AddTagsToResourceRequest |
Container for the parameters to the AddTagsToResource operation.
The AddTagsToResource action adds up to 10 cost allocation tags to the named
resource. A cost allocation tag is a key-value pair where the key and value
are case-sensitive. Cost allocation tags can be used to categorize and track your
AWS costs.
When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache. |
|
AddTagsToResourceResponse | Configuration for accessing Amazon AddTagsToResource service | |
AddTagsToResourceResult | Represents the output from the AddTagsToResource, ListTagsOnResource, and RemoveTagsFromResource actions. | |
AuthorizationAlreadyExistsException | ElastiCache exception | |
AuthorizationNotFoundException | ElastiCache exception | |
AuthorizeCacheSecurityGroupIngressRequest |
Container for the parameters to the AuthorizeCacheSecurityGroupIngress operation.
The AuthorizeCacheSecurityGroupIngress action allows network ingress to a cache
security group. Applications using ElastiCache must be running on Amazon EC2, and
Amazon EC2 security groups are used as the authorization mechanism.
|
|
AuthorizeCacheSecurityGroupIngressResponse | Configuration for accessing Amazon AuthorizeCacheSecurityGroupIngress service | |
AuthorizeCacheSecurityGroupIngressResult |
Represents the output of one of the following actions:
|
|
AvailabilityZone | Describes an Availability Zone in which the cache cluster is launched. | |
CacheCluster | Contains all of the attributes of a specific cache cluster. | |
CacheClusterAlreadyExistsException | ElastiCache exception | |
CacheClusterNotFoundException | ElastiCache exception | |
CacheEngineVersion | Provides all of the details about a particular cache engine version. | |
CacheNode |
Represents an individual cache node within a cache cluster. Each cache node runs its
own instance of the cluster's protocol-compliant caching software - either Memcached
or Redis.
Valid node types are as follows:
Notes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis. |
|
CacheNodeTypeSpecificParameter | A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type. | |
CacheNodeTypeSpecificValue | A value that applies only to a certain cache node type. | |
CacheParameterGroup | Represents the output of a CreateCacheParameterGroup action. | |
CacheParameterGroupAlreadyExistsException | ElastiCache exception | |
CacheParameterGroupNotFoundException | ElastiCache exception | |
CacheParameterGroupQuotaExceededException | ElastiCache exception | |
CacheParameterGroupStatus | The status of the cache parameter group. | |
CacheSecurityGroup |
Represents the output of one of the following actions:
|
|
CacheSecurityGroupAlreadyExistsException | ElastiCache exception | |
CacheSecurityGroupMembership | Represents a cache cluster's status within a particular cache security group. | |
CacheSecurityGroupNotFoundException | ElastiCache exception | |
CacheSecurityGroupQuotaExceededException | ElastiCache exception | |
CacheSubnetGroup |
Represents the output of one of the following actions:
|
|
CacheSubnetGroupAlreadyExistsException | ElastiCache exception | |
CacheSubnetGroupInUseException | ElastiCache exception | |
CacheSubnetGroupNotFoundException | ElastiCache exception | |
CacheSubnetGroupQuotaExceededException | ElastiCache exception | |
CacheSubnetQuotaExceededException | ElastiCache exception | |
ClusterQuotaForCustomerExceededException | ElastiCache exception | |
CopySnapshotRequest | Container for the parameters to the CopySnapshot operation. The CopySnapshot action makes a copy of an existing snapshot. | |
CopySnapshotResponse | Configuration for accessing Amazon CopySnapshot service | |
CopySnapshotResult | Represents a copy of an entire cache cluster as of the time when the snapshot was taken. | |
CreateCacheClusterRequest | Container for the parameters to the CreateCacheCluster operation. The CreateCacheCluster action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis. | |
CreateCacheClusterResponse | Configuration for accessing Amazon CreateCacheCluster service | |
CreateCacheClusterResult | Contains all of the attributes of a specific cache cluster. | |
CreateCacheParameterGroupRequest | Container for the parameters to the CreateCacheParameterGroup operation. The CreateCacheParameterGroup action creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster. | |
CreateCacheParameterGroupResponse | Configuration for accessing Amazon CreateCacheParameterGroup service | |
CreateCacheParameterGroupResult | Represents the output of a CreateCacheParameterGroup action. | |
CreateCacheSecurityGroupRequest |
Container for the parameters to the CreateCacheSecurityGroup operation.
The CreateCacheSecurityGroup action creates a new cache security group. Use
a cache security group to control access to one or more cache clusters.
Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup. |
|
CreateCacheSecurityGroupResponse | Configuration for accessing Amazon CreateCacheSecurityGroup service | |
CreateCacheSecurityGroupResult |
Represents the output of one of the following actions:
|
|
CreateCacheSubnetGroupRequest |
Container for the parameters to the CreateCacheSubnetGroup operation.
The CreateCacheSubnetGroup action creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC). |
|
CreateCacheSubnetGroupResponse | Configuration for accessing Amazon CreateCacheSubnetGroup service | |
CreateCacheSubnetGroupResult |
Represents the output of one of the following actions:
|
|
CreateReplicationGroupRequest |
Container for the parameters to the CreateReplicationGroup operation.
The CreateReplicationGroup action creates a replication group. A replication
group is a collection of cache clusters, where one of the cache clusters is a read/write
primary and the others are read-only replicas. Writes to the primary are automatically
propagated to the replicas.
When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas. Note: This action is valid only for Redis. |
|
CreateReplicationGroupResponse | Configuration for accessing Amazon CreateReplicationGroup service | |
CreateReplicationGroupResult | Contains all of the attributes of a specific replication group. | |
CreateSnapshotRequest | Container for the parameters to the CreateSnapshot operation. The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time. | |
CreateSnapshotResponse | Configuration for accessing Amazon CreateSnapshot service | |
CreateSnapshotResult | Represents a copy of an entire cache cluster as of the time when the snapshot was taken. | |
DeleteCacheClusterRequest |
Container for the parameters to the DeleteCacheCluster operation.
The DeleteCacheCluster action deletes a previously provisioned cache cluster.
DeleteCacheCluster deletes all associated cache nodes, node endpoints and the
cache cluster itself. When you receive a successful response from this action, Amazon
ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert
this action.
This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled. |
|
DeleteCacheClusterResponse | Configuration for accessing Amazon DeleteCacheCluster service | |
DeleteCacheClusterResult | Contains all of the attributes of a specific cache cluster. | |
DeleteCacheParameterGroupRequest | Container for the parameters to the DeleteCacheParameterGroup operation. The DeleteCacheParameterGroup action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. | |
DeleteCacheParameterGroupResponse | ||
DeleteCacheSecurityGroupRequest |
Container for the parameters to the DeleteCacheSecurityGroup operation.
The DeleteCacheSecurityGroup action deletes a cache security group.
|
|
DeleteCacheSecurityGroupResponse | ||
DeleteCacheSubnetGroupRequest |
Container for the parameters to the DeleteCacheSubnetGroup operation.
The DeleteCacheSubnetGroup action deletes a cache subnet group.
|
|
DeleteCacheSubnetGroupResponse | ||
DeleteReplicationGroupRequest |
Container for the parameters to the DeleteReplicationGroup operation.
The DeleteReplicationGroup action deletes an existing replication group. By
default, this action deletes the entire replication group, including the primary cluster
and all of the read replicas. You can optionally delete only the read replicas, while
retaining the primary cluster.
When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action. |
|
DeleteReplicationGroupResponse | Configuration for accessing Amazon DeleteReplicationGroup service | |
DeleteReplicationGroupResult | Contains all of the attributes of a specific replication group. | |
DeleteSnapshotRequest | Container for the parameters to the DeleteSnapshot operation. The DeleteSnapshot action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action. | |
DeleteSnapshotResponse | Configuration for accessing Amazon DeleteSnapshot service | |
DeleteSnapshotResult | Represents a copy of an entire cache cluster as of the time when the snapshot was taken. | |
DescribeCacheClustersRequest |
Container for the parameters to the DescribeCacheClusters operation.
The DescribeCacheClusters action returns information about all provisioned
cache clusters if no cache cluster identifier is specified, or about a specific cache
cluster if a cache cluster identifier is supplied.
By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. If the cluster is in the DELETING state, only cluster level information will be displayed. If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed. |
|
DescribeCacheClustersResponse | Configuration for accessing Amazon DescribeCacheClusters service | |
DescribeCacheClustersResult | Represents the output of a DescribeCacheClusters action. | |
DescribeCacheEngineVersionsRequest | Container for the parameters to the DescribeCacheEngineVersions operation. The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions. | |
DescribeCacheEngineVersionsResponse | Configuration for accessing Amazon DescribeCacheEngineVersions service | |
DescribeCacheEngineVersionsResult | Represents the output of a DescribeCacheEngineVersions action. | |
DescribeCacheParameterGroupsRequest | Container for the parameters to the DescribeCacheParameterGroups operation. The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group. | |
DescribeCacheParameterGroupsResponse | Configuration for accessing Amazon DescribeCacheParameterGroups service | |
DescribeCacheParameterGroupsResult | Represents the output of a DescribeCacheParameterGroups action. | |
DescribeCacheParametersRequest | Container for the parameters to the DescribeCacheParameters operation. The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group. | |
DescribeCacheParametersResponse | Configuration for accessing Amazon DescribeCacheParameters service | |
DescribeCacheParametersResult | Represents the output of a DescribeCacheParameters action. | |
DescribeCacheSecurityGroupsRequest | Container for the parameters to the DescribeCacheSecurityGroups operation. The DescribeCacheSecurityGroups action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group. | |
DescribeCacheSecurityGroupsResponse | Configuration for accessing Amazon DescribeCacheSecurityGroups service | |
DescribeCacheSecurityGroupsResult | Represents the output of a DescribeCacheSecurityGroups action. | |
DescribeCacheSubnetGroupsRequest | Container for the parameters to the DescribeCacheSubnetGroups operation. The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. | |
DescribeCacheSubnetGroupsResponse | Configuration for accessing Amazon DescribeCacheSubnetGroups service | |
DescribeCacheSubnetGroupsResult | Represents the output of a DescribeCacheSubnetGroups action. | |
DescribeEngineDefaultParametersRequest | Container for the parameters to the DescribeEngineDefaultParameters operation. The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine. | |
DescribeEngineDefaultParametersResponse | Configuration for accessing Amazon DescribeEngineDefaultParameters service | |
DescribeEngineDefaultParametersResult | Represents the output of a DescribeEngineDefaultParameters action. | |
DescribeEventsRequest |
Container for the parameters to the DescribeEvents operation.
The DescribeEvents action returns events related to cache clusters, cache security
groups, and cache parameter groups. You can obtain events specific to a particular
cache cluster, cache security group, or cache parameter group by providing the name
as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. |
|
DescribeEventsResponse | Configuration for accessing Amazon DescribeEvents service | |
DescribeEventsResult | Represents the output of a DescribeEvents action. | |
DescribeReplicationGroupsRequest | Container for the parameters to the DescribeReplicationGroups operation. The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. | |
DescribeReplicationGroupsResponse | Configuration for accessing Amazon DescribeReplicationGroups service | |
DescribeReplicationGroupsResult | Represents the output of a DescribeReplicationGroups action. | |
DescribeReservedCacheNodesOfferingsRequest | Container for the parameters to the DescribeReservedCacheNodesOfferings operation. The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings. | |
DescribeReservedCacheNodesOfferingsResponse | Configuration for accessing Amazon DescribeReservedCacheNodesOfferings service | |
DescribeReservedCacheNodesOfferingsResult | Represents the output of a DescribeReservedCacheNodesOfferings action. | |
DescribeReservedCacheNodesRequest | Container for the parameters to the DescribeReservedCacheNodes operation. The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node. | |
DescribeReservedCacheNodesResponse | Configuration for accessing Amazon DescribeReservedCacheNodes service | |
DescribeReservedCacheNodesResult | Represents the output of a DescribeReservedCacheNodes action. | |
DescribeSnapshotsRequest | Container for the parameters to the DescribeSnapshots operation. The DescribeSnapshots action returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. | |
DescribeSnapshotsResponse | Configuration for accessing Amazon DescribeSnapshots service | |
DescribeSnapshotsResult | Represents the output of a DescribeSnapshots action. | |
EC2SecurityGroup | Provides ownership and status information for an Amazon EC2 security group. | |
Endpoint | Represents the information required for client programs to connect to a cache node. | |
EngineDefaults | Represents the output of a DescribeEngineDefaultParameters action. | |
Event | Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node. | |
InsufficientCacheClusterCapacityException | ElastiCache exception | |
InvalidARNException | ElastiCache exception | |
InvalidCacheClusterStateException | ElastiCache exception | |
InvalidCacheParameterGroupStateException | ElastiCache exception | |
InvalidCacheSecurityGroupStateException | ElastiCache exception | |
InvalidParameterCombinationException | ElastiCache exception | |
InvalidParameterValueException | ElastiCache exception | |
InvalidReplicationGroupStateException | ElastiCache exception | |
InvalidSnapshotStateException | ElastiCache exception | |
InvalidSubnetException | ElastiCache exception | |
InvalidVPCNetworkStateException | ElastiCache exception | |
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation.
The ListTagsForResource action lists all cost allocation tags currently on
the named resource. A cost allocation tag is a key-value pair where the key
is case-sensitive and the value is optional. Cost allocation tags can be used to categorize
and track your AWS costs.
You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache. |
|
ListTagsForResourceResponse | Configuration for accessing Amazon ListTagsForResource service | |
ListTagsForResourceResult | Represents the output from the AddTagsToResource, ListTagsOnResource, and RemoveTagsFromResource actions. | |
ModifyCacheClusterRequest | Container for the parameters to the ModifyCacheCluster operation. The ModifyCacheCluster action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values. | |
ModifyCacheClusterResponse | Configuration for accessing Amazon ModifyCacheCluster service | |
ModifyCacheClusterResult | Contains all of the attributes of a specific cache cluster. | |
ModifyCacheParameterGroupRequest | Container for the parameters to the ModifyCacheParameterGroup operation. The ModifyCacheParameterGroup action modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. | |
ModifyCacheParameterGroupResponse | Configuration for accessing Amazon ModifyCacheParameterGroup service | |
ModifyCacheParameterGroupResult |
Represents the output of one of the following actions:
|
|
ModifyCacheSubnetGroupRequest | Container for the parameters to the ModifyCacheSubnetGroup operation. The ModifyCacheSubnetGroup action modifies an existing cache subnet group. | |
ModifyCacheSubnetGroupResponse | Configuration for accessing Amazon ModifyCacheSubnetGroup service | |
ModifyCacheSubnetGroupResult |
Represents the output of one of the following actions:
|
|
ModifyReplicationGroupRequest | Container for the parameters to the ModifyReplicationGroup operation. The ModifyReplicationGroup action modifies the settings for a replication group. | |
ModifyReplicationGroupResponse | Configuration for accessing Amazon ModifyReplicationGroup service | |
ModifyReplicationGroupResult | Contains all of the attributes of a specific replication group. | |
NodeGroup | Represents a collection of cache nodes in a replication group. | |
NodeGroupMember | Represents a single node within a node group. | |
NodeQuotaForClusterExceededException | ElastiCache exception | |
NodeQuotaForCustomerExceededException | ElastiCache exception | |
NodeSnapshot | Represents an individual cache node in a snapshot of a cache cluster. | |
NotificationConfiguration | Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS). | |
Parameter | Describes an individual setting that controls some aspect of ElastiCache behavior. | |
ParameterNameValue | Describes a name-value pair that is used to update the value of a parameter. | |
PendingModifiedValues | A group of settings that will be applied to the cache cluster in the future, or that are currently being applied. | |
PurchaseReservedCacheNodesOfferingRequest | Container for the parameters to the PurchaseReservedCacheNodesOffering operation. The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering. | |
PurchaseReservedCacheNodesOfferingResponse | Configuration for accessing Amazon PurchaseReservedCacheNodesOffering service | |
PurchaseReservedCacheNodesOfferingResult | Represents the output of a PurchaseReservedCacheNodesOffering action. | |
RebootCacheClusterRequest |
Container for the parameters to the RebootCacheCluster operation.
The RebootCacheCluster action reboots some, or all, of the cache nodes within
a provisioned cache cluster. This API will apply any modified cache parameter groups
to the cache cluster. The reboot action takes place as soon as possible, and results
in a momentary outage to the cache cluster. During the reboot, the cache cluster status
is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cache cluster event is created. |
|
RebootCacheClusterResponse | Configuration for accessing Amazon RebootCacheCluster service | |
RebootCacheClusterResult | Contains all of the attributes of a specific cache cluster. | |
RecurringCharge | Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering. | |
RemoveTagsFromResourceRequest |
Container for the parameters to the RemoveTagsFromResource operation.
The RemoveTagsFromResource action removes the tags identified by the TagKeys
list from the named resource.
|
|
RemoveTagsFromResourceResponse | Configuration for accessing Amazon RemoveTagsFromResource service | |
RemoveTagsFromResourceResult | Represents the output from the AddTagsToResource, ListTagsOnResource, and RemoveTagsFromResource actions. | |
ReplicationGroup | Contains all of the attributes of a specific replication group. | |
ReplicationGroupAlreadyExistsException | ElastiCache exception | |
ReplicationGroupNotFoundException | ElastiCache exception | |
ReplicationGroupPendingModifiedValues | The settings to be applied to the replication group, either immediately or during the next maintenance window. | |
ReservedCacheNode | Represents the output of a PurchaseReservedCacheNodesOffering action. | |
ReservedCacheNodeAlreadyExistsException | ElastiCache exception | |
ReservedCacheNodeNotFoundException | ElastiCache exception | |
ReservedCacheNodeQuotaExceededException | ElastiCache exception | |
ReservedCacheNodesOffering | Describes all of the attributes of a reserved cache node offering. | |
ReservedCacheNodesOfferingNotFoundException | ElastiCache exception | |
ResetCacheParameterGroupRequest | Container for the parameters to the ResetCacheParameterGroup operation. The ResetCacheParameterGroup action modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters. | |
ResetCacheParameterGroupResponse | Configuration for accessing Amazon ResetCacheParameterGroup service | |
ResetCacheParameterGroupResult |
Represents the output of one of the following actions:
|
|
RevokeCacheSecurityGroupIngressRequest | Container for the parameters to the RevokeCacheSecurityGroupIngress operation. The RevokeCacheSecurityGroupIngress action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized. | |
RevokeCacheSecurityGroupIngressResponse | Configuration for accessing Amazon RevokeCacheSecurityGroupIngress service | |
RevokeCacheSecurityGroupIngressResult |
Represents the output of one of the following actions:
|
|
SecurityGroupMembership | Represents a single cache security group and its status. | |
Snapshot | Represents a copy of an entire cache cluster as of the time when the snapshot was taken. | |
SnapshotAlreadyExistsException | ElastiCache exception | |
SnapshotFeatureNotSupportedException | ElastiCache exception | |
SnapshotNotFoundException | ElastiCache exception | |
SnapshotQuotaExceededException | ElastiCache exception | |
Subnet | Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache. | |
SubnetInUseException | ElastiCache exception | |
Tag | A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted. | |
TagNotFoundException | ElastiCache exception | |
TagQuotaPerResourceExceededException | ElastiCache exception |