« blib/lib/Paws/Lightsail/UpdateLoadBalancerAttributeResult.pm
↑ Summary
blib/lib/Paws/Lightsail/UpdateRelationalDatabaseParameters.pm »
| 1 | |||
| 2 | package Paws::Lightsail::UpdateRelationalDatabase; | ||
| 3 | use Moose; | ||
| 4 | has ApplyImmediately => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'applyImmediately' ); | ||
| 5 | has CaCertificateIdentifier => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'caCertificateIdentifier' ); | ||
| 6 | has DisableBackupRetention => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'disableBackupRetention' ); | ||
| 7 | has EnableBackupRetention => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableBackupRetention' ); | ||
| 8 | has MasterUserPassword => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'masterUserPassword' ); | ||
| 9 | has PreferredBackupWindow => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'preferredBackupWindow' ); | ||
| 10 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'preferredMaintenanceWindow' ); | ||
| 11 | has PubliclyAccessible => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'publiclyAccessible' ); | ||
| 12 | has RelationalDatabaseName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'relationalDatabaseName' , required => 1); | ||
| 13 | has RotateMasterUserPassword => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'rotateMasterUserPassword' ); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateRelationalDatabase'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::UpdateRelationalDatabaseResult'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Lightsail::UpdateRelationalDatabase - Arguments for method UpdateRelationalDatabase on L<Paws::Lightsail> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method UpdateRelationalDatabase on the | ||
| 31 | L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class | ||
| 32 | as arguments to method UpdateRelationalDatabase. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateRelationalDatabase. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $lightsail = Paws->service('Lightsail'); | ||
| 39 | my $UpdateRelationalDatabaseResult = $lightsail->UpdateRelationalDatabase( | ||
| 40 | RelationalDatabaseName => 'MyResourceName', | ||
| 41 | ApplyImmediately => 1, # OPTIONAL | ||
| 42 | CaCertificateIdentifier => 'Mystring', # OPTIONAL | ||
| 43 | DisableBackupRetention => 1, # OPTIONAL | ||
| 44 | EnableBackupRetention => 1, # OPTIONAL | ||
| 45 | MasterUserPassword => 'MySensitiveString', # OPTIONAL | ||
| 46 | PreferredBackupWindow => 'Mystring', # OPTIONAL | ||
| 47 | PreferredMaintenanceWindow => 'Mystring', # OPTIONAL | ||
| 48 | PubliclyAccessible => 1, # OPTIONAL | ||
| 49 | RotateMasterUserPassword => 1, # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $Operations = $UpdateRelationalDatabaseResult->Operations; | ||
| 54 | |||
| 55 | # Returns a L<Paws::Lightsail::UpdateRelationalDatabaseResult> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/UpdateRelationalDatabase> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ApplyImmediately => Bool | ||
| 64 | |||
| 65 | When C<true>, applies changes immediately. When C<false>, applies | ||
| 66 | changes during the preferred maintenance window. Some changes may cause | ||
| 67 | an outage. | ||
| 68 | |||
| 69 | Default: C<false> | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 CaCertificateIdentifier => Str | ||
| 74 | |||
| 75 | Indicates the certificate that needs to be associated with the | ||
| 76 | database. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 DisableBackupRetention => Bool | ||
| 81 | |||
| 82 | When C<true>, disables automated backup retention for your database. | ||
| 83 | |||
| 84 | Disabling backup retention deletes all automated database backups. | ||
| 85 | Before disabling this, you may want to create a snapshot of your | ||
| 86 | database using the C<create relational database snapshot> operation. | ||
| 87 | |||
| 88 | Updates are applied during the next maintenance window because this can | ||
| 89 | result in an outage. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 EnableBackupRetention => Bool | ||
| 94 | |||
| 95 | When C<true>, enables automated backup retention for your database. | ||
| 96 | |||
| 97 | Updates are applied during the next maintenance window because this can | ||
| 98 | result in an outage. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 MasterUserPassword => Str | ||
| 103 | |||
| 104 | The password for the master user. The password can include any | ||
| 105 | printable ASCII character except "/", """, or "@". | ||
| 106 | |||
| 107 | MyB<SQL> | ||
| 108 | |||
| 109 | Constraints: Must contain from 8 to 41 characters. | ||
| 110 | |||
| 111 | B<PostgreSQL> | ||
| 112 | |||
| 113 | Constraints: Must contain from 8 to 128 characters. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 PreferredBackupWindow => Str | ||
| 118 | |||
| 119 | The daily time range during which automated backups are created for | ||
| 120 | your database if automated backups are enabled. | ||
| 121 | |||
| 122 | Constraints: | ||
| 123 | |||
| 124 | =over | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | Must be in the C<hh24:mi-hh24:mi> format. | ||
| 129 | |||
| 130 | Example: C<16:00-16:30> | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Specified in Coordinated Universal Time (UTC). | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | Must not conflict with the preferred maintenance window. | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | Must be at least 30 minutes. | ||
| 143 | |||
| 144 | =back | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 PreferredMaintenanceWindow => Str | ||
| 150 | |||
| 151 | The weekly time range during which system maintenance can occur on your | ||
| 152 | database. | ||
| 153 | |||
| 154 | The default is a 30-minute window selected at random from an 8-hour | ||
| 155 | block of time for each AWS Region, occurring on a random day of the | ||
| 156 | week. | ||
| 157 | |||
| 158 | Constraints: | ||
| 159 | |||
| 160 | =over | ||
| 161 | |||
| 162 | =item * | ||
| 163 | |||
| 164 | Must be in the C<ddd:hh24:mi-ddd:hh24:mi> format. | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. | ||
| 169 | |||
| 170 | =item * | ||
| 171 | |||
| 172 | Must be at least 30 minutes. | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | Specified in Coordinated Universal Time (UTC). | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | Example: C<Tue:17:00-Tue:17:30> | ||
| 181 | |||
| 182 | =back | ||
| 183 | |||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | =head2 PubliclyAccessible => Bool | ||
| 188 | |||
| 189 | Specifies the accessibility options for your database. A value of | ||
| 190 | C<true> specifies a database that is available to resources outside of | ||
| 191 | your Lightsail account. A value of C<false> specifies a database that | ||
| 192 | is available only to your Lightsail resources in the same region as | ||
| 193 | your database. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | =head2 B<REQUIRED> RelationalDatabaseName => Str | ||
| 198 | |||
| 199 | The name of your Lightsail database resource to update. | ||
| 200 | |||
| 201 | |||
| 202 | |||
| 203 | =head2 RotateMasterUserPassword => Bool | ||
| 204 | |||
| 205 | When C<true>, the master user password is changed to a new strong | ||
| 206 | password generated by Lightsail. | ||
| 207 | |||
| 208 | Use the C<get relational database master user password> operation to | ||
| 209 | get the new password. | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head1 SEE ALSO | ||
| 215 | |||
| 216 | This class forms part of L<Paws>, documenting arguments for method UpdateRelationalDatabase in L<Paws::Lightsail> | ||
| 217 | |||
| 218 | =head1 BUGS and CONTRIBUTIONS | ||
| 219 | |||
| 220 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 221 | |||
| 222 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 223 | |||
| 224 | =cut | ||
| 225 |