software.amazon.awssdk.services.elasticache.ElastiCacheClient Maven / Gradle / Ivy
Show all versions of elasticache Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.elasticache;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.elasticache.model.AddTagsToResourceRequest;
import software.amazon.awssdk.services.elasticache.model.AddTagsToResourceResponse;
import software.amazon.awssdk.services.elasticache.model.ApiCallRateForCustomerExceededException;
import software.amazon.awssdk.services.elasticache.model.AuthorizationAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.AuthorizationNotFoundException;
import software.amazon.awssdk.services.elasticache.model.AuthorizeCacheSecurityGroupIngressRequest;
import software.amazon.awssdk.services.elasticache.model.AuthorizeCacheSecurityGroupIngressResponse;
import software.amazon.awssdk.services.elasticache.model.BatchApplyUpdateActionRequest;
import software.amazon.awssdk.services.elasticache.model.BatchApplyUpdateActionResponse;
import software.amazon.awssdk.services.elasticache.model.BatchStopUpdateActionRequest;
import software.amazon.awssdk.services.elasticache.model.BatchStopUpdateActionResponse;
import software.amazon.awssdk.services.elasticache.model.CacheClusterAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.CacheClusterNotFoundException;
import software.amazon.awssdk.services.elasticache.model.CacheParameterGroupAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.CacheParameterGroupNotFoundException;
import software.amazon.awssdk.services.elasticache.model.CacheParameterGroupQuotaExceededException;
import software.amazon.awssdk.services.elasticache.model.CacheSecurityGroupAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.CacheSecurityGroupNotFoundException;
import software.amazon.awssdk.services.elasticache.model.CacheSecurityGroupQuotaExceededException;
import software.amazon.awssdk.services.elasticache.model.CacheSubnetGroupAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.CacheSubnetGroupInUseException;
import software.amazon.awssdk.services.elasticache.model.CacheSubnetGroupNotFoundException;
import software.amazon.awssdk.services.elasticache.model.CacheSubnetGroupQuotaExceededException;
import software.amazon.awssdk.services.elasticache.model.CacheSubnetQuotaExceededException;
import software.amazon.awssdk.services.elasticache.model.ClusterQuotaForCustomerExceededException;
import software.amazon.awssdk.services.elasticache.model.CompleteMigrationRequest;
import software.amazon.awssdk.services.elasticache.model.CompleteMigrationResponse;
import software.amazon.awssdk.services.elasticache.model.CopySnapshotRequest;
import software.amazon.awssdk.services.elasticache.model.CopySnapshotResponse;
import software.amazon.awssdk.services.elasticache.model.CreateCacheClusterRequest;
import software.amazon.awssdk.services.elasticache.model.CreateCacheClusterResponse;
import software.amazon.awssdk.services.elasticache.model.CreateCacheParameterGroupRequest;
import software.amazon.awssdk.services.elasticache.model.CreateCacheParameterGroupResponse;
import software.amazon.awssdk.services.elasticache.model.CreateCacheSecurityGroupRequest;
import software.amazon.awssdk.services.elasticache.model.CreateCacheSecurityGroupResponse;
import software.amazon.awssdk.services.elasticache.model.CreateCacheSubnetGroupRequest;
import software.amazon.awssdk.services.elasticache.model.CreateCacheSubnetGroupResponse;
import software.amazon.awssdk.services.elasticache.model.CreateGlobalReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.CreateGlobalReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.CreateReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.CreateReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.CreateSnapshotRequest;
import software.amazon.awssdk.services.elasticache.model.CreateSnapshotResponse;
import software.amazon.awssdk.services.elasticache.model.DecreaseNodeGroupsInGlobalReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.DecreaseNodeGroupsInGlobalReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.DecreaseReplicaCountRequest;
import software.amazon.awssdk.services.elasticache.model.DecreaseReplicaCountResponse;
import software.amazon.awssdk.services.elasticache.model.DeleteCacheClusterRequest;
import software.amazon.awssdk.services.elasticache.model.DeleteCacheClusterResponse;
import software.amazon.awssdk.services.elasticache.model.DeleteCacheParameterGroupRequest;
import software.amazon.awssdk.services.elasticache.model.DeleteCacheParameterGroupResponse;
import software.amazon.awssdk.services.elasticache.model.DeleteCacheSecurityGroupRequest;
import software.amazon.awssdk.services.elasticache.model.DeleteCacheSecurityGroupResponse;
import software.amazon.awssdk.services.elasticache.model.DeleteCacheSubnetGroupRequest;
import software.amazon.awssdk.services.elasticache.model.DeleteCacheSubnetGroupResponse;
import software.amazon.awssdk.services.elasticache.model.DeleteGlobalReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.DeleteGlobalReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.DeleteReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.DeleteReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.DeleteSnapshotRequest;
import software.amazon.awssdk.services.elasticache.model.DeleteSnapshotResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse;
import software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest;
import software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse;
import software.amazon.awssdk.services.elasticache.model.DisassociateGlobalReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.DisassociateGlobalReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.ElastiCacheException;
import software.amazon.awssdk.services.elasticache.model.FailoverGlobalReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.FailoverGlobalReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.GlobalReplicationGroupAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.GlobalReplicationGroupNotFoundException;
import software.amazon.awssdk.services.elasticache.model.IncreaseNodeGroupsInGlobalReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.IncreaseNodeGroupsInGlobalReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.IncreaseReplicaCountRequest;
import software.amazon.awssdk.services.elasticache.model.IncreaseReplicaCountResponse;
import software.amazon.awssdk.services.elasticache.model.InsufficientCacheClusterCapacityException;
import software.amazon.awssdk.services.elasticache.model.InvalidArnException;
import software.amazon.awssdk.services.elasticache.model.InvalidCacheClusterStateException;
import software.amazon.awssdk.services.elasticache.model.InvalidCacheParameterGroupStateException;
import software.amazon.awssdk.services.elasticache.model.InvalidCacheSecurityGroupStateException;
import software.amazon.awssdk.services.elasticache.model.InvalidGlobalReplicationGroupStateException;
import software.amazon.awssdk.services.elasticache.model.InvalidKmsKeyException;
import software.amazon.awssdk.services.elasticache.model.InvalidParameterCombinationException;
import software.amazon.awssdk.services.elasticache.model.InvalidParameterValueException;
import software.amazon.awssdk.services.elasticache.model.InvalidReplicationGroupStateException;
import software.amazon.awssdk.services.elasticache.model.InvalidSnapshotStateException;
import software.amazon.awssdk.services.elasticache.model.InvalidSubnetException;
import software.amazon.awssdk.services.elasticache.model.InvalidVpcNetworkStateException;
import software.amazon.awssdk.services.elasticache.model.ListAllowedNodeTypeModificationsRequest;
import software.amazon.awssdk.services.elasticache.model.ListAllowedNodeTypeModificationsResponse;
import software.amazon.awssdk.services.elasticache.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.elasticache.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.elasticache.model.ModifyCacheClusterRequest;
import software.amazon.awssdk.services.elasticache.model.ModifyCacheClusterResponse;
import software.amazon.awssdk.services.elasticache.model.ModifyCacheParameterGroupRequest;
import software.amazon.awssdk.services.elasticache.model.ModifyCacheParameterGroupResponse;
import software.amazon.awssdk.services.elasticache.model.ModifyCacheSubnetGroupRequest;
import software.amazon.awssdk.services.elasticache.model.ModifyCacheSubnetGroupResponse;
import software.amazon.awssdk.services.elasticache.model.ModifyGlobalReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.ModifyGlobalReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.ModifyReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.ModifyReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.ModifyReplicationGroupShardConfigurationRequest;
import software.amazon.awssdk.services.elasticache.model.ModifyReplicationGroupShardConfigurationResponse;
import software.amazon.awssdk.services.elasticache.model.NoOperationException;
import software.amazon.awssdk.services.elasticache.model.NodeGroupNotFoundException;
import software.amazon.awssdk.services.elasticache.model.NodeGroupsPerReplicationGroupQuotaExceededException;
import software.amazon.awssdk.services.elasticache.model.NodeQuotaForClusterExceededException;
import software.amazon.awssdk.services.elasticache.model.NodeQuotaForCustomerExceededException;
import software.amazon.awssdk.services.elasticache.model.PurchaseReservedCacheNodesOfferingRequest;
import software.amazon.awssdk.services.elasticache.model.PurchaseReservedCacheNodesOfferingResponse;
import software.amazon.awssdk.services.elasticache.model.RebalanceSlotsInGlobalReplicationGroupRequest;
import software.amazon.awssdk.services.elasticache.model.RebalanceSlotsInGlobalReplicationGroupResponse;
import software.amazon.awssdk.services.elasticache.model.RebootCacheClusterRequest;
import software.amazon.awssdk.services.elasticache.model.RebootCacheClusterResponse;
import software.amazon.awssdk.services.elasticache.model.RemoveTagsFromResourceRequest;
import software.amazon.awssdk.services.elasticache.model.RemoveTagsFromResourceResponse;
import software.amazon.awssdk.services.elasticache.model.ReplicationGroupAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.ReplicationGroupAlreadyUnderMigrationException;
import software.amazon.awssdk.services.elasticache.model.ReplicationGroupNotFoundException;
import software.amazon.awssdk.services.elasticache.model.ReplicationGroupNotUnderMigrationException;
import software.amazon.awssdk.services.elasticache.model.ReservedCacheNodeAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.ReservedCacheNodeNotFoundException;
import software.amazon.awssdk.services.elasticache.model.ReservedCacheNodeQuotaExceededException;
import software.amazon.awssdk.services.elasticache.model.ReservedCacheNodesOfferingNotFoundException;
import software.amazon.awssdk.services.elasticache.model.ResetCacheParameterGroupRequest;
import software.amazon.awssdk.services.elasticache.model.ResetCacheParameterGroupResponse;
import software.amazon.awssdk.services.elasticache.model.RevokeCacheSecurityGroupIngressRequest;
import software.amazon.awssdk.services.elasticache.model.RevokeCacheSecurityGroupIngressResponse;
import software.amazon.awssdk.services.elasticache.model.ServiceLinkedRoleNotFoundException;
import software.amazon.awssdk.services.elasticache.model.ServiceUpdateNotFoundException;
import software.amazon.awssdk.services.elasticache.model.SnapshotAlreadyExistsException;
import software.amazon.awssdk.services.elasticache.model.SnapshotFeatureNotSupportedException;
import software.amazon.awssdk.services.elasticache.model.SnapshotNotFoundException;
import software.amazon.awssdk.services.elasticache.model.SnapshotQuotaExceededException;
import software.amazon.awssdk.services.elasticache.model.StartMigrationRequest;
import software.amazon.awssdk.services.elasticache.model.StartMigrationResponse;
import software.amazon.awssdk.services.elasticache.model.SubnetInUseException;
import software.amazon.awssdk.services.elasticache.model.TagNotFoundException;
import software.amazon.awssdk.services.elasticache.model.TagQuotaPerResourceExceededException;
import software.amazon.awssdk.services.elasticache.model.TestFailoverNotAvailableException;
import software.amazon.awssdk.services.elasticache.model.TestFailoverRequest;
import software.amazon.awssdk.services.elasticache.model.TestFailoverResponse;
import software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable;
import software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable;
/**
* Service client for accessing Amazon ElastiCache. This can be created using the static {@link #builder()} method.
*
* 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 get all of the benefits of a high-performance, in-memory cache with less of the
* administrative burden involved in launching and managing a distributed cache. The service makes setup, 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface ElastiCacheClient extends SdkClient {
String SERVICE_NAME = "elasticache";
/**
* Create a {@link ElastiCacheClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static ElastiCacheClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link ElastiCacheClient}.
*/
static ElastiCacheClientBuilder builder() {
return new DefaultElastiCacheClientBuilder();
}
/**
*
* Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key
* and value are case-sensitive. You can use cost allocation tags 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 in the ElastiCache User Guide.
*
*
* @param addTagsToResourceRequest
* Represents the input of an AddTagsToResource operation.
* @return Result of the AddTagsToResource operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws TagQuotaPerResourceExceededException
* The request cannot be processed because it would cause the resource to have more than the allowed number
* of tags. The maximum number of tags permitted on a resource is 50.
* @throws InvalidArnException
* The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.AddTagsToResource
* @see AWS
* API Documentation
*/
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
throws CacheClusterNotFoundException, SnapshotNotFoundException, TagQuotaPerResourceExceededException,
InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key
* and value are case-sensitive. You can use cost allocation tags 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 in the ElastiCache User Guide.
*
*
*
* This is a convenience which creates an instance of the {@link AddTagsToResourceRequest.Builder} avoiding the need
* to create one manually via {@link AddTagsToResourceRequest#builder()}
*
*
* @param addTagsToResourceRequest
* A {@link Consumer} that will call methods on {@link AddTagsToResourceMessage.Builder} to create a request.
* Represents the input of an AddTagsToResource operation.
* @return Result of the AddTagsToResource operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws TagQuotaPerResourceExceededException
* The request cannot be processed because it would cause the resource to have more than the allowed number
* of tags. The maximum number of tags permitted on a resource is 50.
* @throws InvalidArnException
* The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.AddTagsToResource
* @see AWS
* API Documentation
*/
default AddTagsToResourceResponse addTagsToResource(Consumer addTagsToResourceRequest)
throws CacheClusterNotFoundException, SnapshotNotFoundException, TagQuotaPerResourceExceededException,
InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException {
return addTagsToResource(AddTagsToResourceRequest.builder().applyMutation(addTagsToResourceRequest).build());
}
/**
*
* 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.
*
*
*
* @param authorizeCacheSecurityGroupIngressRequest
* Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
* @return Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws AuthorizationAlreadyExistsException
* The specified Amazon EC2 security group is already authorized for the specified cache security group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.AuthorizeCacheSecurityGroupIngress
* @see AWS API Documentation
*/
default AuthorizeCacheSecurityGroupIngressResponse authorizeCacheSecurityGroupIngress(
AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
throws CacheSecurityGroupNotFoundException, InvalidCacheSecurityGroupStateException,
AuthorizationAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link AuthorizeCacheSecurityGroupIngressRequest.Builder}
* avoiding the need to create one manually via {@link AuthorizeCacheSecurityGroupIngressRequest#builder()}
*
*
* @param authorizeCacheSecurityGroupIngressRequest
* A {@link Consumer} that will call methods on {@link AuthorizeCacheSecurityGroupIngressMessage.Builder} to
* create a request. Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
* @return Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws AuthorizationAlreadyExistsException
* The specified Amazon EC2 security group is already authorized for the specified cache security group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.AuthorizeCacheSecurityGroupIngress
* @see AWS API Documentation
*/
default AuthorizeCacheSecurityGroupIngressResponse authorizeCacheSecurityGroupIngress(
Consumer authorizeCacheSecurityGroupIngressRequest)
throws CacheSecurityGroupNotFoundException, InvalidCacheSecurityGroupStateException,
AuthorizationAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest.builder()
.applyMutation(authorizeCacheSecurityGroupIngressRequest).build());
}
/**
*
* Apply the service update. For more information on service updates and applying them, see Applying Service
* Updates.
*
*
* @param batchApplyUpdateActionRequest
* @return Result of the BatchApplyUpdateAction operation returned by the service.
* @throws ServiceUpdateNotFoundException
* The service update doesn't exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.BatchApplyUpdateAction
* @see AWS API Documentation
*/
default BatchApplyUpdateActionResponse batchApplyUpdateAction(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest)
throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Apply the service update. For more information on service updates and applying them, see Applying Service
* Updates.
*
*
*
* This is a convenience which creates an instance of the {@link BatchApplyUpdateActionRequest.Builder} avoiding the
* need to create one manually via {@link BatchApplyUpdateActionRequest#builder()}
*
*
* @param batchApplyUpdateActionRequest
* A {@link Consumer} that will call methods on {@link BatchApplyUpdateActionMessage.Builder} to create a
* request.
* @return Result of the BatchApplyUpdateAction operation returned by the service.
* @throws ServiceUpdateNotFoundException
* The service update doesn't exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.BatchApplyUpdateAction
* @see AWS API Documentation
*/
default BatchApplyUpdateActionResponse batchApplyUpdateAction(
Consumer batchApplyUpdateActionRequest) throws ServiceUpdateNotFoundException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
return batchApplyUpdateAction(BatchApplyUpdateActionRequest.builder().applyMutation(batchApplyUpdateActionRequest)
.build());
}
/**
*
* Stop the service update. For more information on service updates and stopping them, see Stopping
* Service Updates.
*
*
* @param batchStopUpdateActionRequest
* @return Result of the BatchStopUpdateAction operation returned by the service.
* @throws ServiceUpdateNotFoundException
* The service update doesn't exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.BatchStopUpdateAction
* @see AWS API Documentation
*/
default BatchStopUpdateActionResponse batchStopUpdateAction(BatchStopUpdateActionRequest batchStopUpdateActionRequest)
throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Stop the service update. For more information on service updates and stopping them, see Stopping
* Service Updates.
*
*
*
* This is a convenience which creates an instance of the {@link BatchStopUpdateActionRequest.Builder} avoiding the
* need to create one manually via {@link BatchStopUpdateActionRequest#builder()}
*
*
* @param batchStopUpdateActionRequest
* A {@link Consumer} that will call methods on {@link BatchStopUpdateActionMessage.Builder} to create a
* request.
* @return Result of the BatchStopUpdateAction operation returned by the service.
* @throws ServiceUpdateNotFoundException
* The service update doesn't exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.BatchStopUpdateAction
* @see AWS API Documentation
*/
default BatchStopUpdateActionResponse batchStopUpdateAction(
Consumer batchStopUpdateActionRequest) throws ServiceUpdateNotFoundException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
return batchStopUpdateAction(BatchStopUpdateActionRequest.builder().applyMutation(batchStopUpdateActionRequest).build());
}
/**
*
* Complete the migration of data.
*
*
* @param completeMigrationRequest
* @return Result of the CompleteMigration operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws ReplicationGroupNotUnderMigrationException
* The designated replication group is not available for data migration.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CompleteMigration
* @see AWS
* API Documentation
*/
default CompleteMigrationResponse completeMigration(CompleteMigrationRequest completeMigrationRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException,
ReplicationGroupNotUnderMigrationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Complete the migration of data.
*
*
*
* This is a convenience which creates an instance of the {@link CompleteMigrationRequest.Builder} avoiding the need
* to create one manually via {@link CompleteMigrationRequest#builder()}
*
*
* @param completeMigrationRequest
* A {@link Consumer} that will call methods on {@link CompleteMigrationMessage.Builder} to create a request.
* @return Result of the CompleteMigration operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws ReplicationGroupNotUnderMigrationException
* The designated replication group is not available for data migration.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CompleteMigration
* @see AWS
* API Documentation
*/
default CompleteMigrationResponse completeMigration(Consumer completeMigrationRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException,
ReplicationGroupNotUnderMigrationException, AwsServiceException, SdkClientException, ElastiCacheException {
return completeMigration(CompleteMigrationRequest.builder().applyMutation(completeMigrationRequest).build());
}
/**
*
* Makes a copy of an existing snapshot.
*
*
*
* This operation is valid for Redis only.
*
*
*
* Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon
* S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has
* the ability to use the CopySnapshot operation. For more information about using IAM to control the
* use of ElastiCache operations, see Exporting Snapshots
* and Authentication & Access
* Control.
*
*
*
* You could receive the following error messages.
*
*
* Error Messages
*
*
* -
*
* Error Message: The S3 bucket %s is outside of the region.
*
*
* Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: The S3 bucket %s does not exist.
*
*
* Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: The S3 bucket %s is not owned by the authenticated user.
*
*
* Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: The authenticated user does not have sufficient permissions to perform the desired
* activity.
*
*
* Solution: Contact your system administrator to get the needed permissions.
*
*
* -
*
* Error Message: The S3 bucket %s already contains an object with key %s.
*
*
* Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you
* could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
*
*
* -
*
* Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
*
*
* Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
*
*
* Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
*
*
* Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
*
*
*
*
* @param copySnapshotRequest
* Represents the input of a CopySnapshotMessage operation.
* @return Result of the CopySnapshot operation returned by the service.
* @throws SnapshotAlreadyExistsException
* You already have a snapshot with the given name.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of snapshots.
* @throws InvalidSnapshotStateException
* The current state of the snapshot does not allow the requested operation to occur.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CopySnapshot
* @see AWS API
* Documentation
*/
default CopySnapshotResponse copySnapshot(CopySnapshotRequest copySnapshotRequest) throws SnapshotAlreadyExistsException,
SnapshotNotFoundException, SnapshotQuotaExceededException, InvalidSnapshotStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Makes a copy of an existing snapshot.
*
*
*
* This operation is valid for Redis only.
*
*
*
* Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon
* S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has
* the ability to use the CopySnapshot operation. For more information about using IAM to control the
* use of ElastiCache operations, see Exporting Snapshots
* and Authentication & Access
* Control.
*
*
*
* You could receive the following error messages.
*
*
* Error Messages
*
*
* -
*
* Error Message: The S3 bucket %s is outside of the region.
*
*
* Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: The S3 bucket %s does not exist.
*
*
* Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: The S3 bucket %s is not owned by the authenticated user.
*
*
* Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: The authenticated user does not have sufficient permissions to perform the desired
* activity.
*
*
* Solution: Contact your system administrator to get the needed permissions.
*
*
* -
*
* Error Message: The S3 bucket %s already contains an object with key %s.
*
*
* Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you
* could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
*
*
* -
*
* Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
*
*
* Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
*
*
* Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
*
*
* -
*
* Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
*
*
* Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CopySnapshotRequest.Builder} avoiding the need to
* create one manually via {@link CopySnapshotRequest#builder()}
*
*
* @param copySnapshotRequest
* A {@link Consumer} that will call methods on {@link CopySnapshotMessage.Builder} to create a request.
* Represents the input of a CopySnapshotMessage operation.
* @return Result of the CopySnapshot operation returned by the service.
* @throws SnapshotAlreadyExistsException
* You already have a snapshot with the given name.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of snapshots.
* @throws InvalidSnapshotStateException
* The current state of the snapshot does not allow the requested operation to occur.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CopySnapshot
* @see AWS API
* Documentation
*/
default CopySnapshotResponse copySnapshot(Consumer copySnapshotRequest)
throws SnapshotAlreadyExistsException, SnapshotNotFoundException, SnapshotQuotaExceededException,
InvalidSnapshotStateException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return copySnapshot(CopySnapshotRequest.builder().applyMutation(copySnapshotRequest).build());
}
/**
*
* Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either
* Memcached or Redis.
*
*
* This operation is not supported for Redis (cluster mode enabled) clusters.
*
*
* @param createCacheClusterRequest
* Represents the input of a CreateCacheCluster operation.
* @return Result of the CreateCacheCluster operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws CacheClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws ClusterQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of clusters per customer.
* @throws NodeQuotaForClusterExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes in a single
* cluster.
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws TagQuotaPerResourceExceededException
* The request cannot be processed because it would cause the resource to have more than the allowed number
* of tags. The maximum number of tags permitted on a resource is 50.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateCacheCluster
* @see AWS
* API Documentation
*/
default CreateCacheClusterResponse createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, CacheClusterAlreadyExistsException,
InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException,
ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException,
TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either
* Memcached or Redis.
*
*
* This operation is not supported for Redis (cluster mode enabled) clusters.
*
*
*
* This is a convenience which creates an instance of the {@link CreateCacheClusterRequest.Builder} avoiding the
* need to create one manually via {@link CreateCacheClusterRequest#builder()}
*
*
* @param createCacheClusterRequest
* A {@link Consumer} that will call methods on {@link CreateCacheClusterMessage.Builder} to create a
* request. Represents the input of a CreateCacheCluster operation.
* @return Result of the CreateCacheCluster operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws CacheClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws ClusterQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of clusters per customer.
* @throws NodeQuotaForClusterExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes in a single
* cluster.
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws TagQuotaPerResourceExceededException
* The request cannot be processed because it would cause the resource to have more than the allowed number
* of tags. The maximum number of tags permitted on a resource is 50.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateCacheCluster
* @see AWS
* API Documentation
*/
default CreateCacheClusterResponse createCacheCluster(Consumer createCacheClusterRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, CacheClusterAlreadyExistsException,
InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException,
ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException,
TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return createCacheCluster(CreateCacheClusterRequest.builder().applyMutation(createCacheClusterRequest).build());
}
/**
*
* Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of
* parameters and their values that are applied to all of the nodes in any cluster or replication group using the
* CacheParameterGroup.
*
*
* A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the
* CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of
* specific parameters. For more information, see:
*
*
* -
*
*
* ModifyCacheParameterGroup in the ElastiCache API Reference.
*
*
* -
*
* Parameters and
* Parameter Groups in the ElastiCache User Guide.
*
*
*
*
* @param createCacheParameterGroupRequest
* Represents the input of a CreateCacheParameterGroup operation.
* @return Result of the CreateCacheParameterGroup operation returned by the service.
* @throws CacheParameterGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of cache security groups.
* @throws CacheParameterGroupAlreadyExistsException
* A cache parameter group with the requested name already exists.
* @throws InvalidCacheParameterGroupStateException
* The current state of the cache parameter group does not allow the requested operation to occur.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateCacheParameterGroup
* @see AWS API Documentation
*/
default CreateCacheParameterGroupResponse createCacheParameterGroup(
CreateCacheParameterGroupRequest createCacheParameterGroupRequest) throws CacheParameterGroupQuotaExceededException,
CacheParameterGroupAlreadyExistsException, InvalidCacheParameterGroupStateException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of
* parameters and their values that are applied to all of the nodes in any cluster or replication group using the
* CacheParameterGroup.
*
*
* A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the
* CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of
* specific parameters. For more information, see:
*
*
* -
*
*
* ModifyCacheParameterGroup in the ElastiCache API Reference.
*
*
* -
*
* Parameters and
* Parameter Groups in the ElastiCache User Guide.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateCacheParameterGroupRequest.Builder} avoiding
* the need to create one manually via {@link CreateCacheParameterGroupRequest#builder()}
*
*
* @param createCacheParameterGroupRequest
* A {@link Consumer} that will call methods on {@link CreateCacheParameterGroupMessage.Builder} to create a
* request. Represents the input of a CreateCacheParameterGroup operation.
* @return Result of the CreateCacheParameterGroup operation returned by the service.
* @throws CacheParameterGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of cache security groups.
* @throws CacheParameterGroupAlreadyExistsException
* A cache parameter group with the requested name already exists.
* @throws InvalidCacheParameterGroupStateException
* The current state of the cache parameter group does not allow the requested operation to occur.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateCacheParameterGroup
* @see AWS API Documentation
*/
default CreateCacheParameterGroupResponse createCacheParameterGroup(
Consumer createCacheParameterGroupRequest)
throws CacheParameterGroupQuotaExceededException, CacheParameterGroupAlreadyExistsException,
InvalidCacheParameterGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return createCacheParameterGroup(CreateCacheParameterGroupRequest.builder()
.applyMutation(createCacheParameterGroupRequest).build());
}
/**
*
* Creates a new cache security group. Use a cache security group to control access to one or more clusters.
*
*
* Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud
* (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more
* information, see CreateCacheSubnetGroup.
*
*
* @param createCacheSecurityGroupRequest
* Represents the input of a CreateCacheSecurityGroup operation.
* @return Result of the CreateCacheSecurityGroup operation returned by the service.
* @throws CacheSecurityGroupAlreadyExistsException
* A cache security group with the specified name already exists.
* @throws CacheSecurityGroupQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of cache security groups.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateCacheSecurityGroup
* @see AWS API Documentation
*/
default CreateCacheSecurityGroupResponse createCacheSecurityGroup(
CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) throws CacheSecurityGroupAlreadyExistsException,
CacheSecurityGroupQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new cache security group. Use a cache security group to control access to one or more clusters.
*
*
* Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud
* (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more
* information, see CreateCacheSubnetGroup.
*
*
*
* This is a convenience which creates an instance of the {@link CreateCacheSecurityGroupRequest.Builder} avoiding
* the need to create one manually via {@link CreateCacheSecurityGroupRequest#builder()}
*
*
* @param createCacheSecurityGroupRequest
* A {@link Consumer} that will call methods on {@link CreateCacheSecurityGroupMessage.Builder} to create a
* request. Represents the input of a CreateCacheSecurityGroup operation.
* @return Result of the CreateCacheSecurityGroup operation returned by the service.
* @throws CacheSecurityGroupAlreadyExistsException
* A cache security group with the specified name already exists.
* @throws CacheSecurityGroupQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of cache security groups.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateCacheSecurityGroup
* @see AWS API Documentation
*/
default CreateCacheSecurityGroupResponse createCacheSecurityGroup(
Consumer createCacheSecurityGroupRequest)
throws CacheSecurityGroupAlreadyExistsException, CacheSecurityGroupQuotaExceededException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return createCacheSecurityGroup(CreateCacheSecurityGroupRequest.builder().applyMutation(createCacheSecurityGroupRequest)
.build());
}
/**
*
* Creates a new cache subnet group.
*
*
* Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
*
*
* @param createCacheSubnetGroupRequest
* Represents the input of a CreateCacheSubnetGroup operation.
* @return Result of the CreateCacheSubnetGroup operation returned by the service.
* @throws CacheSubnetGroupAlreadyExistsException
* The requested cache subnet group name is already in use by an existing cache subnet group.
* @throws CacheSubnetGroupQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of cache subnet groups.
* @throws CacheSubnetQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet
* group.
* @throws InvalidSubnetException
* An invalid subnet identifier was specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateCacheSubnetGroup
* @see AWS API Documentation
*/
default CreateCacheSubnetGroupResponse createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException,
CacheSubnetQuotaExceededException, InvalidSubnetException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new cache subnet group.
*
*
* Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
*
*
*
* This is a convenience which creates an instance of the {@link CreateCacheSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link CreateCacheSubnetGroupRequest#builder()}
*
*
* @param createCacheSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link CreateCacheSubnetGroupMessage.Builder} to create a
* request. Represents the input of a CreateCacheSubnetGroup operation.
* @return Result of the CreateCacheSubnetGroup operation returned by the service.
* @throws CacheSubnetGroupAlreadyExistsException
* The requested cache subnet group name is already in use by an existing cache subnet group.
* @throws CacheSubnetGroupQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of cache subnet groups.
* @throws CacheSubnetQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet
* group.
* @throws InvalidSubnetException
* An invalid subnet identifier was specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateCacheSubnetGroup
* @see AWS API Documentation
*/
default CreateCacheSubnetGroupResponse createCacheSubnetGroup(
Consumer createCacheSubnetGroupRequest)
throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException,
CacheSubnetQuotaExceededException, InvalidSubnetException, AwsServiceException, SdkClientException,
ElastiCacheException {
return createCacheSubnetGroup(CreateCacheSubnetGroupRequest.builder().applyMutation(createCacheSubnetGroupRequest)
.build());
}
/**
*
* Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global
* Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable
* low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global
* Datastore.
*
*
* -
*
* The GlobalReplicationGroupIdSuffix is the name of the Global Datastore.
*
*
* -
*
* The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will
* replicate updates to the secondary cluster.
*
*
*
*
* @param createGlobalReplicationGroupRequest
* @return Result of the CreateGlobalReplicationGroup operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws GlobalReplicationGroupAlreadyExistsException
* The Global Datastore name already exists.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateGlobalReplicationGroup
* @see AWS API Documentation
*/
default CreateGlobalReplicationGroupResponse createGlobalReplicationGroup(
CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest) throws ReplicationGroupNotFoundException,
InvalidReplicationGroupStateException, GlobalReplicationGroupAlreadyExistsException,
ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global
* Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable
* low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global
* Datastore.
*
*
* -
*
* The GlobalReplicationGroupIdSuffix is the name of the Global Datastore.
*
*
* -
*
* The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will
* replicate updates to the secondary cluster.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateGlobalReplicationGroupRequest.Builder}
* avoiding the need to create one manually via {@link CreateGlobalReplicationGroupRequest#builder()}
*
*
* @param createGlobalReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link CreateGlobalReplicationGroupMessage.Builder} to create
* a request.
* @return Result of the CreateGlobalReplicationGroup operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws GlobalReplicationGroupAlreadyExistsException
* The Global Datastore name already exists.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateGlobalReplicationGroup
* @see AWS API Documentation
*/
default CreateGlobalReplicationGroupResponse createGlobalReplicationGroup(
Consumer createGlobalReplicationGroupRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException,
GlobalReplicationGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException,
AwsServiceException, SdkClientException, ElastiCacheException {
return createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest.builder()
.applyMutation(createGlobalReplicationGroupRequest).build());
}
/**
*
* Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
*
*
* This API can be used to create a standalone regional replication group or a secondary replication group
* associated with a Global Datastore.
*
*
* A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a
* read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to
* the replicas.
*
*
* A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group
* (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are
* asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data
* across node groups (shards).
*
*
* When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more
* read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node
* groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis
* Clusters in the ElastiCache User Guide.
*
*
*
* This operation is valid for Redis only.
*
*
*
* @param createReplicationGroupRequest
* Represents the input of a CreateReplicationGroup operation.
* @return Result of the CreateReplicationGroup operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws ReplicationGroupAlreadyExistsException
* The specified replication group already exists.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws ClusterQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of clusters per customer.
* @throws NodeQuotaForClusterExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes in a single
* cluster.
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws TagQuotaPerResourceExceededException
* The request cannot be processed because it would cause the resource to have more than the allowed number
* of tags. The maximum number of tags permitted on a resource is 50.
* @throws NodeGroupsPerReplicationGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum allowed number of node groups
* (shards) in a single replication group. The default maximum is 90
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateReplicationGroup
* @see AWS API Documentation
*/
default CreateReplicationGroupResponse createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
throws CacheClusterNotFoundException, InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException,
InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException,
ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException,
TagQuotaPerResourceExceededException, NodeGroupsPerReplicationGroupQuotaExceededException,
GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
*
*
* This API can be used to create a standalone regional replication group or a secondary replication group
* associated with a Global Datastore.
*
*
* A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a
* read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to
* the replicas.
*
*
* A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group
* (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are
* asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data
* across node groups (shards).
*
*
* When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more
* read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node
* groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis
* Clusters in the ElastiCache User Guide.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a convenience which creates an instance of the {@link CreateReplicationGroupRequest.Builder} avoiding the
* need to create one manually via {@link CreateReplicationGroupRequest#builder()}
*
*
* @param createReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link CreateReplicationGroupMessage.Builder} to create a
* request. Represents the input of a CreateReplicationGroup operation.
* @return Result of the CreateReplicationGroup operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws ReplicationGroupAlreadyExistsException
* The specified replication group already exists.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws ClusterQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of clusters per customer.
* @throws NodeQuotaForClusterExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes in a single
* cluster.
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws TagQuotaPerResourceExceededException
* The request cannot be processed because it would cause the resource to have more than the allowed number
* of tags. The maximum number of tags permitted on a resource is 50.
* @throws NodeGroupsPerReplicationGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum allowed number of node groups
* (shards) in a single replication group. The default maximum is 90
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateReplicationGroup
* @see AWS API Documentation
*/
default CreateReplicationGroupResponse createReplicationGroup(
Consumer createReplicationGroupRequest) throws CacheClusterNotFoundException,
InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException, InsufficientCacheClusterCapacityException,
CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException,
NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException,
InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException,
NodeGroupsPerReplicationGroupQuotaExceededException, GlobalReplicationGroupNotFoundException,
InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return createReplicationGroup(CreateReplicationGroupRequest.builder().applyMutation(createReplicationGroupRequest)
.build());
}
/**
*
* Creates a copy of an entire cluster or replication group at a specific moment in time.
*
*
*
* This operation is valid for Redis only.
*
*
*
* @param createSnapshotRequest
* Represents the input of a CreateSnapshot operation.
* @return Result of the CreateSnapshot operation returned by the service.
* @throws SnapshotAlreadyExistsException
* You already have a snapshot with the given name.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws SnapshotQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of snapshots.
* @throws SnapshotFeatureNotSupportedException
* You attempted one of the following operations:
*
* -
*
* Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
*
*
* -
*
* Creating a snapshot of a cluster that is running Memcached rather than Redis.
*
*
*
*
* Neither of these are supported by ElastiCache.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateSnapshot
* @see AWS API
* Documentation
*/
default CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest)
throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException,
InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException,
SnapshotFeatureNotSupportedException, InvalidParameterCombinationException, InvalidParameterValueException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a copy of an entire cluster or replication group at a specific moment in time.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a convenience which creates an instance of the {@link CreateSnapshotRequest.Builder} avoiding the need to
* create one manually via {@link CreateSnapshotRequest#builder()}
*
*
* @param createSnapshotRequest
* A {@link Consumer} that will call methods on {@link CreateSnapshotMessage.Builder} to create a request.
* Represents the input of a CreateSnapshot operation.
* @return Result of the CreateSnapshot operation returned by the service.
* @throws SnapshotAlreadyExistsException
* You already have a snapshot with the given name.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws SnapshotQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of snapshots.
* @throws SnapshotFeatureNotSupportedException
* You attempted one of the following operations:
*
* -
*
* Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
*
*
* -
*
* Creating a snapshot of a cluster that is running Memcached rather than Redis.
*
*
*
*
* Neither of these are supported by ElastiCache.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.CreateSnapshot
* @see AWS API
* Documentation
*/
default CreateSnapshotResponse createSnapshot(Consumer createSnapshotRequest)
throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException,
InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException,
SnapshotFeatureNotSupportedException, InvalidParameterCombinationException, InvalidParameterValueException,
AwsServiceException, SdkClientException, ElastiCacheException {
return createSnapshot(CreateSnapshotRequest.builder().applyMutation(createSnapshotRequest).build());
}
/**
*
* Decreases the number of node groups in a Global Datastore
*
*
* @param decreaseNodeGroupsInGlobalReplicationGroupRequest
* @return Result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DecreaseNodeGroupsInGlobalReplicationGroup
* @see AWS API Documentation
*/
default DecreaseNodeGroupsInGlobalReplicationGroupResponse decreaseNodeGroupsInGlobalReplicationGroup(
DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Decreases the number of node groups in a Global Datastore
*
*
*
* This is a convenience which creates an instance of the
* {@link DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder} avoiding the need to create one manually via
* {@link DecreaseNodeGroupsInGlobalReplicationGroupRequest#builder()}
*
*
* @param decreaseNodeGroupsInGlobalReplicationGroupRequest
* A {@link Consumer} that will call methods on
* {@link DecreaseNodeGroupsInGlobalReplicationGroupMessage.Builder} to create a request.
* @return Result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DecreaseNodeGroupsInGlobalReplicationGroup
* @see AWS API Documentation
*/
default DecreaseNodeGroupsInGlobalReplicationGroupResponse decreaseNodeGroupsInGlobalReplicationGroup(
Consumer decreaseNodeGroupsInGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest.builder()
.applyMutation(decreaseNodeGroupsInGlobalReplicationGroupRequest).build());
}
/**
*
* Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number
* of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This
* operation is performed with no cluster down time.
*
*
* @param decreaseReplicaCountRequest
* @return Result of the DecreaseReplicaCount operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws ClusterQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of clusters per customer.
* @throws NodeGroupsPerReplicationGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum allowed number of node groups
* (shards) in a single replication group. The default maximum is 90
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws NoOperationException
* The operation was not performed because no changes were required.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DecreaseReplicaCount
* @see AWS API Documentation
*/
default DecreaseReplicaCountResponse decreaseReplicaCount(DecreaseReplicaCountRequest decreaseReplicaCountRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException,
InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException,
NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException,
ServiceLinkedRoleNotFoundException, NoOperationException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number
* of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This
* operation is performed with no cluster down time.
*
*
*
* This is a convenience which creates an instance of the {@link DecreaseReplicaCountRequest.Builder} avoiding the
* need to create one manually via {@link DecreaseReplicaCountRequest#builder()}
*
*
* @param decreaseReplicaCountRequest
* A {@link Consumer} that will call methods on {@link DecreaseReplicaCountMessage.Builder} to create a
* request.
* @return Result of the DecreaseReplicaCount operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws ClusterQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of clusters per customer.
* @throws NodeGroupsPerReplicationGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum allowed number of node groups
* (shards) in a single replication group. The default maximum is 90
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws NoOperationException
* The operation was not performed because no changes were required.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DecreaseReplicaCount
* @see AWS API Documentation
*/
default DecreaseReplicaCountResponse decreaseReplicaCount(
Consumer decreaseReplicaCountRequest) throws ReplicationGroupNotFoundException,
InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException,
InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException,
NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException,
ServiceLinkedRoleNotFoundException, NoOperationException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return decreaseReplicaCount(DecreaseReplicaCountRequest.builder().applyMutation(decreaseReplicaCountRequest).build());
}
/**
*
* Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes,
* node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon
* ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.
*
*
* This operation is not valid for:
*
*
* -
*
* Redis (cluster mode enabled) clusters
*
*
* -
*
* A cluster that is the last read replica of a replication group
*
*
* -
*
* A node group (shard) that has Multi-AZ mode enabled
*
*
* -
*
* A cluster from a Redis (cluster mode enabled) replication group
*
*
* -
*
* A cluster that is not in the available state
*
*
*
*
* @param deleteCacheClusterRequest
* Represents the input of a DeleteCacheCluster operation.
* @return Result of the DeleteCacheCluster operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws SnapshotAlreadyExistsException
* You already have a snapshot with the given name.
* @throws SnapshotFeatureNotSupportedException
* You attempted one of the following operations:
*
* -
*
* Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
*
*
* -
*
* Creating a snapshot of a cluster that is running Memcached rather than Redis.
*
*
*
*
* Neither of these are supported by ElastiCache.
* @throws SnapshotQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of snapshots.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteCacheCluster
* @see AWS
* API Documentation
*/
default DeleteCacheClusterResponse deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
throws CacheClusterNotFoundException, InvalidCacheClusterStateException, SnapshotAlreadyExistsException,
SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes,
* node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon
* ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.
*
*
* This operation is not valid for:
*
*
* -
*
* Redis (cluster mode enabled) clusters
*
*
* -
*
* A cluster that is the last read replica of a replication group
*
*
* -
*
* A node group (shard) that has Multi-AZ mode enabled
*
*
* -
*
* A cluster from a Redis (cluster mode enabled) replication group
*
*
* -
*
* A cluster that is not in the available state
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteCacheClusterRequest.Builder} avoiding the
* need to create one manually via {@link DeleteCacheClusterRequest#builder()}
*
*
* @param deleteCacheClusterRequest
* A {@link Consumer} that will call methods on {@link DeleteCacheClusterMessage.Builder} to create a
* request. Represents the input of a DeleteCacheCluster operation.
* @return Result of the DeleteCacheCluster operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws SnapshotAlreadyExistsException
* You already have a snapshot with the given name.
* @throws SnapshotFeatureNotSupportedException
* You attempted one of the following operations:
*
* -
*
* Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
*
*
* -
*
* Creating a snapshot of a cluster that is running Memcached rather than Redis.
*
*
*
*
* Neither of these are supported by ElastiCache.
* @throws SnapshotQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of snapshots.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteCacheCluster
* @see AWS
* API Documentation
*/
default DeleteCacheClusterResponse deleteCacheCluster(Consumer deleteCacheClusterRequest)
throws CacheClusterNotFoundException, InvalidCacheClusterStateException, SnapshotAlreadyExistsException,
SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return deleteCacheCluster(DeleteCacheClusterRequest.builder().applyMutation(deleteCacheClusterRequest).build());
}
/**
*
* Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with
* any cache clusters.
*
*
* @param deleteCacheParameterGroupRequest
* Represents the input of a DeleteCacheParameterGroup operation.
* @return Result of the DeleteCacheParameterGroup operation returned by the service.
* @throws InvalidCacheParameterGroupStateException
* The current state of the cache parameter group does not allow the requested operation to occur.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteCacheParameterGroup
* @see AWS API Documentation
*/
default DeleteCacheParameterGroupResponse deleteCacheParameterGroup(
DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException,
CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with
* any cache clusters.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteCacheParameterGroupRequest.Builder} avoiding
* the need to create one manually via {@link DeleteCacheParameterGroupRequest#builder()}
*
*
* @param deleteCacheParameterGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteCacheParameterGroupMessage.Builder} to create a
* request. Represents the input of a DeleteCacheParameterGroup operation.
* @return Result of the DeleteCacheParameterGroup operation returned by the service.
* @throws InvalidCacheParameterGroupStateException
* The current state of the cache parameter group does not allow the requested operation to occur.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteCacheParameterGroup
* @see AWS API Documentation
*/
default DeleteCacheParameterGroupResponse deleteCacheParameterGroup(
Consumer deleteCacheParameterGroupRequest)
throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return deleteCacheParameterGroup(DeleteCacheParameterGroupRequest.builder()
.applyMutation(deleteCacheParameterGroupRequest).build());
}
/**
*
* Deletes a cache security group.
*
*
*
* You cannot delete a cache security group if it is associated with any clusters.
*
*
*
* @param deleteCacheSecurityGroupRequest
* Represents the input of a DeleteCacheSecurityGroup operation.
* @return Result of the DeleteCacheSecurityGroup operation returned by the service.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteCacheSecurityGroup
* @see AWS API Documentation
*/
default DeleteCacheSecurityGroupResponse deleteCacheSecurityGroup(
DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) throws InvalidCacheSecurityGroupStateException,
CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a cache security group.
*
*
*
* You cannot delete a cache security group if it is associated with any clusters.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteCacheSecurityGroupRequest.Builder} avoiding
* the need to create one manually via {@link DeleteCacheSecurityGroupRequest#builder()}
*
*
* @param deleteCacheSecurityGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteCacheSecurityGroupMessage.Builder} to create a
* request. Represents the input of a DeleteCacheSecurityGroup operation.
* @return Result of the DeleteCacheSecurityGroup operation returned by the service.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteCacheSecurityGroup
* @see AWS API Documentation
*/
default DeleteCacheSecurityGroupResponse deleteCacheSecurityGroup(
Consumer deleteCacheSecurityGroupRequest)
throws InvalidCacheSecurityGroupStateException, CacheSecurityGroupNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest.builder().applyMutation(deleteCacheSecurityGroupRequest)
.build());
}
/**
*
* Deletes a cache subnet group.
*
*
*
* You cannot delete a cache subnet group if it is associated with any clusters.
*
*
*
* @param deleteCacheSubnetGroupRequest
* Represents the input of a DeleteCacheSubnetGroup operation.
* @return Result of the DeleteCacheSubnetGroup operation returned by the service.
* @throws CacheSubnetGroupInUseException
* The requested cache subnet group is currently in use.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteCacheSubnetGroup
* @see AWS API Documentation
*/
default DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
throws CacheSubnetGroupInUseException, CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a cache subnet group.
*
*
*
* You cannot delete a cache subnet group if it is associated with any clusters.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteCacheSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link DeleteCacheSubnetGroupRequest#builder()}
*
*
* @param deleteCacheSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteCacheSubnetGroupMessage.Builder} to create a
* request. Represents the input of a DeleteCacheSubnetGroup operation.
* @return Result of the DeleteCacheSubnetGroup operation returned by the service.
* @throws CacheSubnetGroupInUseException
* The requested cache subnet group is currently in use.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteCacheSubnetGroup
* @see AWS API Documentation
*/
default DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(
Consumer deleteCacheSubnetGroupRequest) throws CacheSubnetGroupInUseException,
CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException {
return deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest.builder().applyMutation(deleteCacheSubnetGroupRequest)
.build());
}
/**
*
* Deleting a Global Datastore is a two-step process:
*
*
* -
*
* First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global
* Datastore.
*
*
* -
*
* Once the Global Datastore contains only the primary cluster, you can use DeleteGlobalReplicationGroup API to
* delete the Global Datastore while retainining the primary cluster using Retain…= true.
*
*
*
*
* Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the
* primary by setting RetainPrimaryCluster=true.
*
*
* When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the
* selected resources; you cannot cancel or revert this operation.
*
*
* @param deleteGlobalReplicationGroupRequest
* @return Result of the DeleteGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteGlobalReplicationGroup
* @see AWS API Documentation
*/
default DeleteGlobalReplicationGroupResponse deleteGlobalReplicationGroup(
DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Deleting a Global Datastore is a two-step process:
*
*
* -
*
* First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global
* Datastore.
*
*
* -
*
* Once the Global Datastore contains only the primary cluster, you can use DeleteGlobalReplicationGroup API to
* delete the Global Datastore while retainining the primary cluster using Retain…= true.
*
*
*
*
* Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the
* primary by setting RetainPrimaryCluster=true.
*
*
* When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the
* selected resources; you cannot cancel or revert this operation.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteGlobalReplicationGroupRequest.Builder}
* avoiding the need to create one manually via {@link DeleteGlobalReplicationGroupRequest#builder()}
*
*
* @param deleteGlobalReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteGlobalReplicationGroupMessage.Builder} to create
* a request.
* @return Result of the DeleteGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteGlobalReplicationGroup
* @see AWS API Documentation
*/
default DeleteGlobalReplicationGroupResponse deleteGlobalReplicationGroup(
Consumer deleteGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
return deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest.builder()
.applyMutation(deleteGlobalReplicationGroupRequest).build());
}
/**
*
* Deletes an existing replication group. By default, this operation deletes the entire replication group, including
* the primary/primaries and all of the read replicas. If the replication group has only one primary, you can
* optionally delete only the read replicas, while retaining the primary by setting
* RetainPrimaryCluster=true.
*
*
* When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the
* selected resources; you cannot cancel or revert this operation.
*
*
*
* This operation is valid for Redis only.
*
*
*
* @param deleteReplicationGroupRequest
* Represents the input of a DeleteReplicationGroup operation.
* @return Result of the DeleteReplicationGroup operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws SnapshotAlreadyExistsException
* You already have a snapshot with the given name.
* @throws SnapshotFeatureNotSupportedException
* You attempted one of the following operations:
*
* -
*
* Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
*
*
* -
*
* Creating a snapshot of a cluster that is running Memcached rather than Redis.
*
*
*
*
* Neither of these are supported by ElastiCache.
* @throws SnapshotQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of snapshots.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteReplicationGroup
* @see AWS API Documentation
*/
default DeleteReplicationGroupResponse deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, SnapshotAlreadyExistsException,
SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing replication group. By default, this operation deletes the entire replication group, including
* the primary/primaries and all of the read replicas. If the replication group has only one primary, you can
* optionally delete only the read replicas, while retaining the primary by setting
* RetainPrimaryCluster=true.
*
*
* When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the
* selected resources; you cannot cancel or revert this operation.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteReplicationGroupRequest.Builder} avoiding the
* need to create one manually via {@link DeleteReplicationGroupRequest#builder()}
*
*
* @param deleteReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteReplicationGroupMessage.Builder} to create a
* request. Represents the input of a DeleteReplicationGroup operation.
* @return Result of the DeleteReplicationGroup operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws SnapshotAlreadyExistsException
* You already have a snapshot with the given name.
* @throws SnapshotFeatureNotSupportedException
* You attempted one of the following operations:
*
* -
*
* Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
*
*
* -
*
* Creating a snapshot of a cluster that is running Memcached rather than Redis.
*
*
*
*
* Neither of these are supported by ElastiCache.
* @throws SnapshotQuotaExceededException
* The request cannot be processed because it would exceed the maximum number of snapshots.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteReplicationGroup
* @see AWS API Documentation
*/
default DeleteReplicationGroupResponse deleteReplicationGroup(
Consumer deleteReplicationGroupRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, SnapshotAlreadyExistsException,
SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return deleteReplicationGroup(DeleteReplicationGroupRequest.builder().applyMutation(deleteReplicationGroupRequest)
.build());
}
/**
*
* Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately
* begins deleting the snapshot; you cannot cancel or revert this operation.
*
*
*
* This operation is valid for Redis only.
*
*
*
* @param deleteSnapshotRequest
* Represents the input of a DeleteSnapshot operation.
* @return Result of the DeleteSnapshot operation returned by the service.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidSnapshotStateException
* The current state of the snapshot does not allow the requested operation to occur.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteSnapshot
* @see AWS API
* Documentation
*/
default DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws SnapshotNotFoundException,
InvalidSnapshotStateException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately
* begins deleting the snapshot; you cannot cancel or revert this operation.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSnapshotRequest.Builder} avoiding the need to
* create one manually via {@link DeleteSnapshotRequest#builder()}
*
*
* @param deleteSnapshotRequest
* A {@link Consumer} that will call methods on {@link DeleteSnapshotMessage.Builder} to create a request.
* Represents the input of a DeleteSnapshot operation.
* @return Result of the DeleteSnapshot operation returned by the service.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidSnapshotStateException
* The current state of the snapshot does not allow the requested operation to occur.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DeleteSnapshot
* @see AWS API
* Documentation
*/
default DeleteSnapshotResponse deleteSnapshot(Consumer deleteSnapshotRequest)
throws SnapshotNotFoundException, InvalidSnapshotStateException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return deleteSnapshot(DeleteSnapshotRequest.builder().applyMutation(deleteSnapshotRequest).build());
}
/**
*
* Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
* cache cluster if a cluster identifier is supplied.
*
*
* By default, abbreviated information about the clusters is returned. You can use the optional
* ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the
* 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 is displayed until all of the
* nodes are successfully provisioned.
*
*
* If the cluster is in the deleting state, only cluster-level information is displayed.
*
*
* If cache nodes are currently being added to the cluster, node endpoint information and creation time for the
* additional nodes are not displayed until they are completely provisioned. When the cluster state is
* available, the cluster is ready for use.
*
*
* If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is
* displayed.
*
*
* @return Result of the DescribeCacheClusters operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheClusters
* @see #describeCacheClusters(DescribeCacheClustersRequest)
* @see AWS API Documentation
*/
default DescribeCacheClustersResponse describeCacheClusters() throws CacheClusterNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeCacheClusters(DescribeCacheClustersRequest.builder().build());
}
/**
*
* Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
* cache cluster if a cluster identifier is supplied.
*
*
* By default, abbreviated information about the clusters is returned. You can use the optional
* ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the
* 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 is displayed until all of the
* nodes are successfully provisioned.
*
*
* If the cluster is in the deleting state, only cluster-level information is displayed.
*
*
* If cache nodes are currently being added to the cluster, node endpoint information and creation time for the
* additional nodes are not displayed until they are completely provisioned. When the cluster state is
* available, the cluster is ready for use.
*
*
* If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is
* displayed.
*
*
* @param describeCacheClustersRequest
* Represents the input of a DescribeCacheClusters operation.
* @return Result of the DescribeCacheClusters operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheClusters
* @see AWS API Documentation
*/
default DescribeCacheClustersResponse describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)
throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
* cache cluster if a cluster identifier is supplied.
*
*
* By default, abbreviated information about the clusters is returned. You can use the optional
* ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the
* 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 is displayed until all of the
* nodes are successfully provisioned.
*
*
* If the cluster is in the deleting state, only cluster-level information is displayed.
*
*
* If cache nodes are currently being added to the cluster, node endpoint information and creation time for the
* additional nodes are not displayed until they are completely provisioned. When the cluster state is
* available, the cluster is ready for use.
*
*
* If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is
* displayed.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCacheClustersRequest#builder()}
*
*
* @param describeCacheClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheClustersMessage.Builder} to create a
* request. Represents the input of a DescribeCacheClusters operation.
* @return Result of the DescribeCacheClusters operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheClusters
* @see AWS API Documentation
*/
default DescribeCacheClustersResponse describeCacheClusters(
Consumer describeCacheClustersRequest) throws CacheClusterNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeCacheClusters(DescribeCacheClustersRequest.builder().applyMutation(describeCacheClustersRequest).build());
}
/**
*
* Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
* cache cluster if a cluster identifier is supplied.
*
*
* By default, abbreviated information about the clusters is returned. You can use the optional
* ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the
* 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 is displayed until all of the
* nodes are successfully provisioned.
*
*
* If the cluster is in the deleting state, only cluster-level information is displayed.
*
*
* If cache nodes are currently being added to the cluster, node endpoint information and creation time for the
* additional nodes are not displayed until they are completely provisioned. When the cluster state is
* available, the cluster is ready for use.
*
*
* If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is
* displayed.
*
*
*
* This is a variant of
* {@link #describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client
* .describeCacheClustersPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheClusters
* @see #describeCacheClustersPaginator(DescribeCacheClustersRequest)
* @see AWS API Documentation
*/
default DescribeCacheClustersIterable describeCacheClustersPaginator() throws CacheClusterNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeCacheClustersPaginator(DescribeCacheClustersRequest.builder().build());
}
/**
*
* Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
* cache cluster if a cluster identifier is supplied.
*
*
* By default, abbreviated information about the clusters is returned. You can use the optional
* ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the
* 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 is displayed until all of the
* nodes are successfully provisioned.
*
*
* If the cluster is in the deleting state, only cluster-level information is displayed.
*
*
* If cache nodes are currently being added to the cluster, node endpoint information and creation time for the
* additional nodes are not displayed until they are completely provisioned. When the cluster state is
* available, the cluster is ready for use.
*
*
* If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is
* displayed.
*
*
*
* This is a variant of
* {@link #describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client
* .describeCacheClustersPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)}
* operation.
*
*
* @param describeCacheClustersRequest
* Represents the input of a DescribeCacheClusters operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheClusters
* @see AWS API Documentation
*/
default DescribeCacheClustersIterable describeCacheClustersPaginator(DescribeCacheClustersRequest describeCacheClustersRequest)
throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
* cache cluster if a cluster identifier is supplied.
*
*
* By default, abbreviated information about the clusters is returned. You can use the optional
* ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the
* 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 is displayed until all of the
* nodes are successfully provisioned.
*
*
* If the cluster is in the deleting state, only cluster-level information is displayed.
*
*
* If cache nodes are currently being added to the cluster, node endpoint information and creation time for the
* additional nodes are not displayed until they are completely provisioned. When the cluster state is
* available, the cluster is ready for use.
*
*
* If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is
* displayed.
*
*
*
* This is a variant of
* {@link #describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client
* .describeCacheClustersPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCacheClustersRequest#builder()}
*
*
* @param describeCacheClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheClustersMessage.Builder} to create a
* request. Represents the input of a DescribeCacheClusters operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheClusters
* @see AWS API Documentation
*/
default DescribeCacheClustersIterable describeCacheClustersPaginator(
Consumer describeCacheClustersRequest) throws CacheClusterNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeCacheClustersPaginator(DescribeCacheClustersRequest.builder().applyMutation(describeCacheClustersRequest)
.build());
}
/**
*
* Returns a list of the available cache engines and their versions.
*
*
* @return Result of the DescribeCacheEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheEngineVersions
* @see #describeCacheEngineVersions(DescribeCacheEngineVersionsRequest)
* @see AWS API Documentation
*/
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions() throws AwsServiceException, SdkClientException,
ElastiCacheException {
return describeCacheEngineVersions(DescribeCacheEngineVersionsRequest.builder().build());
}
/**
*
* Returns a list of the available cache engines and their versions.
*
*
* @param describeCacheEngineVersionsRequest
* Represents the input of a DescribeCacheEngineVersions operation.
* @return Result of the DescribeCacheEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheEngineVersions
* @see AWS API Documentation
*/
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions(
DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AwsServiceException,
SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the available cache engines and their versions.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheEngineVersionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeCacheEngineVersionsRequest#builder()}
*
*
* @param describeCacheEngineVersionsRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheEngineVersionsMessage.Builder} to create
* a request. Represents the input of a DescribeCacheEngineVersions operation.
* @return Result of the DescribeCacheEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheEngineVersions
* @see AWS API Documentation
*/
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions(
Consumer describeCacheEngineVersionsRequest) throws AwsServiceException,
SdkClientException, ElastiCacheException {
return describeCacheEngineVersions(DescribeCacheEngineVersionsRequest.builder()
.applyMutation(describeCacheEngineVersionsRequest).build());
}
/**
*
* Returns a list of the available cache engines and their versions.
*
*
*
* This is a variant of
* {@link #describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client
* .describeCacheEngineVersionsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheEngineVersions
* @see #describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest)
* @see AWS API Documentation
*/
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator() throws AwsServiceException,
SdkClientException, ElastiCacheException {
return describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest.builder().build());
}
/**
*
* Returns a list of the available cache engines and their versions.
*
*
*
* This is a variant of
* {@link #describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client
* .describeCacheEngineVersionsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)}
* operation.
*
*
* @param describeCacheEngineVersionsRequest
* Represents the input of a DescribeCacheEngineVersions operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheEngineVersions
* @see AWS API Documentation
*/
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator(
DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AwsServiceException,
SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the available cache engines and their versions.
*
*
*
* This is a variant of
* {@link #describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client
* .describeCacheEngineVersionsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheEngineVersionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeCacheEngineVersionsRequest#builder()}
*
*
* @param describeCacheEngineVersionsRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheEngineVersionsMessage.Builder} to create
* a request. Represents the input of a DescribeCacheEngineVersions operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheEngineVersions
* @see AWS API Documentation
*/
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator(
Consumer describeCacheEngineVersionsRequest) throws AwsServiceException,
SdkClientException, ElastiCacheException {
return describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest.builder()
.applyMutation(describeCacheEngineVersionsRequest).build());
}
/**
*
* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list
* contains only the descriptions for that group.
*
*
* @return Result of the DescribeCacheParameterGroups operation returned by the service.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameterGroups
* @see #describeCacheParameterGroups(DescribeCacheParameterGroupsRequest)
* @see AWS API Documentation
*/
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups() throws CacheParameterGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeCacheParameterGroups(DescribeCacheParameterGroupsRequest.builder().build());
}
/**
*
* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list
* contains only the descriptions for that group.
*
*
* @param describeCacheParameterGroupsRequest
* Represents the input of a DescribeCacheParameterGroups operation.
* @return Result of the DescribeCacheParameterGroups operation returned by the service.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameterGroups
* @see AWS API Documentation
*/
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups(
DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list
* contains only the descriptions for that group.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheParameterGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeCacheParameterGroupsRequest#builder()}
*
*
* @param describeCacheParameterGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheParameterGroupsMessage.Builder} to create
* a request. Represents the input of a DescribeCacheParameterGroups operation.
* @return Result of the DescribeCacheParameterGroups operation returned by the service.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameterGroups
* @see AWS API Documentation
*/
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups(
Consumer describeCacheParameterGroupsRequest)
throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheParameterGroups(DescribeCacheParameterGroupsRequest.builder()
.applyMutation(describeCacheParameterGroupsRequest).build());
}
/**
*
* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list
* contains only the descriptions for that group.
*
*
*
* This is a variant of
* {@link #describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client
* .describeCacheParameterGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameterGroups
* @see #describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest)
* @see AWS API Documentation
*/
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator()
throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest.builder().build());
}
/**
*
* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list
* contains only the descriptions for that group.
*
*
*
* This is a variant of
* {@link #describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client
* .describeCacheParameterGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)}
* operation.
*
*
* @param describeCacheParameterGroupsRequest
* Represents the input of a DescribeCacheParameterGroups operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameterGroups
* @see AWS API Documentation
*/
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator(
DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list
* contains only the descriptions for that group.
*
*
*
* This is a variant of
* {@link #describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client
* .describeCacheParameterGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheParameterGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeCacheParameterGroupsRequest#builder()}
*
*
* @param describeCacheParameterGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheParameterGroupsMessage.Builder} to create
* a request. Represents the input of a DescribeCacheParameterGroups operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameterGroups
* @see AWS API Documentation
*/
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator(
Consumer describeCacheParameterGroupsRequest)
throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest.builder()
.applyMutation(describeCacheParameterGroupsRequest).build());
}
/**
*
* Returns the detailed parameter list for a particular cache parameter group.
*
*
* @param describeCacheParametersRequest
* Represents the input of a DescribeCacheParameters operation.
* @return Result of the DescribeCacheParameters operation returned by the service.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameters
* @see AWS API Documentation
*/
default DescribeCacheParametersResponse describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the detailed parameter list for a particular cache parameter group.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheParametersRequest.Builder} avoiding
* the need to create one manually via {@link DescribeCacheParametersRequest#builder()}
*
*
* @param describeCacheParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheParametersMessage.Builder} to create a
* request. Represents the input of a DescribeCacheParameters operation.
* @return Result of the DescribeCacheParameters operation returned by the service.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameters
* @see AWS API Documentation
*/
default DescribeCacheParametersResponse describeCacheParameters(
Consumer describeCacheParametersRequest)
throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheParameters(DescribeCacheParametersRequest.builder().applyMutation(describeCacheParametersRequest)
.build());
}
/**
*
* Returns the detailed parameter list for a particular cache parameter group.
*
*
*
* This is a variant of
* {@link #describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client
* .describeCacheParametersPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)}
* operation.
*
*
* @param describeCacheParametersRequest
* Represents the input of a DescribeCacheParameters operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameters
* @see AWS API Documentation
*/
default DescribeCacheParametersIterable describeCacheParametersPaginator(
DescribeCacheParametersRequest describeCacheParametersRequest) throws CacheParameterGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the detailed parameter list for a particular cache parameter group.
*
*
*
* This is a variant of
* {@link #describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client
* .describeCacheParametersPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheParametersRequest.Builder} avoiding
* the need to create one manually via {@link DescribeCacheParametersRequest#builder()}
*
*
* @param describeCacheParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheParametersMessage.Builder} to create a
* request. Represents the input of a DescribeCacheParameters operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheParameters
* @see AWS API Documentation
*/
default DescribeCacheParametersIterable describeCacheParametersPaginator(
Consumer describeCacheParametersRequest)
throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheParametersPaginator(DescribeCacheParametersRequest.builder()
.applyMutation(describeCacheParametersRequest).build());
}
/**
*
* Returns a list of cache security group descriptions. If a cache security group name is specified, the list
* contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
*
*
* @param describeCacheSecurityGroupsRequest
* Represents the input of a DescribeCacheSecurityGroups operation.
* @return Result of the DescribeCacheSecurityGroups operation returned by the service.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSecurityGroups
* @see AWS API Documentation
*/
default DescribeCacheSecurityGroupsResponse describeCacheSecurityGroups(
DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of cache security group descriptions. If a cache security group name is specified, the list
* contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheSecurityGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeCacheSecurityGroupsRequest#builder()}
*
*
* @param describeCacheSecurityGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheSecurityGroupsMessage.Builder} to create
* a request. Represents the input of a DescribeCacheSecurityGroups operation.
* @return Result of the DescribeCacheSecurityGroups operation returned by the service.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSecurityGroups
* @see AWS API Documentation
*/
default DescribeCacheSecurityGroupsResponse describeCacheSecurityGroups(
Consumer describeCacheSecurityGroupsRequest)
throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest.builder()
.applyMutation(describeCacheSecurityGroupsRequest).build());
}
/**
*
* Returns a list of cache security group descriptions. If a cache security group name is specified, the list
* contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
*
*
*
* This is a variant of
* {@link #describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client
* .describeCacheSecurityGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)}
* operation.
*
*
* @param describeCacheSecurityGroupsRequest
* Represents the input of a DescribeCacheSecurityGroups operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSecurityGroups
* @see AWS API Documentation
*/
default DescribeCacheSecurityGroupsIterable describeCacheSecurityGroupsPaginator(
DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of cache security group descriptions. If a cache security group name is specified, the list
* contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
*
*
*
* This is a variant of
* {@link #describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client
* .describeCacheSecurityGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheSecurityGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeCacheSecurityGroupsRequest#builder()}
*
*
* @param describeCacheSecurityGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheSecurityGroupsMessage.Builder} to create
* a request. Represents the input of a DescribeCacheSecurityGroups operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSecurityGroups
* @see AWS API Documentation
*/
default DescribeCacheSecurityGroupsIterable describeCacheSecurityGroupsPaginator(
Consumer describeCacheSecurityGroupsRequest)
throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheSecurityGroupsPaginator(DescribeCacheSecurityGroupsRequest.builder()
.applyMutation(describeCacheSecurityGroupsRequest).build());
}
/**
*
* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only
* the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache
* clusters now launch in VPC by default.
*
*
* @return Result of the DescribeCacheSubnetGroups operation returned by the service.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSubnetGroups
* @see #describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)
* @see AWS API Documentation
*/
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups() throws CacheSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest.builder().build());
}
/**
*
* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only
* the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache
* clusters now launch in VPC by default.
*
*
* @param describeCacheSubnetGroupsRequest
* Represents the input of a DescribeCacheSubnetGroups operation.
* @return Result of the DescribeCacheSubnetGroups operation returned by the service.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSubnetGroups
* @see AWS API Documentation
*/
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups(
DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only
* the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache
* clusters now launch in VPC by default.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheSubnetGroupsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeCacheSubnetGroupsRequest#builder()}
*
*
* @param describeCacheSubnetGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheSubnetGroupsMessage.Builder} to create a
* request. Represents the input of a DescribeCacheSubnetGroups operation.
* @return Result of the DescribeCacheSubnetGroups operation returned by the service.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSubnetGroups
* @see AWS API Documentation
*/
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups(
Consumer describeCacheSubnetGroupsRequest)
throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest.builder()
.applyMutation(describeCacheSubnetGroupsRequest).build());
}
/**
*
* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only
* the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache
* clusters now launch in VPC by default.
*
*
*
* This is a variant of
* {@link #describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client
* .describeCacheSubnetGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSubnetGroups
* @see #describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest)
* @see AWS API Documentation
*/
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator() throws CacheSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest.builder().build());
}
/**
*
* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only
* the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache
* clusters now launch in VPC by default.
*
*
*
* This is a variant of
* {@link #describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client
* .describeCacheSubnetGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)}
* operation.
*
*
* @param describeCacheSubnetGroupsRequest
* Represents the input of a DescribeCacheSubnetGroups operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSubnetGroups
* @see AWS API Documentation
*/
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator(
DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only
* the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache
* clusters now launch in VPC by default.
*
*
*
* This is a variant of
* {@link #describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client
* .describeCacheSubnetGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheSubnetGroupsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeCacheSubnetGroupsRequest#builder()}
*
*
* @param describeCacheSubnetGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheSubnetGroupsMessage.Builder} to create a
* request. Represents the input of a DescribeCacheSubnetGroups operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeCacheSubnetGroups
* @see AWS API Documentation
*/
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator(
Consumer describeCacheSubnetGroupsRequest)
throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest.builder()
.applyMutation(describeCacheSubnetGroupsRequest).build());
}
/**
*
* Returns the default engine and system parameter information for the specified cache engine.
*
*
* @param describeEngineDefaultParametersRequest
* Represents the input of a DescribeEngineDefaultParameters operation.
* @return Result of the DescribeEngineDefaultParameters operation returned by the service.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(
DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the default engine and system parameter information for the specified cache engine.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEngineDefaultParametersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeEngineDefaultParametersRequest#builder()}
*
*
* @param describeEngineDefaultParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeEngineDefaultParametersMessage.Builder} to
* create a request. Represents the input of a DescribeEngineDefaultParameters operation.
* @return Result of the DescribeEngineDefaultParameters operation returned by the service.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(
Consumer describeEngineDefaultParametersRequest)
throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest.builder()
.applyMutation(describeEngineDefaultParametersRequest).build());
}
/**
*
* Returns the default engine and system parameter information for the specified cache engine.
*
*
*
* This is a variant of
* {@link #describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client
* .describeEngineDefaultParametersPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)}
* operation.
*
*
* @param describeEngineDefaultParametersRequest
* Represents the input of a DescribeEngineDefaultParameters operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(
DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the default engine and system parameter information for the specified cache engine.
*
*
*
* This is a variant of
* {@link #describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client
* .describeEngineDefaultParametersPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeEngineDefaultParametersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeEngineDefaultParametersRequest#builder()}
*
*
* @param describeEngineDefaultParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeEngineDefaultParametersMessage.Builder} to
* create a request. Represents the input of a DescribeEngineDefaultParameters operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEngineDefaultParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(
Consumer describeEngineDefaultParametersRequest)
throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest.builder()
.applyMutation(describeEngineDefaultParametersRequest).build());
}
/**
*
* Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events
* specific to a particular 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.
*
*
* @return Result of the DescribeEvents operation returned by the service.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEvents
* @see #describeEvents(DescribeEventsRequest)
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents() throws InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeEvents(DescribeEventsRequest.builder().build());
}
/**
*
* Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events
* specific to a particular 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.
*
*
* @param describeEventsRequest
* Represents the input of a DescribeEvents operation.
* @return Result of the DescribeEvents operation returned by the service.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest)
throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events
* specific to a particular 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.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEventsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeEventsRequest#builder()}
*
*
* @param describeEventsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventsMessage.Builder} to create a request.
* Represents the input of a DescribeEvents operation.
* @return Result of the DescribeEvents operation returned by the service.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents(Consumer describeEventsRequest)
throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeEvents(DescribeEventsRequest.builder().applyMutation(describeEventsRequest).build());
}
/**
*
* Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events
* specific to a particular 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.
*
*
*
* This is a variant of
* {@link #describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client
* .describeEventsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEvents
* @see #describeEventsPaginator(DescribeEventsRequest)
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator() throws InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeEventsPaginator(DescribeEventsRequest.builder().build());
}
/**
*
* Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events
* specific to a particular 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.
*
*
*
* This is a variant of
* {@link #describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client
* .describeEventsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)} operation.
*
*
* @param describeEventsRequest
* Represents the input of a DescribeEvents operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events
* specific to a particular 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.
*
*
*
* This is a variant of
* {@link #describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client
* .describeEventsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeEventsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeEventsRequest#builder()}
*
*
* @param describeEventsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventsMessage.Builder} to create a request.
* Represents the input of a DescribeEvents operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator(Consumer describeEventsRequest)
throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeEventsPaginator(DescribeEventsRequest.builder().applyMutation(describeEventsRequest).build());
}
/**
*
* Returns information about a particular global replication group. If no identifier is specified, returns
* information about all Global Datastores.
*
*
* @param describeGlobalReplicationGroupsRequest
* @return Result of the DescribeGlobalReplicationGroups operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeGlobalReplicationGroups
* @see AWS API Documentation
*/
default DescribeGlobalReplicationGroupsResponse describeGlobalReplicationGroups(
DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)
throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a particular global replication group. If no identifier is specified, returns
* information about all Global Datastores.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeGlobalReplicationGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeGlobalReplicationGroupsRequest#builder()}
*
*
* @param describeGlobalReplicationGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeGlobalReplicationGroupsMessage.Builder} to
* create a request.
* @return Result of the DescribeGlobalReplicationGroups operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeGlobalReplicationGroups
* @see AWS API Documentation
*/
default DescribeGlobalReplicationGroupsResponse describeGlobalReplicationGroups(
Consumer describeGlobalReplicationGroupsRequest)
throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest.builder()
.applyMutation(describeGlobalReplicationGroupsRequest).build());
}
/**
*
* Returns information about a particular global replication group. If no identifier is specified, returns
* information about all Global Datastores.
*
*
*
* This is a variant of
* {@link #describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client
* .describeGlobalReplicationGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)}
* operation.
*
*
* @param describeGlobalReplicationGroupsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeGlobalReplicationGroups
* @see AWS API Documentation
*/
default DescribeGlobalReplicationGroupsIterable describeGlobalReplicationGroupsPaginator(
DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)
throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a particular global replication group. If no identifier is specified, returns
* information about all Global Datastores.
*
*
*
* This is a variant of
* {@link #describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client
* .describeGlobalReplicationGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeGlobalReplicationGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeGlobalReplicationGroupsRequest#builder()}
*
*
* @param describeGlobalReplicationGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeGlobalReplicationGroupsMessage.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeGlobalReplicationGroups
* @see AWS API Documentation
*/
default DescribeGlobalReplicationGroupsIterable describeGlobalReplicationGroupsPaginator(
Consumer describeGlobalReplicationGroupsRequest)
throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeGlobalReplicationGroupsPaginator(DescribeGlobalReplicationGroupsRequest.builder()
.applyMutation(describeGlobalReplicationGroupsRequest).build());
}
/**
*
* Returns information about a particular replication group. If no identifier is specified,
* DescribeReplicationGroups returns information about all replication groups.
*
*
*
* This operation is valid for Redis only.
*
*
*
* @return Result of the DescribeReplicationGroups operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReplicationGroups
* @see #describeReplicationGroups(DescribeReplicationGroupsRequest)
* @see AWS API Documentation
*/
default DescribeReplicationGroupsResponse describeReplicationGroups() throws ReplicationGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeReplicationGroups(DescribeReplicationGroupsRequest.builder().build());
}
/**
*
* Returns information about a particular replication group. If no identifier is specified,
* DescribeReplicationGroups returns information about all replication groups.
*
*
*
* This operation is valid for Redis only.
*
*
*
* @param describeReplicationGroupsRequest
* Represents the input of a DescribeReplicationGroups operation.
* @return Result of the DescribeReplicationGroups operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReplicationGroups
* @see AWS API Documentation
*/
default DescribeReplicationGroupsResponse describeReplicationGroups(
DescribeReplicationGroupsRequest describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a particular replication group. If no identifier is specified,
* DescribeReplicationGroups returns information about all replication groups.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeReplicationGroupsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeReplicationGroupsRequest#builder()}
*
*
* @param describeReplicationGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeReplicationGroupsMessage.Builder} to create a
* request. Represents the input of a DescribeReplicationGroups operation.
* @return Result of the DescribeReplicationGroups operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReplicationGroups
* @see AWS API Documentation
*/
default DescribeReplicationGroupsResponse describeReplicationGroups(
Consumer describeReplicationGroupsRequest)
throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeReplicationGroups(DescribeReplicationGroupsRequest.builder()
.applyMutation(describeReplicationGroupsRequest).build());
}
/**
*
* Returns information about a particular replication group. If no identifier is specified,
* DescribeReplicationGroups returns information about all replication groups.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a variant of
* {@link #describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client
* .describeReplicationGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReplicationGroups
* @see #describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest)
* @see AWS API Documentation
*/
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator() throws ReplicationGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest.builder().build());
}
/**
*
* Returns information about a particular replication group. If no identifier is specified,
* DescribeReplicationGroups returns information about all replication groups.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a variant of
* {@link #describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client
* .describeReplicationGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)}
* operation.
*
*
* @param describeReplicationGroupsRequest
* Represents the input of a DescribeReplicationGroups operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReplicationGroups
* @see AWS API Documentation
*/
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator(
DescribeReplicationGroupsRequest describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a particular replication group. If no identifier is specified,
* DescribeReplicationGroups returns information about all replication groups.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a variant of
* {@link #describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client
* .describeReplicationGroupsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeReplicationGroupsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeReplicationGroupsRequest#builder()}
*
*
* @param describeReplicationGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeReplicationGroupsMessage.Builder} to create a
* request. Represents the input of a DescribeReplicationGroups operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReplicationGroups
* @see AWS API Documentation
*/
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator(
Consumer describeReplicationGroupsRequest)
throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest.builder()
.applyMutation(describeReplicationGroupsRequest).build());
}
/**
*
* Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
*
*
* @return Result of the DescribeReservedCacheNodes operation returned by the service.
* @throws ReservedCacheNodeNotFoundException
* The requested reserved cache node was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodes
* @see #describeReservedCacheNodes(DescribeReservedCacheNodesRequest)
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesResponse describeReservedCacheNodes() throws ReservedCacheNodeNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeReservedCacheNodes(DescribeReservedCacheNodesRequest.builder().build());
}
/**
*
* Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
*
*
* @param describeReservedCacheNodesRequest
* Represents the input of a DescribeReservedCacheNodes operation.
* @return Result of the DescribeReservedCacheNodes operation returned by the service.
* @throws ReservedCacheNodeNotFoundException
* The requested reserved cache node was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodes
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesResponse describeReservedCacheNodes(
DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeReservedCacheNodesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeReservedCacheNodesRequest#builder()}
*
*
* @param describeReservedCacheNodesRequest
* A {@link Consumer} that will call methods on {@link DescribeReservedCacheNodesMessage.Builder} to create a
* request. Represents the input of a DescribeReservedCacheNodes operation.
* @return Result of the DescribeReservedCacheNodes operation returned by the service.
* @throws ReservedCacheNodeNotFoundException
* The requested reserved cache node was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodes
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesResponse describeReservedCacheNodes(
Consumer describeReservedCacheNodesRequest)
throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeReservedCacheNodes(DescribeReservedCacheNodesRequest.builder()
.applyMutation(describeReservedCacheNodesRequest).build());
}
/**
*
* Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
*
*
*
* This is a variant of
* {@link #describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client
* .describeReservedCacheNodesPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedCacheNodeNotFoundException
* The requested reserved cache node was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodes
* @see #describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest)
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator() throws ReservedCacheNodeNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest.builder().build());
}
/**
*
* Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
*
*
*
* This is a variant of
* {@link #describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client
* .describeReservedCacheNodesPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)}
* operation.
*
*
* @param describeReservedCacheNodesRequest
* Represents the input of a DescribeReservedCacheNodes operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedCacheNodeNotFoundException
* The requested reserved cache node was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodes
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator(
DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
*
*
*
* This is a variant of
* {@link #describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client
* .describeReservedCacheNodesPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeReservedCacheNodesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeReservedCacheNodesRequest#builder()}
*
*
* @param describeReservedCacheNodesRequest
* A {@link Consumer} that will call methods on {@link DescribeReservedCacheNodesMessage.Builder} to create a
* request. Represents the input of a DescribeReservedCacheNodes operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedCacheNodeNotFoundException
* The requested reserved cache node was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodes
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator(
Consumer describeReservedCacheNodesRequest)
throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest.builder()
.applyMutation(describeReservedCacheNodesRequest).build());
}
/**
*
* Lists available reserved cache node offerings.
*
*
* @return Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
* @throws ReservedCacheNodesOfferingNotFoundException
* The requested cache node offering does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodesOfferings
* @see #describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings()
throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest.builder().build());
}
/**
*
* Lists available reserved cache node offerings.
*
*
* @param describeReservedCacheNodesOfferingsRequest
* Represents the input of a DescribeReservedCacheNodesOfferings operation.
* @return Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
* @throws ReservedCacheNodesOfferingNotFoundException
* The requested cache node offering does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodesOfferings
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings(
DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Lists available reserved cache node offerings.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeReservedCacheNodesOfferingsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeReservedCacheNodesOfferingsRequest#builder()}
*
*
* @param describeReservedCacheNodesOfferingsRequest
* A {@link Consumer} that will call methods on {@link DescribeReservedCacheNodesOfferingsMessage.Builder} to
* create a request. Represents the input of a DescribeReservedCacheNodesOfferings operation.
* @return Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
* @throws ReservedCacheNodesOfferingNotFoundException
* The requested cache node offering does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodesOfferings
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings(
Consumer describeReservedCacheNodesOfferingsRequest)
throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest.builder()
.applyMutation(describeReservedCacheNodesOfferingsRequest).build());
}
/**
*
* Lists available reserved cache node offerings.
*
*
*
* This is a variant of
* {@link #describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client
* .describeReservedCacheNodesOfferingsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedCacheNodesOfferingNotFoundException
* The requested cache node offering does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodesOfferings
* @see #describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest)
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator()
throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest.builder().build());
}
/**
*
* Lists available reserved cache node offerings.
*
*
*
* This is a variant of
* {@link #describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client
* .describeReservedCacheNodesOfferingsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)}
* operation.
*
*
* @param describeReservedCacheNodesOfferingsRequest
* Represents the input of a DescribeReservedCacheNodesOfferings operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedCacheNodesOfferingNotFoundException
* The requested cache node offering does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodesOfferings
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator(
DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Lists available reserved cache node offerings.
*
*
*
* This is a variant of
* {@link #describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client
* .describeReservedCacheNodesOfferingsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeReservedCacheNodesOfferingsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeReservedCacheNodesOfferingsRequest#builder()}
*
*
* @param describeReservedCacheNodesOfferingsRequest
* A {@link Consumer} that will call methods on {@link DescribeReservedCacheNodesOfferingsMessage.Builder} to
* create a request. Represents the input of a DescribeReservedCacheNodesOfferings operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ReservedCacheNodesOfferingNotFoundException
* The requested cache node offering does not exist.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeReservedCacheNodesOfferings
* @see AWS API Documentation
*/
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator(
Consumer describeReservedCacheNodesOfferingsRequest)
throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest.builder()
.applyMutation(describeReservedCacheNodesOfferingsRequest).build());
}
/**
*
* Returns details of the service updates
*
*
* @param describeServiceUpdatesRequest
* @return Result of the DescribeServiceUpdates operation returned by the service.
* @throws ServiceUpdateNotFoundException
* The service update doesn't exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeServiceUpdates
* @see AWS API Documentation
*/
default DescribeServiceUpdatesResponse describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns details of the service updates
*
*
*
* This is a convenience which creates an instance of the {@link DescribeServiceUpdatesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeServiceUpdatesRequest#builder()}
*
*
* @param describeServiceUpdatesRequest
* A {@link Consumer} that will call methods on {@link DescribeServiceUpdatesMessage.Builder} to create a
* request.
* @return Result of the DescribeServiceUpdates operation returned by the service.
* @throws ServiceUpdateNotFoundException
* The service update doesn't exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeServiceUpdates
* @see AWS API Documentation
*/
default DescribeServiceUpdatesResponse describeServiceUpdates(
Consumer describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeServiceUpdates(DescribeServiceUpdatesRequest.builder().applyMutation(describeServiceUpdatesRequest)
.build());
}
/**
*
* Returns details of the service updates
*
*
*
* This is a variant of
* {@link #describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client
* .describeServiceUpdatesPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)}
* operation.
*
*
* @param describeServiceUpdatesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUpdateNotFoundException
* The service update doesn't exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeServiceUpdates
* @see AWS API Documentation
*/
default DescribeServiceUpdatesIterable describeServiceUpdatesPaginator(
DescribeServiceUpdatesRequest describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns details of the service updates
*
*
*
* This is a variant of
* {@link #describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client
* .describeServiceUpdatesPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeServiceUpdatesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeServiceUpdatesRequest#builder()}
*
*
* @param describeServiceUpdatesRequest
* A {@link Consumer} that will call methods on {@link DescribeServiceUpdatesMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ServiceUpdateNotFoundException
* The service update doesn't exist
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeServiceUpdates
* @see AWS API Documentation
*/
default DescribeServiceUpdatesIterable describeServiceUpdatesPaginator(
Consumer describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest.builder()
.applyMutation(describeServiceUpdatesRequest).build());
}
/**
*
* Returns information about cluster or replication group 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.
*
*
*
* This operation is valid for Redis only.
*
*
*
* @return Result of the DescribeSnapshots operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeSnapshots
* @see #describeSnapshots(DescribeSnapshotsRequest)
* @see AWS
* API Documentation
*/
default DescribeSnapshotsResponse describeSnapshots() throws CacheClusterNotFoundException, SnapshotNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return describeSnapshots(DescribeSnapshotsRequest.builder().build());
}
/**
*
* Returns information about cluster or replication group 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.
*
*
*
* This operation is valid for Redis only.
*
*
*
* @param describeSnapshotsRequest
* Represents the input of a DescribeSnapshotsMessage operation.
* @return Result of the DescribeSnapshots operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeSnapshots
* @see AWS
* API Documentation
*/
default DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about cluster or replication group 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.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSnapshotsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeSnapshotsRequest#builder()}
*
*
* @param describeSnapshotsRequest
* A {@link Consumer} that will call methods on {@link DescribeSnapshotsMessage.Builder} to create a request.
* Represents the input of a DescribeSnapshotsMessage operation.
* @return Result of the DescribeSnapshots operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeSnapshots
* @see AWS
* API Documentation
*/
default DescribeSnapshotsResponse describeSnapshots(Consumer describeSnapshotsRequest)
throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeSnapshots(DescribeSnapshotsRequest.builder().applyMutation(describeSnapshotsRequest).build());
}
/**
*
* Returns information about cluster or replication group 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.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a variant of
* {@link #describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client
* .describeSnapshotsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeSnapshots
* @see #describeSnapshotsPaginator(DescribeSnapshotsRequest)
* @see AWS
* API Documentation
*/
default DescribeSnapshotsIterable describeSnapshotsPaginator() throws CacheClusterNotFoundException,
SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException,
SdkClientException, ElastiCacheException {
return describeSnapshotsPaginator(DescribeSnapshotsRequest.builder().build());
}
/**
*
* Returns information about cluster or replication group 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.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a variant of
* {@link #describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client
* .describeSnapshotsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)}
* operation.
*
*
* @param describeSnapshotsRequest
* Represents the input of a DescribeSnapshotsMessage operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeSnapshots
* @see AWS
* API Documentation
*/
default DescribeSnapshotsIterable describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)
throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about cluster or replication group 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.
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a variant of
* {@link #describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client
* .describeSnapshotsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeSnapshotsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeSnapshotsRequest#builder()}
*
*
* @param describeSnapshotsRequest
* A {@link Consumer} that will call methods on {@link DescribeSnapshotsMessage.Builder} to create a request.
* Represents the input of a DescribeSnapshotsMessage operation.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeSnapshots
* @see AWS
* API Documentation
*/
default DescribeSnapshotsIterable describeSnapshotsPaginator(
Consumer describeSnapshotsRequest) throws CacheClusterNotFoundException,
SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException,
SdkClientException, ElastiCacheException {
return describeSnapshotsPaginator(DescribeSnapshotsRequest.builder().applyMutation(describeSnapshotsRequest).build());
}
/**
*
* Returns details of the update actions
*
*
* @param describeUpdateActionsRequest
* @return Result of the DescribeUpdateActions operation returned by the service.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeUpdateActions
* @see AWS API Documentation
*/
default DescribeUpdateActionsResponse describeUpdateActions(DescribeUpdateActionsRequest describeUpdateActionsRequest)
throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns details of the update actions
*
*
*
* This is a convenience which creates an instance of the {@link DescribeUpdateActionsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeUpdateActionsRequest#builder()}
*
*
* @param describeUpdateActionsRequest
* A {@link Consumer} that will call methods on {@link DescribeUpdateActionsMessage.Builder} to create a
* request.
* @return Result of the DescribeUpdateActions operation returned by the service.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeUpdateActions
* @see AWS API Documentation
*/
default DescribeUpdateActionsResponse describeUpdateActions(
Consumer describeUpdateActionsRequest) throws InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeUpdateActions(DescribeUpdateActionsRequest.builder().applyMutation(describeUpdateActionsRequest).build());
}
/**
*
* Returns details of the update actions
*
*
*
* This is a variant of
* {@link #describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client
* .describeUpdateActionsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)}
* operation.
*
*
* @param describeUpdateActionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeUpdateActions
* @see AWS API Documentation
*/
default DescribeUpdateActionsIterable describeUpdateActionsPaginator(DescribeUpdateActionsRequest describeUpdateActionsRequest)
throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Returns details of the update actions
*
*
*
* This is a variant of
* {@link #describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client
* .describeUpdateActionsPaginator(request);
* for (software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxRecords won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeUpdateActionsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeUpdateActionsRequest#builder()}
*
*
* @param describeUpdateActionsRequest
* A {@link Consumer} that will call methods on {@link DescribeUpdateActionsMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DescribeUpdateActions
* @see AWS API Documentation
*/
default DescribeUpdateActionsIterable describeUpdateActionsPaginator(
Consumer describeUpdateActionsRequest) throws InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return describeUpdateActionsPaginator(DescribeUpdateActionsRequest.builder().applyMutation(describeUpdateActionsRequest)
.build());
}
/**
*
* Remove a secondary cluster from the Global Datastore using the Global Datastore name. The secondary cluster will
* no longer receive updates from the primary cluster, but will remain as a standalone cluster in that AWS region.
*
*
* @param disassociateGlobalReplicationGroupRequest
* @return Result of the DisassociateGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DisassociateGlobalReplicationGroup
* @see AWS API Documentation
*/
default DisassociateGlobalReplicationGroupResponse disassociateGlobalReplicationGroup(
DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Remove a secondary cluster from the Global Datastore using the Global Datastore name. The secondary cluster will
* no longer receive updates from the primary cluster, but will remain as a standalone cluster in that AWS region.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateGlobalReplicationGroupRequest.Builder}
* avoiding the need to create one manually via {@link DisassociateGlobalReplicationGroupRequest#builder()}
*
*
* @param disassociateGlobalReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link DisassociateGlobalReplicationGroupMessage.Builder} to
* create a request.
* @return Result of the DisassociateGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.DisassociateGlobalReplicationGroup
* @see AWS API Documentation
*/
default DisassociateGlobalReplicationGroupResponse disassociateGlobalReplicationGroup(
Consumer disassociateGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest.builder()
.applyMutation(disassociateGlobalReplicationGroupRequest).build());
}
/**
*
* Used to failover the primary region to a selected secondary region. The selected secondary region will become
* primary, and all other clusters will become secondary.
*
*
* @param failoverGlobalReplicationGroupRequest
* @return Result of the FailoverGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.FailoverGlobalReplicationGroup
* @see AWS API Documentation
*/
default FailoverGlobalReplicationGroupResponse failoverGlobalReplicationGroup(
FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Used to failover the primary region to a selected secondary region. The selected secondary region will become
* primary, and all other clusters will become secondary.
*
*
*
* This is a convenience which creates an instance of the {@link FailoverGlobalReplicationGroupRequest.Builder}
* avoiding the need to create one manually via {@link FailoverGlobalReplicationGroupRequest#builder()}
*
*
* @param failoverGlobalReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link FailoverGlobalReplicationGroupMessage.Builder} to
* create a request.
* @return Result of the FailoverGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.FailoverGlobalReplicationGroup
* @see AWS API Documentation
*/
default FailoverGlobalReplicationGroupResponse failoverGlobalReplicationGroup(
Consumer failoverGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest.builder()
.applyMutation(failoverGlobalReplicationGroupRequest).build());
}
/**
*
* Increase the number of node groups in the Global Datastore
*
*
* @param increaseNodeGroupsInGlobalReplicationGroupRequest
* @return Result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.IncreaseNodeGroupsInGlobalReplicationGroup
* @see AWS API Documentation
*/
default IncreaseNodeGroupsInGlobalReplicationGroupResponse increaseNodeGroupsInGlobalReplicationGroup(
IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Increase the number of node groups in the Global Datastore
*
*
*
* This is a convenience which creates an instance of the
* {@link IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder} avoiding the need to create one manually via
* {@link IncreaseNodeGroupsInGlobalReplicationGroupRequest#builder()}
*
*
* @param increaseNodeGroupsInGlobalReplicationGroupRequest
* A {@link Consumer} that will call methods on
* {@link IncreaseNodeGroupsInGlobalReplicationGroupMessage.Builder} to create a request.
* @return Result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.IncreaseNodeGroupsInGlobalReplicationGroup
* @see AWS API Documentation
*/
default IncreaseNodeGroupsInGlobalReplicationGroupResponse increaseNodeGroupsInGlobalReplicationGroup(
Consumer increaseNodeGroupsInGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
return increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest.builder()
.applyMutation(increaseNodeGroupsInGlobalReplicationGroupRequest).build());
}
/**
*
* Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of
* replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This
* operation is performed with no cluster down time.
*
*
* @param increaseReplicaCountRequest
* @return Result of the IncreaseReplicaCount operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws ClusterQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of clusters per customer.
* @throws NodeGroupsPerReplicationGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum allowed number of node groups
* (shards) in a single replication group. The default maximum is 90
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws NoOperationException
* The operation was not performed because no changes were required.
* @throws InvalidKmsKeyException
* The KMS key supplied is not valid.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.IncreaseReplicaCount
* @see AWS API Documentation
*/
default IncreaseReplicaCountResponse increaseReplicaCount(IncreaseReplicaCountRequest increaseReplicaCountRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException,
InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException,
NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, NoOperationException,
InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException,
SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of
* replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This
* operation is performed with no cluster down time.
*
*
*
* This is a convenience which creates an instance of the {@link IncreaseReplicaCountRequest.Builder} avoiding the
* need to create one manually via {@link IncreaseReplicaCountRequest#builder()}
*
*
* @param increaseReplicaCountRequest
* A {@link Consumer} that will call methods on {@link IncreaseReplicaCountMessage.Builder} to create a
* request.
* @return Result of the IncreaseReplicaCount operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws ClusterQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of clusters per customer.
* @throws NodeGroupsPerReplicationGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum allowed number of node groups
* (shards) in a single replication group. The default maximum is 90
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws NoOperationException
* The operation was not performed because no changes were required.
* @throws InvalidKmsKeyException
* The KMS key supplied is not valid.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.IncreaseReplicaCount
* @see AWS API Documentation
*/
default IncreaseReplicaCountResponse increaseReplicaCount(
Consumer increaseReplicaCountRequest) throws ReplicationGroupNotFoundException,
InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException,
InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException,
NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, NoOperationException,
InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException,
SdkClientException, ElastiCacheException {
return increaseReplicaCount(IncreaseReplicaCountRequest.builder().applyMutation(increaseReplicaCountRequest).build());
}
/**
*
* Lists all available node types that you can scale your Redis cluster's or replication group's current node type.
*
*
* When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your
* cluster or replication group, the value of the CacheNodeType parameter must be one of the node types
* returned by this operation.
*
*
* @param listAllowedNodeTypeModificationsRequest
* The input parameters for the ListAllowedNodeTypeModifications operation.
* @return Result of the ListAllowedNodeTypeModifications operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ListAllowedNodeTypeModifications
* @see AWS API Documentation
*/
default ListAllowedNodeTypeModificationsResponse listAllowedNodeTypeModifications(
ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)
throws CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidParameterCombinationException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Lists all available node types that you can scale your Redis cluster's or replication group's current node type.
*
*
* When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your
* cluster or replication group, the value of the CacheNodeType parameter must be one of the node types
* returned by this operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListAllowedNodeTypeModificationsRequest.Builder}
* avoiding the need to create one manually via {@link ListAllowedNodeTypeModificationsRequest#builder()}
*
*
* @param listAllowedNodeTypeModificationsRequest
* A {@link Consumer} that will call methods on {@link ListAllowedNodeTypeModificationsMessage.Builder} to
* create a request. The input parameters for the ListAllowedNodeTypeModifications operation.
* @return Result of the ListAllowedNodeTypeModifications operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ListAllowedNodeTypeModifications
* @see AWS API Documentation
*/
default ListAllowedNodeTypeModificationsResponse listAllowedNodeTypeModifications(
Consumer listAllowedNodeTypeModificationsRequest)
throws CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidParameterCombinationException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
return listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest.builder()
.applyMutation(listAllowedNodeTypeModificationsRequest).build());
}
/**
*
* 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. You can use cost allocation tags to categorize
* and track your AWS costs.
*
*
* If the cluster is not in the available state, ListTagsForResource returns an error.
*
*
* You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.
*
*
* @param listTagsForResourceRequest
* The input parameters for the ListTagsForResource operation.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidArnException
* The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidArnException, AwsServiceException,
SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* 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. You can use cost allocation tags to categorize
* and track your AWS costs.
*
*
* If the cluster is not in the available state, ListTagsForResource returns an error.
*
*
* You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceMessage.Builder} to create a
* request. The input parameters for the ListTagsForResource operation.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidArnException
* The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws CacheClusterNotFoundException,
SnapshotNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration
* parameters by specifying the parameters and the new values.
*
*
* @param modifyCacheClusterRequest
* Represents the input of a ModifyCacheCluster operation.
* @return Result of the ModifyCacheCluster operation returned by the service.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws NodeQuotaForClusterExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes in a single
* cluster.
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyCacheCluster
* @see AWS
* API Documentation
*/
default ModifyCacheClusterResponse modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
throws InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException,
InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException,
InvalidVpcNetworkStateException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration
* parameters by specifying the parameters and the new values.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyCacheClusterRequest.Builder} avoiding the
* need to create one manually via {@link ModifyCacheClusterRequest#builder()}
*
*
* @param modifyCacheClusterRequest
* A {@link Consumer} that will call methods on {@link ModifyCacheClusterMessage.Builder} to create a
* request. Represents the input of a ModifyCacheCluster operation.
* @return Result of the ModifyCacheCluster operation returned by the service.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws NodeQuotaForClusterExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes in a single
* cluster.
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyCacheCluster
* @see AWS
* API Documentation
*/
default ModifyCacheClusterResponse modifyCacheCluster(Consumer modifyCacheClusterRequest)
throws InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException,
InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException,
InvalidVpcNetworkStateException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return modifyCacheCluster(ModifyCacheClusterRequest.builder().applyMutation(modifyCacheClusterRequest).build());
}
/**
*
* 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.
*
*
* @param modifyCacheParameterGroupRequest
* Represents the input of a ModifyCacheParameterGroup operation.
* @return Result of the ModifyCacheParameterGroup operation returned by the service.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidCacheParameterGroupStateException
* The current state of the cache parameter group does not allow the requested operation to occur.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyCacheParameterGroup
* @see AWS API Documentation
*/
default ModifyCacheParameterGroupResponse modifyCacheParameterGroup(
ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) throws CacheParameterGroupNotFoundException,
InvalidCacheParameterGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException,
InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyCacheParameterGroupRequest.Builder} avoiding
* the need to create one manually via {@link ModifyCacheParameterGroupRequest#builder()}
*
*
* @param modifyCacheParameterGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyCacheParameterGroupMessage.Builder} to create a
* request. Represents the input of a ModifyCacheParameterGroup operation.
* @return Result of the ModifyCacheParameterGroup operation returned by the service.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidCacheParameterGroupStateException
* The current state of the cache parameter group does not allow the requested operation to occur.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyCacheParameterGroup
* @see AWS API Documentation
*/
default ModifyCacheParameterGroupResponse modifyCacheParameterGroup(
Consumer modifyCacheParameterGroupRequest)
throws CacheParameterGroupNotFoundException, InvalidCacheParameterGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException,
AwsServiceException, SdkClientException, ElastiCacheException {
return modifyCacheParameterGroup(ModifyCacheParameterGroupRequest.builder()
.applyMutation(modifyCacheParameterGroupRequest).build());
}
/**
*
* Modifies an existing cache subnet group.
*
*
* @param modifyCacheSubnetGroupRequest
* Represents the input of a ModifyCacheSubnetGroup operation.
* @return Result of the ModifyCacheSubnetGroup operation returned by the service.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws CacheSubnetQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet
* group.
* @throws SubnetInUseException
* The requested subnet is being used by another cache subnet group.
* @throws InvalidSubnetException
* An invalid subnet identifier was specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyCacheSubnetGroup
* @see AWS API Documentation
*/
default ModifyCacheSubnetGroupResponse modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException,
InvalidSubnetException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Modifies an existing cache subnet group.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyCacheSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link ModifyCacheSubnetGroupRequest#builder()}
*
*
* @param modifyCacheSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyCacheSubnetGroupMessage.Builder} to create a
* request. Represents the input of a ModifyCacheSubnetGroup operation.
* @return Result of the ModifyCacheSubnetGroup operation returned by the service.
* @throws CacheSubnetGroupNotFoundException
* The requested cache subnet group name does not refer to an existing cache subnet group.
* @throws CacheSubnetQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet
* group.
* @throws SubnetInUseException
* The requested subnet is being used by another cache subnet group.
* @throws InvalidSubnetException
* An invalid subnet identifier was specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyCacheSubnetGroup
* @see AWS API Documentation
*/
default ModifyCacheSubnetGroupResponse modifyCacheSubnetGroup(
Consumer modifyCacheSubnetGroupRequest)
throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException,
InvalidSubnetException, AwsServiceException, SdkClientException, ElastiCacheException {
return modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest.builder().applyMutation(modifyCacheSubnetGroupRequest)
.build());
}
/**
*
* Modifies the settings for a Global Datastore.
*
*
* @param modifyGlobalReplicationGroupRequest
* @return Result of the ModifyGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyGlobalReplicationGroup
* @see AWS API Documentation
*/
default ModifyGlobalReplicationGroupResponse modifyGlobalReplicationGroup(
ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Modifies the settings for a Global Datastore.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyGlobalReplicationGroupRequest.Builder}
* avoiding the need to create one manually via {@link ModifyGlobalReplicationGroupRequest#builder()}
*
*
* @param modifyGlobalReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyGlobalReplicationGroupMessage.Builder} to create
* a request.
* @return Result of the ModifyGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyGlobalReplicationGroup
* @see AWS API Documentation
*/
default ModifyGlobalReplicationGroupResponse modifyGlobalReplicationGroup(
Consumer modifyGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
return modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest.builder()
.applyMutation(modifyGlobalReplicationGroupRequest).build());
}
/**
*
* Modifies the settings for a replication group.
*
*
* -
*
*
* Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
*
*
* -
*
* ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
*
*
*
*
*
* This operation is valid for Redis only.
*
*
*
* @param modifyReplicationGroupRequest
* Represents the input of a ModifyReplicationGroups operation.
* @return Result of the ModifyReplicationGroup operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws NodeQuotaForClusterExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes in a single
* cluster.
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InvalidKmsKeyException
* The KMS key supplied is not valid.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyReplicationGroup
* @see AWS API Documentation
*/
default ModifyReplicationGroupResponse modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException,
InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException,
NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException,
CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidKmsKeyException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Modifies the settings for a replication group.
*
*
* -
*
*
* Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
*
*
* -
*
* ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
*
*
*
*
*
* This operation is valid for Redis only.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyReplicationGroupRequest.Builder} avoiding the
* need to create one manually via {@link ModifyReplicationGroupRequest#builder()}
*
*
* @param modifyReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyReplicationGroupMessage.Builder} to create a
* request. Represents the input of a ModifyReplicationGroups operation.
* @return Result of the ModifyReplicationGroup operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws NodeQuotaForClusterExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes in a single
* cluster.
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InvalidKmsKeyException
* The KMS key supplied is not valid.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyReplicationGroup
* @see AWS API Documentation
*/
default ModifyReplicationGroupResponse modifyReplicationGroup(
Consumer modifyReplicationGroupRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException,
InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException,
NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException,
CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidKmsKeyException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return modifyReplicationGroup(ModifyReplicationGroupRequest.builder().applyMutation(modifyReplicationGroupRequest)
.build());
}
/**
*
* Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance
* the keyspaces among exisiting shards.
*
*
* @param modifyReplicationGroupShardConfigurationRequest
* Represents the input for a ModifyReplicationGroupShardConfiguration operation.
* @return Result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws NodeGroupsPerReplicationGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum allowed number of node groups
* (shards) in a single replication group. The default maximum is 90
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws InvalidKmsKeyException
* The KMS key supplied is not valid.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyReplicationGroupShardConfiguration
* @see AWS API Documentation
*/
default ModifyReplicationGroupShardConfigurationResponse modifyReplicationGroupShardConfiguration(
ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException,
InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException,
NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, InvalidKmsKeyException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance
* the keyspaces among exisiting shards.
*
*
*
* This is a convenience which creates an instance of the
* {@link ModifyReplicationGroupShardConfigurationRequest.Builder} avoiding the need to create one manually via
* {@link ModifyReplicationGroupShardConfigurationRequest#builder()}
*
*
* @param modifyReplicationGroupShardConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link ModifyReplicationGroupShardConfigurationMessage.Builder} to create a request. Represents the input
* for a ModifyReplicationGroupShardConfiguration operation.
* @return Result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidVpcNetworkStateException
* The VPC network is in an invalid state.
* @throws InsufficientCacheClusterCapacityException
* The requested cache node type is not available in the specified Availability Zone. For more information,
* see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* @throws NodeGroupsPerReplicationGroupQuotaExceededException
* The request cannot be processed because it would exceed the maximum allowed number of node groups
* (shards) in a single replication group. The default maximum is 90
* @throws NodeQuotaForCustomerExceededException
* The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
* @throws InvalidKmsKeyException
* The KMS key supplied is not valid.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ModifyReplicationGroupShardConfiguration
* @see AWS API Documentation
*/
default ModifyReplicationGroupShardConfigurationResponse modifyReplicationGroupShardConfiguration(
Consumer modifyReplicationGroupShardConfigurationRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException,
InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException,
NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, InvalidKmsKeyException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest.builder()
.applyMutation(modifyReplicationGroupShardConfigurationRequest).build());
}
/**
*
* Allows you to purchase a reserved cache node offering.
*
*
* @param purchaseReservedCacheNodesOfferingRequest
* Represents the input of a PurchaseReservedCacheNodesOffering operation.
* @return Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
* @throws ReservedCacheNodesOfferingNotFoundException
* The requested cache node offering does not exist.
* @throws ReservedCacheNodeAlreadyExistsException
* You already have a reservation with the given identifier.
* @throws ReservedCacheNodeQuotaExceededException
* The request cannot be processed because it would exceed the user's cache node quota.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.PurchaseReservedCacheNodesOffering
* @see AWS API Documentation
*/
default PurchaseReservedCacheNodesOfferingResponse purchaseReservedCacheNodesOffering(
PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException,
ReservedCacheNodeQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Allows you to purchase a reserved cache node offering.
*
*
*
* This is a convenience which creates an instance of the {@link PurchaseReservedCacheNodesOfferingRequest.Builder}
* avoiding the need to create one manually via {@link PurchaseReservedCacheNodesOfferingRequest#builder()}
*
*
* @param purchaseReservedCacheNodesOfferingRequest
* A {@link Consumer} that will call methods on {@link PurchaseReservedCacheNodesOfferingMessage.Builder} to
* create a request. Represents the input of a PurchaseReservedCacheNodesOffering operation.
* @return Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
* @throws ReservedCacheNodesOfferingNotFoundException
* The requested cache node offering does not exist.
* @throws ReservedCacheNodeAlreadyExistsException
* You already have a reservation with the given identifier.
* @throws ReservedCacheNodeQuotaExceededException
* The request cannot be processed because it would exceed the user's cache node quota.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.PurchaseReservedCacheNodesOffering
* @see AWS API Documentation
*/
default PurchaseReservedCacheNodesOfferingResponse purchaseReservedCacheNodesOffering(
Consumer purchaseReservedCacheNodesOfferingRequest)
throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException,
ReservedCacheNodeQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException,
AwsServiceException, SdkClientException, ElastiCacheException {
return purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest.builder()
.applyMutation(purchaseReservedCacheNodesOfferingRequest).build());
}
/**
*
* Redistribute slots to ensure uniform distribution across existing shards in the cluster.
*
*
* @param rebalanceSlotsInGlobalReplicationGroupRequest
* @return Result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.RebalanceSlotsInGlobalReplicationGroup
* @see AWS API Documentation
*/
default RebalanceSlotsInGlobalReplicationGroupResponse rebalanceSlotsInGlobalReplicationGroup(
RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Redistribute slots to ensure uniform distribution across existing shards in the cluster.
*
*
*
* This is a convenience which creates an instance of the
* {@link RebalanceSlotsInGlobalReplicationGroupRequest.Builder} avoiding the need to create one manually via
* {@link RebalanceSlotsInGlobalReplicationGroupRequest#builder()}
*
*
* @param rebalanceSlotsInGlobalReplicationGroupRequest
* A {@link Consumer} that will call methods on {@link RebalanceSlotsInGlobalReplicationGroupMessage.Builder}
* to create a request.
* @return Result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
* @throws GlobalReplicationGroupNotFoundException
* The Global Datastore does not exist
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.RebalanceSlotsInGlobalReplicationGroup
* @see AWS API Documentation
*/
default RebalanceSlotsInGlobalReplicationGroupResponse rebalanceSlotsInGlobalReplicationGroup(
Consumer rebalanceSlotsInGlobalReplicationGroupRequest)
throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException,
InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException {
return rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest.builder()
.applyMutation(rebalanceSlotsInGlobalReplicationGroupRequest).build());
}
/**
*
* Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache
* parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary
* outage to the cluster. During the reboot, the 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 cluster event is created.
*
*
* Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is
* not supported on Redis (cluster mode enabled) clusters.
*
*
* If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to
* be applied, see Rebooting a Cluster
* for an alternate process.
*
*
* @param rebootCacheClusterRequest
* Represents the input of a RebootCacheCluster operation.
* @return Result of the RebootCacheCluster operation returned by the service.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.RebootCacheCluster
* @see AWS
* API Documentation
*/
default RebootCacheClusterResponse rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
throws InvalidCacheClusterStateException, CacheClusterNotFoundException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache
* parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary
* outage to the cluster. During the reboot, the 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 cluster event is created.
*
*
* Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is
* not supported on Redis (cluster mode enabled) clusters.
*
*
* If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to
* be applied, see Rebooting a Cluster
* for an alternate process.
*
*
*
* This is a convenience which creates an instance of the {@link RebootCacheClusterRequest.Builder} avoiding the
* need to create one manually via {@link RebootCacheClusterRequest#builder()}
*
*
* @param rebootCacheClusterRequest
* A {@link Consumer} that will call methods on {@link RebootCacheClusterMessage.Builder} to create a
* request. Represents the input of a RebootCacheCluster operation.
* @return Result of the RebootCacheCluster operation returned by the service.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.RebootCacheCluster
* @see AWS
* API Documentation
*/
default RebootCacheClusterResponse rebootCacheCluster(Consumer rebootCacheClusterRequest)
throws InvalidCacheClusterStateException, CacheClusterNotFoundException, AwsServiceException, SdkClientException,
ElastiCacheException {
return rebootCacheCluster(RebootCacheClusterRequest.builder().applyMutation(rebootCacheClusterRequest).build());
}
/**
*
* Removes the tags identified by the TagKeys list from the named resource.
*
*
* @param removeTagsFromResourceRequest
* Represents the input of a RemoveTagsFromResource operation.
* @return Result of the RemoveTagsFromResource operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidArnException
* The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* @throws TagNotFoundException
* The requested tag was not found on this resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.RemoveTagsFromResource
* @see AWS API Documentation
*/
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidArnException, TagNotFoundException,
AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Removes the tags identified by the TagKeys list from the named resource.
*
*
*
* This is a convenience which creates an instance of the {@link RemoveTagsFromResourceRequest.Builder} avoiding the
* need to create one manually via {@link RemoveTagsFromResourceRequest#builder()}
*
*
* @param removeTagsFromResourceRequest
* A {@link Consumer} that will call methods on {@link RemoveTagsFromResourceMessage.Builder} to create a
* request. Represents the input of a RemoveTagsFromResource operation.
* @return Result of the RemoveTagsFromResource operation returned by the service.
* @throws CacheClusterNotFoundException
* The requested cluster ID does not refer to an existing cluster.
* @throws SnapshotNotFoundException
* The requested snapshot name does not refer to an existing snapshot.
* @throws InvalidArnException
* The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* @throws TagNotFoundException
* The requested tag was not found on this resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.RemoveTagsFromResource
* @see AWS API Documentation
*/
default RemoveTagsFromResourceResponse removeTagsFromResource(
Consumer removeTagsFromResourceRequest) throws CacheClusterNotFoundException,
SnapshotNotFoundException, InvalidArnException, TagNotFoundException, AwsServiceException, SdkClientException,
ElastiCacheException {
return removeTagsFromResource(RemoveTagsFromResourceRequest.builder().applyMutation(removeTagsFromResourceRequest)
.build());
}
/**
*
* 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.
*
*
* @param resetCacheParameterGroupRequest
* Represents the input of a ResetCacheParameterGroup operation.
* @return Result of the ResetCacheParameterGroup operation returned by the service.
* @throws InvalidCacheParameterGroupStateException
* The current state of the cache parameter group does not allow the requested operation to occur.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ResetCacheParameterGroup
* @see AWS API Documentation
*/
default ResetCacheParameterGroupResponse resetCacheParameterGroup(
ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException,
CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException,
InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ResetCacheParameterGroupRequest.Builder} avoiding
* the need to create one manually via {@link ResetCacheParameterGroupRequest#builder()}
*
*
* @param resetCacheParameterGroupRequest
* A {@link Consumer} that will call methods on {@link ResetCacheParameterGroupMessage.Builder} to create a
* request. Represents the input of a ResetCacheParameterGroup operation.
* @return Result of the ResetCacheParameterGroup operation returned by the service.
* @throws InvalidCacheParameterGroupStateException
* The current state of the cache parameter group does not allow the requested operation to occur.
* @throws CacheParameterGroupNotFoundException
* The requested cache parameter group name does not refer to an existing cache parameter group.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws InvalidGlobalReplicationGroupStateException
* The Global Datastore is not available or in primary-only state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.ResetCacheParameterGroup
* @see AWS API Documentation
*/
default ResetCacheParameterGroupResponse resetCacheParameterGroup(
Consumer resetCacheParameterGroupRequest)
throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException,
InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException,
AwsServiceException, SdkClientException, ElastiCacheException {
return resetCacheParameterGroup(ResetCacheParameterGroupRequest.builder().applyMutation(resetCacheParameterGroupRequest)
.build());
}
/**
*
* Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security
* group that had been previously authorized.
*
*
* @param revokeCacheSecurityGroupIngressRequest
* Represents the input of a RevokeCacheSecurityGroupIngress operation.
* @return Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws AuthorizationNotFoundException
* The specified Amazon EC2 security group is not authorized for the specified cache security group.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.RevokeCacheSecurityGroupIngress
* @see AWS API Documentation
*/
default RevokeCacheSecurityGroupIngressResponse revokeCacheSecurityGroupIngress(
RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
throws CacheSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidCacheSecurityGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security
* group that had been previously authorized.
*
*
*
* This is a convenience which creates an instance of the {@link RevokeCacheSecurityGroupIngressRequest.Builder}
* avoiding the need to create one manually via {@link RevokeCacheSecurityGroupIngressRequest#builder()}
*
*
* @param revokeCacheSecurityGroupIngressRequest
* A {@link Consumer} that will call methods on {@link RevokeCacheSecurityGroupIngressMessage.Builder} to
* create a request. Represents the input of a RevokeCacheSecurityGroupIngress operation.
* @return Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
* @throws CacheSecurityGroupNotFoundException
* The requested cache security group name does not refer to an existing cache security group.
* @throws AuthorizationNotFoundException
* The specified Amazon EC2 security group is not authorized for the specified cache security group.
* @throws InvalidCacheSecurityGroupStateException
* The current state of the cache security group does not allow deletion.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.RevokeCacheSecurityGroupIngress
* @see AWS API Documentation
*/
default RevokeCacheSecurityGroupIngressResponse revokeCacheSecurityGroupIngress(
Consumer revokeCacheSecurityGroupIngressRequest)
throws CacheSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidCacheSecurityGroupStateException,
InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException,
ElastiCacheException {
return revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest.builder()
.applyMutation(revokeCacheSecurityGroupIngressRequest).build());
}
/**
*
* Start the migration of data.
*
*
* @param startMigrationRequest
* @return Result of the StartMigration operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws ReplicationGroupAlreadyUnderMigrationException
* The targeted replication group is not available.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.StartMigration
* @see AWS API
* Documentation
*/
default StartMigrationResponse startMigration(StartMigrationRequest startMigrationRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException,
ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException,
SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Start the migration of data.
*
*
*
* This is a convenience which creates an instance of the {@link StartMigrationRequest.Builder} avoiding the need to
* create one manually via {@link StartMigrationRequest#builder()}
*
*
* @param startMigrationRequest
* A {@link Consumer} that will call methods on {@link StartMigrationMessage.Builder} to create a request.
* @return Result of the StartMigration operation returned by the service.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws ReplicationGroupAlreadyUnderMigrationException
* The targeted replication group is not available.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.StartMigration
* @see AWS API
* Documentation
*/
default StartMigrationResponse startMigration(Consumer startMigrationRequest)
throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException,
ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException,
SdkClientException, ElastiCacheException {
return startMigration(StartMigrationRequest.builder().applyMutation(startMigrationRequest).build());
}
/**
*
* Represents the input of a TestFailover operation which test automatic failover on a specified node
* group (called shard in the console) in a replication group (called cluster in the console).
*
*
* Note the following
*
*
* -
*
* A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the
* ElastiCache API and AWS CLI) in any rolling 24-hour period.
*
*
* -
*
* If calling this operation on shards in different clusters (called replication groups in the API and CLI), the
* calls can be made concurrently.
*
*
*
* -
*
* If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication
* group, the first node replacement must complete before a subsequent call can be made.
*
*
* -
*
* To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,
* the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in
* order of occurrance:
*
*
* -
*
* Replication group message: Test Failover API called for node group <node-group-id>
*
*
* -
*
* Cache cluster message:
* Failover from master node <primary-node-id> to replica node <node-id> completed
*
*
* -
*
* Replication group message:
* Failover from master node <primary-node-id> to replica node <node-id> completed
*
*
* -
*
* Cache cluster message: Recovering cache nodes <node-id>
*
*
* -
*
* Cache cluster message: Finished recovery for cache nodes <node-id>
*
*
*
*
* For more information see:
*
*
* -
*
* Viewing ElastiCache
* Events in the ElastiCache User Guide
*
*
* -
*
* DescribeEvents
* in the ElastiCache API Reference
*
*
*
*
*
*
* Also see, Testing
* Multi-AZ in the ElastiCache User Guide.
*
*
* @param testFailoverRequest
* @return Result of the TestFailover operation returned by the service.
* @throws ApiCallRateForCustomerExceededException
* The customer has exceeded the allowed rate of API calls.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws NodeGroupNotFoundException
* The node group specified by the NodeGroupId parameter could not be found. Please verify that
* the node group exists and that you spelled the NodeGroupId value correctly.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws TestFailoverNotAvailableException
* The TestFailover action is not available.
* @throws InvalidKmsKeyException
* The KMS key supplied is not valid.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.TestFailover
* @see AWS API
* Documentation
*/
default TestFailoverResponse testFailover(TestFailoverRequest testFailoverRequest)
throws ApiCallRateForCustomerExceededException, InvalidCacheClusterStateException,
InvalidReplicationGroupStateException, NodeGroupNotFoundException, ReplicationGroupNotFoundException,
TestFailoverNotAvailableException, InvalidKmsKeyException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
throw new UnsupportedOperationException();
}
/**
*
* Represents the input of a TestFailover operation which test automatic failover on a specified node
* group (called shard in the console) in a replication group (called cluster in the console).
*
*
* Note the following
*
*
* -
*
* A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the
* ElastiCache API and AWS CLI) in any rolling 24-hour period.
*
*
* -
*
* If calling this operation on shards in different clusters (called replication groups in the API and CLI), the
* calls can be made concurrently.
*
*
*
* -
*
* If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication
* group, the first node replacement must complete before a subsequent call can be made.
*
*
* -
*
* To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,
* the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in
* order of occurrance:
*
*
* -
*
* Replication group message: Test Failover API called for node group <node-group-id>
*
*
* -
*
* Cache cluster message:
* Failover from master node <primary-node-id> to replica node <node-id> completed
*
*
* -
*
* Replication group message:
* Failover from master node <primary-node-id> to replica node <node-id> completed
*
*
* -
*
* Cache cluster message: Recovering cache nodes <node-id>
*
*
* -
*
* Cache cluster message: Finished recovery for cache nodes <node-id>
*
*
*
*
* For more information see:
*
*
* -
*
* Viewing ElastiCache
* Events in the ElastiCache User Guide
*
*
* -
*
* DescribeEvents
* in the ElastiCache API Reference
*
*
*
*
*
*
* Also see, Testing
* Multi-AZ in the ElastiCache User Guide.
*
*
*
* This is a convenience which creates an instance of the {@link TestFailoverRequest.Builder} avoiding the need to
* create one manually via {@link TestFailoverRequest#builder()}
*
*
* @param testFailoverRequest
* A {@link Consumer} that will call methods on {@link TestFailoverMessage.Builder} to create a request.
* @return Result of the TestFailover operation returned by the service.
* @throws ApiCallRateForCustomerExceededException
* The customer has exceeded the allowed rate of API calls.
* @throws InvalidCacheClusterStateException
* The requested cluster is not in the available state.
* @throws InvalidReplicationGroupStateException
* The requested replication group is not in the available state.
* @throws NodeGroupNotFoundException
* The node group specified by the NodeGroupId parameter could not be found. Please verify that
* the node group exists and that you spelled the NodeGroupId value correctly.
* @throws ReplicationGroupNotFoundException
* The specified replication group does not exist.
* @throws TestFailoverNotAvailableException
* The TestFailover action is not available.
* @throws InvalidKmsKeyException
* The KMS key supplied is not valid.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws ElastiCacheException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample ElastiCacheClient.TestFailover
* @see AWS API
* Documentation
*/
default TestFailoverResponse testFailover(Consumer testFailoverRequest)
throws ApiCallRateForCustomerExceededException, InvalidCacheClusterStateException,
InvalidReplicationGroupStateException, NodeGroupNotFoundException, ReplicationGroupNotFoundException,
TestFailoverNotAvailableException, InvalidKmsKeyException, InvalidParameterValueException,
InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException {
return testFailover(TestFailoverRequest.builder().applyMutation(testFailoverRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of("elasticache");
}
}