« blib/lib/Paws/ElastiCache/RemoveTagsFromResource.pm
↑ Summary
blib/lib/Paws/ElastiCache/ReplicationGroupMessage.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElastiCache::ReplicationGroup; | ||
| 3 | use Moose; | ||
| 4 | has ARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has AtRestEncryptionEnabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has AuthTokenEnabled => (is => 'ro', isa => 'Bool'); | ||
| 7 | has AuthTokenLastModifiedDate => (is => 'ro', isa => 'Str'); | ||
| 8 | has AutomaticFailover => (is => 'ro', isa => 'Str'); | ||
| 9 | has CacheNodeType => (is => 'ro', isa => 'Str'); | ||
| 10 | has ClusterEnabled => (is => 'ro', isa => 'Bool'); | ||
| 11 | has ConfigurationEndpoint => (is => 'ro', isa => 'Paws::ElastiCache::Endpoint'); | ||
| 12 | has Description => (is => 'ro', isa => 'Str'); | ||
| 13 | has GlobalReplicationGroupInfo => (is => 'ro', isa => 'Paws::ElastiCache::GlobalReplicationGroupInfo'); | ||
| 14 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 15 | has LogDeliveryConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::LogDeliveryConfiguration]', request_name => 'LogDeliveryConfiguration', traits => ['NameInRequest']); | ||
| 16 | has MemberClusters => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ClusterId', traits => ['NameInRequest']); | ||
| 17 | has MemberClustersOutpostArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReplicationGroupOutpostArn', traits => ['NameInRequest']); | ||
| 18 | has MultiAZ => (is => 'ro', isa => 'Str'); | ||
| 19 | has NodeGroups => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::NodeGroup]', request_name => 'NodeGroup', traits => ['NameInRequest']); | ||
| 20 | has PendingModifiedValues => (is => 'ro', isa => 'Paws::ElastiCache::ReplicationGroupPendingModifiedValues'); | ||
| 21 | has ReplicationGroupId => (is => 'ro', isa => 'Str'); | ||
| 22 | has SnapshotRetentionLimit => (is => 'ro', isa => 'Int'); | ||
| 23 | has SnapshottingClusterId => (is => 'ro', isa => 'Str'); | ||
| 24 | has SnapshotWindow => (is => 'ro', isa => 'Str'); | ||
| 25 | has Status => (is => 'ro', isa => 'Str'); | ||
| 26 | has TransitEncryptionEnabled => (is => 'ro', isa => 'Bool'); | ||
| 27 | has UserGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 28 | |||
| 29 | 1; | ||
| 30 | |||
| 31 | ### main pod documentation begin ### | ||
| 32 | |||
| 33 | =head1 NAME | ||
| 34 | |||
| 35 | Paws::ElastiCache::ReplicationGroup | ||
| 36 | |||
| 37 | =head1 USAGE | ||
| 38 | |||
| 39 | This class represents one of two things: | ||
| 40 | |||
| 41 | =head3 Arguments in a call to a service | ||
| 42 | |||
| 43 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 44 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 45 | |||
| 46 | As an example, if Att1 is expected to be a Paws::ElastiCache::ReplicationGroup object: | ||
| 47 | |||
| 48 | $service_obj->Method(Att1 => { ARN => $value, ..., UserGroupIds => $value }); | ||
| 49 | |||
| 50 | =head3 Results returned from an API call | ||
| 51 | |||
| 52 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElastiCache::ReplicationGroup object: | ||
| 53 | |||
| 54 | $result = $service_obj->Method(...); | ||
| 55 | $result->Att1->ARN | ||
| 56 | |||
| 57 | =head1 DESCRIPTION | ||
| 58 | |||
| 59 | Contains all of the attributes of a specific Redis replication group. | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 ARN => Str | ||
| 65 | |||
| 66 | The ARN (Amazon Resource Name) of the replication group. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 AtRestEncryptionEnabled => Bool | ||
| 70 | |||
| 71 | A flag that enables encryption at-rest when set to C<true>. | ||
| 72 | |||
| 73 | You cannot modify the value of C<AtRestEncryptionEnabled> after the | ||
| 74 | cluster is created. To enable encryption at-rest on a cluster you must | ||
| 75 | set C<AtRestEncryptionEnabled> to C<true> when you create a cluster. | ||
| 76 | |||
| 77 | B<Required:> Only available when creating a replication group in an | ||
| 78 | Amazon VPC using redis version C<3.2.6>, C<4.x> or later. | ||
| 79 | |||
| 80 | Default: C<false> | ||
| 81 | |||
| 82 | |||
| 83 | =head2 AuthTokenEnabled => Bool | ||
| 84 | |||
| 85 | A flag that enables using an C<AuthToken> (password) when issuing Redis | ||
| 86 | commands. | ||
| 87 | |||
| 88 | Default: C<false> | ||
| 89 | |||
| 90 | |||
| 91 | =head2 AuthTokenLastModifiedDate => Str | ||
| 92 | |||
| 93 | The date the auth token was last modified | ||
| 94 | |||
| 95 | |||
| 96 | =head2 AutomaticFailover => Str | ||
| 97 | |||
| 98 | Indicates the status of automatic failover for this Redis replication | ||
| 99 | group. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 CacheNodeType => Str | ||
| 103 | |||
| 104 | The name of the compute and memory capacity node type for each node in | ||
| 105 | the replication group. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 ClusterEnabled => Bool | ||
| 109 | |||
| 110 | A flag indicating whether or not this replication group is cluster | ||
| 111 | enabled; i.e., whether its data can be partitioned across multiple | ||
| 112 | shards (API/CLI: node groups). | ||
| 113 | |||
| 114 | Valid values: C<true> | C<false> | ||
| 115 | |||
| 116 | |||
| 117 | =head2 ConfigurationEndpoint => L<Paws::ElastiCache::Endpoint> | ||
| 118 | |||
| 119 | The configuration endpoint for this replication group. Use the | ||
| 120 | configuration endpoint to connect to this replication group. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 Description => Str | ||
| 124 | |||
| 125 | The user supplied description of the replication group. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 GlobalReplicationGroupInfo => L<Paws::ElastiCache::GlobalReplicationGroupInfo> | ||
| 129 | |||
| 130 | The name of the Global datastore and role of this replication group in | ||
| 131 | the Global datastore. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 KmsKeyId => Str | ||
| 135 | |||
| 136 | The ID of the KMS key used to encrypt the disk in the cluster. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 LogDeliveryConfigurations => ArrayRef[L<Paws::ElastiCache::LogDeliveryConfiguration>] | ||
| 140 | |||
| 141 | Returns the destination, format and type of the logs. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 MemberClusters => ArrayRef[Str|Undef] | ||
| 145 | |||
| 146 | The names of all the cache clusters that are part of this replication | ||
| 147 | group. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 MemberClustersOutpostArns => ArrayRef[Str|Undef] | ||
| 151 | |||
| 152 | The outpost ARNs of the replication group's member clusters. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 MultiAZ => Str | ||
| 156 | |||
| 157 | A flag indicating if you have Multi-AZ enabled to enhance fault | ||
| 158 | tolerance. For more information, see Minimizing Downtime: Multi-AZ | ||
| 159 | (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html) | ||
| 160 | |||
| 161 | |||
| 162 | =head2 NodeGroups => ArrayRef[L<Paws::ElastiCache::NodeGroup>] | ||
| 163 | |||
| 164 | A list of node groups in this replication group. For Redis (cluster | ||
| 165 | mode disabled) replication groups, this is a single-element list. For | ||
| 166 | Redis (cluster mode enabled) replication groups, the list contains an | ||
| 167 | entry for each node group (shard). | ||
| 168 | |||
| 169 | |||
| 170 | =head2 PendingModifiedValues => L<Paws::ElastiCache::ReplicationGroupPendingModifiedValues> | ||
| 171 | |||
| 172 | A group of settings to be applied to the replication group, either | ||
| 173 | immediately or during the next maintenance window. | ||
| 174 | |||
| 175 | |||
| 176 | =head2 ReplicationGroupId => Str | ||
| 177 | |||
| 178 | The identifier for the replication group. | ||
| 179 | |||
| 180 | |||
| 181 | =head2 SnapshotRetentionLimit => Int | ||
| 182 | |||
| 183 | The number of days for which ElastiCache retains automatic cluster | ||
| 184 | snapshots before deleting them. For example, if you set | ||
| 185 | C<SnapshotRetentionLimit> to 5, a snapshot that was taken today is | ||
| 186 | retained for 5 days before being deleted. | ||
| 187 | |||
| 188 | If the value of C<SnapshotRetentionLimit> is set to zero (0), backups | ||
| 189 | are turned off. | ||
| 190 | |||
| 191 | |||
| 192 | =head2 SnapshottingClusterId => Str | ||
| 193 | |||
| 194 | The cluster ID that is used as the daily snapshot source for the | ||
| 195 | replication group. | ||
| 196 | |||
| 197 | |||
| 198 | =head2 SnapshotWindow => Str | ||
| 199 | |||
| 200 | The daily time range (in UTC) during which ElastiCache begins taking a | ||
| 201 | daily snapshot of your node group (shard). | ||
| 202 | |||
| 203 | Example: C<05:00-09:00> | ||
| 204 | |||
| 205 | If you do not specify this parameter, ElastiCache automatically chooses | ||
| 206 | an appropriate time range. | ||
| 207 | |||
| 208 | This parameter is only valid if the C<Engine> parameter is C<redis>. | ||
| 209 | |||
| 210 | |||
| 211 | =head2 Status => Str | ||
| 212 | |||
| 213 | The current state of this replication group - C<creating>, | ||
| 214 | C<available>, C<modifying>, C<deleting>, C<create-failed>, | ||
| 215 | C<snapshotting>. | ||
| 216 | |||
| 217 | |||
| 218 | =head2 TransitEncryptionEnabled => Bool | ||
| 219 | |||
| 220 | A flag that enables in-transit encryption when set to C<true>. | ||
| 221 | |||
| 222 | You cannot modify the value of C<TransitEncryptionEnabled> after the | ||
| 223 | cluster is created. To enable in-transit encryption on a cluster you | ||
| 224 | must set C<TransitEncryptionEnabled> to C<true> when you create a | ||
| 225 | cluster. | ||
| 226 | |||
| 227 | B<Required:> Only available when creating a replication group in an | ||
| 228 | Amazon VPC using redis version C<3.2.6>, C<4.x> or later. | ||
| 229 | |||
| 230 | Default: C<false> | ||
| 231 | |||
| 232 | |||
| 233 | =head2 UserGroupIds => ArrayRef[Str|Undef] | ||
| 234 | |||
| 235 | The list of user group IDs that have access to the replication group. | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | =head1 SEE ALSO | ||
| 240 | |||
| 241 | This class forms part of L<Paws>, describing an object used in L<Paws::ElastiCache> | ||
| 242 | |||
| 243 | =head1 BUGS and CONTRIBUTIONS | ||
| 244 | |||
| 245 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 246 | |||
| 247 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 248 | |||
| 249 | =cut | ||
| 250 |