Package software.amazon.awssdk.services.elasticache.model

Class DescribeReservedCacheNodesRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeReservedCacheNodesRequest.Builder,DescribeReservedCacheNodesRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeReservedCacheNodesRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeReservedCacheNodesRequest.Builder,DescribeReservedCacheNodesRequest>

Represents the input of a DescribeReservedCacheNodes operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeReservedCacheNodesRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeReservedCacheNodesRequest.Builder	builder()
String	cacheNodeType()	The cache node type filter value.
String	duration()	The duration filter value, specified in years or seconds.
boolean	equals(Object obj)
int	hashCode()
String	marker()	An optional marker returned from a prior request.
Integer	maxRecords()	The maximum number of records to include in the response.
String	offeringType()	The offering type filter value.
String	productDescription()	The product description filter value.
String	reservedCacheNodeId()	The reserved cache node identifier filter value.
String	reservedCacheNodesOfferingId()	The offering identifier filter value.
static Class<? extends DescribeReservedCacheNodesRequest.Builder>	serializableBuilderClass()
DescribeReservedCacheNodesRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

reservedCacheNodeId

public String reservedCacheNodeId()

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Returns:

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

reservedCacheNodesOfferingId

public String reservedCacheNodesOfferingId()

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Returns:

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

cacheNodeType

public String cacheNodeType()

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

Valid node types are as follows:

• General purpose:

  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized: cache.c1.xlarge

• Memory optimized:

  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

• Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

• Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Returns:

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

Valid node types are as follows:

• General purpose:

  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized: cache.c1.xlarge

• Memory optimized:

  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

• Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

• Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

duration

public String 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

Returns:

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

productDescription

public String productDescription()

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Returns:

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

offeringType

public String 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"

Returns:

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"

maxRecords

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

Returns:

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.

marker

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

Returns:

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.

toBuilder

public DescribeReservedCacheNodesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeReservedCacheNodesRequest.Builder,DescribeReservedCacheNodesRequest>

Returns:

a builder for type T

builder

public static DescribeReservedCacheNodesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeReservedCacheNodesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object