software.amazon.awssdk.services.elasticache.model

Interface Snapshot.Builder

All Superinterfaces:

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

Enclosing class:

Snapshot

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

Method Summary

Modifier and Type	Method and Description
Snapshot.Builder	arn(String arn) The ARN (Amazon Resource Name) of the snapshot.
Snapshot.Builder	automaticFailover(AutomaticFailoverStatus automaticFailover) Indicates the status of automatic failover for the source Redis replication group.
Snapshot.Builder	automaticFailover(String automaticFailover) Indicates the status of automatic failover for the source Redis replication group.
Snapshot.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign.
Snapshot.Builder	cacheClusterCreateTime(Instant cacheClusterCreateTime) The date and time when the source cluster was created.
Snapshot.Builder	cacheClusterId(String cacheClusterId) The user-supplied identifier of the source cluster.
Snapshot.Builder	cacheNodeType(String cacheNodeType) The name of the compute and memory capacity node type for the source cluster.
Snapshot.Builder	cacheParameterGroupName(String cacheParameterGroupName) The cache parameter group that is associated with the source cluster.
Snapshot.Builder	cacheSubnetGroupName(String cacheSubnetGroupName) The name of the cache subnet group associated with the source cluster.
Snapshot.Builder	dataTiering(DataTieringStatus dataTiering) Enables data tiering.
Snapshot.Builder	dataTiering(String dataTiering) Enables data tiering.
Snapshot.Builder	engine(String engine) The name of the cache engine (memcached or redis) used by the source cluster.
Snapshot.Builder	engineVersion(String engineVersion) The version of the cache engine version that is used by the source cluster.
Snapshot.Builder	kmsKeyId(String kmsKeyId) The ID of the KMS key used to encrypt the snapshot.
Snapshot.Builder	nodeSnapshots(Collection<NodeSnapshot> nodeSnapshots) A list of the cache nodes in the source cluster.
Snapshot.Builder	nodeSnapshots(Consumer<NodeSnapshot.Builder>... nodeSnapshots) A list of the cache nodes in the source cluster.
Snapshot.Builder	nodeSnapshots(NodeSnapshot... nodeSnapshots) A list of the cache nodes in the source cluster.
Snapshot.Builder	numCacheNodes(Integer numCacheNodes) The number of cache nodes in the source cluster.
Snapshot.Builder	numNodeGroups(Integer numNodeGroups) The number of node groups (shards) in this snapshot.
Snapshot.Builder	port(Integer port) The port number used by each cache nodes in the source cluster.
Snapshot.Builder	preferredAvailabilityZone(String preferredAvailabilityZone) The name of the Availability Zone in which the source cluster is located.
Snapshot.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cluster is performed.
Snapshot.Builder	preferredOutpostArn(String preferredOutpostArn) The ARN (Amazon Resource Name) of the preferred outpost.
Snapshot.Builder	replicationGroupDescription(String replicationGroupDescription) A description of the source replication group.
Snapshot.Builder	replicationGroupId(String replicationGroupId) The unique identifier of the source replication group.
Snapshot.Builder	snapshotName(String snapshotName) The name of a snapshot.
Snapshot.Builder	snapshotRetentionLimit(Integer snapshotRetentionLimit) For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
Snapshot.Builder	snapshotSource(String snapshotSource) Indicates whether the snapshot is from an automatic backup (automated) or was created manually ( manual).
Snapshot.Builder	snapshotStatus(String snapshotStatus) The status of the snapshot.
Snapshot.Builder	snapshotWindow(String snapshotWindow) The daily time range during which ElastiCache takes daily snapshots of the source cluster.
Snapshot.Builder	topicArn(String topicArn) The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Snapshot.Builder	vpcId(String vpcId) The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

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

snapshotName

Snapshot.Builder snapshotName(String snapshotName)

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

Parameters:

snapshotName - The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

Returns:

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

replicationGroupId

Snapshot.Builder replicationGroupId(String replicationGroupId)

The unique identifier of the source replication group.

Parameters:

replicationGroupId - The unique identifier of the source replication group.

Returns:

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

replicationGroupDescription

Snapshot.Builder replicationGroupDescription(String replicationGroupDescription)

A description of the source replication group.

Parameters:

replicationGroupDescription - A description of the source replication group.

Returns:

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

cacheClusterId

Snapshot.Builder cacheClusterId(String cacheClusterId)

The user-supplied identifier of the source cluster.

Parameters:

cacheClusterId - The user-supplied identifier of the source cluster.

Returns:

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

snapshotStatus

Snapshot.Builder snapshotStatus(String snapshotStatus)

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

Parameters:

snapshotStatus - The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

Returns:

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

snapshotSource

Snapshot.Builder snapshotSource(String snapshotSource)

Indicates whether the snapshot is from an automatic backup (automated) or was created manually ( manual).

Parameters:

snapshotSource - Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

Returns:

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

cacheNodeType

Snapshot.Builder cacheNodeType(String cacheNodeType)

The name of the compute and memory capacity node type for the source cluster.

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 name of the compute and memory capacity node type for the source cluster.

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.

engine

Snapshot.Builder engine(String engine)

The name of the cache engine (memcached or redis) used by the source cluster.

Parameters:

engine - The name of the cache engine (memcached or redis) used by the source cluster.

Returns:

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

engineVersion

Snapshot.Builder engineVersion(String engineVersion)

The version of the cache engine version that is used by the source cluster.

Parameters:

