Class: Aws::ElastiCache::Types::ReplicationGroup

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 Redis replication group.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN (Amazon Resource Name) of the replication group.

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#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 encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Returns:

  • (Boolean)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#auth_token_enabledBoolean

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

Default: false

Returns:

  • (Boolean)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#auth_token_last_modified_dateTime

The date the auth token was last modified

Returns:

  • (Time)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_failoverString

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

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_typeString

The name of the compute and memory capacity node type for each node in the replication group.

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_enabledBoolean

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Returns:

  • (Boolean)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_endpointTypes::Endpoint

The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

Returns:



6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The user supplied description of the replication group.

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#global_replication_group_infoTypes::GlobalReplicationGroupInfo

The name of the Global Datastore and role of this replication group in the Global Datastore.



6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The ID of the KMS key used to encrypt the disk in the cluster.

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#member_clustersArray<String>

The names of all the cache clusters that are part of this replication group.

Returns:

  • (Array<String>)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#multi_azString

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#node_groupsArray<Types::NodeGroup>

A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Returns:



6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#pending_modified_valuesTypes::ReplicationGroupPendingModifiedValues

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.



6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_idString

The identifier for the replication group.

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  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)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_windowString

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

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#snapshotting_cluster_idString

The cluster ID that is used as the daily snapshot source for the replication group.

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Returns:

  • (String)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  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.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Returns:

  • (Boolean)


6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 6702

class ReplicationGroup < Struct.new(
  :replication_group_id,
  :description,
  :global_replication_group_info,
  :status,
  :pending_modified_values,
  :member_clusters,
  :node_groups,
  :snapshotting_cluster_id,
  :automatic_failover,
  :multi_az,
  :configuration_endpoint,
  :snapshot_retention_limit,
  :snapshot_window,
  :cluster_enabled,
  :cache_node_type,
  :auth_token_enabled,
  :auth_token_last_modified_date,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :kms_key_id,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end