com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.elasticache.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input of a DescribeReservedCacheNodes operation.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeReservedCacheNodesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the
* specified reservation ID.
*
*/
private String reservedCacheNodeId;
/**
*
* The offering identifier filter value. Use this parameter to show only purchased reservations matching the
* specified offering identifier.
*
*/
private String reservedCacheNodesOfferingId;
/**
*
* The cache node type filter value. Use this parameter to show only those reservations matching the specified cache
* node type.
*
*
* The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
* more memory and computational power at lower cost when compared to their equivalent previous generation
* counterparts.
*
*
* -
*
* General purpose:
*
*
* -
*
* Current generation:
*
*
* M7g node types: cache.m7g.large, cache.m7g.xlarge,
* cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
* cache.m7g.12xlarge, cache.m7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
* cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
* cache.m6g.16xlarge
*
*
* M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
* cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
*
*
* M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
* cache.m4.4xlarge, cache.m4.10xlarge
*
*
* T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version
* 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
*
*
* T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
*
*
* T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* T1 node types: cache.t1.micro
*
*
* M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
*
*
* M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge
*
*
*
*
* -
*
* Compute optimized:
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* C1 node types: cache.c1.xlarge
*
*
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation:
*
*
* R7g node types: cache.r7g.large, cache.r7g.xlarge,
* cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
* cache.r7g.12xlarge, cache.r7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
* cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
* cache.r6g.16xlarge
*
*
* R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
* cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
*
*
* R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
* cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
*
*
* R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
*
*
*
*
* Additional node type info
*
*
* -
*
* All current generation instance types are created in Amazon VPC by default.
*
*
* -
*
* Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
*
*
* -
*
* Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
*
*
* -
*
* Redis OSS configuration variables appendonly and appendfsync are not supported on Redis
* OSS version 2.8.22 and later.
*
*
*
*/
private String cacheNodeType;
/**
*
* The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this
* duration.
*
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
*/
private String duration;
/**
*
* The product description filter value. Use this parameter to show only those reservations matching the specified
* product description.
*
*/
private String productDescription;
/**
*
* The offering type filter value. Use this parameter to show only the available offerings matching the specified
* offering type.
*
*
* Valid values:
* "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
*
*/
private String offeringType;
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*
*/
private Integer maxRecords;
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
* If this parameter is specified, the response includes only records beyond the marker, up to the value specified
* by MaxRecords.
*
*/
private String marker;
/**
*
* The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the
* specified reservation ID.
*
*
* @param reservedCacheNodeId
* The reserved cache node identifier filter value. Use this parameter to show only the reservation that
* matches the specified reservation ID.
*/
public void setReservedCacheNodeId(String reservedCacheNodeId) {
this.reservedCacheNodeId = reservedCacheNodeId;
}
/**
*
* The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the
* specified reservation ID.
*
*
* @return The reserved cache node identifier filter value. Use this parameter to show only the reservation that
* matches the specified reservation ID.
*/
public String getReservedCacheNodeId() {
return this.reservedCacheNodeId;
}
/**
*
* The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the
* specified reservation ID.
*
*
* @param reservedCacheNodeId
* The reserved cache node identifier filter value. Use this parameter to show only the reservation that
* matches the specified reservation ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedCacheNodesRequest withReservedCacheNodeId(String reservedCacheNodeId) {
setReservedCacheNodeId(reservedCacheNodeId);
return this;
}
/**
*
* The offering identifier filter value. Use this parameter to show only purchased reservations matching the
* specified offering identifier.
*
*
* @param reservedCacheNodesOfferingId
* The offering identifier filter value. Use this parameter to show only purchased reservations matching the
* specified offering identifier.
*/
public void setReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) {
this.reservedCacheNodesOfferingId = reservedCacheNodesOfferingId;
}
/**
*
* The offering identifier filter value. Use this parameter to show only purchased reservations matching the
* specified offering identifier.
*
*
* @return The offering identifier filter value. Use this parameter to show only purchased reservations matching the
* specified offering identifier.
*/
public String getReservedCacheNodesOfferingId() {
return this.reservedCacheNodesOfferingId;
}
/**
*
* The offering identifier filter value. Use this parameter to show only purchased reservations matching the
* specified offering identifier.
*
*
* @param reservedCacheNodesOfferingId
* The offering identifier filter value. Use this parameter to show only purchased reservations matching the
* specified offering identifier.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedCacheNodesRequest withReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) {
setReservedCacheNodesOfferingId(reservedCacheNodesOfferingId);
return this;
}
/**
*
* The cache node type filter value. Use this parameter to show only those reservations matching the specified cache
* node type.
*
*
* The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
* more memory and computational power at lower cost when compared to their equivalent previous generation
* counterparts.
*
*
* -
*
* General purpose:
*
*
* -
*
* Current generation:
*
*
* M7g node types: cache.m7g.large, cache.m7g.xlarge,
* cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
* cache.m7g.12xlarge, cache.m7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
* cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
* cache.m6g.16xlarge
*
*
* M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
* cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
*
*
* M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
* cache.m4.4xlarge, cache.m4.10xlarge
*
*
* T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version
* 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
*
*
* T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
*
*
* T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* T1 node types: cache.t1.micro
*
*
* M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
*
*
* M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge
*
*
*
*
* -
*
* Compute optimized:
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* C1 node types: cache.c1.xlarge
*
*
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation:
*
*
* R7g node types: cache.r7g.large, cache.r7g.xlarge,
* cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
* cache.r7g.12xlarge, cache.r7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
* cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
* cache.r6g.16xlarge
*
*
* R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
* cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
*
*
* R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
* cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
*
*
* R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
*
*
*
*
* Additional node type info
*
*
* -
*
* All current generation instance types are created in Amazon VPC by default.
*
*
* -
*
* Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
*
*
* -
*
* Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
*
*
* -
*
* Redis OSS configuration variables appendonly and appendfsync are not supported on Redis
* OSS version 2.8.22 and later.
*
*
*
*
* @param cacheNodeType
* The cache node type filter value. Use this parameter to show only those reservations matching the
* specified cache node type.
*
* The following node types are supported by ElastiCache. Generally speaking, the current generation types
* provide more memory and computational power at lower cost when compared to their equivalent previous
* generation counterparts.
*
*
* -
*
* General purpose:
*
*
* -
*
* Current generation:
*
*
* M7g node types: cache.m7g.large, cache.m7g.xlarge,
* cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
* cache.m7g.12xlarge, cache.m7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine
* version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge,
* cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
* cache.m6g.12xlarge, cache.m6g.16xlarge
*
*
* M5 node types: cache.m5.large, cache.m5.xlarge,
* cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
* cache.m5.24xlarge
*
*
* M4 node types: cache.m4.large, cache.m4.xlarge,
* cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
*
*
* T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine
* version 1.5.16 onward): cache.t4g.micro, cache.t4g.small,
* cache.t4g.medium
*
*
* T3 node types: cache.t3.micro, cache.t3.small,
* cache.t3.medium
*
*
* T2 node types: cache.t2.micro, cache.t2.small,
* cache.t2.medium
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* T1 node types: cache.t1.micro
*
*
* M1 node types: cache.m1.small, cache.m1.medium,
* cache.m1.large, cache.m1.xlarge
*
*
* M3 node types: cache.m3.medium, cache.m3.large,
* cache.m3.xlarge, cache.m3.2xlarge
*
*
*
*
* -
*
* Compute optimized:
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* C1 node types: cache.c1.xlarge
*
*
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation:
*
*
* R7g node types: cache.r7g.large, cache.r7g.xlarge,
* cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
* cache.r7g.12xlarge, cache.r7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine
* version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge,
* cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge,
* cache.r6g.12xlarge, cache.r6g.16xlarge
*
*
* R5 node types: cache.r5.large, cache.r5.xlarge,
* cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
* cache.r5.24xlarge
*
*
* R4 node types: cache.r4.large, cache.r4.xlarge,
* cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge,
* cache.r4.16xlarge
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* M2 node types: cache.m2.xlarge, cache.m2.2xlarge,
* cache.m2.4xlarge
*
*
* R3 node types: cache.r3.large, cache.r3.xlarge,
* cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
*
*
*
*
*
*
* Additional node type info
*
*
* -
*
* All current generation instance types are created in Amazon VPC by default.
*
*
* -
*
* Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
*
*
* -
*
* Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
*
*
* -
*
* Redis OSS configuration variables appendonly and appendfsync are not supported
* on Redis OSS version 2.8.22 and later.
*
*
*/
public void setCacheNodeType(String cacheNodeType) {
this.cacheNodeType = cacheNodeType;
}
/**
*
* The cache node type filter value. Use this parameter to show only those reservations matching the specified cache
* node type.
*
*
* The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
* more memory and computational power at lower cost when compared to their equivalent previous generation
* counterparts.
*
*
* -
*
* General purpose:
*
*
* -
*
* Current generation:
*
*
* M7g node types: cache.m7g.large, cache.m7g.xlarge,
* cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
* cache.m7g.12xlarge, cache.m7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
* cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
* cache.m6g.16xlarge
*
*
* M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
* cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
*
*
* M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
* cache.m4.4xlarge, cache.m4.10xlarge
*
*
* T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version
* 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
*
*
* T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
*
*
* T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* T1 node types: cache.t1.micro
*
*
* M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
*
*
* M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge
*
*
*
*
* -
*
* Compute optimized:
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* C1 node types: cache.c1.xlarge
*
*
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation:
*
*
* R7g node types: cache.r7g.large, cache.r7g.xlarge,
* cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
* cache.r7g.12xlarge, cache.r7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
* cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
* cache.r6g.16xlarge
*
*
* R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
* cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
*
*
* R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
* cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
*
*
* R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
*
*
*
*
* Additional node type info
*
*
* -
*
* All current generation instance types are created in Amazon VPC by default.
*
*
* -
*
* Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
*
*
* -
*
* Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
*
*
* -
*
* Redis OSS configuration variables appendonly and appendfsync are not supported on Redis
* OSS version 2.8.22 and later.
*
*
*
*
* @return The cache node type filter value. Use this parameter to show only those reservations matching the
* specified cache node type.
*
* The following node types are supported by ElastiCache. Generally speaking, the current generation types
* provide more memory and computational power at lower cost when compared to their equivalent previous
* generation counterparts.
*
*
* -
*
* General purpose:
*
*
* -
*
* Current generation:
*
*
* M7g node types: cache.m7g.large, cache.m7g.xlarge,
* cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
* cache.m7g.12xlarge, cache.m7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine
* version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge,
* cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
* cache.m6g.12xlarge, cache.m6g.16xlarge
*
*
* M5 node types: cache.m5.large, cache.m5.xlarge,
* cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
* cache.m5.24xlarge
*
*
* M4 node types: cache.m4.large, cache.m4.xlarge,
* cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
*
*
* T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine
* version 1.5.16 onward): cache.t4g.micro, cache.t4g.small,
* cache.t4g.medium
*
*
* T3 node types: cache.t3.micro, cache.t3.small,
* cache.t3.medium
*
*
* T2 node types: cache.t2.micro, cache.t2.small,
* cache.t2.medium
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* T1 node types: cache.t1.micro
*
*
* M1 node types: cache.m1.small, cache.m1.medium,
* cache.m1.large, cache.m1.xlarge
*
*
* M3 node types: cache.m3.medium, cache.m3.large,
* cache.m3.xlarge, cache.m3.2xlarge
*
*
*
*
* -
*
* Compute optimized:
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* C1 node types: cache.c1.xlarge
*
*
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation:
*
*
* R7g node types: cache.r7g.large, cache.r7g.xlarge,
* cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
* cache.r7g.12xlarge, cache.r7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine
* version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge,
* cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge,
* cache.r6g.12xlarge, cache.r6g.16xlarge
*
*
* R5 node types: cache.r5.large, cache.r5.xlarge,
* cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
* cache.r5.24xlarge
*
*
* R4 node types: cache.r4.large, cache.r4.xlarge,
* cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge,
* cache.r4.16xlarge
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* M2 node types: cache.m2.xlarge, cache.m2.2xlarge,
* cache.m2.4xlarge
*
*
* R3 node types: cache.r3.large, cache.r3.xlarge,
* cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
*
*
*
*
*
*
* Additional node type info
*
*
* -
*
* All current generation instance types are created in Amazon VPC by default.
*
*
* -
*
* Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
*
*
* -
*
* Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
*
*
* -
*
* Redis OSS configuration variables appendonly and appendfsync are not supported
* on Redis OSS version 2.8.22 and later.
*
*
*/
public String getCacheNodeType() {
return this.cacheNodeType;
}
/**
*
* The cache node type filter value. Use this parameter to show only those reservations matching the specified cache
* node type.
*
*
* The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
* more memory and computational power at lower cost when compared to their equivalent previous generation
* counterparts.
*
*
* -
*
* General purpose:
*
*
* -
*
* Current generation:
*
*
* M7g node types: cache.m7g.large, cache.m7g.xlarge,
* cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
* cache.m7g.12xlarge, cache.m7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
* cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
* cache.m6g.16xlarge
*
*
* M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
* cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
*
*
* M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
* cache.m4.4xlarge, cache.m4.10xlarge
*
*
* T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version
* 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
*
*
* T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
*
*
* T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* T1 node types: cache.t1.micro
*
*
* M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
*
*
* M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge
*
*
*
*
* -
*
* Compute optimized:
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* C1 node types: cache.c1.xlarge
*
*
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation:
*
*
* R7g node types: cache.r7g.large, cache.r7g.xlarge,
* cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
* cache.r7g.12xlarge, cache.r7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
* cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
* cache.r6g.16xlarge
*
*
* R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
* cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
*
*
* R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
* cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
*
*
* R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
*
*
*
*
* Additional node type info
*
*
* -
*
* All current generation instance types are created in Amazon VPC by default.
*
*
* -
*
* Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
*
*
* -
*
* Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
*
*
* -
*
* Redis OSS configuration variables appendonly and appendfsync are not supported on Redis
* OSS version 2.8.22 and later.
*
*
*
*
* @param cacheNodeType
* The cache node type filter value. Use this parameter to show only those reservations matching the
* specified cache node type.
*
* The following node types are supported by ElastiCache. Generally speaking, the current generation types
* provide more memory and computational power at lower cost when compared to their equivalent previous
* generation counterparts.
*
*
* -
*
* General purpose:
*
*
* -
*
* Current generation:
*
*
* M7g node types: cache.m7g.large, cache.m7g.xlarge,
* cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
* cache.m7g.12xlarge, cache.m7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine
* version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge,
* cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
* cache.m6g.12xlarge, cache.m6g.16xlarge
*
*
* M5 node types: cache.m5.large, cache.m5.xlarge,
* cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge,
* cache.m5.24xlarge
*
*
* M4 node types: cache.m4.large, cache.m4.xlarge,
* cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
*
*
* T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine
* version 1.5.16 onward): cache.t4g.micro, cache.t4g.small,
* cache.t4g.medium
*
*
* T3 node types: cache.t3.micro, cache.t3.small,
* cache.t3.medium
*
*
* T2 node types: cache.t2.micro, cache.t2.small,
* cache.t2.medium
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* T1 node types: cache.t1.micro
*
*
* M1 node types: cache.m1.small, cache.m1.medium,
* cache.m1.large, cache.m1.xlarge
*
*
* M3 node types: cache.m3.medium, cache.m3.large,
* cache.m3.xlarge, cache.m3.2xlarge
*
*
*
*
* -
*
* Compute optimized:
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* C1 node types: cache.c1.xlarge
*
*
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation:
*
*
* R7g node types: cache.r7g.large, cache.r7g.xlarge,
* cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge,
* cache.r7g.12xlarge, cache.r7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine
* version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge,
* cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge,
* cache.r6g.12xlarge, cache.r6g.16xlarge
*
*
* R5 node types: cache.r5.large, cache.r5.xlarge,
* cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge,
* cache.r5.24xlarge
*
*
* R4 node types: cache.r4.large, cache.r4.xlarge,
* cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge,
* cache.r4.16xlarge
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters
* is not supported for these types.)
*
*
* M2 node types: cache.m2.xlarge, cache.m2.2xlarge,
* cache.m2.4xlarge
*
*
* R3 node types: cache.r3.large, cache.r3.xlarge,
* cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
*
*
*
*
*
*
* Additional node type info
*
*
* -
*
* All current generation instance types are created in Amazon VPC by default.
*
*
* -
*
* Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
*
*
* -
*
* Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
*
*
* -
*
* Redis OSS configuration variables appendonly and appendfsync are not supported
* on Redis OSS version 2.8.22 and later.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedCacheNodesRequest withCacheNodeType(String cacheNodeType) {
setCacheNodeType(cacheNodeType);
return this;
}
/**
*
* The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this
* duration.
*
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
*
* @param duration
* The duration filter value, specified in years or seconds. Use this parameter to show only reservations for
* this duration.
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*/
public void setDuration(String duration) {
this.duration = duration;
}
/**
*
* The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this
* duration.
*
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
*
* @return The duration filter value, specified in years or seconds. Use this parameter to show only reservations
* for this duration.
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*/
public String getDuration() {
return this.duration;
}
/**
*
* The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this
* duration.
*
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
*
* @param duration
* The duration filter value, specified in years or seconds. Use this parameter to show only reservations for
* this duration.
*
* Valid Values: 1 | 3 | 31536000 | 94608000
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedCacheNodesRequest withDuration(String duration) {
setDuration(duration);
return this;
}
/**
*
* The product description filter value. Use this parameter to show only those reservations matching the specified
* product description.
*
*
* @param productDescription
* The product description filter value. Use this parameter to show only those reservations matching the
* specified product description.
*/
public void setProductDescription(String productDescription) {
this.productDescription = productDescription;
}
/**
*
* The product description filter value. Use this parameter to show only those reservations matching the specified
* product description.
*
*
* @return The product description filter value. Use this parameter to show only those reservations matching the
* specified product description.
*/
public String getProductDescription() {
return this.productDescription;
}
/**
*
* The product description filter value. Use this parameter to show only those reservations matching the specified
* product description.
*
*
* @param productDescription
* The product description filter value. Use this parameter to show only those reservations matching the
* specified product description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedCacheNodesRequest withProductDescription(String productDescription) {
setProductDescription(productDescription);
return this;
}
/**
*
* The offering type filter value. Use this parameter to show only the available offerings matching the specified
* offering type.
*
*
* Valid values:
* "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
*
*
* @param offeringType
* The offering type filter value. Use this parameter to show only the available offerings matching the
* specified offering type.
*
* Valid values:
* "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
*/
public void setOfferingType(String offeringType) {
this.offeringType = offeringType;
}
/**
*
* The offering type filter value. Use this parameter to show only the available offerings matching the specified
* offering type.
*
*
* Valid values:
* "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
*
*
* @return The offering type filter value. Use this parameter to show only the available offerings matching the
* specified offering type.
*
* Valid values:
* "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
*/
public String getOfferingType() {
return this.offeringType;
}
/**
*
* The offering type filter value. Use this parameter to show only the available offerings matching the specified
* offering type.
*
*
* Valid values:
* "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
*
*
* @param offeringType
* The offering type filter value. Use this parameter to show only the available offerings matching the
* specified offering type.
*
* Valid values:
* "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedCacheNodesRequest withOfferingType(String offeringType) {
setOfferingType(offeringType);
return this;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*
*
* @return The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*/
public Integer getMaxRecords() {
return this.maxRecords;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a marker is included in the response so that the remaining results can be
* retrieved.
*
* Default: 100
*
*
* Constraints: minimum 20; maximum 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedCacheNodesRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
* If this parameter is specified, the response includes only records beyond the marker, up to the value specified
* by MaxRecords.
*
*
* @param marker
* An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. If this parameter is specified, the response includes only records beyond the marker, up to the
* value specified by MaxRecords.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
* If this parameter is specified, the response includes only records beyond the marker, up to the value specified
* by MaxRecords.
*
*
* @return An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. If this parameter is specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
public String getMarker() {
return this.marker;
}
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
* If this parameter is specified, the response includes only records beyond the marker, up to the value specified
* by MaxRecords.
*
*
* @param marker
* An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. If this parameter is specified, the response includes only records beyond the marker, up to the
* value specified by MaxRecords.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeReservedCacheNodesRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getReservedCacheNodeId() != null)
sb.append("ReservedCacheNodeId: ").append(getReservedCacheNodeId()).append(",");
if (getReservedCacheNodesOfferingId() != null)
sb.append("ReservedCacheNodesOfferingId: ").append(getReservedCacheNodesOfferingId()).append(",");
if (getCacheNodeType() != null)
sb.append("CacheNodeType: ").append(getCacheNodeType()).append(",");
if (getDuration() != null)
sb.append("Duration: ").append(getDuration()).append(",");
if (getProductDescription() != null)
sb.append("ProductDescription: ").append(getProductDescription()).append(",");
if (getOfferingType() != null)
sb.append("OfferingType: ").append(getOfferingType()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeReservedCacheNodesRequest == false)
return false;
DescribeReservedCacheNodesRequest other = (DescribeReservedCacheNodesRequest) obj;
if (other.getReservedCacheNodeId() == null ^ this.getReservedCacheNodeId() == null)
return false;
if (other.getReservedCacheNodeId() != null && other.getReservedCacheNodeId().equals(this.getReservedCacheNodeId()) == false)
return false;
if (other.getReservedCacheNodesOfferingId() == null ^ this.getReservedCacheNodesOfferingId() == null)
return false;
if (other.getReservedCacheNodesOfferingId() != null && other.getReservedCacheNodesOfferingId().equals(this.getReservedCacheNodesOfferingId()) == false)
return false;
if (other.getCacheNodeType() == null ^ this.getCacheNodeType() == null)
return false;
if (other.getCacheNodeType() != null && other.getCacheNodeType().equals(this.getCacheNodeType()) == false)
return false;
if (other.getDuration() == null ^ this.getDuration() == null)
return false;
if (other.getDuration() != null && other.getDuration().equals(this.getDuration()) == false)
return false;
if (other.getProductDescription() == null ^ this.getProductDescription() == null)
return false;
if (other.getProductDescription() != null && other.getProductDescription().equals(this.getProductDescription()) == false)
return false;
if (other.getOfferingType() == null ^ this.getOfferingType() == null)
return false;
if (other.getOfferingType() != null && other.getOfferingType().equals(this.getOfferingType()) == false)
return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null)
return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReservedCacheNodeId() == null) ? 0 : getReservedCacheNodeId().hashCode());
hashCode = prime * hashCode + ((getReservedCacheNodesOfferingId() == null) ? 0 : getReservedCacheNodesOfferingId().hashCode());
hashCode = prime * hashCode + ((getCacheNodeType() == null) ? 0 : getCacheNodeType().hashCode());
hashCode = prime * hashCode + ((getDuration() == null) ? 0 : getDuration().hashCode());
hashCode = prime * hashCode + ((getProductDescription() == null) ? 0 : getProductDescription().hashCode());
hashCode = prime * hashCode + ((getOfferingType() == null) ? 0 : getOfferingType().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public DescribeReservedCacheNodesRequest clone() {
return (DescribeReservedCacheNodesRequest) super.clone();
}
}