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