software.amazon.awssdk.services.elasticache.model

Interface ReservedCacheNode.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ReservedCacheNode.Builder,ReservedCacheNode>, SdkBuilder<ReservedCacheNode.Builder,ReservedCacheNode>, SdkPojo

Enclosing class:

ReservedCacheNode

public static interface ReservedCacheNode.Builder
extends SdkPojo, CopyableBuilder<ReservedCacheNode.Builder,ReservedCacheNode>

Method Summary

Modifier and Type	Method and Description
ReservedCacheNode.Builder	cacheNodeCount(Integer cacheNodeCount) The number of cache nodes that have been reserved.
ReservedCacheNode.Builder	cacheNodeType(String cacheNodeType) The cache node type for the reserved cache nodes.
ReservedCacheNode.Builder	duration(Integer duration) The duration of the reservation in seconds.
ReservedCacheNode.Builder	fixedPrice(Double fixedPrice) The fixed price charged for this reserved cache node.
ReservedCacheNode.Builder	offeringType(String offeringType) The offering type of this reserved cache node.
ReservedCacheNode.Builder	productDescription(String productDescription) The description of the reserved cache node.
ReservedCacheNode.Builder	recurringCharges(Collection<RecurringCharge> recurringCharges) The recurring price charged to run this reserved cache node.
ReservedCacheNode.Builder	recurringCharges(Consumer<RecurringCharge.Builder>... recurringCharges) The recurring price charged to run this reserved cache node.
ReservedCacheNode.Builder	recurringCharges(RecurringCharge... recurringCharges) The recurring price charged to run this reserved cache node.
ReservedCacheNode.Builder	reservationARN(String reservationARN) The Amazon Resource Name (ARN) of the reserved cache node.
ReservedCacheNode.Builder	reservedCacheNodeId(String reservedCacheNodeId) The unique identifier for the reservation.
ReservedCacheNode.Builder	reservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) The offering identifier.
ReservedCacheNode.Builder	startTime(Instant startTime) The time the reservation started.
ReservedCacheNode.Builder	state(String state) The state of the reserved cache node.
ReservedCacheNode.Builder	usagePrice(Double usagePrice) The hourly price charged for this reserved cache node.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

reservedCacheNodeId

ReservedCacheNode.Builder reservedCacheNodeId(String reservedCacheNodeId)

The unique identifier for the reservation.

Parameters:

reservedCacheNodeId - The unique identifier for the reservation.

Returns:

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

reservedCacheNodesOfferingId

ReservedCacheNode.Builder reservedCacheNodesOfferingId(String reservedCacheNodesOfferingId)

The offering identifier.

Parameters:

reservedCacheNodesOfferingId - The offering identifier.

Returns:

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

cacheNodeType

ReservedCacheNode.Builder cacheNodeType(String cacheNodeType)

The cache node type for the reserved cache nodes.

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:

    M6g node types (available only for Redis 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

    For region availability, see Supported Node Types

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

    R6g node types (available only for Redis 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

    For region availability, see Supported Node Types

    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 append-only files (AOF) are not supported for T1 or T2 instances.

• Redis Multi-AZ with automatic failover is not supported on T1 instances.

• Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Parameters:

cacheNodeType - The cache node type for the reserved cache nodes.

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:

    M6g node types (available only for Redis 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

    For region availability, see Supported Node Types

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

    R6g node types (available only for Redis 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

    For region availability, see Supported Node Types

    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 append-only files (AOF) are not supported for T1 or T2 instances.

• Redis Multi-AZ with automatic failover is not supported on T1 instances.

• Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Returns:

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

startTime

ReservedCacheNode.Builder startTime(Instant startTime)

The time the reservation started.

Parameters:

startTime - The time the reservation started.

Returns:

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

duration

ReservedCacheNode.Builder duration(Integer duration)

The duration of the reservation in seconds.

Parameters:

duration - The duration of the reservation in seconds.

Returns:

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

fixedPrice

ReservedCacheNode.Builder fixedPrice(Double fixedPrice)

The fixed price charged for this reserved cache node.

Parameters:

fixedPrice - The fixed price charged for this reserved cache node.

Returns:

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

usagePrice

ReservedCacheNode.Builder usagePrice(Double usagePrice)

The hourly price charged for this reserved cache node.

Parameters:

usagePrice - The hourly price charged for this reserved cache node.

Returns:

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

cacheNodeCount

ReservedCacheNode.Builder cacheNodeCount(Integer cacheNodeCount)

The number of cache nodes that have been reserved.

Parameters:

cacheNodeCount - The number of cache nodes that have been reserved.

Returns:

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

productDescription

ReservedCacheNode.Builder productDescription(String productDescription)

The description of the reserved cache node.

Parameters:

productDescription - The description of the reserved cache node.

Returns:

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

offeringType

ReservedCacheNode.Builder offeringType(String offeringType)

The offering type of this reserved cache node.

Parameters:

offeringType - The offering type of this reserved cache node.

Returns:

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

state

ReservedCacheNode.Builder state(String state)

The state of the reserved cache node.

Parameters:

state - The state of the reserved cache node.

Returns:

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

recurringCharges

ReservedCacheNode.Builder recurringCharges(Collection<RecurringCharge> recurringCharges)

The recurring price charged to run this reserved cache node.

Parameters:

recurringCharges - The recurring price charged to run this reserved cache node.

Returns:

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

recurringCharges

ReservedCacheNode.Builder recurringCharges(RecurringCharge... recurringCharges)

The recurring price charged to run this reserved cache node.

Parameters:

recurringCharges - The recurring price charged to run this reserved cache node.

Returns:

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

recurringCharges

ReservedCacheNode.Builder recurringCharges(Consumer<RecurringCharge.Builder>... recurringCharges)

The recurring price charged to run this reserved cache node.

This is a convenience method that creates an instance of the RecurringCharge.Builder avoiding the need to create one manually via RecurringCharge.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #recurringCharges(List).

Parameters:

recurringCharges - a consumer that will call methods on RecurringCharge.Builder

Returns:

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

See Also:

#recurringCharges(java.util.Collection)

reservationARN

ReservedCacheNode.Builder reservationARN(String reservationARN)

The Amazon Resource Name (ARN) of the reserved cache node.

Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582

Parameters:

reservationARN - The Amazon Resource Name (ARN) of the reserved cache node.

Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582

Returns:

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