com.amazonaws.services.elasticache.model

Class Snapshot

java.lang.Object

com.amazonaws.services.elasticache.model.Snapshot

All Implemented Interfaces:

Serializable, Cloneable

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

Represents a copy of an entire Redis OSS cluster as of the time when the snapshot was taken.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Snapshot()

Method Summary

Modifier and Type	Method and Description
Snapshot	clone()
boolean	equals(Object obj)
String	getARN() The ARN (Amazon Resource Name) of the snapshot.
String	getAutomaticFailover() Indicates the status of automatic failover for the source Redis OSS replication group.
Boolean	getAutoMinorVersionUpgrade() If you are running Redis OSS 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.
Date	getCacheClusterCreateTime() The date and time when the source cluster was created.
String	getCacheClusterId() The user-supplied identifier of the source cluster.
String	getCacheNodeType() The name of the compute and memory capacity node type for the source cluster.
String	getCacheParameterGroupName() The cache parameter group that is associated with the source cluster.
String	getCacheSubnetGroupName() The name of the cache subnet group associated with the source cluster.
String	getDataTiering() Enables data tiering.
String	getEngine() The name of the cache engine (memcached or redis) used by the source cluster.
String	getEngineVersion() The version of the cache engine version that is used by the source cluster.
String	getKmsKeyId() The ID of the KMS key used to encrypt the snapshot.
List<NodeSnapshot>	getNodeSnapshots() A list of the cache nodes in the source cluster.
Integer	getNumCacheNodes() The number of cache nodes in the source cluster.
Integer	getNumNodeGroups() The number of node groups (shards) in this snapshot.
Integer	getPort() The port number used by each cache nodes in the source cluster.
String	getPreferredAvailabilityZone() The name of the Availability Zone in which the source cluster is located.
String	getPreferredMaintenanceWindow() Specifies the weekly time range during which maintenance on the cluster is performed.
String	getPreferredOutpostArn() The ARN (Amazon Resource Name) of the preferred outpost.
String	getReplicationGroupDescription() A description of the source replication group.
String	getReplicationGroupId() The unique identifier of the source replication group.
String	getSnapshotName() The name of a snapshot.
Integer	getSnapshotRetentionLimit() For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
String	getSnapshotSource() Indicates whether the snapshot is from an automatic backup (automated) or was created manually ( manual).
String	getSnapshotStatus() The status of the snapshot.
String	getSnapshotWindow() The daily time range during which ElastiCache takes daily snapshots of the source cluster.
String	getTopicArn() The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
String	getVpcId() The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() If you are running Redis OSS 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.
void	setARN(String aRN) The ARN (Amazon Resource Name) of the snapshot.
void	setAutomaticFailover(AutomaticFailoverStatus automaticFailover) Indicates the status of automatic failover for the source Redis OSS replication group.
void	setAutomaticFailover(String automaticFailover) Indicates the status of automatic failover for the source Redis OSS replication group.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) If you are running Redis OSS 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.
void	setCacheClusterCreateTime(Date cacheClusterCreateTime) The date and time when the source cluster was created.
void	setCacheClusterId(String cacheClusterId) The user-supplied identifier of the source cluster.
void	setCacheNodeType(String cacheNodeType) The name of the compute and memory capacity node type for the source cluster.
void	setCacheParameterGroupName(String cacheParameterGroupName) The cache parameter group that is associated with the source cluster.
void	setCacheSubnetGroupName(String cacheSubnetGroupName) The name of the cache subnet group associated with the source cluster.
void	setDataTiering(DataTieringStatus dataTiering) Enables data tiering.
void	setDataTiering(String dataTiering) Enables data tiering.
void	setEngine(String engine) The name of the cache engine (memcached or redis) used by the source cluster.
void	setEngineVersion(String engineVersion) The version of the cache engine version that is used by the source cluster.
void	setKmsKeyId(String kmsKeyId) The ID of the KMS key used to encrypt the snapshot.
void	setNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots) A list of the cache nodes in the source cluster.
void	setNumCacheNodes(Integer numCacheNodes) The number of cache nodes in the source cluster.
void	setNumNodeGroups(Integer numNodeGroups) The number of node groups (shards) in this snapshot.
void	setPort(Integer port) The port number used by each cache nodes in the source cluster.
void	setPreferredAvailabilityZone(String preferredAvailabilityZone) The name of the Availability Zone in which the source cluster is located.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cluster is performed.
void	setPreferredOutpostArn(String preferredOutpostArn) The ARN (Amazon Resource Name) of the preferred outpost.
void	setReplicationGroupDescription(String replicationGroupDescription) A description of the source replication group.
void	setReplicationGroupId(String replicationGroupId) The unique identifier of the source replication group.
void	setSnapshotName(String snapshotName) The name of a snapshot.
void	setSnapshotRetentionLimit(Integer snapshotRetentionLimit) For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
void	setSnapshotSource(String snapshotSource) Indicates whether the snapshot is from an automatic backup (automated) or was created manually ( manual).
void	setSnapshotStatus(String snapshotStatus) The status of the snapshot.
void	setSnapshotWindow(String snapshotWindow) The daily time range during which ElastiCache takes daily snapshots of the source cluster.
void	setTopicArn(String topicArn) The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
void	setVpcId(String vpcId) The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
String	toString() Returns a string representation of this object.
Snapshot	withARN(String aRN) The ARN (Amazon Resource Name) of the snapshot.
Snapshot	withAutomaticFailover(AutomaticFailoverStatus automaticFailover) Indicates the status of automatic failover for the source Redis OSS replication group.
Snapshot	withAutomaticFailover(String automaticFailover) Indicates the status of automatic failover for the source Redis OSS replication group.
Snapshot	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) If you are running Redis OSS 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	withCacheClusterCreateTime(Date cacheClusterCreateTime) The date and time when the source cluster was created.
Snapshot	withCacheClusterId(String cacheClusterId) The user-supplied identifier of the source cluster.
Snapshot	withCacheNodeType(String cacheNodeType) The name of the compute and memory capacity node type for the source cluster.
Snapshot	withCacheParameterGroupName(String cacheParameterGroupName) The cache parameter group that is associated with the source cluster.
Snapshot	withCacheSubnetGroupName(String cacheSubnetGroupName) The name of the cache subnet group associated with the source cluster.
Snapshot	withDataTiering(DataTieringStatus dataTiering) Enables data tiering.
Snapshot	withDataTiering(String dataTiering) Enables data tiering.
Snapshot	withEngine(String engine) The name of the cache engine (memcached or redis) used by the source cluster.
Snapshot	withEngineVersion(String engineVersion) The version of the cache engine version that is used by the source cluster.
Snapshot	withKmsKeyId(String kmsKeyId) The ID of the KMS key used to encrypt the snapshot.
Snapshot	withNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots) A list of the cache nodes in the source cluster.
Snapshot	withNodeSnapshots(NodeSnapshot... nodeSnapshots) A list of the cache nodes in the source cluster.
Snapshot	withNumCacheNodes(Integer numCacheNodes) The number of cache nodes in the source cluster.
Snapshot	withNumNodeGroups(Integer numNodeGroups) The number of node groups (shards) in this snapshot.
Snapshot	withPort(Integer port) The port number used by each cache nodes in the source cluster.
Snapshot	withPreferredAvailabilityZone(String preferredAvailabilityZone) The name of the Availability Zone in which the source cluster is located.
Snapshot	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cluster is performed.
Snapshot	withPreferredOutpostArn(String preferredOutpostArn) The ARN (Amazon Resource Name) of the preferred outpost.
Snapshot	withReplicationGroupDescription(String replicationGroupDescription) A description of the source replication group.
Snapshot	withReplicationGroupId(String replicationGroupId) The unique identifier of the source replication group.
Snapshot	withSnapshotName(String snapshotName) The name of a snapshot.
Snapshot	withSnapshotRetentionLimit(Integer snapshotRetentionLimit) For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
Snapshot	withSnapshotSource(String snapshotSource) Indicates whether the snapshot is from an automatic backup (automated) or was created manually ( manual).
Snapshot	withSnapshotStatus(String snapshotStatus) The status of the snapshot.
Snapshot	withSnapshotWindow(String snapshotWindow) The daily time range during which ElastiCache takes daily snapshots of the source cluster.
Snapshot	withTopicArn(String topicArn) The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Snapshot	withVpcId(String vpcId) The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Snapshot

public Snapshot()

Method Detail

setSnapshotName

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

getSnapshotName

public String getSnapshotName()

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:

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

withSnapshotName

public Snapshot withSnapshotName(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.

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

The unique identifier of the source replication group.

Parameters:

replicationGroupId - The unique identifier of the source replication group.

getReplicationGroupId

public String getReplicationGroupId()

The unique identifier of the source replication group.

Returns:

The unique identifier of the source replication group.

withReplicationGroupId

public Snapshot withReplicationGroupId(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.

setReplicationGroupDescription

public void setReplicationGroupDescription(String replicationGroupDescription)

A description of the source replication group.

Parameters:

replicationGroupDescription - A description of the source replication group.

getReplicationGroupDescription

public String getReplicationGroupDescription()

A description of the source replication group.

Returns:

A description of the source replication group.

withReplicationGroupDescription

public Snapshot withReplicationGroupDescription(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.

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

The user-supplied identifier of the source cluster.

Parameters:

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

getCacheClusterId

public String getCacheClusterId()

The user-supplied identifier of the source cluster.

Returns:

The user-supplied identifier of the source cluster.

withCacheClusterId

public Snapshot withCacheClusterId(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.

setSnapshotStatus

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

getSnapshotStatus

public String getSnapshotStatus()

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

Returns:

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

withSnapshotStatus

public Snapshot withSnapshotStatus(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.

setSnapshotSource

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

getSnapshotSource

public String getSnapshotSource()

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

Returns:

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

withSnapshotSource

public Snapshot withSnapshotSource(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.

setCacheNodeType

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

    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.

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:

    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.

getCacheNodeType

public String getCacheNodeType()

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:

    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.

Returns:

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:

    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.

withCacheNodeType

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

    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.

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:

    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.

Returns:

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

setEngine

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

getEngine

public String getEngine()

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

Returns:

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

withEngine

public Snapshot withEngine(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.

setEngineVersion

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

getEngineVersion

public String getEngineVersion()

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

Returns:

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

withEngineVersion

public Snapshot withEngineVersion(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.

setNumCacheNodes

public void setNumCacheNodes(Integer numCacheNodes)

The number of cache nodes in the source cluster.

For clusters running Redis OSS, 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 OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

getNumCacheNodes

public Integer getNumCacheNodes()

The number of cache nodes in the source cluster.

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

Returns:

The number of cache nodes in the source cluster.

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

withNumCacheNodes

public Snapshot withNumCacheNodes(Integer numCacheNodes)

The number of cache nodes in the source cluster.

For clusters running Redis OSS, 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 OSS, 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.

setPreferredAvailabilityZone

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

getPreferredAvailabilityZone

public String getPreferredAvailabilityZone()

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

Returns:

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

withPreferredAvailabilityZone

public Snapshot withPreferredAvailabilityZone(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.

setPreferredOutpostArn

public void setPreferredOutpostArn(String preferredOutpostArn)

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

Parameters:

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

getPreferredOutpostArn

public String getPreferredOutpostArn()

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

Returns:

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

withPreferredOutpostArn

public Snapshot withPreferredOutpostArn(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.

setCacheClusterCreateTime

public void setCacheClusterCreateTime(Date cacheClusterCreateTime)

The date and time when the source cluster was created.

Parameters:

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

getCacheClusterCreateTime

public Date getCacheClusterCreateTime()

The date and time when the source cluster was created.

Returns:

The date and time when the source cluster was created.

withCacheClusterCreateTime

public Snapshot withCacheClusterCreateTime(Date 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.

setPreferredMaintenanceWindow

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

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

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:

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

withPreferredMaintenanceWindow

public Snapshot withPreferredMaintenanceWindow(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.

setTopicArn

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

getTopicArn

public String getTopicArn()

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

Returns:

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

withTopicArn

public Snapshot withTopicArn(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.

setPort

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

getPort

public Integer getPort()

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

Returns:

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

withPort

public Snapshot withPort(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.

setCacheParameterGroupName

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

getCacheParameterGroupName

public String getCacheParameterGroupName()

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

Returns:

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

withCacheParameterGroupName

public Snapshot withCacheParameterGroupName(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.

setCacheSubnetGroupName

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

getCacheSubnetGroupName

public String getCacheSubnetGroupName()

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

Returns:

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

withCacheSubnetGroupName

public Snapshot withCacheSubnetGroupName(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.

setVpcId

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

getVpcId

public String getVpcId()

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

Returns:

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

withVpcId

public Snapshot withVpcId(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.

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

If you are running Redis OSS 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 OSS 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.

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

If you are running Redis OSS 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:

If you are running Redis OSS 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.

withAutoMinorVersionUpgrade

public Snapshot withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

If you are running Redis OSS 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 OSS 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.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

If you are running Redis OSS 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:

If you are running Redis OSS 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.

setSnapshotRetentionLimit

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

getSnapshotRetentionLimit

public Integer getSnapshotRetentionLimit()

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:

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.

withSnapshotRetentionLimit

public Snapshot withSnapshotRetentionLimit(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.

setSnapshotWindow

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

getSnapshotWindow

public String getSnapshotWindow()

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

Returns:

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

withSnapshotWindow

public Snapshot withSnapshotWindow(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.

setNumNodeGroups

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

getNumNodeGroups

public Integer getNumNodeGroups()

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:

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.

withNumNodeGroups

public Snapshot withNumNodeGroups(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.

setAutomaticFailover

public void setAutomaticFailover(String automaticFailover)

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

Parameters:

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

See Also:

AutomaticFailoverStatus

getAutomaticFailover

public String getAutomaticFailover()

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

Returns:

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

See Also:

AutomaticFailoverStatus

withAutomaticFailover

public Snapshot withAutomaticFailover(String automaticFailover)

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

Parameters:

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

Returns:

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

See Also:

AutomaticFailoverStatus

setAutomaticFailover

public void setAutomaticFailover(AutomaticFailoverStatus automaticFailover)

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

Parameters:

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

See Also:

AutomaticFailoverStatus

withAutomaticFailover

public Snapshot withAutomaticFailover(AutomaticFailoverStatus automaticFailover)

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

Parameters:

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

Returns:

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

See Also:

AutomaticFailoverStatus

getNodeSnapshots

public List<NodeSnapshot> getNodeSnapshots()

A list of the cache nodes in the source cluster.

Returns:

A list of the cache nodes in the source cluster.

setNodeSnapshots

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

withNodeSnapshots

public Snapshot withNodeSnapshots(NodeSnapshot... nodeSnapshots)

A list of the cache nodes in the source cluster.

NOTE: This method appends the values to the existing list (if any). Use setNodeSnapshots(java.util.Collection) or withNodeSnapshots(java.util.Collection) if you want to override the existing values.

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.

withNodeSnapshots

public Snapshot withNodeSnapshots(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.

setKmsKeyId

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

getKmsKeyId

public String getKmsKeyId()

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

Returns:

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

withKmsKeyId

public Snapshot withKmsKeyId(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.

setARN

public void setARN(String aRN)

The ARN (Amazon Resource Name) of the snapshot.

Parameters:

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

getARN

public String getARN()

The ARN (Amazon Resource Name) of the snapshot.

Returns:

The ARN (Amazon Resource Name) of the snapshot.

withARN

public Snapshot withARN(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.

setDataTiering

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

See Also:

DataTieringStatus

getDataTiering

public String getDataTiering()

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:

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.

See Also:

DataTieringStatus

withDataTiering

public Snapshot withDataTiering(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

setDataTiering

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

See Also:

DataTieringStatus

withDataTiering

public Snapshot withDataTiering(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

toString

public String toString()

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.

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 Snapshot clone()

Overrides:

clone in class Object