Class: Aws::ElastiCache::Types::Snapshot

Inherits:

Struct

Object
Struct
Aws::ElastiCache::Types::Snapshot

show all

Includes:: Structure

Defined in:: lib/aws-sdk-elasticache/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String

The ARN (Amazon Resource Name) of the snapshot.
#auto_minor_version_upgrade ⇒ Boolean

If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign.
#automatic_failover ⇒ String

Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.
#cache_cluster_create_time ⇒ Time

The date and time when the source cluster was created.
#cache_cluster_id ⇒ String

The user-supplied identifier of the source cluster.
#cache_node_type ⇒ String

The name of the compute and memory capacity node type for the source cluster.
#cache_parameter_group_name ⇒ String

The cache parameter group that is associated with the source cluster.
#cache_subnet_group_name ⇒ String

The name of the cache subnet group associated with the source cluster.
#data_tiering ⇒ String

Enables data tiering.
#engine ⇒ String

The name of the cache engine (‘memcached` or `redis`) used by the source cluster.
#engine_version ⇒ String

The version of the cache engine version that is used by the source cluster.
#kms_key_id ⇒ String

The ID of the KMS key used to encrypt the snapshot.
#node_snapshots ⇒ Array<Types::NodeSnapshot>

A list of the cache nodes in the source cluster.
#num_cache_nodes ⇒ Integer

The number of cache nodes in the source cluster.
#num_node_groups ⇒ Integer

The number of node groups (shards) in this snapshot.
#port ⇒ Integer

The port number used by each cache nodes in the source cluster.
#preferred_availability_zone ⇒ String

The name of the Availability Zone in which the source cluster is located.
#preferred_maintenance_window ⇒ String

Specifies the weekly time range during which maintenance on the cluster is performed.
#preferred_outpost_arn ⇒ String

The ARN (Amazon Resource Name) of the preferred outpost.
#replication_group_description ⇒ String

A description of the source replication group.
#replication_group_id ⇒ String

The unique identifier of the source replication group.
#snapshot_name ⇒ String

The name of a snapshot.
#snapshot_retention_limit ⇒ Integer

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

Indicates whether the snapshot is from an automatic backup (‘automated`) or was created manually (`manual`).
#snapshot_status ⇒ String

The status of the snapshot.
#snapshot_window ⇒ String

The daily time range during which ElastiCache takes daily snapshots of the source cluster.
#topic_arn ⇒ String

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

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

Instance Attribute Details

#arn ⇒ `String`

The ARN (Amazon Resource Name) of the snapshot.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ `Boolean`

If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, 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:

(Boolean)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_failover ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_create_time ⇒ `Time`

The date and time when the source cluster was created.

Returns:

(Time)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_id ⇒ `String`

The user-supplied identifier of the source cluster.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_type ⇒ `String`

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`
  
  <note markdown=“1”> For region availability, see [Supported Node Types]
```
</note>
```
  **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`
  
  <note markdown=“1”> For region availability, see [Supported Node Types]
```
</note>
```
  **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.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables ‘appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#cache_parameter_group_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#cache_subnet_group_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#data_tiering ⇒ `String`

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

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#node_snapshots ⇒ `Array<Types::NodeSnapshot>`

A list of the cache nodes in the source cluster.

Returns:

(Array<Types::NodeSnapshot>)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#num_cache_nodes ⇒ `Integer`

The number of cache nodes in the source cluster.

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

Returns:

(Integer)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#num_node_groups ⇒ `Integer`

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:

(Integer)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_availability_zone ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_outpost_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_description ⇒ `String`

A description of the source replication group.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_id ⇒ `String`

The unique identifier of the source replication group.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_name ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limit ⇒ `Integer`

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:

(Integer)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_source ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_status ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_window ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#topic_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 9163

class Snapshot < Struct.new(
  :snapshot_name,
  :replication_group_id,
  :replication_group_description,
  :cache_cluster_id,
  :snapshot_status,
  :snapshot_source,
  :cache_node_type,
  :engine,
  :engine_version,
  :num_cache_nodes,
  :preferred_availability_zone,
  :preferred_outpost_arn,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :topic_arn,
  :port,
  :cache_parameter_group_name,
  :cache_subnet_group_name,
  :vpc_id,
  :auto_minor_version_upgrade,
  :snapshot_retention_limit,
  :snapshot_window,
  :num_node_groups,
  :automatic_failover,
  :node_snapshots,
  :kms_key_id,
  :arn,
  :data_tiering)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::ElastiCache::Types::Snapshot

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#auto_minor_version_upgrade ⇒ Boolean

#automatic_failover ⇒ String

#cache_cluster_create_time ⇒ Time

#cache_cluster_id ⇒ String

#cache_node_type ⇒ String

#cache_parameter_group_name ⇒ String

#cache_subnet_group_name ⇒ String

#data_tiering ⇒ String

#engine ⇒ String

#engine_version ⇒ String

#kms_key_id ⇒ String

#node_snapshots ⇒ Array<Types::NodeSnapshot>

#num_cache_nodes ⇒ Integer

#num_node_groups ⇒ Integer

#port ⇒ Integer

#preferred_availability_zone ⇒ String

#preferred_maintenance_window ⇒ String

#preferred_outpost_arn ⇒ String

#replication_group_description ⇒ String

#replication_group_id ⇒ String

#snapshot_name ⇒ String

#snapshot_retention_limit ⇒ Integer

#snapshot_source ⇒ String

#snapshot_status ⇒ String

#snapshot_window ⇒ String

#topic_arn ⇒ String

#vpc_id ⇒ String

#arn ⇒ `String`

#auto_minor_version_upgrade ⇒ `Boolean`

#automatic_failover ⇒ `String`

#cache_cluster_create_time ⇒ `Time`

#cache_cluster_id ⇒ `String`

#cache_node_type ⇒ `String`

#cache_parameter_group_name ⇒ `String`

#cache_subnet_group_name ⇒ `String`

#data_tiering ⇒ `String`

#engine ⇒ `String`

#engine_version ⇒ `String`

#kms_key_id ⇒ `String`

#node_snapshots ⇒ `Array<Types::NodeSnapshot>`

#num_cache_nodes ⇒ `Integer`

#num_node_groups ⇒ `Integer`

#port ⇒ `Integer`

#preferred_availability_zone ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#preferred_outpost_arn ⇒ `String`

#replication_group_description ⇒ `String`

#replication_group_id ⇒ `String`

#snapshot_name ⇒ `String`

#snapshot_retention_limit ⇒ `Integer`

#snapshot_source ⇒ `String`

#snapshot_status ⇒ `String`

#snapshot_window ⇒ `String`

#topic_arn ⇒ `String`

#vpc_id ⇒ `String`