java.lang.Object
com.amazonaws.services.elasticache.model.Snapshot
All Implemented Interfaces:
Serializable, Cloneable

public class Snapshot extends Object implements Serializable, Cloneable

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

See Also:
  • Constructor Details

    • Snapshot

      public Snapshot()
  • Method Details

    • 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.
    • setCacheClusterId

      public void setCacheClusterId(String cacheClusterId)

      The user-supplied identifier of the source cache cluster.

      Parameters:
      cacheClusterId - The user-supplied identifier of the source cache cluster.
    • getCacheClusterId

      public String getCacheClusterId()

      The user-supplied identifier of the source cache cluster.

      Returns:
      The user-supplied identifier of the source cache cluster.
    • withCacheClusterId

      public Snapshot withCacheClusterId(String cacheClusterId)

      The user-supplied identifier of the source cache cluster.

      Parameters:
      cacheClusterId - The user-supplied identifier of the source cache 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 cache cluster.

      Valid node types are as follows:

      • General purpose:
        • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
        • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
      • Compute optimized: cache.c1.xlarge
      • Memory optimized
        • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
        • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      Notes:

      • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
      • Redis backup/restore is not supported for t2 instances.
      • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

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

      Parameters:
      cacheNodeType - The name of the compute and memory capacity node type for the source cache cluster.

      Valid node types are as follows:

      • General purpose:
        • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
        • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
      • Compute optimized: cache.c1.xlarge
      • Memory optimized
        • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
        • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      Notes:

      • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
      • Redis backup/restore is not supported for t2 instances.
      • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

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

    • getCacheNodeType

      public String getCacheNodeType()

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

      Valid node types are as follows:

      • General purpose:
        • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
        • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
      • Compute optimized: cache.c1.xlarge
      • Memory optimized
        • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
        • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      Notes:

      • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
      • Redis backup/restore is not supported for t2 instances.
      • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

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

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

      Valid node types are as follows:

      • General purpose:
        • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
        • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
      • Compute optimized: cache.c1.xlarge
      • Memory optimized
        • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
        • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      Notes:

      • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
      • Redis backup/restore is not supported for t2 instances.
      • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

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

    • withCacheNodeType

      public Snapshot withCacheNodeType(String cacheNodeType)

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

      Valid node types are as follows:

      • General purpose:
        • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
        • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
      • Compute optimized: cache.c1.xlarge
      • Memory optimized
        • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
        • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      Notes:

      • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
      • Redis backup/restore is not supported for t2 instances.
      • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

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

      Parameters:
      cacheNodeType - The name of the compute and memory capacity node type for the source cache cluster.

      Valid node types are as follows:

      • General purpose:
        • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
        • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
      • Compute optimized: cache.c1.xlarge
      • Memory optimized
        • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
        • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      Notes:

      • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
      • Redis backup/restore is not supported for t2 instances.
      • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

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

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

      public void setEngine(String engine)

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

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

      public String getEngine()

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

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

      public Snapshot withEngine(String engine)

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

      Parameters:
      engine - The name of the cache engine (memcached or redis) used by the source cache 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 cache cluster.

      Parameters:
      engineVersion - The version of the cache engine version that is used by the source cache cluster.
    • getEngineVersion

      public String getEngineVersion()

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

      Returns:
      The version of the cache engine version that is used by the source cache cluster.
    • withEngineVersion

      public Snapshot withEngineVersion(String engineVersion)

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

      Parameters:
      engineVersion - The version of the cache engine version that is used by the source cache 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 cache cluster.

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

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

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

    • getNumCacheNodes

      public Integer getNumCacheNodes()

      The number of cache nodes in the source cache cluster.

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

      Returns:
      The number of cache nodes in the source cache cluster.

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

    • withNumCacheNodes

      public Snapshot withNumCacheNodes(Integer numCacheNodes)

      The number of cache nodes in the source cache cluster.

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

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

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

      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 cache cluster is located.

      Parameters:
      preferredAvailabilityZone - The name of the Availability Zone in which the source cache cluster is located.
    • getPreferredAvailabilityZone

      public String getPreferredAvailabilityZone()

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

      Returns:
      The name of the Availability Zone in which the source cache cluster is located.
    • withPreferredAvailabilityZone

      public Snapshot withPreferredAvailabilityZone(String preferredAvailabilityZone)

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

      Parameters:
      preferredAvailabilityZone - The name of the Availability Zone in which the source cache cluster is located.
      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 cache cluster was created.

      Parameters:
      cacheClusterCreateTime - The date and time when the source cache cluster was created.
    • getCacheClusterCreateTime

      public Date getCacheClusterCreateTime()

      The date and time when the source cache cluster was created.

      Returns:
      The date and time when the source cache cluster was created.
    • withCacheClusterCreateTime

      public Snapshot withCacheClusterCreateTime(Date cacheClusterCreateTime)

      The date and time when the source cache cluster was created.

      Parameters:
      cacheClusterCreateTime - The date and time when the source cache 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 cache 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:05:00-sun:09:00

      Parameters:
      preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

    • getPreferredMaintenanceWindow

      public String getPreferredMaintenanceWindow()

      Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

      Returns:
      Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

    • withPreferredMaintenanceWindow

      public Snapshot withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

      Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

      Parameters:
      preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

      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 cache cluster for publishing notifications.

      Parameters:
      topicArn - The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
    • getTopicArn

      public String getTopicArn()

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

      Returns:
      The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
    • withTopicArn

      public Snapshot withTopicArn(String topicArn)

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

      Parameters:
      topicArn - The Amazon Resource Name (ARN) for the topic used by the source cache 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 cache cluster.

      Parameters:
      port - The port number used by each cache nodes in the source cache cluster.
    • getPort

      public Integer getPort()

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

      Returns:
      The port number used by each cache nodes in the source cache cluster.
    • withPort

      public Snapshot withPort(Integer port)

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

      Parameters:
      port - The port number used by each cache nodes in the source cache 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 cache cluster.

      Parameters:
      cacheParameterGroupName - The cache parameter group that is associated with the source cache cluster.
    • getCacheParameterGroupName

      public String getCacheParameterGroupName()

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

      Returns:
      The cache parameter group that is associated with the source cache cluster.
    • withCacheParameterGroupName

      public Snapshot withCacheParameterGroupName(String cacheParameterGroupName)

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

      Parameters:
      cacheParameterGroupName - The cache parameter group that is associated with the source cache 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 cache cluster.

      Parameters:
      cacheSubnetGroupName - The name of the cache subnet group associated with the source cache cluster.
    • getCacheSubnetGroupName

      public String getCacheSubnetGroupName()

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

      Returns:
      The name of the cache subnet group associated with the source cache cluster.
    • withCacheSubnetGroupName

      public Snapshot withCacheSubnetGroupName(String cacheSubnetGroupName)

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

      Parameters:
      cacheSubnetGroupName - The name of the cache subnet group associated with the source cache 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 cache cluster.

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

      public String getVpcId()

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

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

      public Snapshot withVpcId(String vpcId)

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

      Parameters:
      vpcId - The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAutoMinorVersionUpgrade

      public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

      This parameter is currently disabled.

      Parameters:
      autoMinorVersionUpgrade - This parameter is currently disabled.
    • getAutoMinorVersionUpgrade

      public Boolean getAutoMinorVersionUpgrade()

      This parameter is currently disabled.

      Returns:
      This parameter is currently disabled.
    • withAutoMinorVersionUpgrade

      public Snapshot withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

      This parameter is currently disabled.

      Parameters:
      autoMinorVersionUpgrade - This parameter is currently disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isAutoMinorVersionUpgrade

      public Boolean isAutoMinorVersionUpgrade()

      This parameter is currently disabled.

      Returns:
      This parameter is currently disabled.
    • setSnapshotRetentionLimit

      public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)

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

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

      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 will retain the snapshot before deleting it.

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

      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 will retain the snapshot before deleting it.

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

      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 will retain the snapshot before deleting it.

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

      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 will retain the snapshot before deleting it.

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

      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 will retain the snapshot before deleting it.

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

      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 cache cluster.

      Parameters:
      snapshotWindow - The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
    • getSnapshotWindow

      public String getSnapshotWindow()

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

      Returns:
      The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
    • withSnapshotWindow

      public Snapshot withSnapshotWindow(String snapshotWindow)

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

      Parameters:
      snapshotWindow - The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getNodeSnapshots

      public List<NodeSnapshot> getNodeSnapshots()

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

      Returns:
      A list of the cache nodes in the source cache cluster.
    • setNodeSnapshots

      public void setNodeSnapshots(Collection<NodeSnapshot> nodeSnapshots)

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

      Parameters:
      nodeSnapshots - A list of the cache nodes in the source cache cluster.
    • withNodeSnapshots

      public Snapshot withNodeSnapshots(NodeSnapshot... nodeSnapshots)

      A list of the cache nodes in the source cache 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 cache 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 cache cluster.

      Parameters:
      nodeSnapshots - A list of the cache nodes in the source cache cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • 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