« blib/lib/Paws/RDS/PendingMaintenanceActionsMessage.pm
↑ Summary
blib/lib/Paws/RDS/PromoteReadReplicaDBCluster.pm »
| 1 | |||
| 2 | package Paws::RDS::PromoteReadReplica; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::RDS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method PromoteReadReplica on the | ||
| 24 | L<Amazon Relational Database Service|Paws::RDS> 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 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $rds = Paws->service('RDS'); | ||
| 32 | # To promote a read replica | ||
| 33 | # This example promotes the specified read replica and sets its backup retention | ||
| 34 | # period and preferred backup window. | ||
| 35 | my $PromoteReadReplicaResult = $rds->PromoteReadReplica( | ||
| 36 | 'BackupRetentionPeriod' => 1, | ||
| 37 | 'DBInstanceIdentifier' => 'mydbreadreplica', | ||
| 38 | 'PreferredBackupWindow' => '03:30-04:00' | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $DBInstance = $PromoteReadReplicaResult->DBInstance; | ||
| 43 | |||
| 44 | # Returns a L<Paws::RDS::PromoteReadReplicaResult> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/PromoteReadReplica> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 BackupRetentionPeriod => Int | ||
| 53 | |||
| 54 | The number of days for which automated backups are retained. Setting | ||
| 55 | this parameter to a positive number enables backups. Setting this | ||
| 56 | parameter to 0 disables automated backups. | ||
| 57 | |||
| 58 | Default: 1 | ||
| 59 | |||
| 60 | Constraints: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | Must be a value from 0 to 35. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | Can't be set to 0 if the DB instance is a source to read replicas. | ||
| 71 | |||
| 72 | =back | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> DBInstanceIdentifier => Str | ||
| 78 | |||
| 79 | The DB instance identifier. This value is stored as a lowercase string. | ||
| 80 | |||
| 81 | Constraints: | ||
| 82 | |||
| 83 | =over | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | Must match the identifier of an existing read replica DB instance. | ||
| 88 | |||
| 89 | =back | ||
| 90 | |||
| 91 | Example: C<mydbinstance> | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 PreferredBackupWindow => Str | ||
| 96 | |||
| 97 | The daily time range during which automated backups are created if | ||
| 98 | automated backups are enabled, using the C<BackupRetentionPeriod> | ||
| 99 | parameter. | ||
| 100 | |||
| 101 | The default is a 30-minute window selected at random from an 8-hour | ||
| 102 | block of time for each Amazon Web Services Region. To see the time | ||
| 103 | blocks available, see Adjusting the Preferred Maintenance Window | ||
| 104 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) | ||
| 105 | in the I<Amazon RDS User Guide.> | ||
| 106 | |||
| 107 | Constraints: | ||
| 108 | |||
| 109 | =over | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | Must be in the format C<hh24:mi-hh24:mi>. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | Must be in Universal Coordinated Time (UTC). | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | Must not conflict with the preferred maintenance window. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | Must be at least 30 minutes. | ||
| 126 | |||
| 127 | =back | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, documenting arguments for method PromoteReadReplica in L<Paws::RDS> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |