class Aws::ElastiCache::Types::ReplicationGroup
Contains all of the attributes of a specific Redis replication group.
@!attribute [rw] replication_group_id
The identifier for the replication group. @return [String]
@!attribute [rw] description
The user supplied description of the replication group. @return [String]
@!attribute [rw] global_replication_group_info
The name of the Global datastore and role of this replication group in the Global datastore. @return [Types::GlobalReplicationGroupInfo]
@!attribute [rw] status
The current state of this replication group - `creating`, `available`, `modifying`, `deleting`, `create-failed`, `snapshotting`. @return [String]
@!attribute [rw] pending_modified_values
A group of settings to be applied to the replication group, either immediately or during the next maintenance window. @return [Types::ReplicationGroupPendingModifiedValues]
@!attribute [rw] member_clusters
The names of all the cache clusters that are part of this replication group. @return [Array<String>]
@!attribute [rw] node_groups
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). @return [Array<Types::NodeGroup>]
@!attribute [rw] snapshotting_cluster_id
The cluster ID that is used as the daily snapshot source for the replication group. @return [String]
@!attribute [rw] automatic_failover
Indicates the status of automatic failover for this Redis replication group. @return [String]
@!attribute [rw] multi_az
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see [Minimizing Downtime: Multi-AZ][1] [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html @return [String]
@!attribute [rw] configuration_endpoint
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group. @return [Types::Endpoint]
@!attribute [rw] snapshot_retention_limit
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. @return [Integer]
@!attribute [rw] snapshot_window
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. <note markdown="1"> This parameter is only valid if the `Engine` parameter is `redis`. </note> @return [String]
@!attribute [rw] cluster_enabled
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` @return [Boolean]
@!attribute [rw] cache_node_type
The name of the compute and memory capacity node type for each node in the replication group. @return [String]
@!attribute [rw] auth_token_enabled
A flag that enables using an `AuthToken` (password) when issuing Redis commands. Default: `false` @return [Boolean]
@!attribute [rw] auth_token_last_modified_date
The date the auth token was last modified @return [Time]
@!attribute [rw] transit_encryption_enabled
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` @return [Boolean]
@!attribute [rw] at_rest_encryption_enabled
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` @return [Boolean]
@!attribute [rw] member_clusters_outpost_arns
The outpost ARNs of the replication group's member clusters. @return [Array<String>]
@!attribute [rw] kms_key_id
The ID of the KMS key used to encrypt the disk in the cluster. @return [String]
@!attribute [rw] arn
The ARN (Amazon Resource Name) of the replication group. @return [String]
@!attribute [rw] user_group_ids
The ID of the user group associated to the replication group. @return [Array<String>]
@!attribute [rw] log_delivery_configurations
Returns the destination, format and type of the logs. @return [Array<Types::LogDeliveryConfiguration>]
@!attribute [rw] replication_group_create_time
The date and time when the cluster was created. @return [Time]
@see docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ReplicationGroup AWS API Documentation
Constants
- SENSITIVE