You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElastiCache::Types::CacheCluster

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

Overview

Contains all of the attributes of a specific cluster.

Instance Attribute Summary collapse

Instance Attribute Details

#at_rest_encryption_enabledBoolean

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Default: false

Returns:

  • (Boolean)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#auth_token_enabledBoolean

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

Returns:

  • (Boolean)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

This parameter is currently disabled.

Returns:

  • (Boolean)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_cluster_create_timeTime

The date and time when the cluster was created.

Returns:

  • (Time)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_cluster_idString

The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_cluster_statusString

The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_node_typeString

The name of the compute and memory capacity node type for the 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:

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • 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

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

  • Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

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

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_nodesArray<Types::CacheNode>

A list of cache nodes that are members of the cluster.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_parameter_groupTypes::CacheParameterGroupStatus

Status of the cache parameter group.



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_security_groupsArray<Types::CacheSecurityGroupMembership>

A list of cache security group elements, composed of name and status sub-elements.



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#cache_subnet_group_nameString

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

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#client_download_landing_pageString

The URL of the web page where you can download the latest ElastiCache client library.

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#configuration_endpointTypes::Endpoint

Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#engineString

The name of the cache engine (memcached or redis) to be used for this cluster.

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#engine_versionString

The version of the cache engine that is used in this cluster.

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#notification_configurationTypes::NotificationConfiguration

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#num_cache_nodesInteger

The number of cache nodes in the cluster.

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

Returns:

  • (Integer)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#pending_modified_valuesTypes::PendingModifiedValues

A group of settings that are applied to the cluster in the future, or that are currently being applied.



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#preferred_availability_zoneString

The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  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)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#replication_group_idString

The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#security_groupsArray<Types::SecurityGroupMembership>

A list of VPC Security Groups associated with the cluster.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#snapshot_retention_limitInteger

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Returns:

  • (Integer)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#snapshot_windowString

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Example: 05:00-09:00

Returns:

  • (String)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end

#transit_encryption_enabledBoolean

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

Default: false

Returns:

  • (Boolean)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 380

class CacheCluster < Struct.new(
  :cache_cluster_id,
  :configuration_endpoint,
  :client_download_landing_page,
  :cache_node_type,
  :engine,
  :engine_version,
  :cache_cluster_status,
  :num_cache_nodes,
  :preferred_availability_zone,
  :cache_cluster_create_time,
  :preferred_maintenance_window,
  :pending_modified_values,
  :notification_configuration,
  :cache_security_groups,
  :cache_parameter_group,
  :cache_subnet_group_name,
  :cache_nodes,
  :auto_minor_version_upgrade,
  :security_groups,
  :replication_group_id,
  :snapshot_retention_limit,
  :snapshot_window,
  :auth_token_enabled,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled)
  include Aws::Structure
end