Class AbstractAmazonElastiCache
- java.lang.Object
-
- com.amazonaws.services.elasticache.AbstractAmazonElastiCache
-
- All Implemented Interfaces:
AmazonElastiCache
- Direct Known Subclasses:
AbstractAmazonElastiCacheAsync
public class AbstractAmazonElastiCache extends Object implements AmazonElastiCache
Abstract implementation ofAmazonElastiCache
. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAmazonElastiCache()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddTagsToResourceResult
addTagsToResource(AddTagsToResourceRequest request)
The AddTagsToResource action adds up to 10 cost allocation tags to the named resource.CacheSecurityGroup
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)
The AuthorizeCacheSecurityGroupIngress action allows network ingress to a cache security group.Snapshot
copySnapshot(CopySnapshotRequest request)
The CopySnapshot action makes a copy of an existing snapshot.CacheCluster
createCacheCluster(CreateCacheClusterRequest request)
The CreateCacheCluster action creates a cache cluster.CacheParameterGroup
createCacheParameterGroup(CreateCacheParameterGroupRequest request)
The CreateCacheParameterGroup action creates a new cache parameter group.CacheSecurityGroup
createCacheSecurityGroup(CreateCacheSecurityGroupRequest request)
The CreateCacheSecurityGroup action creates a new cache security group.CacheSubnetGroup
createCacheSubnetGroup(CreateCacheSubnetGroupRequest request)
The CreateCacheSubnetGroup action creates a new cache subnet group.ReplicationGroup
createReplicationGroup(CreateReplicationGroupRequest request)
The CreateReplicationGroup action creates a replication group.Snapshot
createSnapshot(CreateSnapshotRequest request)
The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time.CacheCluster
deleteCacheCluster(DeleteCacheClusterRequest request)
The DeleteCacheCluster action deletes a previously provisioned cache cluster.DeleteCacheParameterGroupResult
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest request)
The DeleteCacheParameterGroup action deletes the specified cache parameter group.DeleteCacheSecurityGroupResult
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request)
The DeleteCacheSecurityGroup action deletes a cache security group.DeleteCacheSubnetGroupResult
deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request)
The DeleteCacheSubnetGroup action deletes a cache subnet group.ReplicationGroup
deleteReplicationGroup(DeleteReplicationGroupRequest request)
The DeleteReplicationGroup action deletes an existing replication group.Snapshot
deleteSnapshot(DeleteSnapshotRequest request)
The DeleteSnapshot action deletes an existing snapshot.DescribeCacheClustersResult
describeCacheClusters()
Simplified method form for invoking the DescribeCacheClusters operation.DescribeCacheClustersResult
describeCacheClusters(DescribeCacheClustersRequest request)
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.DescribeCacheEngineVersionsResult
describeCacheEngineVersions()
Simplified method form for invoking the DescribeCacheEngineVersions operation.DescribeCacheEngineVersionsResult
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest request)
The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.DescribeCacheParameterGroupsResult
describeCacheParameterGroups()
Simplified method form for invoking the DescribeCacheParameterGroups operation.DescribeCacheParameterGroupsResult
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest request)
The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions.DescribeCacheParametersResult
describeCacheParameters(DescribeCacheParametersRequest request)
The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group.DescribeCacheSecurityGroupsResult
describeCacheSecurityGroups()
Simplified method form for invoking the DescribeCacheSecurityGroups operation.DescribeCacheSecurityGroupsResult
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest request)
The DescribeCacheSecurityGroups action returns a list of cache security group descriptions.DescribeCacheSubnetGroupsResult
describeCacheSubnetGroups()
Simplified method form for invoking the DescribeCacheSubnetGroups operation.DescribeCacheSubnetGroupsResult
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest request)
The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions.EngineDefaults
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine.DescribeEventsResult
describeEvents()
Simplified method form for invoking the DescribeEvents operation.DescribeEventsResult
describeEvents(DescribeEventsRequest request)
The DescribeEvents action returns events related to cache clusters, cache security groups, and cache parameter groups.DescribeReplicationGroupsResult
describeReplicationGroups()
Simplified method form for invoking the DescribeReplicationGroups operation.DescribeReplicationGroupsResult
describeReplicationGroups(DescribeReplicationGroupsRequest request)
The DescribeReplicationGroups action returns information about a particular replication group.DescribeReservedCacheNodesResult
describeReservedCacheNodes()
Simplified method form for invoking the DescribeReservedCacheNodes operation.DescribeReservedCacheNodesResult
describeReservedCacheNodes(DescribeReservedCacheNodesRequest request)
The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.DescribeReservedCacheNodesOfferingsResult
describeReservedCacheNodesOfferings()
Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.DescribeReservedCacheNodesOfferingsResult
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest request)
The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.DescribeSnapshotsResult
describeSnapshots()
Simplified method form for invoking the DescribeSnapshots operation.DescribeSnapshotsResult
describeSnapshots(DescribeSnapshotsRequest request)
The DescribeSnapshots action returns information about cache cluster snapshots.ResponseMetadata
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.ListAllowedNodeTypeModificationsResult
listAllowedNodeTypeModifications()
Simplified method form for invoking the ListAllowedNodeTypeModifications operation.ListAllowedNodeTypeModificationsResult
listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)
TheListAllowedNodeTypeModifications
action lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.ListTagsForResourceResult
listTagsForResource(ListTagsForResourceRequest request)
The ListTagsForResource action lists all cost allocation tags currently on the named resource.CacheCluster
modifyCacheCluster(ModifyCacheClusterRequest request)
The ModifyCacheCluster action modifies the settings for a cache cluster.ModifyCacheParameterGroupResult
modifyCacheParameterGroup(ModifyCacheParameterGroupRequest request)
The ModifyCacheParameterGroup action modifies the parameters of a cache parameter group.CacheSubnetGroup
modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request)
The ModifyCacheSubnetGroup action modifies an existing cache subnet group.ReplicationGroup
modifyReplicationGroup(ModifyReplicationGroupRequest request)
The ModifyReplicationGroup action modifies the settings for a replication group.ReservedCacheNode
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering.CacheCluster
rebootCacheCluster(RebootCacheClusterRequest request)
The RebootCacheCluster action reboots some, or all, of the cache nodes within a provisioned cache cluster.RemoveTagsFromResourceResult
removeTagsFromResource(RemoveTagsFromResourceRequest request)
The RemoveTagsFromResource action removes the tags identified by theTagKeys
list from the named resource.ResetCacheParameterGroupResult
resetCacheParameterGroup(ResetCacheParameterGroupRequest request)
The ResetCacheParameterGroup action modifies the parameters of a cache parameter group to the engine or system default value.CacheSecurityGroup
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest request)
The RevokeCacheSecurityGroupIngress action revokes ingress from a cache security group.void
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("elasticache.us-east-1.amazonaws.com").void
setRegion(Region region)
An alternative toAmazonElastiCache.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AmazonElastiCache
Overrides the default endpoint for this client ("elasticache.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "elasticache.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "elasticache.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonElastiCache
- Parameters:
endpoint
- The endpoint (ex: "elasticache.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "elasticache.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
public void setRegion(Region region)
Description copied from interface:AmazonElastiCache
An alternative toAmazonElastiCache.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAmazonElastiCache
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
addTagsToResource
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
addTagsToResource
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of an AddTagsToResource action.- Returns:
- Result of the AddTagsToResource operation returned by the service.
-
authorizeCacheSecurityGroupIngress
public CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)
Description copied from interface:AmazonElastiCache
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.
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region. - Specified by:
authorizeCacheSecurityGroupIngress
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of an AuthorizeCacheSecurityGroupIngress action.- Returns:
- Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
-
copySnapshot
public Snapshot copySnapshot(CopySnapshotRequest request)
Description copied from interface:AmazonElastiCache
The CopySnapshot action makes a copy of an existing snapshot.
- Specified by:
copySnapshot
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a CopySnapshotMessage action.- Returns:
- Result of the CopySnapshot operation returned by the service.
-
createCacheCluster
public CacheCluster createCacheCluster(CreateCacheClusterRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
createCacheCluster
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a CreateCacheCluster action.- Returns:
- Result of the CreateCacheCluster operation returned by the service.
-
createCacheParameterGroup
public CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
createCacheParameterGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a CreateCacheParameterGroup action.- Returns:
- Result of the CreateCacheParameterGroup operation returned by the service.
-
createCacheSecurityGroup
public CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
createCacheSecurityGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a CreateCacheSecurityGroup action.- Returns:
- Result of the CreateCacheSecurityGroup operation returned by the service.
-
createCacheSubnetGroup
public CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest request)
Description copied from interface:AmazonElastiCache
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).
- Specified by:
createCacheSubnetGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a CreateCacheSubnetGroup action.- Returns:
- Result of the CreateCacheSubnetGroup operation returned by the service.
-
createReplicationGroup
public ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
createReplicationGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a CreateReplicationGroup action.- Returns:
- Result of the CreateReplicationGroup operation returned by the service.
-
createSnapshot
public Snapshot createSnapshot(CreateSnapshotRequest request)
Description copied from interface:AmazonElastiCache
The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time.
- Specified by:
createSnapshot
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a CreateSnapshot action.- Returns:
- Result of the CreateSnapshot operation returned by the service.
-
deleteCacheCluster
public CacheCluster deleteCacheCluster(DeleteCacheClusterRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
deleteCacheCluster
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DeleteCacheCluster action.- Returns:
- Result of the DeleteCacheCluster operation returned by the service.
-
deleteCacheParameterGroup
public DeleteCacheParameterGroupResult deleteCacheParameterGroup(DeleteCacheParameterGroupRequest request)
Description copied from interface:AmazonElastiCache
The DeleteCacheParameterGroup action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
- Specified by:
deleteCacheParameterGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DeleteCacheParameterGroup action.- Returns:
- Result of the DeleteCacheParameterGroup operation returned by the service.
-
deleteCacheSecurityGroup
public DeleteCacheSecurityGroupResult deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request)
Description copied from interface:AmazonElastiCache
The DeleteCacheSecurityGroup action deletes a cache security group.
You cannot delete a cache security group if it is associated with any cache clusters. - Specified by:
deleteCacheSecurityGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DeleteCacheSecurityGroup action.- Returns:
- Result of the DeleteCacheSecurityGroup operation returned by the service.
-
deleteCacheSubnetGroup
public DeleteCacheSubnetGroupResult deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request)
Description copied from interface:AmazonElastiCache
The DeleteCacheSubnetGroup action deletes a cache subnet group.
You cannot delete a cache subnet group if it is associated with any cache clusters. - Specified by:
deleteCacheSubnetGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DeleteCacheSubnetGroup action.- Returns:
- Result of the DeleteCacheSubnetGroup operation returned by the service.
-
deleteReplicationGroup
public ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
deleteReplicationGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DeleteReplicationGroup action.- Returns:
- Result of the DeleteReplicationGroup operation returned by the service.
-
deleteSnapshot
public Snapshot deleteSnapshot(DeleteSnapshotRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
deleteSnapshot
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DeleteSnapshot action.- Returns:
- Result of the DeleteSnapshot operation returned by the service.
-
describeCacheClusters
public DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
describeCacheClusters
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeCacheClusters action.- Returns:
- Result of the DescribeCacheClusters operation returned by the service.
-
describeCacheClusters
public DescribeCacheClustersResult describeCacheClusters()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeCacheClusters operation.- Specified by:
describeCacheClusters
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeCacheClusters(DescribeCacheClustersRequest)
-
describeCacheEngineVersions
public DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest request)
Description copied from interface:AmazonElastiCache
The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
- Specified by:
describeCacheEngineVersions
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeCacheEngineVersions action.- Returns:
- Result of the DescribeCacheEngineVersions operation returned by the service.
-
describeCacheEngineVersions
public DescribeCacheEngineVersionsResult describeCacheEngineVersions()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeCacheEngineVersions operation.- Specified by:
describeCacheEngineVersions
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeCacheEngineVersions(DescribeCacheEngineVersionsRequest)
-
describeCacheParameterGroups
public DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
describeCacheParameterGroups
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeCacheParameterGroups action.- Returns:
- Result of the DescribeCacheParameterGroups operation returned by the service.
-
describeCacheParameterGroups
public DescribeCacheParameterGroupsResult describeCacheParameterGroups()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeCacheParameterGroups operation.- Specified by:
describeCacheParameterGroups
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeCacheParameterGroups(DescribeCacheParameterGroupsRequest)
-
describeCacheParameters
public DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest request)
Description copied from interface:AmazonElastiCache
The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group.
- Specified by:
describeCacheParameters
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeCacheParameters action.- Returns:
- Result of the DescribeCacheParameters operation returned by the service.
-
describeCacheSecurityGroups
public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
describeCacheSecurityGroups
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeCacheSecurityGroups action.- Returns:
- Result of the DescribeCacheSecurityGroups operation returned by the service.
-
describeCacheSecurityGroups
public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeCacheSecurityGroups operation.- Specified by:
describeCacheSecurityGroups
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest)
-
describeCacheSubnetGroups
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
describeCacheSubnetGroups
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeCacheSubnetGroups action.- Returns:
- Result of the DescribeCacheSubnetGroups operation returned by the service.
-
describeCacheSubnetGroups
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeCacheSubnetGroups operation.- Specified by:
describeCacheSubnetGroups
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)
-
describeEngineDefaultParameters
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
Description copied from interface:AmazonElastiCache
The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine.
- Specified by:
describeEngineDefaultParameters
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeEngineDefaultParameters action.- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
-
describeEvents
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
describeEvents
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeEvents action.- Returns:
- Result of the DescribeEvents operation returned by the service.
-
describeEvents
public DescribeEventsResult describeEvents()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeEvents operation.- Specified by:
describeEvents
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeEvents(DescribeEventsRequest)
-
describeReplicationGroups
public DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest request)
Description copied from interface:AmazonElastiCache
The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
- Specified by:
describeReplicationGroups
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeReplicationGroups action.- Returns:
- Result of the DescribeReplicationGroups operation returned by the service.
-
describeReplicationGroups
public DescribeReplicationGroupsResult describeReplicationGroups()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeReplicationGroups operation.- Specified by:
describeReplicationGroups
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeReplicationGroups(DescribeReplicationGroupsRequest)
-
describeReservedCacheNodes
public DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest request)
Description copied from interface:AmazonElastiCache
The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
- Specified by:
describeReservedCacheNodes
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeReservedCacheNodes action.- Returns:
- Result of the DescribeReservedCacheNodes operation returned by the service.
-
describeReservedCacheNodes
public DescribeReservedCacheNodesResult describeReservedCacheNodes()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeReservedCacheNodes operation.- Specified by:
describeReservedCacheNodes
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeReservedCacheNodes(DescribeReservedCacheNodesRequest)
-
describeReservedCacheNodesOfferings
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest request)
Description copied from interface:AmazonElastiCache
The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
- Specified by:
describeReservedCacheNodesOfferings
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeReservedCacheNodesOfferings action.- Returns:
- Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
-
describeReservedCacheNodesOfferings
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.- Specified by:
describeReservedCacheNodesOfferings
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)
-
describeSnapshots
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
describeSnapshots
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a DescribeSnapshotsMessage action.- Returns:
- Result of the DescribeSnapshots operation returned by the service.
-
describeSnapshots
public DescribeSnapshotsResult describeSnapshots()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the DescribeSnapshots operation.- Specified by:
describeSnapshots
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.describeSnapshots(DescribeSnapshotsRequest)
-
listAllowedNodeTypeModifications
public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)
Description copied from interface:AmazonElastiCache
The
ListAllowedNodeTypeModifications
action lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.When you use the
ModifyCacheCluster
orModifyReplicationGroup
APIs to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this action.- Specified by:
listAllowedNodeTypeModifications
in interfaceAmazonElastiCache
- Parameters:
request
- The input parameters for the ListAllowedNodeTypeModifications action.- Returns:
- Result of the ListAllowedNodeTypeModifications operation returned by the service.
-
listAllowedNodeTypeModifications
public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications()
Description copied from interface:AmazonElastiCache
Simplified method form for invoking the ListAllowedNodeTypeModifications operation.- Specified by:
listAllowedNodeTypeModifications
in interfaceAmazonElastiCache
- See Also:
AmazonElastiCache.listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest)
-
listTagsForResource
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
listTagsForResource
in interfaceAmazonElastiCache
- Parameters:
request
- The input parameters for the ListTagsForResource action.- Returns:
- Result of the ListTagsForResource operation returned by the service.
-
modifyCacheCluster
public CacheCluster modifyCacheCluster(ModifyCacheClusterRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
modifyCacheCluster
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a ModifyCacheCluster action.- Returns:
- Result of the ModifyCacheCluster operation returned by the service.
-
modifyCacheParameterGroup
public ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
modifyCacheParameterGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a ModifyCacheParameterGroup action.- Returns:
- Result of the ModifyCacheParameterGroup operation returned by the service.
-
modifyCacheSubnetGroup
public CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request)
Description copied from interface:AmazonElastiCache
The ModifyCacheSubnetGroup action modifies an existing cache subnet group.
- Specified by:
modifyCacheSubnetGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a ModifyCacheSubnetGroup action.- Returns:
- Result of the ModifyCacheSubnetGroup operation returned by the service.
-
modifyReplicationGroup
public ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest request)
Description copied from interface:AmazonElastiCache
The ModifyReplicationGroup action modifies the settings for a replication group.
- Specified by:
modifyReplicationGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a ModifyReplicationGroups action.- Returns:
- Result of the ModifyReplicationGroup operation returned by the service.
-
purchaseReservedCacheNodesOffering
public ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
Description copied from interface:AmazonElastiCache
The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering.
- Specified by:
purchaseReservedCacheNodesOffering
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a PurchaseReservedCacheNodesOffering action.- Returns:
- Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
-
rebootCacheCluster
public CacheCluster rebootCacheCluster(RebootCacheClusterRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
rebootCacheCluster
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a RebootCacheCluster action.- Returns:
- Result of the RebootCacheCluster operation returned by the service.
-
removeTagsFromResource
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Description copied from interface:AmazonElastiCache
The RemoveTagsFromResource action removes the tags identified by the
TagKeys
list from the named resource.- Specified by:
removeTagsFromResource
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a RemoveTagsFromResource action.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
-
resetCacheParameterGroup
public ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
resetCacheParameterGroup
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a ResetCacheParameterGroup action.- Returns:
- Result of the ResetCacheParameterGroup operation returned by the service.
-
revokeCacheSecurityGroupIngress
public CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest request)
Description copied from interface:AmazonElastiCache
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.
- Specified by:
revokeCacheSecurityGroupIngress
in interfaceAmazonElastiCache
- Parameters:
request
- Represents the input of a RevokeCacheSecurityGroupIngress action.- Returns:
- Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
-
shutdown
public void shutdown()
Description copied from interface:AmazonElastiCache
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAmazonElastiCache
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AmazonElastiCache
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonElastiCache
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-