Class: Aws::ElastiCache::Types::ReplicationGroup
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElastiCache::Types::ReplicationGroup
- 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
-
#arn ⇒ String
The ARN (Amazon Resource Name) of the replication group.
-
#at_rest_encryption_enabled ⇒ Boolean
A flag that enables encryption at-rest when set to
true
. -
#auth_token_enabled ⇒ Boolean
A flag that enables using an
AuthToken
(password) when issuing Redis commands. -
#auth_token_last_modified_date ⇒ Time
The date the auth token was last modified.
-
#auto_minor_version_upgrade ⇒ Boolean
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign.
-
#automatic_failover ⇒ String
Indicates the status of automatic failover for this Redis replication group.
-
#cache_node_type ⇒ String
The name of the compute and memory capacity node type for each node in the replication group.
-
#cluster_enabled ⇒ Boolean
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).
-
#configuration_endpoint ⇒ Types::Endpoint
The configuration endpoint for this replication group.
-
#data_tiering ⇒ String
Enables data tiering.
-
#description ⇒ String
The user supplied description of the replication group.
-
#global_replication_group_info ⇒ Types::GlobalReplicationGroupInfo
The name of the Global datastore and role of this replication group in the Global datastore.
-
#kms_key_id ⇒ String
The ID of the KMS key used to encrypt the disk in the cluster.
-
#log_delivery_configurations ⇒ Array<Types::LogDeliveryConfiguration>
Returns the destination, format and type of the logs.
-
#member_clusters ⇒ Array<String>
The names of all the cache clusters that are part of this replication group.
-
#member_clusters_outpost_arns ⇒ Array<String>
The outpost ARNs of the replication group's member clusters.
-
#multi_az ⇒ String
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
-
#node_groups ⇒ Array<Types::NodeGroup>
A list of node groups in this replication group.
-
#pending_modified_values ⇒ Types::ReplicationGroupPendingModifiedValues
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
-
#replication_group_create_time ⇒ Time
The date and time when the cluster was created.
-
#replication_group_id ⇒ String
The identifier for the replication group.
-
#snapshot_retention_limit ⇒ Integer
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
-
#snapshot_window ⇒ String
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
-
#snapshotting_cluster_id ⇒ String
The cluster ID that is used as the daily snapshot source for the replication group.
-
#status ⇒ String
The current state of this replication group -
creating
,available
,modifying
,deleting
,create-failed
,snapshotting
. -
#transit_encryption_enabled ⇒ Boolean
A flag that enables in-transit encryption when set to
true
. -
#user_group_ids ⇒ Array<String>
The ID of the user group associated to the replication group.
Instance Attribute Details
#arn ⇒ String
The ARN (Amazon Resource Name) of the replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#at_rest_encryption_enabled ⇒ Boolean
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
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#auth_token_enabled ⇒ Boolean
A flag that enables using an AuthToken
(password) when issuing
Redis commands.
Default: false
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#auth_token_last_modified_date ⇒ Time
The date the auth token was last modified
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#auto_minor_version_upgrade ⇒ Boolean
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#automatic_failover ⇒ String
Indicates the status of automatic failover for this Redis replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#cache_node_type ⇒ String
The name of the compute and memory capacity node type for each node in the replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#cluster_enabled ⇒ Boolean
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
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#configuration_endpoint ⇒ Types::Endpoint
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) 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.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The user supplied description of the replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#global_replication_group_info ⇒ Types::GlobalReplicationGroupInfo
The name of the Global datastore and role of this replication group in the Global datastore.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The ID of the KMS key used to encrypt the disk in the cluster.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#log_delivery_configurations ⇒ Array<Types::LogDeliveryConfiguration>
Returns the destination, format and type of the logs.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#member_clusters ⇒ Array<String>
The names of all the cache clusters that are part of this replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#member_clusters_outpost_arns ⇒ Array<String>
The outpost ARNs of the replication group's member clusters.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#multi_az ⇒ String
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#node_groups ⇒ Array<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).
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#pending_modified_values ⇒ Types::ReplicationGroupPendingModifiedValues
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#replication_group_create_time ⇒ Time
The date and time when the cluster was created.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#replication_group_id ⇒ String
The identifier for the replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#snapshot_retention_limit ⇒ Integer
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.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#snapshot_window ⇒ String
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.
Engine
parameter is redis
.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#snapshotting_cluster_id ⇒ String
The cluster ID that is used as the daily snapshot source for the replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current state of this replication group - creating
,
available
, modifying
, deleting
, create-failed
,
snapshotting
.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#transit_encryption_enabled ⇒ Boolean
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
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |
#user_group_ids ⇒ Array<String>
The ID of the user group associated to the replication group.
7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 7937 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, :member_clusters_outpost_arns, :kms_key_id, :arn, :user_group_ids, :log_delivery_configurations, :replication_group_create_time, :data_tiering, :auto_minor_version_upgrade) SENSITIVE = [] include Aws::Structure end |