« blib/lib/Paws/RDS/CreateCustomAvailabilityZoneResult.pm
↑ Summary
blib/lib/Paws/RDS/CreateDBClusterEndpoint.pm »
| 1 | |||
| 2 | package Paws::RDS::CreateDBCluster; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has BacktrackWindow => (is => 'ro', isa => 'Int'); | ||
| 6 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 7 | has CharacterSetName => (is => 'ro', isa => 'Str'); | ||
| 8 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 9 | has DatabaseName => (is => 'ro', isa => 'Str'); | ||
| 10 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has DBClusterParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 12 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 13 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 14 | has Domain => (is => 'ro', isa => 'Str'); | ||
| 15 | has DomainIAMRoleName => (is => 'ro', isa => 'Str'); | ||
| 16 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 17 | has EnableGlobalWriteForwarding => (is => 'ro', isa => 'Bool'); | ||
| 18 | has EnableHttpEndpoint => (is => 'ro', isa => 'Bool'); | ||
| 19 | has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool'); | ||
| 20 | has Engine => (is => 'ro', isa => 'Str', required => 1); | ||
| 21 | has EngineMode => (is => 'ro', isa => 'Str'); | ||
| 22 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 23 | has GlobalClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 24 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 25 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 26 | has MasterUserPassword => (is => 'ro', isa => 'Str'); | ||
| 27 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 28 | has Port => (is => 'ro', isa => 'Int'); | ||
| 29 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | ||
| 30 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 31 | has PreSignedUrl => (is => 'ro', isa => 'Str'); | ||
| 32 | has ReplicationSourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 33 | has ScalingConfiguration => (is => 'ro', isa => 'Paws::RDS::ScalingConfiguration'); | ||
| 34 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 35 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 36 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 37 | |||
| 38 | use MooseX::ClassAttribute; | ||
| 39 | |||
| 40 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBCluster'); | ||
| 41 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CreateDBClusterResult'); | ||
| 42 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBClusterResult'); | ||
| 43 | 1; | ||
| 44 | |||
| 45 | ### main pod documentation begin ### | ||
| 46 | |||
| 47 | =head1 NAME | ||
| 48 | |||
| 49 | Paws::RDS::CreateDBCluster - Arguments for method CreateDBCluster on L<Paws::RDS> | ||
| 50 | |||
| 51 | =head1 DESCRIPTION | ||
| 52 | |||
| 53 | This class represents the parameters used for calling the method CreateDBCluster on the | ||
| 54 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 55 | as arguments to method CreateDBCluster. | ||
| 56 | |||
| 57 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBCluster. | ||
| 58 | |||
| 59 | =head1 SYNOPSIS | ||
| 60 | |||
| 61 | my $rds = Paws->service('RDS'); | ||
| 62 | # To create a DB cluster | ||
| 63 | # This example creates a DB cluster. | ||
| 64 | my $CreateDBClusterResult = $rds->CreateDBCluster( | ||
| 65 | 'AvailabilityZones' => ['us-east-1a'], | ||
| 66 | 'BackupRetentionPeriod' => 1, | ||
| 67 | 'DBClusterIdentifier' => 'mydbcluster', | ||
| 68 | 'DBClusterParameterGroupName' => 'mydbclusterparametergroup', | ||
| 69 | 'DatabaseName' => 'myauroradb', | ||
| 70 | 'Engine' => 'aurora', | ||
| 71 | 'EngineVersion' => '5.6.10a', | ||
| 72 | 'MasterUserPassword' => 'mypassword', | ||
| 73 | 'MasterUsername' => 'myuser', | ||
| 74 | 'Port' => 3306, | ||
| 75 | 'StorageEncrypted' => 1 | ||
| 76 | ); | ||
| 77 | |||
| 78 | # Results: | ||
| 79 | my $DBCluster = $CreateDBClusterResult->DBCluster; | ||
| 80 | |||
| 81 | # Returns a L<Paws::RDS::CreateDBClusterResult> object. | ||
| 82 | |||
| 83 | 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. | ||
| 84 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBCluster> | ||
| 85 | |||
| 86 | =head1 ATTRIBUTES | ||
| 87 | |||
| 88 | |||
| 89 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 90 | |||
| 91 | A list of Availability Zones (AZs) where instances in the DB cluster | ||
| 92 | can be created. For information on Amazon Web Services Regions and | ||
| 93 | Availability Zones, see Choosing the Regions and Availability Zones | ||
| 94 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) | ||
| 95 | in the I<Amazon Aurora User Guide>. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 BacktrackWindow => Int | ||
| 100 | |||
| 101 | The target backtrack window, in seconds. To disable backtracking, set | ||
| 102 | this value to 0. | ||
| 103 | |||
| 104 | Currently, Backtrack is only supported for Aurora MySQL DB clusters. | ||
| 105 | |||
| 106 | Default: 0 | ||
| 107 | |||
| 108 | Constraints: | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | If specified, this value must be set to a number from 0 to 259,200 (72 | ||
| 115 | hours). | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 BackupRetentionPeriod => Int | ||
| 123 | |||
| 124 | The number of days for which automated backups are retained. | ||
| 125 | |||
| 126 | Default: 1 | ||
| 127 | |||
| 128 | Constraints: | ||
| 129 | |||
| 130 | =over | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Must be a value from 1 to 35 | ||
| 135 | |||
| 136 | =back | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 CharacterSetName => Str | ||
| 142 | |||
| 143 | A value that indicates that the DB cluster should be associated with | ||
| 144 | the specified CharacterSet. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 CopyTagsToSnapshot => Bool | ||
| 149 | |||
| 150 | A value that indicates whether to copy all tags from the DB cluster to | ||
| 151 | snapshots of the DB cluster. The default is not to copy them. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 DatabaseName => Str | ||
| 156 | |||
| 157 | The name for your database of up to 64 alphanumeric characters. If you | ||
| 158 | do not provide a name, Amazon RDS doesn't create a database in the DB | ||
| 159 | cluster you are creating. | ||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 164 | |||
| 165 | The DB cluster identifier. This parameter is stored as a lowercase | ||
| 166 | string. | ||
| 167 | |||
| 168 | Constraints: | ||
| 169 | |||
| 170 | =over | ||
| 171 | |||
| 172 | =item * | ||
| 173 | |||
| 174 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 175 | |||
| 176 | =item * | ||
| 177 | |||
| 178 | First character must be a letter. | ||
| 179 | |||
| 180 | =item * | ||
| 181 | |||
| 182 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 183 | |||
| 184 | =back | ||
| 185 | |||
| 186 | Example: C<my-cluster1> | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 DBClusterParameterGroupName => Str | ||
| 191 | |||
| 192 | The name of the DB cluster parameter group to associate with this DB | ||
| 193 | cluster. If you do not specify a value, then the default DB cluster | ||
| 194 | parameter group for the specified DB engine and version is used. | ||
| 195 | |||
| 196 | Constraints: | ||
| 197 | |||
| 198 | =over | ||
| 199 | |||
| 200 | =item * | ||
| 201 | |||
| 202 | If supplied, must match the name of an existing DB cluster parameter | ||
| 203 | group. | ||
| 204 | |||
| 205 | =back | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | |||
| 210 | =head2 DBSubnetGroupName => Str | ||
| 211 | |||
| 212 | A DB subnet group to associate with this DB cluster. | ||
| 213 | |||
| 214 | Constraints: Must match the name of an existing DBSubnetGroup. Must not | ||
| 215 | be default. | ||
| 216 | |||
| 217 | Example: C<mySubnetgroup> | ||
| 218 | |||
| 219 | |||
| 220 | |||
| 221 | =head2 DeletionProtection => Bool | ||
| 222 | |||
| 223 | A value that indicates whether the DB cluster has deletion protection | ||
| 224 | enabled. The database can't be deleted when deletion protection is | ||
| 225 | enabled. By default, deletion protection is disabled. | ||
| 226 | |||
| 227 | |||
| 228 | |||
| 229 | =head2 Domain => Str | ||
| 230 | |||
| 231 | The Active Directory directory ID to create the DB cluster in. | ||
| 232 | |||
| 233 | For Amazon Aurora DB clusters, Amazon RDS can use Kerberos | ||
| 234 | Authentication to authenticate users that connect to the DB cluster. | ||
| 235 | For more information, see Kerberos Authentication | ||
| 236 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) | ||
| 237 | in the I<Amazon Aurora User Guide>. | ||
| 238 | |||
| 239 | |||
| 240 | |||
| 241 | =head2 DomainIAMRoleName => Str | ||
| 242 | |||
| 243 | Specify the name of the IAM role to be used when making API calls to | ||
| 244 | the Directory Service. | ||
| 245 | |||
| 246 | |||
| 247 | |||
| 248 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 249 | |||
| 250 | The list of log types that need to be enabled for exporting to | ||
| 251 | CloudWatch Logs. The values in the list depend on the DB engine being | ||
| 252 | used. For more information, see Publishing Database Logs to Amazon | ||
| 253 | CloudWatch Logs | ||
| 254 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) | ||
| 255 | in the I<Amazon Aurora User Guide>. | ||
| 256 | |||
| 257 | B<Aurora MySQL> | ||
| 258 | |||
| 259 | Possible values are C<audit>, C<error>, C<general>, and C<slowquery>. | ||
| 260 | |||
| 261 | B<Aurora PostgreSQL> | ||
| 262 | |||
| 263 | Possible value is C<postgresql>. | ||
| 264 | |||
| 265 | |||
| 266 | |||
| 267 | =head2 EnableGlobalWriteForwarding => Bool | ||
| 268 | |||
| 269 | A value that indicates whether to enable this DB cluster to forward | ||
| 270 | write operations to the primary cluster of an Aurora global database | ||
| 271 | (GlobalCluster). By default, write operations are not allowed on Aurora | ||
| 272 | DB clusters that are secondary clusters in an Aurora global database. | ||
| 273 | |||
| 274 | You can set this value only on Aurora DB clusters that are members of | ||
| 275 | an Aurora global database. With this parameter enabled, a secondary | ||
| 276 | cluster can forward writes to the current primary cluster and the | ||
| 277 | resulting changes are replicated back to this cluster. For the primary | ||
| 278 | DB cluster of an Aurora global database, this value is used immediately | ||
| 279 | if the primary is demoted by the FailoverGlobalCluster API operation, | ||
| 280 | but it does nothing until then. | ||
| 281 | |||
| 282 | |||
| 283 | |||
| 284 | =head2 EnableHttpEndpoint => Bool | ||
| 285 | |||
| 286 | A value that indicates whether to enable the HTTP endpoint for an | ||
| 287 | Aurora Serverless DB cluster. By default, the HTTP endpoint is | ||
| 288 | disabled. | ||
| 289 | |||
| 290 | When enabled, the HTTP endpoint provides a connectionless web service | ||
| 291 | API for running SQL queries on the Aurora Serverless DB cluster. You | ||
| 292 | can also query your database from inside the RDS console with the query | ||
| 293 | editor. | ||
| 294 | |||
| 295 | For more information, see Using the Data API for Aurora Serverless | ||
| 296 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) | ||
| 297 | in the I<Amazon Aurora User Guide>. | ||
| 298 | |||
| 299 | |||
| 300 | |||
| 301 | =head2 EnableIAMDatabaseAuthentication => Bool | ||
| 302 | |||
| 303 | A value that indicates whether to enable mapping of Amazon Web Services | ||
| 304 | Identity and Access Management (IAM) accounts to database accounts. By | ||
| 305 | default, mapping is disabled. | ||
| 306 | |||
| 307 | For more information, see IAM Database Authentication | ||
| 308 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) | ||
| 309 | in the I<Amazon Aurora User Guide.> | ||
| 310 | |||
| 311 | |||
| 312 | |||
| 313 | =head2 B<REQUIRED> Engine => Str | ||
| 314 | |||
| 315 | The name of the database engine to be used for this DB cluster. | ||
| 316 | |||
| 317 | Valid Values: C<aurora> (for MySQL 5.6-compatible Aurora), | ||
| 318 | C<aurora-mysql> (for MySQL 5.7-compatible Aurora), and | ||
| 319 | C<aurora-postgresql> | ||
| 320 | |||
| 321 | |||
| 322 | |||
| 323 | =head2 EngineMode => Str | ||
| 324 | |||
| 325 | The DB engine mode of the DB cluster, either C<provisioned>, | ||
| 326 | C<serverless>, C<parallelquery>, C<global>, or C<multimaster>. | ||
| 327 | |||
| 328 | The C<parallelquery> engine mode isn't required for Aurora MySQL | ||
| 329 | version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x | ||
| 330 | versions. | ||
| 331 | |||
| 332 | The C<global> engine mode isn't required for Aurora MySQL version 1.22 | ||
| 333 | and higher 1.x versions, and C<global> engine mode isn't required for | ||
| 334 | any 2.x versions. | ||
| 335 | |||
| 336 | The C<multimaster> engine mode only applies for DB clusters created | ||
| 337 | with Aurora MySQL version 5.6.10a. | ||
| 338 | |||
| 339 | For Aurora PostgreSQL, the C<global> engine mode isn't required, and | ||
| 340 | both the C<parallelquery> and the C<multimaster> engine modes currently | ||
| 341 | aren't supported. | ||
| 342 | |||
| 343 | Limitations and requirements apply to some DB engine modes. For more | ||
| 344 | information, see the following sections in the I<Amazon Aurora User | ||
| 345 | Guide>: | ||
| 346 | |||
| 347 | =over | ||
| 348 | |||
| 349 | =item * | ||
| 350 | |||
| 351 | Limitations of Aurora Serverless | ||
| 352 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) | ||
| 353 | |||
| 354 | =item * | ||
| 355 | |||
| 356 | Limitations of Parallel Query | ||
| 357 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) | ||
| 358 | |||
| 359 | =item * | ||
| 360 | |||
| 361 | Limitations of Aurora Global Databases | ||
| 362 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) | ||
| 363 | |||
| 364 | =item * | ||
| 365 | |||
| 366 | Limitations of Multi-Master Clusters | ||
| 367 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations) | ||
| 368 | |||
| 369 | =back | ||
| 370 | |||
| 371 | |||
| 372 | |||
| 373 | |||
| 374 | =head2 EngineVersion => Str | ||
| 375 | |||
| 376 | The version number of the database engine to use. | ||
| 377 | |||
| 378 | To list all of the available engine versions for C<aurora> (for MySQL | ||
| 379 | 5.6-compatible Aurora), use the following command: | ||
| 380 | |||
| 381 | C<aws rds describe-db-engine-versions --engine aurora --query | ||
| 382 | "DBEngineVersions[].EngineVersion"> | ||
| 383 | |||
| 384 | To list all of the available engine versions for C<aurora-mysql> (for | ||
| 385 | MySQL 5.7-compatible Aurora), use the following command: | ||
| 386 | |||
| 387 | C<aws rds describe-db-engine-versions --engine aurora-mysql --query | ||
| 388 | "DBEngineVersions[].EngineVersion"> | ||
| 389 | |||
| 390 | To list all of the available engine versions for C<aurora-postgresql>, | ||
| 391 | use the following command: | ||
| 392 | |||
| 393 | C<aws rds describe-db-engine-versions --engine aurora-postgresql | ||
| 394 | --query "DBEngineVersions[].EngineVersion"> | ||
| 395 | |||
| 396 | B<Aurora MySQL> | ||
| 397 | |||
| 398 | Example: C<5.6.10a>, C<5.6.mysql_aurora.1.19.2>, C<5.7.12>, | ||
| 399 | C<5.7.mysql_aurora.2.04.5> | ||
| 400 | |||
| 401 | B<Aurora PostgreSQL> | ||
| 402 | |||
| 403 | Example: C<9.6.3>, C<10.7> | ||
| 404 | |||
| 405 | |||
| 406 | |||
| 407 | =head2 GlobalClusterIdentifier => Str | ||
| 408 | |||
| 409 | The global cluster ID of an Aurora cluster that becomes the primary | ||
| 410 | cluster in the new global database cluster. | ||
| 411 | |||
| 412 | |||
| 413 | |||
| 414 | =head2 KmsKeyId => Str | ||
| 415 | |||
| 416 | The Amazon Web Services KMS key identifier for an encrypted DB cluster. | ||
| 417 | |||
| 418 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 419 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 420 | master key (CMK). To use a CMK in a different Amazon Web Services | ||
| 421 | account, specify the key ARN or alias ARN. | ||
| 422 | |||
| 423 | When a CMK isn't specified in C<KmsKeyId>: | ||
| 424 | |||
| 425 | =over | ||
| 426 | |||
| 427 | =item * | ||
| 428 | |||
| 429 | If C<ReplicationSourceIdentifier> identifies an encrypted source, then | ||
| 430 | Amazon RDS will use the CMK used to encrypt the source. Otherwise, | ||
| 431 | Amazon RDS will use your default CMK. | ||
| 432 | |||
| 433 | =item * | ||
| 434 | |||
| 435 | If the C<StorageEncrypted> parameter is enabled and | ||
| 436 | C<ReplicationSourceIdentifier> isn't specified, then Amazon RDS will | ||
| 437 | use your default CMK. | ||
| 438 | |||
| 439 | =back | ||
| 440 | |||
| 441 | There is a default CMK for your Amazon Web Services account. Your | ||
| 442 | Amazon Web Services account has a different default CMK for each Amazon | ||
| 443 | Web Services Region. | ||
| 444 | |||
| 445 | If you create a read replica of an encrypted DB cluster in another | ||
| 446 | Amazon Web Services Region, you must set C<KmsKeyId> to a Amazon Web | ||
| 447 | Services KMS key identifier that is valid in the destination Amazon Web | ||
| 448 | Services Region. This CMK is used to encrypt the read replica in that | ||
| 449 | Amazon Web Services Region. | ||
| 450 | |||
| 451 | |||
| 452 | |||
| 453 | =head2 MasterUsername => Str | ||
| 454 | |||
| 455 | The name of the master user for the DB cluster. | ||
| 456 | |||
| 457 | Constraints: | ||
| 458 | |||
| 459 | =over | ||
| 460 | |||
| 461 | =item * | ||
| 462 | |||
| 463 | Must be 1 to 16 letters or numbers. | ||
| 464 | |||
| 465 | =item * | ||
| 466 | |||
| 467 | First character must be a letter. | ||
| 468 | |||
| 469 | =item * | ||
| 470 | |||
| 471 | Can't be a reserved word for the chosen database engine. | ||
| 472 | |||
| 473 | =back | ||
| 474 | |||
| 475 | |||
| 476 | |||
| 477 | |||
| 478 | =head2 MasterUserPassword => Str | ||
| 479 | |||
| 480 | The password for the master database user. This password can contain | ||
| 481 | any printable ASCII character except "/", """, or "@". | ||
| 482 | |||
| 483 | Constraints: Must contain from 8 to 41 characters. | ||
| 484 | |||
| 485 | |||
| 486 | |||
| 487 | =head2 OptionGroupName => Str | ||
| 488 | |||
| 489 | A value that indicates that the DB cluster should be associated with | ||
| 490 | the specified option group. | ||
| 491 | |||
| 492 | Permanent options can't be removed from an option group. The option | ||
| 493 | group can't be removed from a DB cluster once it is associated with a | ||
| 494 | DB cluster. | ||
| 495 | |||
| 496 | |||
| 497 | |||
| 498 | =head2 Port => Int | ||
| 499 | |||
| 500 | The port number on which the instances in the DB cluster accept | ||
| 501 | connections. | ||
| 502 | |||
| 503 | Default: C<3306> if engine is set as aurora or C<5432> if set to | ||
| 504 | aurora-postgresql. | ||
| 505 | |||
| 506 | |||
| 507 | |||
| 508 | =head2 PreferredBackupWindow => Str | ||
| 509 | |||
| 510 | The daily time range during which automated backups are created if | ||
| 511 | automated backups are enabled using the C<BackupRetentionPeriod> | ||
| 512 | parameter. | ||
| 513 | |||
| 514 | The default is a 30-minute window selected at random from an 8-hour | ||
| 515 | block of time for each Amazon Web Services Region. To view the time | ||
| 516 | blocks available, see Backup window | ||
| 517 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) | ||
| 518 | in the I<Amazon Aurora User Guide.> | ||
| 519 | |||
| 520 | Constraints: | ||
| 521 | |||
| 522 | =over | ||
| 523 | |||
| 524 | =item * | ||
| 525 | |||
| 526 | Must be in the format C<hh24:mi-hh24:mi>. | ||
| 527 | |||
| 528 | =item * | ||
| 529 | |||
| 530 | Must be in Universal Coordinated Time (UTC). | ||
| 531 | |||
| 532 | =item * | ||
| 533 | |||
| 534 | Must not conflict with the preferred maintenance window. | ||
| 535 | |||
| 536 | =item * | ||
| 537 | |||
| 538 | Must be at least 30 minutes. | ||
| 539 | |||
| 540 | =back | ||
| 541 | |||
| 542 | |||
| 543 | |||
| 544 | |||
| 545 | =head2 PreferredMaintenanceWindow => Str | ||
| 546 | |||
| 547 | The weekly time range during which system maintenance can occur, in | ||
| 548 | Universal Coordinated Time (UTC). | ||
| 549 | |||
| 550 | Format: C<ddd:hh24:mi-ddd:hh24:mi> | ||
| 551 | |||
| 552 | The default is a 30-minute window selected at random from an 8-hour | ||
| 553 | block of time for each Amazon Web Services Region, occurring on a | ||
| 554 | random day of the week. To see the time blocks available, see Adjusting | ||
| 555 | the Preferred DB Cluster Maintenance Window | ||
| 556 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) | ||
| 557 | in the I<Amazon Aurora User Guide.> | ||
| 558 | |||
| 559 | Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. | ||
| 560 | |||
| 561 | Constraints: Minimum 30-minute window. | ||
| 562 | |||
| 563 | |||
| 564 | |||
| 565 | =head2 PreSignedUrl => Str | ||
| 566 | |||
| 567 | A URL that contains a Signature Version 4 signed request for the | ||
| 568 | C<CreateDBCluster> action to be called in the source Amazon Web | ||
| 569 | Services Region where the DB cluster is replicated from. You only need | ||
| 570 | to specify C<PreSignedUrl> when you are performing cross-region | ||
| 571 | replication from an encrypted DB cluster. | ||
| 572 | |||
| 573 | The pre-signed URL must be a valid request for the C<CreateDBCluster> | ||
| 574 | API action that can be executed in the source Amazon Web Services | ||
| 575 | Region that contains the encrypted DB cluster to be copied. | ||
| 576 | |||
| 577 | The pre-signed URL request must contain the following parameter values: | ||
| 578 | |||
| 579 | =over | ||
| 580 | |||
| 581 | =item * | ||
| 582 | |||
| 583 | C<KmsKeyId> - The Amazon Web Services KMS key identifier for the key to | ||
| 584 | use to encrypt the copy of the DB cluster in the destination Amazon Web | ||
| 585 | Services Region. This should refer to the same Amazon Web Services KMS | ||
| 586 | CMK for both the C<CreateDBCluster> action that is called in the | ||
| 587 | destination Amazon Web Services Region, and the action contained in the | ||
| 588 | pre-signed URL. | ||
| 589 | |||
| 590 | =item * | ||
| 591 | |||
| 592 | C<DestinationRegion> - The name of the Amazon Web Services Region that | ||
| 593 | Aurora read replica will be created in. | ||
| 594 | |||
| 595 | =item * | ||
| 596 | |||
| 597 | C<ReplicationSourceIdentifier> - The DB cluster identifier for the | ||
| 598 | encrypted DB cluster to be copied. This identifier must be in the | ||
| 599 | Amazon Resource Name (ARN) format for the source Amazon Web Services | ||
| 600 | Region. For example, if you are copying an encrypted DB cluster from | ||
| 601 | the us-west-2 Amazon Web Services Region, then your | ||
| 602 | C<ReplicationSourceIdentifier> would look like Example: | ||
| 603 | C<arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1>. | ||
| 604 | |||
| 605 | =back | ||
| 606 | |||
| 607 | To learn how to generate a Signature Version 4 signed request, see | ||
| 608 | Authenticating Requests: Using Query Parameters (Amazon Web Services | ||
| 609 | Signature Version 4) | ||
| 610 | (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) | ||
| 611 | and Signature Version 4 Signing Process | ||
| 612 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). | ||
| 613 | |||
| 614 | If you are using an Amazon Web Services SDK tool or the CLI, you can | ||
| 615 | specify C<SourceRegion> (or C<--source-region> for the CLI) instead of | ||
| 616 | specifying C<PreSignedUrl> manually. Specifying C<SourceRegion> | ||
| 617 | autogenerates a pre-signed URL that is a valid request for the | ||
| 618 | operation that can be executed in the source Amazon Web Services | ||
| 619 | Region. | ||
| 620 | |||
| 621 | |||
| 622 | |||
| 623 | =head2 ReplicationSourceIdentifier => Str | ||
| 624 | |||
| 625 | The Amazon Resource Name (ARN) of the source DB instance or DB cluster | ||
| 626 | if this DB cluster is created as a read replica. | ||
| 627 | |||
| 628 | |||
| 629 | |||
| 630 | =head2 ScalingConfiguration => L<Paws::RDS::ScalingConfiguration> | ||
| 631 | |||
| 632 | For DB clusters in C<serverless> DB engine mode, the scaling properties | ||
| 633 | of the DB cluster. | ||
| 634 | |||
| 635 | |||
| 636 | |||
| 637 | =head2 StorageEncrypted => Bool | ||
| 638 | |||
| 639 | A value that indicates whether the DB cluster is encrypted. | ||
| 640 | |||
| 641 | |||
| 642 | |||
| 643 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 644 | |||
| 645 | Tags to assign to the DB cluster. | ||
| 646 | |||
| 647 | |||
| 648 | |||
| 649 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 650 | |||
| 651 | A list of EC2 VPC security groups to associate with this DB cluster. | ||
| 652 | |||
| 653 | |||
| 654 | |||
| 655 | |||
| 656 | =head1 SEE ALSO | ||
| 657 | |||
| 658 | This class forms part of L<Paws>, documenting arguments for method CreateDBCluster in L<Paws::RDS> | ||
| 659 | |||
| 660 | =head1 BUGS and CONTRIBUTIONS | ||
| 661 | |||
| 662 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 663 | |||
| 664 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 665 | |||
| 666 | =cut | ||
| 667 |