engineVersion - The version of the cache engine version that is used by the source cluster.

Returns:

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

numCacheNodes

Snapshot.Builder numCacheNodes(Integer numCacheNodes)

The number of cache nodes in the source cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

Parameters:

numCacheNodes - The number of cache nodes in the source cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

Returns:

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

preferredAvailabilityZone

Snapshot.Builder preferredAvailabilityZone(String preferredAvailabilityZone)

The name of the Availability Zone in which the source cluster is located.

Parameters:

preferredAvailabilityZone - The name of the Availability Zone in which the source cluster is located.

Returns:

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

preferredOutpostArn

Snapshot.Builder preferredOutpostArn(String preferredOutpostArn)

The ARN (Amazon Resource Name) of the preferred outpost.

Parameters:

preferredOutpostArn - The ARN (Amazon Resource Name) of the preferred outpost.

Returns:

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

cacheClusterCreateTime

Snapshot.Builder cacheClusterCreateTime(Instant cacheClusterCreateTime)

The date and time when the source cluster was created.

Parameters:

cacheClusterCreateTime - The date and time when the source cluster was created.

Returns:

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

preferredMaintenanceWindow

Snapshot.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

• sun

• mon

• tue

• wed

• thu

• fri

• sat

Example: sun:23:00-mon:01:30

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

• sun

• mon

• tue

• wed

• thu

• fri

• sat

Example: sun:23:00-mon:01:30

Returns:

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

topicArn

Snapshot.Builder topicArn(String topicArn)

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

Parameters:

topicArn - The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

Returns:

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

port

Snapshot.Builder port(Integer port)

The port number used by each cache nodes in the source cluster.

Parameters:

port - The port number used by each cache nodes in the source cluster.

Returns:

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

cacheParameterGroupName

Snapshot.Builder cacheParameterGroupName(String cacheParameterGroupName)

The cache parameter group that is associated with the source cluster.

Parameters:

cacheParameterGroupName - The cache parameter group that is associated with the source cluster.

Returns:

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

cacheSubnetGroupName

Snapshot.Builder cacheSubnetGroupName(String cacheSubnetGroupName)

The name of the cache subnet group associated with the source cluster.

Parameters:

cacheSubnetGroupName - The name of the cache subnet group associated with the source cluster.

Returns:

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

vpcId

Snapshot.Builder vpcId(String vpcId)

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

Parameters:

vpcId - The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

Returns:

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

autoMinorVersionUpgrade

Snapshot.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

Parameters:

autoMinorVersionUpgrade - If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

Returns:

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

snapshotRetentionLimit

Snapshot.Builder snapshotRetentionLimit(Integer snapshotRetentionLimit)

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Parameters:

snapshotRetentionLimit - For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Returns:

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

snapshotWindow

Snapshot.Builder snapshotWindow(String snapshotWindow)

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

Parameters:

snapshotWindow - The daily time range during which ElastiCache takes daily snapshots of the source cluster.

Returns:

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

numNodeGroups

Snapshot.Builder numNodeGroups(Integer numNodeGroups)

The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

Parameters:

numNodeGroups - The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

Returns:

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

automaticFailover

Snapshot.Builder automaticFailover(String automaticFailover)

Indicates the status of automatic failover for the source Redis replication group.

Parameters:

automaticFailover - Indicates the status of automatic failover for the source Redis replication group.

Returns:

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

See Also:

AutomaticFailoverStatus, AutomaticFailoverStatus

automaticFailover

Snapshot.Builder automaticFailover(AutomaticFailoverStatus automaticFailover)

Indicates the status of automatic failover for the source Redis replication group.

Parameters:

automaticFailover - Indicates the status of automatic failover for the source Redis replication group.

Returns:

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

See Also:

AutomaticFailoverStatus, AutomaticFailoverStatus

nodeSnapshots

Snapshot.Builder nodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)

A list of the cache nodes in the source cluster.

Parameters:

nodeSnapshots - A list of the cache nodes in the source cluster.

Returns:

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

nodeSnapshots

Snapshot.Builder nodeSnapshots(NodeSnapshot... nodeSnapshots)

A list of the cache nodes in the source cluster.

Parameters:

nodeSnapshots - A list of the cache nodes in the source cluster.

Returns:

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

nodeSnapshots

Snapshot.Builder nodeSnapshots(Consumer<NodeSnapshot.Builder>... nodeSnapshots)

A list of the cache nodes in the source cluster.

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

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

Parameters:

nodeSnapshots - a consumer that will call methods on NodeSnapshot.Builder

Returns:

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

See Also:

#nodeSnapshots(java.util.Collection)

kmsKeyId

Snapshot.Builder kmsKeyId(String kmsKeyId)

The ID of the KMS key used to encrypt the snapshot.

Parameters:

kmsKeyId - The ID of the KMS key used to encrypt the snapshot.

Returns:

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

arn

Snapshot.Builder arn(String arn)

The ARN (Amazon Resource Name) of the snapshot.

Parameters:

arn - The ARN (Amazon Resource Name) of the snapshot.

Returns:

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

dataTiering

Snapshot.Builder dataTiering(String dataTiering)

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Parameters:

dataTiering - Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Returns:

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

See Also:

DataTieringStatus, DataTieringStatus

dataTiering

Snapshot.Builder dataTiering(DataTieringStatus dataTiering)

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Parameters:

dataTiering - Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Returns:

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

See Also:

DataTieringStatus, DataTieringStatus