« blib/lib/Paws/DocDB/ListTagsForResource.pm
↑ Summary
blib/lib/Paws/DocDB/ModifyDBClusterParameterGroup.pm »
| 1 | |||
| 2 | package Paws::DocDB::ModifyDBCluster; | ||
| 3 | use Moose; | ||
| 4 | has ApplyImmediately => (is => 'ro', isa => 'Bool'); | ||
| 5 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 6 | has CloudwatchLogsExportConfiguration => (is => 'ro', isa => 'Paws::DocDB::CloudwatchLogsExportConfiguration'); | ||
| 7 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has DBClusterParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 9 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 10 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 11 | has MasterUserPassword => (is => 'ro', isa => 'Str'); | ||
| 12 | has NewDBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 13 | has Port => (is => 'ro', isa => 'Int'); | ||
| 14 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | ||
| 15 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 16 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDBCluster'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::ModifyDBClusterResult'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyDBClusterResult'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::DocDB::ModifyDBCluster - Arguments for method ModifyDBCluster on L<Paws::DocDB> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method ModifyDBCluster on the | ||
| 34 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 35 | as arguments to method ModifyDBCluster. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBCluster. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $rds = Paws->service('DocDB'); | ||
| 42 | my $ModifyDBClusterResult = $rds->ModifyDBCluster( | ||
| 43 | DBClusterIdentifier => 'MyString', | ||
| 44 | ApplyImmediately => 1, # OPTIONAL | ||
| 45 | BackupRetentionPeriod => 1, # OPTIONAL | ||
| 46 | CloudwatchLogsExportConfiguration => { | ||
| 47 | DisableLogTypes => [ 'MyString', ... ], # OPTIONAL | ||
| 48 | EnableLogTypes => [ 'MyString', ... ], # OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | DBClusterParameterGroupName => 'MyString', # OPTIONAL | ||
| 51 | DeletionProtection => 1, # OPTIONAL | ||
| 52 | EngineVersion => 'MyString', # OPTIONAL | ||
| 53 | MasterUserPassword => 'MyString', # OPTIONAL | ||
| 54 | NewDBClusterIdentifier => 'MyString', # OPTIONAL | ||
| 55 | Port => 1, # OPTIONAL | ||
| 56 | PreferredBackupWindow => 'MyString', # OPTIONAL | ||
| 57 | PreferredMaintenanceWindow => 'MyString', # OPTIONAL | ||
| 58 | VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $DBCluster = $ModifyDBClusterResult->DBCluster; | ||
| 63 | |||
| 64 | # Returns a L<Paws::DocDB::ModifyDBClusterResult> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBCluster> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 ApplyImmediately => Bool | ||
| 73 | |||
| 74 | A value that specifies whether the changes in this request and any | ||
| 75 | pending changes are asynchronously applied as soon as possible, | ||
| 76 | regardless of the C<PreferredMaintenanceWindow> setting for the | ||
| 77 | cluster. If this parameter is set to C<false>, changes to the cluster | ||
| 78 | are applied during the next maintenance window. | ||
| 79 | |||
| 80 | The C<ApplyImmediately> parameter affects only the | ||
| 81 | C<NewDBClusterIdentifier> and C<MasterUserPassword> values. If you set | ||
| 82 | this parameter value to C<false>, the changes to the | ||
| 83 | C<NewDBClusterIdentifier> and C<MasterUserPassword> values are applied | ||
| 84 | during the next maintenance window. All other changes are applied | ||
| 85 | immediately, regardless of the value of the C<ApplyImmediately> | ||
| 86 | parameter. | ||
| 87 | |||
| 88 | Default: C<false> | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 BackupRetentionPeriod => Int | ||
| 93 | |||
| 94 | The number of days for which automated backups are retained. You must | ||
| 95 | specify a minimum value of 1. | ||
| 96 | |||
| 97 | Default: 1 | ||
| 98 | |||
| 99 | Constraints: | ||
| 100 | |||
| 101 | =over | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | Must be a value from 1 to 35. | ||
| 106 | |||
| 107 | =back | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 CloudwatchLogsExportConfiguration => L<Paws::DocDB::CloudwatchLogsExportConfiguration> | ||
| 113 | |||
| 114 | The configuration setting for the log types to be enabled for export to | ||
| 115 | Amazon CloudWatch Logs for a specific instance or cluster. The | ||
| 116 | C<EnableLogTypes> and C<DisableLogTypes> arrays determine which logs | ||
| 117 | are exported (or not exported) to CloudWatch Logs. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 122 | |||
| 123 | The cluster identifier for the cluster that is being modified. This | ||
| 124 | parameter is not case sensitive. | ||
| 125 | |||
| 126 | Constraints: | ||
| 127 | |||
| 128 | =over | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | Must match the identifier of an existing C<DBCluster>. | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 DBClusterParameterGroupName => Str | ||
| 140 | |||
| 141 | The name of the cluster parameter group to use for the cluster. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 DeletionProtection => Bool | ||
| 146 | |||
| 147 | Specifies whether this cluster can be deleted. If C<DeletionProtection> | ||
| 148 | is enabled, the cluster cannot be deleted unless it is modified and | ||
| 149 | C<DeletionProtection> is disabled. C<DeletionProtection> protects | ||
| 150 | clusters from being accidentally deleted. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 EngineVersion => Str | ||
| 155 | |||
| 156 | The version number of the database engine to which you want to upgrade. | ||
| 157 | Modifying engine version is not supported on Amazon DocumentDB. | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 MasterUserPassword => Str | ||
| 162 | |||
| 163 | The password for the master database user. This password can contain | ||
| 164 | any printable ASCII character except forward slash (/), double quote | ||
| 165 | ("), or the "at" symbol (@). | ||
| 166 | |||
| 167 | Constraints: Must contain from 8 to 100 characters. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 NewDBClusterIdentifier => Str | ||
| 172 | |||
| 173 | The new cluster identifier for the cluster when renaming a cluster. | ||
| 174 | This value is stored as a lowercase string. | ||
| 175 | |||
| 176 | Constraints: | ||
| 177 | |||
| 178 | =over | ||
| 179 | |||
| 180 | =item * | ||
| 181 | |||
| 182 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | The first character must be a letter. | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 191 | |||
| 192 | =back | ||
| 193 | |||
| 194 | Example: C<my-cluster2> | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head2 Port => Int | ||
| 199 | |||
| 200 | The port number on which the cluster accepts connections. | ||
| 201 | |||
| 202 | Constraints: Must be a value from C<1150> to C<65535>. | ||
| 203 | |||
| 204 | Default: The same port as the original cluster. | ||
| 205 | |||
| 206 | |||
| 207 | |||
| 208 | =head2 PreferredBackupWindow => Str | ||
| 209 | |||
| 210 | The daily time range during which automated backups are created if | ||
| 211 | automated backups are enabled, using the C<BackupRetentionPeriod> | ||
| 212 | parameter. | ||
| 213 | |||
| 214 | The default is a 30-minute window selected at random from an 8-hour | ||
| 215 | block of time for each Region. | ||
| 216 | |||
| 217 | Constraints: | ||
| 218 | |||
| 219 | =over | ||
| 220 | |||
| 221 | =item * | ||
| 222 | |||
| 223 | Must be in the format C<hh24:mi-hh24:mi>. | ||
| 224 | |||
| 225 | =item * | ||
| 226 | |||
| 227 | Must be in Universal Coordinated Time (UTC). | ||
| 228 | |||
| 229 | =item * | ||
| 230 | |||
| 231 | Must not conflict with the preferred maintenance window. | ||
| 232 | |||
| 233 | =item * | ||
| 234 | |||
| 235 | Must be at least 30 minutes. | ||
| 236 | |||
| 237 | =back | ||
| 238 | |||
| 239 | |||
| 240 | |||
| 241 | |||
| 242 | =head2 PreferredMaintenanceWindow => Str | ||
| 243 | |||
| 244 | The weekly time range during which system maintenance can occur, in | ||
| 245 | Universal Coordinated Time (UTC). | ||
| 246 | |||
| 247 | Format: C<ddd:hh24:mi-ddd:hh24:mi> | ||
| 248 | |||
| 249 | The default is a 30-minute window selected at random from an 8-hour | ||
| 250 | block of time for each Region, occurring on a random day of the week. | ||
| 251 | |||
| 252 | Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun | ||
| 253 | |||
| 254 | Constraints: Minimum 30-minute window. | ||
| 255 | |||
| 256 | |||
| 257 | |||
| 258 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 259 | |||
| 260 | A list of virtual private cloud (VPC) security groups that the cluster | ||
| 261 | will belong to. | ||
| 262 | |||
| 263 | |||
| 264 | |||
| 265 | |||
| 266 | =head1 SEE ALSO | ||
| 267 | |||
| 268 | This class forms part of L<Paws>, documenting arguments for method ModifyDBCluster in L<Paws::DocDB> | ||
| 269 | |||
| 270 | =head1 BUGS and CONTRIBUTIONS | ||
| 271 | |||
| 272 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 273 | |||
| 274 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 275 | |||
| 276 | =cut | ||
| 277 |