blib/lib/Paws/RDS/DBCluster.pm untested

filter: Statementstmt 0.0% 0 / 67 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 68 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::RDS::DBCluster;
3 use Moose;
4 has ActivityStreamKinesisStreamName => (is => 'ro', isa => 'Str');
5 has ActivityStreamKmsKeyId => (is => 'ro', isa => 'Str');
6 has ActivityStreamMode => (is => 'ro', isa => 'Str');
7 has ActivityStreamStatus => (is => 'ro', isa => 'Str');
8 has AllocatedStorage => (is => 'ro', isa => 'Int');
9 has AssociatedRoles => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBClusterRole]', request_name => 'DBClusterRole', traits => ['NameInRequest']);
10 has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'AvailabilityZone', traits => ['NameInRequest']);
11 has BacktrackConsumedChangeRecords => (is => 'ro', isa => 'Int');
12 has BacktrackWindow => (is => 'ro', isa => 'Int');
13 has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
14 has Capacity => (is => 'ro', isa => 'Int');
15 has CharacterSetName => (is => 'ro', isa => 'Str');
16 has CloneGroupId => (is => 'ro', isa => 'Str');
17 has ClusterCreateTime => (is => 'ro', isa => 'Str');
18 has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
19 has CrossAccountClone => (is => 'ro', isa => 'Bool');
20 has CustomEndpoints => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
21 has DatabaseName => (is => 'ro', isa => 'Str');
22 has DBClusterArn => (is => 'ro', isa => 'Str');
23 has DBClusterIdentifier => (is => 'ro', isa => 'Str');
24 has DBClusterMembers => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBClusterMember]', request_name => 'DBClusterMember', traits => ['NameInRequest']);
25 has DBClusterOptionGroupMemberships => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBClusterOptionGroupStatus]', request_name => 'DBClusterOptionGroup', traits => ['NameInRequest']);
26 has DBClusterParameterGroup => (is => 'ro', isa => 'Str');
27 has DbClusterResourceId => (is => 'ro', isa => 'Str');
28 has DBSubnetGroup => (is => 'ro', isa => 'Str');
29 has DeletionProtection => (is => 'ro', isa => 'Bool');
30 has DomainMemberships => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DomainMembership]', request_name => 'DomainMembership', traits => ['NameInRequest']);
31 has EarliestBacktrackTime => (is => 'ro', isa => 'Str');
32 has EarliestRestorableTime => (is => 'ro', isa => 'Str');
33 has EnabledCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
34 has Endpoint => (is => 'ro', isa => 'Str');
35 has Engine => (is => 'ro', isa => 'Str');
36 has EngineMode => (is => 'ro', isa => 'Str');
37 has EngineVersion => (is => 'ro', isa => 'Str');
38 has GlobalWriteForwardingRequested => (is => 'ro', isa => 'Bool');
39 has GlobalWriteForwardingStatus => (is => 'ro', isa => 'Str');
40 has HostedZoneId => (is => 'ro', isa => 'Str');
41 has HttpEndpointEnabled => (is => 'ro', isa => 'Bool');
42 has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool');
43 has KmsKeyId => (is => 'ro', isa => 'Str');
44 has LatestRestorableTime => (is => 'ro', isa => 'Str');
45 has MasterUsername => (is => 'ro', isa => 'Str');
46 has MultiAZ => (is => 'ro', isa => 'Bool');
47 has PendingModifiedValues => (is => 'ro', isa => 'Paws::RDS::ClusterPendingModifiedValues');
48 has PercentProgress => (is => 'ro', isa => 'Str');
49 has Port => (is => 'ro', isa => 'Int');
50 has PreferredBackupWindow => (is => 'ro', isa => 'Str');
51 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
52 has ReaderEndpoint => (is => 'ro', isa => 'Str');
53 has ReadReplicaIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaIdentifier', traits => ['NameInRequest']);
54 has ReplicationSourceIdentifier => (is => 'ro', isa => 'Str');
55 has ScalingConfigurationInfo => (is => 'ro', isa => 'Paws::RDS::ScalingConfigurationInfo');
56 has Status => (is => 'ro', isa => 'Str');
57 has StorageEncrypted => (is => 'ro', isa => 'Bool');
58 has TagList => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]', request_name => 'Tag', traits => ['NameInRequest']);
59 has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RDS::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroupMembership', traits => ['NameInRequest']);
60  
61 1;
62  
63 ### main pod documentation begin ###
64  
65 =head1 NAME
66  
67 Paws::RDS::DBCluster
68  
69 =head1 USAGE
70  
71 This class represents one of two things:
72  
73 =head3 Arguments in a call to a service
74  
75 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
76 Each attribute should be used as a named argument in the calls that expect this type of object.
77  
78 As an example, if Att1 is expected to be a Paws::RDS::DBCluster object:
79  
80 $service_obj->Method(Att1 => { ActivityStreamKinesisStreamName => $value, ..., VpcSecurityGroups => $value });
81  
82 =head3 Results returned from an API call
83  
84 Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBCluster object:
85  
86 $result = $service_obj->Method(...);
87 $result->Att1->ActivityStreamKinesisStreamName
88  
89 =head1 DESCRIPTION
90  
91 Contains the details of an Amazon Aurora DB cluster.
92  
93 This data type is used as a response element in the
94 C<DescribeDBClusters>, C<StopDBCluster>, and C<StartDBCluster> actions.
95  
96 =head1 ATTRIBUTES
97  
98  
99 =head2 ActivityStreamKinesisStreamName => Str
100  
101 The name of the Amazon Kinesis data stream used for the database
102 activity stream.
103  
104  
105 =head2 ActivityStreamKmsKeyId => Str
106  
107 The Amazon Web Services KMS key identifier used for encrypting messages
108 in the database activity stream.
109  
110 The Amazon Web Services KMS key identifier is the key ARN, key ID,
111 alias ARN, or alias name for the Amazon Web Services KMS customer
112 master key (CMK).
113  
114  
115 =head2 ActivityStreamMode => Str
116  
117 The mode of the database activity stream. Database events such as a
118 change or access generate an activity stream event. The database
119 session can handle these events either synchronously or asynchronously.
120  
121  
122 =head2 ActivityStreamStatus => Str
123  
124 The status of the database activity stream.
125  
126  
127 =head2 AllocatedStorage => Int
128  
129 For all database engines except Amazon Aurora, C<AllocatedStorage>
130 specifies the allocated storage size in gibibytes (GiB). For Aurora,
131 C<AllocatedStorage> always returns 1, because Aurora DB cluster storage
132 size isn't fixed, but instead automatically adjusts as needed.
133  
134  
135 =head2 AssociatedRoles => ArrayRef[L<Paws::RDS::DBClusterRole>]
136  
137 Provides a list of the Amazon Web Services Identity and Access
138 Management (IAM) roles that are associated with the DB cluster. IAM
139 roles that are associated with a DB cluster grant permission for the DB
140 cluster to access other Amazon Web Services on your behalf.
141  
142  
143 =head2 AvailabilityZones => ArrayRef[Str|Undef]
144  
145 Provides the list of Availability Zones (AZs) where instances in the DB
146 cluster can be created.
147  
148  
149 =head2 BacktrackConsumedChangeRecords => Int
150  
151 The number of change records stored for Backtrack.
152  
153  
154 =head2 BacktrackWindow => Int
155  
156 The target backtrack window, in seconds. If this value is set to 0,
157 backtracking is disabled for the DB cluster. Otherwise, backtracking is
158 enabled.
159  
160  
161 =head2 BackupRetentionPeriod => Int
162  
163 Specifies the number of days for which automatic DB snapshots are
164 retained.
165  
166  
167 =head2 Capacity => Int
168  
169 The current capacity of an Aurora Serverless DB cluster. The capacity
170 is 0 (zero) when the cluster is paused.
171  
172 For more information about Aurora Serverless, see Using Amazon Aurora
173 Serverless
174 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)
175 in the I<Amazon Aurora User Guide>.
176  
177  
178 =head2 CharacterSetName => Str
179  
180 If present, specifies the name of the character set that this cluster
181 is associated with.
182  
183  
184 =head2 CloneGroupId => Str
185  
186 Identifies the clone group to which the DB cluster is associated.
187  
188  
189 =head2 ClusterCreateTime => Str
190  
191 Specifies the time when the DB cluster was created, in Universal
192 Coordinated Time (UTC).
193  
194  
195 =head2 CopyTagsToSnapshot => Bool
196  
197 Specifies whether tags are copied from the DB cluster to snapshots of
198 the DB cluster.
199  
200  
201 =head2 CrossAccountClone => Bool
202  
203 Specifies whether the DB cluster is a clone of a DB cluster owned by a
204 different Amazon Web Services account.
205  
206  
207 =head2 CustomEndpoints => ArrayRef[Str|Undef]
208  
209 Identifies all custom endpoints associated with the cluster.
210  
211  
212 =head2 DatabaseName => Str
213  
214 Contains the name of the initial database of this DB cluster that was
215 provided at create time, if one was specified when the DB cluster was
216 created. This same name is returned for the life of the DB cluster.
217  
218  
219 =head2 DBClusterArn => Str
220  
221 The Amazon Resource Name (ARN) for the DB cluster.
222  
223  
224 =head2 DBClusterIdentifier => Str
225  
226 Contains a user-supplied DB cluster identifier. This identifier is the
227 unique key that identifies a DB cluster.
228  
229  
230 =head2 DBClusterMembers => ArrayRef[L<Paws::RDS::DBClusterMember>]
231  
232 Provides the list of instances that make up the DB cluster.
233  
234  
235 =head2 DBClusterOptionGroupMemberships => ArrayRef[L<Paws::RDS::DBClusterOptionGroupStatus>]
236  
237 Provides the list of option group memberships for this DB cluster.
238  
239  
240 =head2 DBClusterParameterGroup => Str
241  
242 Specifies the name of the DB cluster parameter group for the DB
243 cluster.
244  
245  
246 =head2 DbClusterResourceId => Str
247  
248 The Amazon Web Services Region-unique, immutable identifier for the DB
249 cluster. This identifier is found in Amazon Web Services CloudTrail log
250 entries whenever the Amazon Web Services KMS CMK for the DB cluster is
251 accessed.
252  
253  
254 =head2 DBSubnetGroup => Str
255  
256 Specifies information on the subnet group associated with the DB
257 cluster, including the name, description, and subnets in the subnet
258 group.
259  
260  
261 =head2 DeletionProtection => Bool
262  
263 Indicates if the DB cluster has deletion protection enabled. The
264 database can't be deleted when deletion protection is enabled.
265  
266  
267 =head2 DomainMemberships => ArrayRef[L<Paws::RDS::DomainMembership>]
268  
269 The Active Directory Domain membership records associated with the DB
270 cluster.
271  
272  
273 =head2 EarliestBacktrackTime => Str
274  
275 The earliest time to which a DB cluster can be backtracked.
276  
277  
278 =head2 EarliestRestorableTime => Str
279  
280 The earliest time to which a database can be restored with
281 point-in-time restore.
282  
283  
284 =head2 EnabledCloudwatchLogsExports => ArrayRef[Str|Undef]
285  
286 A list of log types that this DB cluster is configured to export to
287 CloudWatch Logs.
288  
289 Log types vary by DB engine. For information about the log types for
290 each DB engine, see Amazon RDS Database Log Files
291 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html)
292 in the I<Amazon Aurora User Guide.>
293  
294  
295 =head2 Endpoint => Str
296  
297 Specifies the connection endpoint for the primary instance of the DB
298 cluster.
299  
300  
301 =head2 Engine => Str
302  
303 The name of the database engine to be used for this DB cluster.
304  
305  
306 =head2 EngineMode => Str
307  
308 The DB engine mode of the DB cluster, either C<provisioned>,
309 C<serverless>, C<parallelquery>, C<global>, or C<multimaster>.
310  
311 For more information, see CreateDBCluster
312 (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html).
313  
314  
315 =head2 EngineVersion => Str
316  
317 Indicates the database engine version.
318  
319  
320 =head2 GlobalWriteForwardingRequested => Bool
321  
322 Specifies whether you have requested to enable write forwarding for a
323 secondary cluster in an Aurora global database. Because write
324 forwarding takes time to enable, check the value of
325 C<GlobalWriteForwardingStatus> to confirm that the request has
326 completed before using the write forwarding feature for this cluster.
327  
328  
329 =head2 GlobalWriteForwardingStatus => Str
330  
331 Specifies whether a secondary cluster in an Aurora global database has
332 write forwarding enabled, not enabled, or is in the process of enabling
333 it.
334  
335  
336 =head2 HostedZoneId => Str
337  
338 Specifies the ID that Amazon Route 53 assigns when you create a hosted
339 zone.
340  
341  
342 =head2 HttpEndpointEnabled => Bool
343  
344 A value that indicates whether the HTTP endpoint for an Aurora
345 Serverless DB cluster is enabled.
346  
347 When enabled, the HTTP endpoint provides a connectionless web service
348 API for running SQL queries on the Aurora Serverless DB cluster. You
349 can also query your database from inside the RDS console with the query
350 editor.
351  
352 For more information, see Using the Data API for Aurora Serverless
353 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
354 in the I<Amazon Aurora User Guide>.
355  
356  
357 =head2 IAMDatabaseAuthenticationEnabled => Bool
358  
359 A value that indicates whether the mapping of Amazon Web Services
360 Identity and Access Management (IAM) accounts to database accounts is
361 enabled.
362  
363  
364 =head2 KmsKeyId => Str
365  
366 If C<StorageEncrypted> is enabled, the Amazon Web Services KMS key
367 identifier for the encrypted DB cluster.
368  
369 The Amazon Web Services KMS key identifier is the key ARN, key ID,
370 alias ARN, or alias name for the Amazon Web Services KMS customer
371 master key (CMK).
372  
373  
374 =head2 LatestRestorableTime => Str
375  
376 Specifies the latest time to which a database can be restored with
377 point-in-time restore.
378  
379  
380 =head2 MasterUsername => Str
381  
382 Contains the master username for the DB cluster.
383  
384  
385 =head2 MultiAZ => Bool
386  
387 Specifies whether the DB cluster has instances in multiple Availability
388 Zones.
389  
390  
391 =head2 PendingModifiedValues => L<Paws::RDS::ClusterPendingModifiedValues>
392  
393 A value that specifies that changes to the DB cluster are pending. This
394 element is only included when changes are pending. Specific changes are
395 identified by subelements.
396  
397  
398 =head2 PercentProgress => Str
399  
400 Specifies the progress of the operation as a percentage.
401  
402  
403 =head2 Port => Int
404  
405 Specifies the port that the database engine is listening on.
406  
407  
408 =head2 PreferredBackupWindow => Str
409  
410 Specifies the daily time range during which automated backups are
411 created if automated backups are enabled, as determined by the
412 C<BackupRetentionPeriod>.
413  
414  
415 =head2 PreferredMaintenanceWindow => Str
416  
417 Specifies the weekly time range during which system maintenance can
418 occur, in Universal Coordinated Time (UTC).
419  
420  
421 =head2 ReaderEndpoint => Str
422  
423 The reader endpoint for the DB cluster. The reader endpoint for a DB
424 cluster load-balances connections across the Aurora Replicas that are
425 available in a DB cluster. As clients request new connections to the
426 reader endpoint, Aurora distributes the connection requests among the
427 Aurora Replicas in the DB cluster. This functionality can help balance
428 your read workload across multiple Aurora Replicas in your DB cluster.
429  
430 If a failover occurs, and the Aurora Replica that you are connected to
431 is promoted to be the primary instance, your connection is dropped. To
432 continue sending your read workload to other Aurora Replicas in the
433 cluster, you can then reconnect to the reader endpoint.
434  
435  
436 =head2 ReadReplicaIdentifiers => ArrayRef[Str|Undef]
437  
438 Contains one or more identifiers of the read replicas associated with
439 this DB cluster.
440  
441  
442 =head2 ReplicationSourceIdentifier => Str
443  
444 Contains the identifier of the source DB cluster if this DB cluster is
445 a read replica.
446  
447  
448 =head2 ScalingConfigurationInfo => L<Paws::RDS::ScalingConfigurationInfo>
449  
450  
451  
452  
453 =head2 Status => Str
454  
455 Specifies the current state of this DB cluster.
456  
457  
458 =head2 StorageEncrypted => Bool
459  
460 Specifies whether the DB cluster is encrypted.
461  
462  
463 =head2 TagList => ArrayRef[L<Paws::RDS::Tag>]
464  
465  
466  
467  
468 =head2 VpcSecurityGroups => ArrayRef[L<Paws::RDS::VpcSecurityGroupMembership>]
469  
470 Provides a list of VPC security groups that the DB cluster belongs to.
471  
472  
473  
474 =head1 SEE ALSO
475  
476 This class forms part of L<Paws>, describing an object used in L<Paws::RDS>
477  
478 =head1 BUGS and CONTRIBUTIONS
479  
480 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
481  
482 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
483  
484 =cut
485