NAME
Paws::ElastiCache::ReplicationGroup
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::ElastiCache::ReplicationGroup object:
$service_obj->Method(Att1 => { ARN => $value, ..., UserGroupIds => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::ElastiCache::ReplicationGroup object:
$result = $service_obj->Method(...);
$result->Att1->ARNDESCRIPTION
Contains all of the attributes of a specific Redis replication group.
ATTRIBUTES
ARN => Str
The ARN (Amazon Resource Name) of the replication group.
AtRestEncryptionEnabled => Bool
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
AuthTokenEnabled => Bool
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
AuthTokenLastModifiedDate => Str
The date the auth token was last modified
AutomaticFailover => Str
Indicates the status of automatic failover for this Redis replication group.
CacheNodeType => Str
The name of the compute and memory capacity node type for each node in the replication group.
ClusterEnabled => Bool
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
ConfigurationEndpoint => Paws::ElastiCache::Endpoint
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Description => Str
The user supplied description of the replication group.
GlobalReplicationGroupInfo => Paws::ElastiCache::GlobalReplicationGroupInfo
The name of the Global datastore and role of this replication group in the Global datastore.
KmsKeyId => Str
The ID of the KMS key used to encrypt the disk in the cluster.
LogDeliveryConfigurations => ArrayRef[Paws::ElastiCache::LogDeliveryConfiguration]
Returns the destination, format and type of the logs.
MemberClusters => ArrayRef[Str|Undef]
The names of all the cache clusters that are part of this replication group.
MemberClustersOutpostArns => ArrayRef[Str|Undef]
The outpost ARNs of the replication group's member clusters.
MultiAZ => Str
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html)
NodeGroups => ArrayRef[Paws::ElastiCache::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).
PendingModifiedValues => Paws::ElastiCache::ReplicationGroupPendingModifiedValues
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
ReplicationGroupId => Str
The identifier for the replication group.
SnapshotRetentionLimit => Int
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.
SnapshottingClusterId => Str
The cluster ID that is used as the daily snapshot source for the replication group.
SnapshotWindow => Str
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.
Status => Str
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
TransitEncryptionEnabled => Bool
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
UserGroupIds => ArrayRef[Str|Undef]
The list of user group IDs that have access to the replication group.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::ElastiCache
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues