|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceClient
com.amazonaws.services.elasticache.AmazonElastiCacheClient
public class AmazonElastiCacheClient
Client for accessing AmazonElastiCache. All service calls made using this client are blocking, and will not return until the service call completes.
Amazon ElastiCache
Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With Amazon ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes set-up, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
Constructor Summary | |
---|---|
AmazonElastiCacheClient()
Constructs a new client to invoke service methods on AmazonElastiCache. |
|
AmazonElastiCacheClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials. |
|
AmazonElastiCacheClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials and client configuration options. |
|
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider. |
|
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider and client configuration options. |
|
AmazonElastiCacheClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonElastiCache. |
Method Summary | |
---|---|
CacheSecurityGroup |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
Authorizes ingress to a CacheSecurityGroup using EC2 Security Groups as authorization (therefore the application using the cache must be running on EC2 clusters). |
CacheCluster |
createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
Creates a new Cache Cluster. |
CacheParameterGroup |
createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
Creates a new Cache Parameter Group. |
CacheSecurityGroup |
createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
Creates a new Cache Security Group. |
CacheSubnetGroup |
createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
Creates a new Cache Subnet Group. |
CacheCluster |
deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
Deletes a previously provisioned Cache Cluster. |
void |
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
Deletes the specified CacheParameterGroup. |
void |
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
Deletes a Cache Security Group. |
void |
deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
Deletes a Cache Subnet Group. |
DescribeCacheClustersResult |
describeCacheClusters()
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. |
DescribeCacheClustersResult |
describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)
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()
Returns a list of the available cache engines and their versions. |
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions. |
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups()
Returns a list of CacheParameterGroup descriptions. |
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
Returns a list of CacheParameterGroup descriptions. |
DescribeCacheParametersResult |
describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
Returns the detailed parameter list for a particular CacheParameterGroup. |
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups()
Returns a list of CacheSecurityGroup descriptions. |
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
Returns a list of CacheSecurityGroup descriptions. |
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups()
Returns a list of CacheSubnetGroup descriptions. |
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
Returns a list of CacheSubnetGroup descriptions. |
EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine. |
DescribeEventsResult |
describeEvents()
Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. |
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. |
DescribeReservedCacheNodesResult |
describeReservedCacheNodes()
Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node. |
DescribeReservedCacheNodesResult |
describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node. |
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings()
Lists available reserved Cache Node offerings. |
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved Cache Node offerings. |
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. |
CacheCluster |
modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
Modifies the Cache Cluster settings. |
ModifyCacheParameterGroupResult |
modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
Modifies the parameters of a CacheParameterGroup. |
CacheSubnetGroup |
modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
Modifies an existing Cache Subnet Group. |
ReservedCacheNode |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
Purchases a reserved Cache Node offering. |
CacheCluster |
rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
Reboots some (or all) of the cache cluster nodes within a previously provisioned ElastiCache cluster. |
ResetCacheParameterGroupResult |
resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
Modifies the parameters of a CacheParameterGroup to the engine or system default value. |
CacheSecurityGroup |
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a CacheSecurityGroup for previously authorized EC2 Security Groups. |
Methods inherited from class com.amazonaws.AmazonWebServiceClient |
---|
addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, shutdown |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.amazonaws.services.elasticache.AmazonElastiCache |
---|
setEndpoint, shutdown |
Constructor Detail |
---|
public AmazonElastiCacheClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProvider
public AmazonElastiCacheClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonElastiCache
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProvider
public AmazonElastiCacheClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonElastiCacheClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonElastiCache
(ex: proxy settings, retry counts, etc.).public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonElastiCache
(ex: proxy settings, retry counts, etc.).Method Detail |
---|
public CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
Authorizes ingress to a CacheSecurityGroup using EC2 Security Groups as authorization (therefore the application using the cache must be running on EC2 clusters). This API requires the following parameters: EC2SecurityGroupName and EC2SecurityGroupOwnerId.
NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon Cache Cluster in another.
authorizeCacheSecurityGroupIngress
in interface AmazonElastiCache
authorizeCacheSecurityGroupIngressRequest
- Container for the
necessary parameters to execute the AuthorizeCacheSecurityGroupIngress
service method on AmazonElastiCache.
InvalidParameterValueException
AuthorizationAlreadyExistsException
InvalidCacheSecurityGroupStateException
InvalidParameterCombinationException
CacheSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new Cache Subnet Group.
createCacheSubnetGroup
in interface AmazonElastiCache
createCacheSubnetGroupRequest
- Container for the necessary
parameters to execute the CreateCacheSubnetGroup service method on
AmazonElastiCache.
CacheSubnetGroupAlreadyExistsException
CacheSubnetGroupQuotaExceededException
CacheSubnetQuotaExceededException
InvalidSubnetException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) throws AmazonServiceException, AmazonClientException
Purchases a reserved Cache Node offering.
purchaseReservedCacheNodesOffering
in interface AmazonElastiCache
purchaseReservedCacheNodesOfferingRequest
- Container for the
necessary parameters to execute the PurchaseReservedCacheNodesOffering
service method on AmazonElastiCache.
InvalidParameterValueException
ReservedCacheNodeQuotaExceededException
ReservedCacheNodeAlreadyExistsException
ReservedCacheNodesOfferingNotFoundException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheCluster rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest) throws AmazonServiceException, AmazonClientException
Reboots some (or all) of the cache cluster nodes within a previously provisioned ElastiCache cluster. This API results in the application of modified CacheParameterGroup parameters to the cache cluster. This action is taken as soon as possible, and results in a momentary outage to the cache cluster during which the cache cluster status is set to rebooting. During that momentary outage, the contents of the cache (for each cache cluster node being rebooted) are lost. A CacheCluster event is created when the reboot is completed.
rebootCacheCluster
in interface AmazonElastiCache
rebootCacheClusterRequest
- Container for the necessary
parameters to execute the RebootCacheCluster service method on
AmazonElastiCache.
CacheClusterNotFoundException
InvalidCacheClusterStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
Revokes ingress from a CacheSecurityGroup for previously authorized EC2 Security Groups.
revokeCacheSecurityGroupIngress
in interface AmazonElastiCache
revokeCacheSecurityGroupIngressRequest
- Container for the
necessary parameters to execute the RevokeCacheSecurityGroupIngress
service method on AmazonElastiCache.
InvalidParameterValueException
InvalidCacheSecurityGroupStateException
AuthorizationNotFoundException
InvalidParameterCombinationException
CacheSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of CacheSubnetGroup descriptions. If a CacheSubnetGroupName is specified, the list will contain only the description of the specified Cache Subnet Group.
describeCacheSubnetGroups
in interface AmazonElastiCache
describeCacheSubnetGroupsRequest
- Container for the necessary
parameters to execute the DescribeCacheSubnetGroups service method on
AmazonElastiCache.
CacheSubnetGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new Cache Security Group. Cache Security groups control access to one or more Cache Clusters.
Only use cache security groups when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). Inside of a VPC, use VPC security groups.
createCacheSecurityGroup
in interface AmazonElastiCache
createCacheSecurityGroupRequest
- Container for the necessary
parameters to execute the CreateCacheSecurityGroup service method on
AmazonElastiCache.
CacheSecurityGroupAlreadyExistsException
InvalidParameterValueException
CacheSecurityGroupQuotaExceededException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheCluster createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest) throws AmazonServiceException, AmazonClientException
Creates a new Cache Cluster.
createCacheCluster
in interface AmazonElastiCache
createCacheClusterRequest
- Container for the necessary
parameters to execute the CreateCacheCluster service method on
AmazonElastiCache.
NodeQuotaForCustomerExceededException
NodeQuotaForClusterExceededException
CacheSubnetGroupNotFoundException
InvalidParameterValueException
ClusterQuotaForCustomerExceededException
CacheClusterAlreadyExistsException
InvalidVPCNetworkStateException
InsufficientCacheClusterCapacityException
InvalidParameterCombinationException
CacheParameterGroupNotFoundException
CacheSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest) throws AmazonServiceException, AmazonClientException
Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. Events specific to a particular Cache Cluster, Cache Security Group, or Cache Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEvents
in interface AmazonElastiCache
describeEventsRequest
- Container for the necessary parameters to
execute the DescribeEvents service method on AmazonElastiCache.
InvalidParameterValueException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws AmazonServiceException, AmazonClientException
Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node.
describeReservedCacheNodes
in interface AmazonElastiCache
describeReservedCacheNodesRequest
- Container for the necessary
parameters to execute the DescribeReservedCacheNodes service method on
AmazonElastiCache.
ReservedCacheNodeNotFoundException
InvalidParameterValueException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the available cache engines and their versions.
describeCacheEngineVersions
in interface AmazonElastiCache
describeCacheEngineVersionsRequest
- Container for the necessary
parameters to execute the DescribeCacheEngineVersions service method
on AmazonElastiCache.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public void deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified CacheParameterGroup. The CacheParameterGroup cannot be deleted if it is associated with any cache clusters.
deleteCacheParameterGroup
in interface AmazonElastiCache
deleteCacheParameterGroupRequest
- Container for the necessary
parameters to execute the DeleteCacheParameterGroup service method on
AmazonElastiCache.
InvalidParameterValueException
InvalidParameterCombinationException
InvalidCacheParameterGroupStateException
CacheParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a CacheParameterGroup. To modify more than one parameter, submit a list of ParameterName and ParameterValue parameters. A maximum of 20 parameters can be modified in a single request.
modifyCacheParameterGroup
in interface AmazonElastiCache
modifyCacheParameterGroupRequest
- Container for the necessary
parameters to execute the ModifyCacheParameterGroup service method on
AmazonElastiCache.
InvalidParameterValueException
InvalidParameterCombinationException
CacheParameterGroupNotFoundException
InvalidCacheParameterGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AmazonServiceException, AmazonClientException
Returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParameters
in interface AmazonElastiCache
describeEngineDefaultParametersRequest
- Container for the
necessary parameters to execute the DescribeEngineDefaultParameters
service method on AmazonElastiCache.
InvalidParameterValueException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public void deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a Cache Subnet Group.
NOTE:The specified Cache Subnet Group must not be associated with any Cache Clusters.
deleteCacheSubnetGroup
in interface AmazonElastiCache
deleteCacheSubnetGroupRequest
- Container for the necessary
parameters to execute the DeleteCacheSubnetGroup service method on
AmazonElastiCache.
CacheSubnetGroupNotFoundException
CacheSubnetGroupInUseException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new Cache Parameter Group. Cache Parameter groups control the parameters for a Cache Cluster.
createCacheParameterGroup
in interface AmazonElastiCache
createCacheParameterGroupRequest
- Container for the necessary
parameters to execute the CreateCacheParameterGroup service method on
AmazonElastiCache.
InvalidParameterValueException
CacheParameterGroupQuotaExceededException
CacheParameterGroupAlreadyExistsException
InvalidParameterCombinationException
InvalidCacheParameterGroupStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of CacheSecurityGroup descriptions. If a CacheSecurityGroupName is specified, the list will contain only the description of the specified CacheSecurityGroup.
describeCacheSecurityGroups
in interface AmazonElastiCache
describeCacheSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeCacheSecurityGroups service method
on AmazonElastiCache.
InvalidParameterValueException
InvalidParameterCombinationException
CacheSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup.
describeCacheParameterGroups
in interface AmazonElastiCache
describeCacheParameterGroupsRequest
- Container for the necessary
parameters to execute the DescribeCacheParameterGroups service method
on AmazonElastiCache.
InvalidParameterValueException
InvalidParameterCombinationException
CacheParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest) throws AmazonServiceException, AmazonClientException
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.
Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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.
While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE.
While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed.
DescribeCacheClusters supports pagination.
describeCacheClusters
in interface AmazonElastiCache
describeCacheClustersRequest
- Container for the necessary
parameters to execute the DescribeCacheClusters service method on
AmazonElastiCache.
InvalidParameterValueException
CacheClusterNotFoundException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a CacheParameterGroup to the engine or system default value. To reset specific parameters submit a list of the parameter names. To reset the entire CacheParameterGroup, specify the CacheParameterGroup name and ResetAllParameters parameters.
resetCacheParameterGroup
in interface AmazonElastiCache
resetCacheParameterGroupRequest
- Container for the necessary
parameters to execute the ResetCacheParameterGroup service method on
AmazonElastiCache.
InvalidParameterValueException
InvalidParameterCombinationException
InvalidCacheParameterGroupStateException
CacheParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public void deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a Cache Security Group.
NOTE:The specified Cache Security Group must not be associated with any Cache Clusters.
deleteCacheSecurityGroup
in interface AmazonElastiCache
deleteCacheSecurityGroupRequest
- Container for the necessary
parameters to execute the DeleteCacheSecurityGroup service method on
AmazonElastiCache.
InvalidParameterValueException
InvalidCacheSecurityGroupStateException
InvalidParameterCombinationException
CacheSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheCluster modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest) throws AmazonServiceException, AmazonClientException
Modifies the Cache Cluster settings. You can change one or more Cache Cluster configuration parameters by specifying the parameters and the new values in the request.
modifyCacheCluster
in interface AmazonElastiCache
modifyCacheClusterRequest
- Container for the necessary
parameters to execute the ModifyCacheCluster service method on
AmazonElastiCache.
NodeQuotaForCustomerExceededException
NodeQuotaForClusterExceededException
InvalidParameterValueException
InvalidCacheSecurityGroupStateException
InvalidVPCNetworkStateException
CacheClusterNotFoundException
InvalidParameterCombinationException
CacheParameterGroupNotFoundException
InvalidCacheClusterStateException
CacheSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheCluster deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest) throws AmazonServiceException, AmazonClientException
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.
deleteCacheCluster
in interface AmazonElastiCache
deleteCacheClusterRequest
- Container for the necessary
parameters to execute the DeleteCacheCluster service method on
AmazonElastiCache.
InvalidParameterValueException
CacheClusterNotFoundException
InvalidParameterCombinationException
InvalidCacheClusterStateException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws AmazonServiceException, AmazonClientException
Lists available reserved Cache Node offerings.
describeReservedCacheNodesOfferings
in interface AmazonElastiCache
describeReservedCacheNodesOfferingsRequest
- Container for the
necessary parameters to execute the
DescribeReservedCacheNodesOfferings service method on
AmazonElastiCache.
InvalidParameterValueException
ReservedCacheNodesOfferingNotFoundException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest) throws AmazonServiceException, AmazonClientException
Returns the detailed parameter list for a particular CacheParameterGroup.
describeCacheParameters
in interface AmazonElastiCache
describeCacheParametersRequest
- Container for the necessary
parameters to execute the DescribeCacheParameters service method on
AmazonElastiCache.
InvalidParameterValueException
InvalidParameterCombinationException
CacheParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies an existing Cache Subnet Group.
modifyCacheSubnetGroup
in interface AmazonElastiCache
modifyCacheSubnetGroupRequest
- Container for the necessary
parameters to execute the ModifyCacheSubnetGroup service method on
AmazonElastiCache.
CacheSubnetGroupNotFoundException
CacheSubnetQuotaExceededException
InvalidSubnetException
SubnetInUseException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups() throws AmazonServiceException, AmazonClientException
Returns a list of CacheSubnetGroup descriptions. If a CacheSubnetGroupName is specified, the list will contain only the description of the specified Cache Subnet Group.
describeCacheSubnetGroups
in interface AmazonElastiCache
CacheSubnetGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeEventsResult describeEvents() throws AmazonServiceException, AmazonClientException
Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. Events specific to a particular Cache Cluster, Cache Security Group, or Cache Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEvents
in interface AmazonElastiCache
InvalidParameterValueException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeReservedCacheNodesResult describeReservedCacheNodes() throws AmazonServiceException, AmazonClientException
Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node.
describeReservedCacheNodes
in interface AmazonElastiCache
ReservedCacheNodeNotFoundException
InvalidParameterValueException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheEngineVersionsResult describeCacheEngineVersions() throws AmazonServiceException, AmazonClientException
Returns a list of the available cache engines and their versions.
describeCacheEngineVersions
in interface AmazonElastiCache
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups() throws AmazonServiceException, AmazonClientException
Returns a list of CacheSecurityGroup descriptions. If a CacheSecurityGroupName is specified, the list will contain only the description of the specified CacheSecurityGroup.
describeCacheSecurityGroups
in interface AmazonElastiCache
InvalidParameterValueException
InvalidParameterCombinationException
CacheSecurityGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheParameterGroupsResult describeCacheParameterGroups() throws AmazonServiceException, AmazonClientException
Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup.
describeCacheParameterGroups
in interface AmazonElastiCache
InvalidParameterValueException
InvalidParameterCombinationException
CacheParameterGroupNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeCacheClustersResult describeCacheClusters() throws AmazonServiceException, AmazonClientException
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.
Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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.
While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE.
While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed.
DescribeCacheClusters supports pagination.
describeCacheClusters
in interface AmazonElastiCache
InvalidParameterValueException
CacheClusterNotFoundException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings() throws AmazonServiceException, AmazonClientException
Lists available reserved Cache Node offerings.
describeReservedCacheNodesOfferings
in interface AmazonElastiCache
InvalidParameterValueException
ReservedCacheNodesOfferingNotFoundException
InvalidParameterCombinationException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AmazonElastiCache
request
- The originally executed request
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |