File Coverage

blib/lib/Paws/RDS/DBInstance.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::RDS::DBInstance;
2 1     1   314 use Moose;
  1     1   2  
  1         7  
  1         493  
  1         2  
  1         8  
3             has AllocatedStorage => (is => 'ro', isa => 'Int');
4             has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool');
5             has AvailabilityZone => (is => 'ro', isa => 'Str');
6             has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
7             has CACertificateIdentifier => (is => 'ro', isa => 'Str');
8             has CharacterSetName => (is => 'ro', isa => 'Str');
9             has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
10             has DBClusterIdentifier => (is => 'ro', isa => 'Str');
11             has DBInstanceArn => (is => 'ro', isa => 'Str');
12             has DBInstanceClass => (is => 'ro', isa => 'Str');
13             has DBInstanceIdentifier => (is => 'ro', isa => 'Str');
14             has DbInstancePort => (is => 'ro', isa => 'Int');
15             has DBInstanceStatus => (is => 'ro', isa => 'Str');
16             has DbiResourceId => (is => 'ro', isa => 'Str');
17             has DBName => (is => 'ro', isa => 'Str');
18             has DBParameterGroups => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBParameterGroupStatus]', request_name => 'DBParameterGroup', traits => ['NameInRequest']);
19             has DBSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBSecurityGroupMembership]', request_name => 'DBSecurityGroup', traits => ['NameInRequest']);
20             has DBSubnetGroup => (is => 'ro', isa => 'Paws::RDS::DBSubnetGroup');
21             has DomainMemberships => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DomainMembership]', request_name => 'DomainMembership', traits => ['NameInRequest']);
22             has Endpoint => (is => 'ro', isa => 'Paws::RDS::Endpoint');
23             has Engine => (is => 'ro', isa => 'Str');
24             has EngineVersion => (is => 'ro', isa => 'Str');
25             has EnhancedMonitoringResourceArn => (is => 'ro', isa => 'Str');
26             has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool');
27             has InstanceCreateTime => (is => 'ro', isa => 'Str');
28             has Iops => (is => 'ro', isa => 'Int');
29             has KmsKeyId => (is => 'ro', isa => 'Str');
30             has LatestRestorableTime => (is => 'ro', isa => 'Str');
31             has LicenseModel => (is => 'ro', isa => 'Str');
32             has MasterUsername => (is => 'ro', isa => 'Str');
33             has MonitoringInterval => (is => 'ro', isa => 'Int');
34             has MonitoringRoleArn => (is => 'ro', isa => 'Str');
35             has MultiAZ => (is => 'ro', isa => 'Bool');
36             has OptionGroupMemberships => (is => 'ro', isa => 'ArrayRef[Paws::RDS::OptionGroupMembership]', request_name => 'OptionGroupMembership', traits => ['NameInRequest']);
37             has PendingModifiedValues => (is => 'ro', isa => 'Paws::RDS::PendingModifiedValues');
38             has PerformanceInsightsEnabled => (is => 'ro', isa => 'Bool');
39             has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str');
40             has PreferredBackupWindow => (is => 'ro', isa => 'Str');
41             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
42             has PromotionTier => (is => 'ro', isa => 'Int');
43             has PubliclyAccessible => (is => 'ro', isa => 'Bool');
44             has ReadReplicaDBClusterIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaDBClusterIdentifier', traits => ['NameInRequest']);
45             has ReadReplicaDBInstanceIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaDBInstanceIdentifier', traits => ['NameInRequest']);
46             has ReadReplicaSourceDBInstanceIdentifier => (is => 'ro', isa => 'Str');
47             has SecondaryAvailabilityZone => (is => 'ro', isa => 'Str');
48             has StatusInfos => (is => 'ro', isa => 'ArrayRef[Paws::RDS::DBInstanceStatusInfo]', request_name => 'DBInstanceStatusInfo', traits => ['NameInRequest']);
49             has StorageEncrypted => (is => 'ro', isa => 'Bool');
50             has StorageType => (is => 'ro', isa => 'Str');
51             has TdeCredentialArn => (is => 'ro', isa => 'Str');
52             has Timezone => (is => 'ro', isa => 'Str');
53             has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::RDS::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroupMembership', traits => ['NameInRequest']);
54             1;
55              
56             ### main pod documentation begin ###
57              
58             =head1 NAME
59              
60             Paws::RDS::DBInstance
61              
62             =head1 USAGE
63              
64             This class represents one of two things:
65              
66             =head3 Arguments in a call to a service
67              
68             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
69             Each attribute should be used as a named argument in the calls that expect this type of object.
70              
71             As an example, if Att1 is expected to be a Paws::RDS::DBInstance object:
72              
73             $service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcSecurityGroups => $value });
74              
75             =head3 Results returned from an API call
76              
77             Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBInstance object:
78              
79             $result = $service_obj->Method(...);
80             $result->Att1->AllocatedStorage
81              
82             =head1 DESCRIPTION
83              
84             Contains the result of a successful invocation of the following
85             actions:
86              
87             =over
88              
89             =item *
90              
91             CreateDBInstance
92              
93             =item *
94              
95             DeleteDBInstance
96              
97             =item *
98              
99             ModifyDBInstance
100              
101             =item *
102              
103             StopDBInstance
104              
105             =item *
106              
107             StartDBInstance
108              
109             =back
110              
111             This data type is used as a response element in the DescribeDBInstances
112             action.
113              
114             =head1 ATTRIBUTES
115              
116              
117             =head2 AllocatedStorage => Int
118              
119             Specifies the allocated storage size specified in gigabytes.
120              
121              
122             =head2 AutoMinorVersionUpgrade => Bool
123              
124             Indicates that minor version patches are applied automatically.
125              
126              
127             =head2 AvailabilityZone => Str
128              
129             Specifies the name of the Availability Zone the DB instance is located
130             in.
131              
132              
133             =head2 BackupRetentionPeriod => Int
134              
135             Specifies the number of days for which automatic DB snapshots are
136             retained.
137              
138              
139             =head2 CACertificateIdentifier => Str
140              
141             The identifier of the CA certificate for this DB instance.
142              
143              
144             =head2 CharacterSetName => Str
145              
146             If present, specifies the name of the character set that this instance
147             is associated with.
148              
149              
150             =head2 CopyTagsToSnapshot => Bool
151              
152             Specifies whether tags are copied from the DB instance to snapshots of
153             the DB instance.
154              
155              
156             =head2 DBClusterIdentifier => Str
157              
158             If the DB instance is a member of a DB cluster, contains the name of
159             the DB cluster that the DB instance is a member of.
160              
161              
162             =head2 DBInstanceArn => Str
163              
164             The Amazon Resource Name (ARN) for the DB instance.
165              
166              
167             =head2 DBInstanceClass => Str
168              
169             Contains the name of the compute and memory capacity class of the DB
170             instance.
171              
172              
173             =head2 DBInstanceIdentifier => Str
174              
175             Contains a user-supplied database identifier. This identifier is the
176             unique key that identifies a DB instance.
177              
178              
179             =head2 DbInstancePort => Int
180              
181             Specifies the port that the DB instance listens on. If the DB instance
182             is part of a DB cluster, this can be a different port than the DB
183             cluster port.
184              
185              
186             =head2 DBInstanceStatus => Str
187              
188             Specifies the current state of this database.
189              
190              
191             =head2 DbiResourceId => Str
192              
193             The region-unique, immutable identifier for the DB instance. This
194             identifier is found in AWS CloudTrail log entries whenever the KMS key
195             for the DB instance is accessed.
196              
197              
198             =head2 DBName => Str
199              
200             The meaning of this parameter differs according to the database engine
201             you use. For example, this value returns MySQL, MariaDB, or PostgreSQL
202             information when returning values from CreateDBInstanceReadReplica
203             since Read Replicas are only supported for these engines.
204              
205             B<MySQL, MariaDB, SQL Server, PostgreSQL>
206              
207             Contains the name of the initial database of this instance that was
208             provided at create time, if one was specified when the DB instance was
209             created. This same name is returned for the life of the DB instance.
210              
211             Type: String
212              
213             B<Oracle>
214              
215             Contains the Oracle System ID (SID) of the created DB instance. Not
216             shown when the returned parameters do not apply to an Oracle DB
217             instance.
218              
219              
220             =head2 DBParameterGroups => ArrayRef[L<Paws::RDS::DBParameterGroupStatus>]
221              
222             Provides the list of DB parameter groups applied to this DB instance.
223              
224              
225             =head2 DBSecurityGroups => ArrayRef[L<Paws::RDS::DBSecurityGroupMembership>]
226              
227             Provides List of DB security group elements containing only
228             C<DBSecurityGroup.Name> and C<DBSecurityGroup.Status> subelements.
229              
230              
231             =head2 DBSubnetGroup => L<Paws::RDS::DBSubnetGroup>
232              
233             Specifies information on the subnet group associated with the DB
234             instance, including the name, description, and subnets in the subnet
235             group.
236              
237              
238             =head2 DomainMemberships => ArrayRef[L<Paws::RDS::DomainMembership>]
239              
240             The Active Directory Domain membership records associated with the DB
241             instance.
242              
243              
244             =head2 Endpoint => L<Paws::RDS::Endpoint>
245              
246             Specifies the connection endpoint.
247              
248              
249             =head2 Engine => Str
250              
251             Provides the name of the database engine to be used for this DB
252             instance.
253              
254              
255             =head2 EngineVersion => Str
256              
257             Indicates the database engine version.
258              
259              
260             =head2 EnhancedMonitoringResourceArn => Str
261              
262             The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream
263             that receives the Enhanced Monitoring metrics data for the DB instance.
264              
265              
266             =head2 IAMDatabaseAuthenticationEnabled => Bool
267              
268             True if mapping of AWS Identity and Access Management (IAM) accounts to
269             database accounts is enabled; otherwise false.
270              
271             IAM database authentication can be enabled for the following database
272             engines
273              
274             =over
275              
276             =item *
277              
278             For MySQL 5.6, minor version 5.6.34 or higher
279              
280             =item *
281              
282             For MySQL 5.7, minor version 5.7.16 or higher
283              
284             =item *
285              
286             Aurora 5.6 or higher. To enable IAM database authentication for Aurora,
287             see DBCluster Type.
288              
289             =back
290              
291              
292              
293             =head2 InstanceCreateTime => Str
294              
295             Provides the date and time the DB instance was created.
296              
297              
298             =head2 Iops => Int
299              
300             Specifies the Provisioned IOPS (I/O operations per second) value.
301              
302              
303             =head2 KmsKeyId => Str
304              
305             If C<StorageEncrypted> is true, the KMS key identifier for the
306             encrypted DB instance.
307              
308              
309             =head2 LatestRestorableTime => Str
310              
311             Specifies the latest time to which a database can be restored with
312             point-in-time restore.
313              
314              
315             =head2 LicenseModel => Str
316              
317             License model information for this DB instance.
318              
319              
320             =head2 MasterUsername => Str
321              
322             Contains the master username for the DB instance.
323              
324              
325             =head2 MonitoringInterval => Int
326              
327             The interval, in seconds, between points when Enhanced Monitoring
328             metrics are collected for the DB instance.
329              
330              
331             =head2 MonitoringRoleArn => Str
332              
333             The ARN for the IAM role that permits RDS to send Enhanced Monitoring
334             metrics to CloudWatch Logs.
335              
336              
337             =head2 MultiAZ => Bool
338              
339             Specifies if the DB instance is a Multi-AZ deployment.
340              
341              
342             =head2 OptionGroupMemberships => ArrayRef[L<Paws::RDS::OptionGroupMembership>]
343              
344             Provides the list of option group memberships for this DB instance.
345              
346              
347             =head2 PendingModifiedValues => L<Paws::RDS::PendingModifiedValues>
348              
349             Specifies that changes to the DB instance are pending. This element is
350             only included when changes are pending. Specific changes are identified
351             by subelements.
352              
353              
354             =head2 PerformanceInsightsEnabled => Bool
355              
356            
357              
358              
359             =head2 PerformanceInsightsKMSKeyId => Str
360              
361            
362              
363              
364             =head2 PreferredBackupWindow => Str
365              
366             Specifies the daily time range during which automated backups are
367             created if automated backups are enabled, as determined by the
368             C<BackupRetentionPeriod>.
369              
370              
371             =head2 PreferredMaintenanceWindow => Str
372              
373             Specifies the weekly time range during which system maintenance can
374             occur, in Universal Coordinated Time (UTC).
375              
376              
377             =head2 PromotionTier => Int
378              
379             A value that specifies the order in which an Aurora Replica is promoted
380             to the primary instance after a failure of the existing primary
381             instance. For more information, see Fault Tolerance for an Aurora DB
382             Cluster.
383              
384              
385             =head2 PubliclyAccessible => Bool
386              
387             Specifies the accessibility options for the DB instance. A value of
388             true specifies an Internet-facing instance with a publicly resolvable
389             DNS name, which resolves to a public IP address. A value of false
390             specifies an internal instance with a DNS name that resolves to a
391             private IP address.
392              
393             Default: The default behavior varies depending on whether a VPC has
394             been requested or not. The following list shows the default behavior in
395             each case.
396              
397             =over
398              
399             =item *
400              
401             B<Default VPC:>true
402              
403             =item *
404              
405             B<VPC:>false
406              
407             =back
408              
409             If no DB subnet group has been specified as part of the request and the
410             PubliclyAccessible value has not been set, the DB instance will be
411             publicly accessible. If a specific DB subnet group has been specified
412             as part of the request and the PubliclyAccessible value has not been
413             set, the DB instance will be private.
414              
415              
416             =head2 ReadReplicaDBClusterIdentifiers => ArrayRef[Str|Undef]
417              
418             Contains one or more identifiers of Aurora DB clusters that are Read
419             Replicas of this DB instance.
420              
421              
422             =head2 ReadReplicaDBInstanceIdentifiers => ArrayRef[Str|Undef]
423              
424             Contains one or more identifiers of the Read Replicas associated with
425             this DB instance.
426              
427              
428             =head2 ReadReplicaSourceDBInstanceIdentifier => Str
429              
430             Contains the identifier of the source DB instance if this DB instance
431             is a Read Replica.
432              
433              
434             =head2 SecondaryAvailabilityZone => Str
435              
436             If present, specifies the name of the secondary Availability Zone for a
437             DB instance with multi-AZ support.
438              
439              
440             =head2 StatusInfos => ArrayRef[L<Paws::RDS::DBInstanceStatusInfo>]
441              
442             The status of a Read Replica. If the instance is not a Read Replica,
443             this will be blank.
444              
445              
446             =head2 StorageEncrypted => Bool
447              
448             Specifies whether the DB instance is encrypted.
449              
450              
451             =head2 StorageType => Str
452              
453             Specifies the storage type associated with DB instance.
454              
455              
456             =head2 TdeCredentialArn => Str
457              
458             The ARN from the key store with which the instance is associated for
459             TDE encryption.
460              
461              
462             =head2 Timezone => Str
463              
464             The time zone of the DB instance. In most cases, the C<Timezone>
465             element is empty. C<Timezone> content appears only for Microsoft SQL
466             Server DB instances that were created with a time zone specified.
467              
468              
469             =head2 VpcSecurityGroups => ArrayRef[L<Paws::RDS::VpcSecurityGroupMembership>]
470              
471             Provides a list of VPC security group elements that the DB instance
472             belongs to.
473              
474              
475              
476             =head1 SEE ALSO
477              
478             This class forms part of L<Paws>, describing an object used in L<Paws::RDS>
479              
480             =head1 BUGS and CONTRIBUTIONS
481              
482             The source code is located here: https://github.com/pplu/aws-sdk-perl
483              
484             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
485              
486             =cut
487