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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN (Amazon Resource Name) of the snapshot.

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

This parameter is currently disabled.

Returns:

  • (Boolean)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_failoverString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_create_timeTime

The date and time when the source cluster was created.

Returns:

  • (Time)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_idString

The user-supplied identifier of the source cluster.

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_typeString

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:

      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

      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)

      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)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      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)

      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:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cache_parameter_group_nameString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cache_subnet_group_nameString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#node_snapshotsArray<Types::NodeSnapshot>

A list of the cache nodes in the source cluster.

Returns:



7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#num_cache_nodesInteger

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

Returns:

  • (Integer)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#num_node_groupsInteger

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)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

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

Returns:

  • (Integer)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_availability_zoneString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_windowString

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)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_descriptionString

A description of the source replication group.

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_idString

The unique identifier of the source replication group.

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_nameString

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)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_limitInteger

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)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_sourceString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_statusString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_windowString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#topic_arnString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

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

Returns:

  • (String)


7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7660

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end