File Coverage

blib/lib/Paws/RDS/PromoteReadReplica.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	sub	time	code
1
2				package Paws::RDS::PromoteReadReplica;
3	1	1	562	use Moose;
	1		2
	1		8
4				has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
5				has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
6				has PreferredBackupWindow => (is => 'ro', isa => 'Str');
7
8	1	1	9613	use MooseX::ClassAttribute;
	1		3
	1		13
9
10				class_has _api_call => (isa => 'Str', is => 'ro', default => 'PromoteReadReplica');
11				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::PromoteReadReplicaResult');
12				class_has _result_key => (isa => 'Str', is => 'ro', default => 'PromoteReadReplicaResult');
13				1;
14
15				### main pod documentation begin ###
16
17				=head1 NAME
18
19				Paws::RDS::PromoteReadReplica - Arguments for method PromoteReadReplica on Paws::RDS
20
21				=head1 DESCRIPTION
22
23				This class represents the parameters used for calling the method PromoteReadReplica on the
24				Amazon Relational Database Service service. Use the attributes of this class
25				as arguments to method PromoteReadReplica.
26
27				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PromoteReadReplica.
28
29				As an example:
30
31				$service_obj->PromoteReadReplica(Att1 => $value1, Att2 => $value2, ...);
32
33				Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
34
35				=head1 ATTRIBUTES
36
37
38				=head2 BackupRetentionPeriod => Int
39
40				The number of days to retain automated backups. Setting this parameter
41				to a positive number enables backups. Setting this parameter to 0
42				disables automated backups.
43
44				Default: 1
45
46				Constraints:
47
48				=over
49
50				=item *
51
52				Must be a value from 0 to 8
53
54				=back
55
56
57
58
59				=head2 B<REQUIRED> DBInstanceIdentifier => Str
60
61				The DB instance identifier. This value is stored as a lowercase string.
62
63				Constraints:
64
65				=over
66
67				=item *
68
69				Must be the identifier for an existing Read Replica DB instance
70
71				=item *
72
73				Must contain from 1 to 63 alphanumeric characters or hyphens
74
75				=item *
76
77				First character must be a letter
78
79				=item *
80
81				Cannot end with a hyphen or contain two consecutive hyphens
82
83				=back
84
85				Example: C<mydbinstance>
86
87
88
89				=head2 PreferredBackupWindow => Str
90
91				The daily time range during which automated backups are created if
92				automated backups are enabled, using the C<BackupRetentionPeriod>
93				parameter.
94
95				Default: A 30-minute window selected at random from an 8-hour block of
96				time per region. To see the time blocks available, see Adjusting the
97				Preferred Maintenance Window in the I<Amazon RDS User Guide.>
98
99				Constraints:
100
101				=over
102
103				=item *
104
105				Must be in the format C<hh24:mi-hh24:mi>.
106
107				=item *
108
109				Times should be in Universal Coordinated Time (UTC).
110
111				=item *
112
113				Must not conflict with the preferred maintenance window.
114
115				=item *
116
117				Must be at least 30 minutes.
118
119				=back
120
121
122
123
124
125				=head1 SEE ALSO
126
127				This class forms part of L<Paws>, documenting arguments for method PromoteReadReplica in L<Paws::RDS>
128
129				=head1 BUGS and CONTRIBUTIONS
130
131				The source code is located here: https://github.com/pplu/aws-sdk-perl
132
133				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
134
135				=cut
136