Package software.amazon.awssdk.services.elasticache.model

Class Snapshot

java.lang.Object
software.amazon.awssdk.services.elasticache.model.Snapshot
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Snapshot.Builder,Snapshot>
@Generated("software.amazon.awssdk:codegen") public final class Snapshot extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Snapshot.Builder,Snapshot>

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

See Also:

  • Method Details

    • snapshotName

      public final 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.

      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.

    • replicationGroupId

      public final String replicationGroupId()

      The unique identifier of the source replication group.

      Returns:
      The unique identifier of the source replication group.

    • replicationGroupDescription

      public final String replicationGroupDescription()

      A description of the source replication group.

      Returns:
      A description of the source replication group.

    • cacheClusterId

      public final String cacheClusterId()

      The user-supplied identifier of the source cluster.

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

    • snapshotStatus

      public final String snapshotStatus()

      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.

    • snapshotSource

      public final String snapshotSource()

      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).

    • cacheNodeType

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

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

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

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

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

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

    • engine

      public final String engine()

      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.

    • engineVersion

      public final String engineVersion()

      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.

    • numCacheNodes

      public final Integer numCacheNodes()

      The number of cache nodes in the source cluster.

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

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

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

    • preferredAvailabilityZone

      public final String preferredAvailabilityZone()

      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.

    • preferredOutpostArn

      public final String preferredOutpostArn()

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

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

    • cacheClusterCreateTime

      public final Instant cacheClusterCreateTime()

      The date and time when the source cluster was created.

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

    • preferredMaintenanceWindow

      public final 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

      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

    • topicArn

      public final String topicArn()

      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.

    • port

      public final Integer port()

      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.

    • cacheParameterGroupName

      public final String cacheParameterGroupName()

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

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

    • cacheSubnetGroupName

      public final String cacheSubnetGroupName()

      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.

    • vpcId

      public final String vpcId()

      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.

    • autoMinorVersionUpgrade

      public final Boolean autoMinorVersionUpgrade()

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

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

    • snapshotRetentionLimit

      public final 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.

      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.

    • snapshotWindow

      public final String snapshotWindow()

      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.

    • numNodeGroups

      public final 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.

      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.

    • automaticFailover

      public final AutomaticFailoverStatus automaticFailover()

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

      If the service returns an enum value that is not available in the current SDK version, automaticFailover will return AutomaticFailoverStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automaticFailoverAsString().

      Returns:
      Indicates the status of automatic failover for the source Redis replication group.
      See Also:

    • automaticFailoverAsString

      public final String automaticFailoverAsString()

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

      If the service returns an enum value that is not available in the current SDK version, automaticFailover will return AutomaticFailoverStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automaticFailoverAsString().

      Returns:
      Indicates the status of automatic failover for the source Redis replication group.
      See Also:

    • hasNodeSnapshots

      public final boolean hasNodeSnapshots()
      For responses, this returns true if the service returned a value for the NodeSnapshots property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • nodeSnapshots

      public final List<NodeSnapshot> nodeSnapshots()

      A list of the cache nodes in the source cluster.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNodeSnapshots() method.

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

    • kmsKeyId

      public final String kmsKeyId()

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

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

    • arn

      public final String arn()

      The ARN (Amazon Resource Name) of the snapshot.

      Returns:
      The ARN (Amazon Resource Name) of the snapshot.

    • dataTiering

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, dataTiering will return DataTieringStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTieringAsString().

      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:

    • dataTieringAsString

      public final String dataTieringAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, dataTiering will return DataTieringStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTieringAsString().

      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:

    • toBuilder

      public Snapshot.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>
      Returns:
      a builder for type T

    • builder

      public static Snapshot.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Snapshot.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.