com.amazonaws.services.elasticache.model

Class DescribeReservedCacheNodesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeReservedCacheNodesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a DescribeReservedCacheNodes operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeReservedCacheNodesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeReservedCacheNodesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCacheNodeType() The cache node type filter value.
String	getDuration() The duration filter value, specified in years or seconds.
String	getMarker() An optional marker returned from a prior request.
Integer	getMaxRecords() The maximum number of records to include in the response.
String	getOfferingType() The offering type filter value.
String	getProductDescription() The product description filter value.
String	getReservedCacheNodeId() The reserved cache node identifier filter value.
String	getReservedCacheNodesOfferingId() The offering identifier filter value.
int	hashCode()
void	setCacheNodeType(String cacheNodeType) The cache node type filter value.
void	setDuration(String duration) The duration filter value, specified in years or seconds.
void	setMarker(String marker) An optional marker returned from a prior request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setOfferingType(String offeringType) The offering type filter value.
void	setProductDescription(String productDescription) The product description filter value.
void	setReservedCacheNodeId(String reservedCacheNodeId) The reserved cache node identifier filter value.
void	setReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) The offering identifier filter value.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeReservedCacheNodesRequest	withCacheNodeType(String cacheNodeType) The cache node type filter value.
DescribeReservedCacheNodesRequest	withDuration(String duration) The duration filter value, specified in years or seconds.
DescribeReservedCacheNodesRequest	withMarker(String marker) An optional marker returned from a prior request.
DescribeReservedCacheNodesRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeReservedCacheNodesRequest	withOfferingType(String offeringType) The offering type filter value.
DescribeReservedCacheNodesRequest	withProductDescription(String productDescription) The product description filter value.
DescribeReservedCacheNodesRequest	withReservedCacheNodeId(String reservedCacheNodeId) The reserved cache node identifier filter value.
DescribeReservedCacheNodesRequest	withReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) The offering identifier filter value.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeReservedCacheNodesRequest

public DescribeReservedCacheNodesRequest()

Method Detail

setReservedCacheNodeId

public void setReservedCacheNodeId(String reservedCacheNodeId)

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

Parameters:

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

getReservedCacheNodeId

public String getReservedCacheNodeId()

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.

withReservedCacheNodeId

public DescribeReservedCacheNodesRequest withReservedCacheNodeId(String reservedCacheNodeId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setReservedCacheNodesOfferingId

public void setReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)

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

Parameters:

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

getReservedCacheNodesOfferingId

public String getReservedCacheNodesOfferingId()

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.

withReservedCacheNodesOfferingId

public DescribeReservedCacheNodesRequest withReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setCacheNodeType

public void setCacheNodeType(String 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:

    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: (not recommended)

    T1 node types: cache.t1.micro

    M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized:

  • Previous generation: (not recommended)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: (not recommended)

    M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

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

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

• Redis (cluster mode enabled): Backup/restore is not supported on T1 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.

Parameters:

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:

    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: (not recommended)

    T1 node types: cache.t1.micro

    M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized:

  • Previous generation: (not recommended)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: (not recommended)

    M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

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

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

• Redis (cluster mode enabled): Backup/restore is not supported on T1 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.

getCacheNodeType

public String getCacheNodeType()

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:

    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: (not recommended)

    T1 node types: cache.t1.micro

    M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized:

  • Previous generation: (not recommended)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: (not recommended)

    M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

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

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

• Redis (cluster mode enabled): Backup/restore is not supported on T1 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.

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:

    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: (not recommended)

    T1 node types: cache.t1.micro

    M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized:

  • Previous generation: (not recommended)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: (not recommended)

    M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

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

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

• Redis (cluster mode enabled): Backup/restore is not supported on T1 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.

withCacheNodeType

public DescribeReservedCacheNodesRequest withCacheNodeType(String 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:

    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: (not recommended)

    T1 node types: cache.t1.micro

    M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized:

  • Previous generation: (not recommended)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: (not recommended)

    M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

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

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

• Redis (cluster mode enabled): Backup/restore is not supported on T1 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.

Parameters:

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:

    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: (not recommended)

    T1 node types: cache.t1.micro

    M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized:

  • Previous generation: (not recommended)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

  • Previous generation: (not recommended)

    M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

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

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

• Redis (cluster mode enabled): Backup/restore is not supported on T1 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:

Returns a reference to this object so that method calls can be chained together.

setDuration

public void setDuration(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

Parameters:

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

getDuration

public String getDuration()

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

withDuration

public DescribeReservedCacheNodesRequest withDuration(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setProductDescription

public void setProductDescription(String productDescription)

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

Parameters:

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

getProductDescription

public String getProductDescription()

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.

withProductDescription

public DescribeReservedCacheNodesRequest withProductDescription(String productDescription)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOfferingType

public void setOfferingType(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"

Parameters:

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"

getOfferingType

public String getOfferingType()

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"

withOfferingType

public DescribeReservedCacheNodesRequest withOfferingType(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"

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMaxRecords

public void setMaxRecords(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.

Parameters:

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.

getMaxRecords

public Integer getMaxRecords()

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.

withMaxRecords

public DescribeReservedCacheNodesRequest withMaxRecords(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMarker

public void setMarker(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.

Parameters:

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.

getMarker

public String getMarker()

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.

withMarker

public DescribeReservedCacheNodesRequest withMarker(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeReservedCacheNodesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()