AmazonElastiCacheClient (AWS SDK for Java 1.7.15 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.elasticache
Class AmazonElastiCacheClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.elasticache.AmazonElastiCacheClient

All Implemented Interfaces:: AmazonElastiCache

Direct Known Subclasses:: AmazonElastiCacheAsyncClient

public class AmazonElastiCacheClient
extends AmazonWebServiceClient
implements AmazonElastiCache
extends AmazonWebServiceClient
implements AmazonElastiCache

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 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.

Field Summary
`protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>`	`exceptionUnmarshallers` List of exception unmarshallers for all AmazonElastiCache exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient
`client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset`

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(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider, client configuration options, and request metric collector.
`AmazonElastiCacheClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonElastiCache.

Method Summary
`CacheSecurityGroup`	`authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)` The AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache security group.
`Snapshot`	`copySnapshot(CopySnapshotRequest copySnapshotRequest)` The CopySnapshot operation makes a copy of an existing snapshot.
`CacheCluster`	`createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)` The CreateCacheCluster operation creates a new cache cluster.
`CacheParameterGroup`	`createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)` The CreateCacheParameterGroup operation creates a new cache parameter group.
`CacheSecurityGroup`	`createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)` The CreateCacheSecurityGroup operation creates a new cache security group.
`CacheSubnetGroup`	`createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)` The CreateCacheSubnetGroup operation creates a new cache subnet group.
`ReplicationGroup`	`createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)` The CreateReplicationGroup operation creates a replication group.
`Snapshot`	`createSnapshot(CreateSnapshotRequest createSnapshotRequest)` The CreateSnapshot operation creates a copy of an entire cache cluster at a specific moment in time.
`CacheCluster`	`deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)` The DeleteCacheCluster operation deletes a previously provisioned cache cluster.
`void`	`deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)` The DeleteCacheParameterGroup operation deletes the specified cache parameter group.
`void`	`deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)` The DeleteCacheSecurityGroup operation deletes a cache security group.
`void`	`deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)` The DeleteCacheSubnetGroup operation deletes a cache subnet group.
`ReplicationGroup`	`deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)` The DeleteReplicationGroup operation deletes an existing replication group.
`Snapshot`	`deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)` The DeleteSnapshot operation deletes an existing snapshot.
`DescribeCacheClustersResult`	`describeCacheClusters()` The DescribeCacheClusters operation 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)` The DescribeCacheClusters operation 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()` The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.
`DescribeCacheEngineVersionsResult`	`describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)` The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.
`DescribeCacheParameterGroupsResult`	`describeCacheParameterGroups()` The DescribeCacheParameterGroups operation returns a list of cache parameter group descriptions.
`DescribeCacheParameterGroupsResult`	`describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)` The DescribeCacheParameterGroups operation returns a list of cache parameter group descriptions.
`DescribeCacheParametersResult`	`describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)` The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.
`DescribeCacheSecurityGroupsResult`	`describeCacheSecurityGroups()` The DescribeCacheSecurityGroups operation returns a list of cache security group descriptions.
`DescribeCacheSecurityGroupsResult`	`describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)` The DescribeCacheSecurityGroups operation returns a list of cache security group descriptions.
`DescribeCacheSubnetGroupsResult`	`describeCacheSubnetGroups()` The DescribeCacheSubnetGroups operation returns a list of cache subnet group descriptions.
`DescribeCacheSubnetGroupsResult`	`describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)` The DescribeCacheSubnetGroups operation returns a list of cache subnet group descriptions.
`EngineDefaults`	`describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)` The DescribeEngineDefaultParameters operation returns the default engine and system parameter information for the specified cache engine.
`DescribeEventsResult`	`describeEvents()` The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest describeEventsRequest)` The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups.
`DescribeReplicationGroupsResult`	`describeReplicationGroups()` The DescribeReplicationGroups operation returns information about a particular replication group.
`DescribeReplicationGroupsResult`	`describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)` The DescribeReplicationGroups operation returns information about a particular replication group.
`DescribeReservedCacheNodesResult`	`describeReservedCacheNodes()` The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.
`DescribeReservedCacheNodesResult`	`describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)` The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.
`DescribeReservedCacheNodesOfferingsResult`	`describeReservedCacheNodesOfferings()` The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.
`DescribeReservedCacheNodesOfferingsResult`	`describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)` The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.
`DescribeSnapshotsResult`	`describeSnapshots()` The DescribeSnapshots operation returns information about cache cluster snapshots.
`DescribeSnapshotsResult`	`describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)` The DescribeSnapshots operation 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.
`CacheCluster`	`modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)` The ModifyCacheCluster operation modifies the settings for a cache cluster.
`ModifyCacheParameterGroupResult`	`modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)` The ModifyCacheParameterGroup operation modifies the parameters of a cache parameter group.
`CacheSubnetGroup`	`modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)` The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.
`ReplicationGroup`	`modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)` The ModifyReplicationGroup operation modifies the settings for a replication group.
`ReservedCacheNode`	`purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)` The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.
`CacheCluster`	`rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)` The RebootCacheCluster operation reboots some, or all, of the cache cluster nodes within a provisioned cache cluster.
`ResetCacheParameterGroupResult`	`resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)` The ResetCacheParameterGroup operation modifies the parameters of a cache parameter group to the engine or system default value.
`CacheSecurityGroup`	`revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)` The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache security group.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.amazonaws.services.elasticache.AmazonElastiCache
`setEndpoint, setRegion, shutdown`

Field Detail

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all AmazonElastiCache exceptions.

Constructor Detail

AmazonElastiCacheClient

public AmazonElastiCacheClient()

Constructs a new client to invoke service methods on AmazonElastiCache. A credentials provider chain will be used that searches for credentials in this order:

Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
Java System Properties - aws.accessKeyId and aws.secretKey
Instance profile credentials delivered through the Amazon EC2 metadata service