« blib/lib/Paws/RDS/CreateDBClusterSnapshotResult.pm
↑ Summary
blib/lib/Paws/RDS/CreateDBInstanceReadReplica.pm »
| 1 | |||
| 2 | package Paws::RDS::CreateDBInstance; | ||
| 3 | use Moose; | ||
| 4 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 5 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 6 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 7 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 8 | has CharacterSetName => (is => 'ro', isa => 'Str'); | ||
| 9 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 10 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 11 | has DBInstanceClass => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has DBName => (is => 'ro', isa => 'Str'); | ||
| 14 | has DBParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 15 | has DBSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 16 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 17 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 18 | has Domain => (is => 'ro', isa => 'Str'); | ||
| 19 | has DomainIAMRoleName => (is => 'ro', isa => 'Str'); | ||
| 20 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 21 | has EnableCustomerOwnedIp => (is => 'ro', isa => 'Bool'); | ||
| 22 | has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool'); | ||
| 23 | has EnablePerformanceInsights => (is => 'ro', isa => 'Bool'); | ||
| 24 | has Engine => (is => 'ro', isa => 'Str', required => 1); | ||
| 25 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 26 | has Iops => (is => 'ro', isa => 'Int'); | ||
| 27 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 28 | has LicenseModel => (is => 'ro', isa => 'Str'); | ||
| 29 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 30 | has MasterUserPassword => (is => 'ro', isa => 'Str'); | ||
| 31 | has MaxAllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 32 | has MonitoringInterval => (is => 'ro', isa => 'Int'); | ||
| 33 | has MonitoringRoleArn => (is => 'ro', isa => 'Str'); | ||
| 34 | has MultiAZ => (is => 'ro', isa => 'Bool'); | ||
| 35 | has NcharCharacterSetName => (is => 'ro', isa => 'Str'); | ||
| 36 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 37 | has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str'); | ||
| 38 | has PerformanceInsightsRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 39 | has Port => (is => 'ro', isa => 'Int'); | ||
| 40 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | ||
| 41 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 42 | has ProcessorFeatures => (is => 'ro', isa => 'ArrayRef[Paws::RDS::ProcessorFeature]'); | ||
| 43 | has PromotionTier => (is => 'ro', isa => 'Int'); | ||
| 44 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | ||
| 45 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 46 | has StorageType => (is => 'ro', isa => 'Str'); | ||
| 47 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 48 | has TdeCredentialArn => (is => 'ro', isa => 'Str'); | ||
| 49 | has TdeCredentialPassword => (is => 'ro', isa => 'Str'); | ||
| 50 | has Timezone => (is => 'ro', isa => 'Str'); | ||
| 51 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 52 | |||
| 53 | use MooseX::ClassAttribute; | ||
| 54 | |||
| 55 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBInstance'); | ||
| 56 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CreateDBInstanceResult'); | ||
| 57 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBInstanceResult'); | ||
| 58 | 1; | ||
| 59 | |||
| 60 | ### main pod documentation begin ### | ||
| 61 | |||
| 62 | =head1 NAME | ||
| 63 | |||
| 64 | Paws::RDS::CreateDBInstance - Arguments for method CreateDBInstance on L<Paws::RDS> | ||
| 65 | |||
| 66 | =head1 DESCRIPTION | ||
| 67 | |||
| 68 | This class represents the parameters used for calling the method CreateDBInstance on the | ||
| 69 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 70 | as arguments to method CreateDBInstance. | ||
| 71 | |||
| 72 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBInstance. | ||
| 73 | |||
| 74 | =head1 SYNOPSIS | ||
| 75 | |||
| 76 | my $rds = Paws->service('RDS'); | ||
| 77 | # To create a DB instance. | ||
| 78 | # This example creates a DB instance. | ||
| 79 | my $CreateDBInstanceResult = $rds->CreateDBInstance( | ||
| 80 | 'AllocatedStorage' => 5, | ||
| 81 | 'DBInstanceClass' => 'db.t2.micro', | ||
| 82 | 'DBInstanceIdentifier' => 'mymysqlinstance', | ||
| 83 | 'Engine' => 'MySQL', | ||
| 84 | 'MasterUserPassword' => 'MyPassword', | ||
| 85 | 'MasterUsername' => 'MyUser' | ||
| 86 | ); | ||
| 87 | |||
| 88 | # Results: | ||
| 89 | my $DBInstance = $CreateDBInstanceResult->DBInstance; | ||
| 90 | |||
| 91 | # Returns a L<Paws::RDS::CreateDBInstanceResult> object. | ||
| 92 | |||
| 93 | 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. | ||
| 94 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBInstance> | ||
| 95 | |||
| 96 | =head1 ATTRIBUTES | ||
| 97 | |||
| 98 | |||
| 99 | =head2 AllocatedStorage => Int | ||
| 100 | |||
| 101 | The amount of storage (in gibibytes) to allocate for the DB instance. | ||
| 102 | |||
| 103 | Type: Integer | ||
| 104 | |||
| 105 | B<Amazon Aurora> | ||
| 106 | |||
| 107 | Not applicable. Aurora cluster volumes automatically grow as the amount | ||
| 108 | of data in your database increases, though you are only charged for the | ||
| 109 | space that you use in an Aurora cluster volume. | ||
| 110 | |||
| 111 | B<MySQL> | ||
| 112 | |||
| 113 | Constraints to the amount of storage for each storage type are the | ||
| 114 | following: | ||
| 115 | |||
| 116 | =over | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | General Purpose (SSD) storage (gp2): Must be an integer from 20 to | ||
| 121 | 65536. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | Magnetic storage (standard): Must be an integer from 5 to 3072. | ||
| 130 | |||
| 131 | =back | ||
| 132 | |||
| 133 | B<MariaDB> | ||
| 134 | |||
| 135 | Constraints to the amount of storage for each storage type are the | ||
| 136 | following: | ||
| 137 | |||
| 138 | =over | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | General Purpose (SSD) storage (gp2): Must be an integer from 20 to | ||
| 143 | 65536. | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. | ||
| 148 | |||
| 149 | =item * | ||
| 150 | |||
| 151 | Magnetic storage (standard): Must be an integer from 5 to 3072. | ||
| 152 | |||
| 153 | =back | ||
| 154 | |||
| 155 | B<PostgreSQL> | ||
| 156 | |||
| 157 | Constraints to the amount of storage for each storage type are the | ||
| 158 | following: | ||
| 159 | |||
| 160 | =over | ||
| 161 | |||
| 162 | =item * | ||
| 163 | |||
| 164 | General Purpose (SSD) storage (gp2): Must be an integer from 20 to | ||
| 165 | 65536. | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. | ||
| 170 | |||
| 171 | =item * | ||
| 172 | |||
| 173 | Magnetic storage (standard): Must be an integer from 5 to 3072. | ||
| 174 | |||
| 175 | =back | ||
| 176 | |||
| 177 | B<Oracle> | ||
| 178 | |||
| 179 | Constraints to the amount of storage for each storage type are the | ||
| 180 | following: | ||
| 181 | |||
| 182 | =over | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | General Purpose (SSD) storage (gp2): Must be an integer from 20 to | ||
| 187 | 65536. | ||
| 188 | |||
| 189 | =item * | ||
| 190 | |||
| 191 | Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. | ||
| 192 | |||
| 193 | =item * | ||
| 194 | |||
| 195 | Magnetic storage (standard): Must be an integer from 10 to 3072. | ||
| 196 | |||
| 197 | =back | ||
| 198 | |||
| 199 | B<SQL Server> | ||
| 200 | |||
| 201 | Constraints to the amount of storage for each storage type are the | ||
| 202 | following: | ||
| 203 | |||
| 204 | =over | ||
| 205 | |||
| 206 | =item * | ||
| 207 | |||
| 208 | General Purpose (SSD) storage (gp2): | ||
| 209 | |||
| 210 | =over | ||
| 211 | |||
| 212 | =item * | ||
| 213 | |||
| 214 | Enterprise and Standard editions: Must be an integer from 200 to 16384. | ||
| 215 | |||
| 216 | =item * | ||
| 217 | |||
| 218 | Web and Express editions: Must be an integer from 20 to 16384. | ||
| 219 | |||
| 220 | =back | ||
| 221 | |||
| 222 | =item * | ||
| 223 | |||
| 224 | Provisioned IOPS storage (io1): | ||
| 225 | |||
| 226 | =over | ||
| 227 | |||
| 228 | =item * | ||
| 229 | |||
| 230 | Enterprise and Standard editions: Must be an integer from 200 to 16384. | ||
| 231 | |||
| 232 | =item * | ||
| 233 | |||
| 234 | Web and Express editions: Must be an integer from 100 to 16384. | ||
| 235 | |||
| 236 | =back | ||
| 237 | |||
| 238 | =item * | ||
| 239 | |||
| 240 | Magnetic storage (standard): | ||
| 241 | |||
| 242 | =over | ||
| 243 | |||
| 244 | =item * | ||
| 245 | |||
| 246 | Enterprise and Standard editions: Must be an integer from 200 to 1024. | ||
| 247 | |||
| 248 | =item * | ||
| 249 | |||
| 250 | Web and Express editions: Must be an integer from 20 to 1024. | ||
| 251 | |||
| 252 | =back | ||
| 253 | |||
| 254 | =back | ||
| 255 | |||
| 256 | |||
| 257 | |||
| 258 | |||
| 259 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 260 | |||
| 261 | A value that indicates whether minor engine upgrades are applied | ||
| 262 | automatically to the DB instance during the maintenance window. By | ||
| 263 | default, minor engine upgrades are applied automatically. | ||
| 264 | |||
| 265 | |||
| 266 | |||
| 267 | =head2 AvailabilityZone => Str | ||
| 268 | |||
| 269 | The Availability Zone (AZ) where the database will be created. For | ||
| 270 | information on Amazon Web Services Regions and Availability Zones, see | ||
| 271 | Regions and Availability Zones | ||
| 272 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). | ||
| 273 | |||
| 274 | Default: A random, system-chosen Availability Zone in the endpoint's | ||
| 275 | Amazon Web Services Region. | ||
| 276 | |||
| 277 | Example: C<us-east-1d> | ||
| 278 | |||
| 279 | Constraint: The C<AvailabilityZone> parameter can't be specified if the | ||
| 280 | DB instance is a Multi-AZ deployment. The specified Availability Zone | ||
| 281 | must be in the same Amazon Web Services Region as the current endpoint. | ||
| 282 | |||
| 283 | If you're creating a DB instance in an RDS on VMware environment, | ||
| 284 | specify the identifier of the custom Availability Zone to create the DB | ||
| 285 | instance in. | ||
| 286 | |||
| 287 | For more information about RDS on VMware, see the RDS on VMware User | ||
| 288 | Guide. | ||
| 289 | (https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html) | ||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | =head2 BackupRetentionPeriod => Int | ||
| 294 | |||
| 295 | The number of days for which automated backups are retained. Setting | ||
| 296 | this parameter to a positive number enables backups. Setting this | ||
| 297 | parameter to 0 disables automated backups. | ||
| 298 | |||
| 299 | B<Amazon Aurora> | ||
| 300 | |||
| 301 | Not applicable. The retention period for automated backups is managed | ||
| 302 | by the DB cluster. | ||
| 303 | |||
| 304 | Default: 1 | ||
| 305 | |||
| 306 | Constraints: | ||
| 307 | |||
| 308 | =over | ||
| 309 | |||
| 310 | =item * | ||
| 311 | |||
| 312 | Must be a value from 0 to 35 | ||
| 313 | |||
| 314 | =item * | ||
| 315 | |||
| 316 | Can't be set to 0 if the DB instance is a source to read replicas | ||
| 317 | |||
| 318 | =back | ||
| 319 | |||
| 320 | |||
| 321 | |||
| 322 | |||
| 323 | =head2 CharacterSetName => Str | ||
| 324 | |||
| 325 | For supported engines, indicates that the DB instance should be | ||
| 326 | associated with the specified CharacterSet. | ||
| 327 | |||
| 328 | B<Amazon Aurora> | ||
| 329 | |||
| 330 | Not applicable. The character set is managed by the DB cluster. For | ||
| 331 | more information, see C<CreateDBCluster>. | ||
| 332 | |||
| 333 | |||
| 334 | |||
| 335 | =head2 CopyTagsToSnapshot => Bool | ||
| 336 | |||
| 337 | A value that indicates whether to copy tags from the DB instance to | ||
| 338 | snapshots of the DB instance. By default, tags are not copied. | ||
| 339 | |||
| 340 | B<Amazon Aurora> | ||
| 341 | |||
| 342 | Not applicable. Copying tags to snapshots is managed by the DB cluster. | ||
| 343 | Setting this value for an Aurora DB instance has no effect on the DB | ||
| 344 | cluster setting. | ||
| 345 | |||
| 346 | |||
| 347 | |||
| 348 | =head2 DBClusterIdentifier => Str | ||
| 349 | |||
| 350 | The identifier of the DB cluster that the instance will belong to. | ||
| 351 | |||
| 352 | |||
| 353 | |||
| 354 | =head2 B<REQUIRED> DBInstanceClass => Str | ||
| 355 | |||
| 356 | The compute and memory capacity of the DB instance, for example, | ||
| 357 | C<db.m4.large>. Not all DB instance classes are available in all Amazon | ||
| 358 | Web Services Regions, or for all database engines. For the full list of | ||
| 359 | DB instance classes, and availability for your engine, see DB Instance | ||
| 360 | Class | ||
| 361 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) | ||
| 362 | in the I<Amazon RDS User Guide.> | ||
| 363 | |||
| 364 | |||
| 365 | |||
| 366 | =head2 B<REQUIRED> DBInstanceIdentifier => Str | ||
| 367 | |||
| 368 | The DB instance identifier. This parameter is stored as a lowercase | ||
| 369 | string. | ||
| 370 | |||
| 371 | Constraints: | ||
| 372 | |||
| 373 | =over | ||
| 374 | |||
| 375 | =item * | ||
| 376 | |||
| 377 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 378 | |||
| 379 | =item * | ||
| 380 | |||
| 381 | First character must be a letter. | ||
| 382 | |||
| 383 | =item * | ||
| 384 | |||
| 385 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 386 | |||
| 387 | =back | ||
| 388 | |||
| 389 | Example: C<mydbinstance> | ||
| 390 | |||
| 391 | |||
| 392 | |||
| 393 | =head2 DBName => Str | ||
| 394 | |||
| 395 | The meaning of this parameter differs according to the database engine | ||
| 396 | you use. | ||
| 397 | |||
| 398 | B<MySQL> | ||
| 399 | |||
| 400 | The name of the database to create when the DB instance is created. If | ||
| 401 | this parameter isn't specified, no database is created in the DB | ||
| 402 | instance. | ||
| 403 | |||
| 404 | Constraints: | ||
| 405 | |||
| 406 | =over | ||
| 407 | |||
| 408 | =item * | ||
| 409 | |||
| 410 | Must contain 1 to 64 letters or numbers. | ||
| 411 | |||
| 412 | =item * | ||
| 413 | |||
| 414 | Must begin with a letter. Subsequent characters can be letters, | ||
| 415 | underscores, or digits (0-9). | ||
| 416 | |||
| 417 | =item * | ||
| 418 | |||
| 419 | Can't be a word reserved by the specified database engine | ||
| 420 | |||
| 421 | =back | ||
| 422 | |||
| 423 | B<MariaDB> | ||
| 424 | |||
| 425 | The name of the database to create when the DB instance is created. If | ||
| 426 | this parameter isn't specified, no database is created in the DB | ||
| 427 | instance. | ||
| 428 | |||
| 429 | Constraints: | ||
| 430 | |||
| 431 | =over | ||
| 432 | |||
| 433 | =item * | ||
| 434 | |||
| 435 | Must contain 1 to 64 letters or numbers. | ||
| 436 | |||
| 437 | =item * | ||
| 438 | |||
| 439 | Must begin with a letter. Subsequent characters can be letters, | ||
| 440 | underscores, or digits (0-9). | ||
| 441 | |||
| 442 | =item * | ||
| 443 | |||
| 444 | Can't be a word reserved by the specified database engine | ||
| 445 | |||
| 446 | =back | ||
| 447 | |||
| 448 | B<PostgreSQL> | ||
| 449 | |||
| 450 | The name of the database to create when the DB instance is created. If | ||
| 451 | this parameter isn't specified, a database named C<postgres> is created | ||
| 452 | in the DB instance. | ||
| 453 | |||
| 454 | Constraints: | ||
| 455 | |||
| 456 | =over | ||
| 457 | |||
| 458 | =item * | ||
| 459 | |||
| 460 | Must contain 1 to 63 letters, numbers, or underscores. | ||
| 461 | |||
| 462 | =item * | ||
| 463 | |||
| 464 | Must begin with a letter. Subsequent characters can be letters, | ||
| 465 | underscores, or digits (0-9). | ||
| 466 | |||
| 467 | =item * | ||
| 468 | |||
| 469 | Can't be a word reserved by the specified database engine | ||
| 470 | |||
| 471 | =back | ||
| 472 | |||
| 473 | B<Oracle> | ||
| 474 | |||
| 475 | The Oracle System ID (SID) of the created DB instance. If you specify | ||
| 476 | C<null>, the default value C<ORCL> is used. You can't specify the | ||
| 477 | string NULL, or any other reserved word, for C<DBName>. | ||
| 478 | |||
| 479 | Default: C<ORCL> | ||
| 480 | |||
| 481 | Constraints: | ||
| 482 | |||
| 483 | =over | ||
| 484 | |||
| 485 | =item * | ||
| 486 | |||
| 487 | Can't be longer than 8 characters | ||
| 488 | |||
| 489 | =back | ||
| 490 | |||
| 491 | B<SQL Server> | ||
| 492 | |||
| 493 | Not applicable. Must be null. | ||
| 494 | |||
| 495 | B<Amazon Aurora MySQL> | ||
| 496 | |||
| 497 | The name of the database to create when the primary DB instance of the | ||
| 498 | Aurora MySQL DB cluster is created. If this parameter isn't specified | ||
| 499 | for an Aurora MySQL DB cluster, no database is created in the DB | ||
| 500 | cluster. | ||
| 501 | |||
| 502 | Constraints: | ||
| 503 | |||
| 504 | =over | ||
| 505 | |||
| 506 | =item * | ||
| 507 | |||
| 508 | It must contain 1 to 64 alphanumeric characters. | ||
| 509 | |||
| 510 | =item * | ||
| 511 | |||
| 512 | It can't be a word reserved by the database engine. | ||
| 513 | |||
| 514 | =back | ||
| 515 | |||
| 516 | B<Amazon Aurora PostgreSQL> | ||
| 517 | |||
| 518 | The name of the database to create when the primary DB instance of the | ||
| 519 | Aurora PostgreSQL DB cluster is created. If this parameter isn't | ||
| 520 | specified for an Aurora PostgreSQL DB cluster, a database named | ||
| 521 | C<postgres> is created in the DB cluster. | ||
| 522 | |||
| 523 | Constraints: | ||
| 524 | |||
| 525 | =over | ||
| 526 | |||
| 527 | =item * | ||
| 528 | |||
| 529 | It must contain 1 to 63 alphanumeric characters. | ||
| 530 | |||
| 531 | =item * | ||
| 532 | |||
| 533 | It must begin with a letter or an underscore. Subsequent characters can | ||
| 534 | be letters, underscores, or digits (0 to 9). | ||
| 535 | |||
| 536 | =item * | ||
| 537 | |||
| 538 | It can't be a word reserved by the database engine. | ||
| 539 | |||
| 540 | =back | ||
| 541 | |||
| 542 | |||
| 543 | |||
| 544 | |||
| 545 | =head2 DBParameterGroupName => Str | ||
| 546 | |||
| 547 | The name of the DB parameter group to associate with this DB instance. | ||
| 548 | If you do not specify a value, then the default DB parameter group for | ||
| 549 | the specified DB engine and version is used. | ||
| 550 | |||
| 551 | Constraints: | ||
| 552 | |||
| 553 | =over | ||
| 554 | |||
| 555 | =item * | ||
| 556 | |||
| 557 | Must be 1 to 255 letters, numbers, or hyphens. | ||
| 558 | |||
| 559 | =item * | ||
| 560 | |||
| 561 | First character must be a letter | ||
| 562 | |||
| 563 | =item * | ||
| 564 | |||
| 565 | Can't end with a hyphen or contain two consecutive hyphens | ||
| 566 | |||
| 567 | =back | ||
| 568 | |||
| 569 | |||
| 570 | |||
| 571 | |||
| 572 | =head2 DBSecurityGroups => ArrayRef[Str|Undef] | ||
| 573 | |||
| 574 | A list of DB security groups to associate with this DB instance. | ||
| 575 | |||
| 576 | Default: The default DB security group for the database engine. | ||
| 577 | |||
| 578 | |||
| 579 | |||
| 580 | =head2 DBSubnetGroupName => Str | ||
| 581 | |||
| 582 | A DB subnet group to associate with this DB instance. | ||
| 583 | |||
| 584 | If there is no DB subnet group, then it is a non-VPC DB instance. | ||
| 585 | |||
| 586 | |||
| 587 | |||
| 588 | =head2 DeletionProtection => Bool | ||
| 589 | |||
| 590 | A value that indicates whether the DB instance has deletion protection | ||
| 591 | enabled. The database can't be deleted when deletion protection is | ||
| 592 | enabled. By default, deletion protection is disabled. For more | ||
| 593 | information, see Deleting a DB Instance | ||
| 594 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). | ||
| 595 | |||
| 596 | B<Amazon Aurora> | ||
| 597 | |||
| 598 | Not applicable. You can enable or disable deletion protection for the | ||
| 599 | DB cluster. For more information, see C<CreateDBCluster>. DB instances | ||
| 600 | in a DB cluster can be deleted even when deletion protection is enabled | ||
| 601 | for the DB cluster. | ||
| 602 | |||
| 603 | |||
| 604 | |||
| 605 | =head2 Domain => Str | ||
| 606 | |||
| 607 | The Active Directory directory ID to create the DB instance in. | ||
| 608 | Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB | ||
| 609 | instances can be created in an Active Directory Domain. | ||
| 610 | |||
| 611 | For more information, see Kerberos Authentication | ||
| 612 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) | ||
| 613 | in the I<Amazon RDS User Guide>. | ||
| 614 | |||
| 615 | |||
| 616 | |||
| 617 | =head2 DomainIAMRoleName => Str | ||
| 618 | |||
| 619 | Specify the name of the IAM role to be used when making API calls to | ||
| 620 | the Directory Service. | ||
| 621 | |||
| 622 | |||
| 623 | |||
| 624 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 625 | |||
| 626 | The list of log types that need to be enabled for exporting to | ||
| 627 | CloudWatch Logs. The values in the list depend on the DB engine being | ||
| 628 | used. For more information, see Publishing Database Logs to Amazon | ||
| 629 | CloudWatch Logs | ||
| 630 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) | ||
| 631 | in the I<Amazon Relational Database Service User Guide>. | ||
| 632 | |||
| 633 | B<Amazon Aurora> | ||
| 634 | |||
| 635 | Not applicable. CloudWatch Logs exports are managed by the DB cluster. | ||
| 636 | |||
| 637 | B<MariaDB> | ||
| 638 | |||
| 639 | Possible values are C<audit>, C<error>, C<general>, and C<slowquery>. | ||
| 640 | |||
| 641 | B<Microsoft SQL Server> | ||
| 642 | |||
| 643 | Possible values are C<agent> and C<error>. | ||
| 644 | |||
| 645 | B<MySQL> | ||
| 646 | |||
| 647 | Possible values are C<audit>, C<error>, C<general>, and C<slowquery>. | ||
| 648 | |||
| 649 | B<Oracle> | ||
| 650 | |||
| 651 | Possible values are C<alert>, C<audit>, C<listener>, C<trace>, and | ||
| 652 | C<oemagent>. | ||
| 653 | |||
| 654 | B<PostgreSQL> | ||
| 655 | |||
| 656 | Possible values are C<postgresql> and C<upgrade>. | ||
| 657 | |||
| 658 | |||
| 659 | |||
| 660 | =head2 EnableCustomerOwnedIp => Bool | ||
| 661 | |||
| 662 | A value that indicates whether to enable a customer-owned IP address | ||
| 663 | (CoIP) for an RDS on Outposts DB instance. | ||
| 664 | |||
| 665 | A I<CoIP> provides local or external connectivity to resources in your | ||
| 666 | Outpost subnets through your on-premises network. For some use cases, a | ||
| 667 | CoIP can provide lower latency for connections to the DB instance from | ||
| 668 | outside of its virtual private cloud (VPC) on your local network. | ||
| 669 | |||
| 670 | For more information about RDS on Outposts, see Working with Amazon RDS | ||
| 671 | on Amazon Web Services Outposts | ||
| 672 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) | ||
| 673 | in the I<Amazon RDS User Guide>. | ||
| 674 | |||
| 675 | For more information about CoIPs, see Customer-owned IP addresses | ||
| 676 | (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing) | ||
| 677 | in the I<Amazon Web Services Outposts User Guide>. | ||
| 678 | |||
| 679 | |||
| 680 | |||
| 681 | =head2 EnableIAMDatabaseAuthentication => Bool | ||
| 682 | |||
| 683 | A value that indicates whether to enable mapping of Amazon Web Services | ||
| 684 | Identity and Access Management (IAM) accounts to database accounts. By | ||
| 685 | default, mapping is disabled. | ||
| 686 | |||
| 687 | This setting doesn't apply to Amazon Aurora. Mapping Amazon Web | ||
| 688 | Services IAM accounts to database accounts is managed by the DB | ||
| 689 | cluster. | ||
| 690 | |||
| 691 | For more information, see IAM Database Authentication for MySQL and | ||
| 692 | PostgreSQL | ||
| 693 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) | ||
| 694 | in the I<Amazon RDS User Guide.> | ||
| 695 | |||
| 696 | |||
| 697 | |||
| 698 | =head2 EnablePerformanceInsights => Bool | ||
| 699 | |||
| 700 | A value that indicates whether to enable Performance Insights for the | ||
| 701 | DB instance. | ||
| 702 | |||
| 703 | For more information, see Using Amazon Performance Insights | ||
| 704 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) | ||
| 705 | in the I<Amazon Relational Database Service User Guide>. | ||
| 706 | |||
| 707 | |||
| 708 | |||
| 709 | =head2 B<REQUIRED> Engine => Str | ||
| 710 | |||
| 711 | The name of the database engine to be used for this instance. | ||
| 712 | |||
| 713 | Not every database engine is available for every Amazon Web Services | ||
| 714 | Region. | ||
| 715 | |||
| 716 | Valid Values: | ||
| 717 | |||
| 718 | =over | ||
| 719 | |||
| 720 | =item * | ||
| 721 | |||
| 722 | C<aurora> (for MySQL 5.6-compatible Aurora) | ||
| 723 | |||
| 724 | =item * | ||
| 725 | |||
| 726 | C<aurora-mysql> (for MySQL 5.7-compatible Aurora) | ||
| 727 | |||
| 728 | =item * | ||
| 729 | |||
| 730 | C<aurora-postgresql> | ||
| 731 | |||
| 732 | =item * | ||
| 733 | |||
| 734 | C<mariadb> | ||
| 735 | |||
| 736 | =item * | ||
| 737 | |||
| 738 | C<mysql> | ||
| 739 | |||
| 740 | =item * | ||
| 741 | |||
| 742 | C<oracle-ee> | ||
| 743 | |||
| 744 | =item * | ||
| 745 | |||
| 746 | C<oracle-ee-cdb> | ||
| 747 | |||
| 748 | =item * | ||
| 749 | |||
| 750 | C<oracle-se2> | ||
| 751 | |||
| 752 | =item * | ||
| 753 | |||
| 754 | C<oracle-se2-cdb> | ||
| 755 | |||
| 756 | =item * | ||
| 757 | |||
| 758 | C<postgres> | ||
| 759 | |||
| 760 | =item * | ||
| 761 | |||
| 762 | C<sqlserver-ee> | ||
| 763 | |||
| 764 | =item * | ||
| 765 | |||
| 766 | C<sqlserver-se> | ||
| 767 | |||
| 768 | =item * | ||
| 769 | |||
| 770 | C<sqlserver-ex> | ||
| 771 | |||
| 772 | =item * | ||
| 773 | |||
| 774 | C<sqlserver-web> | ||
| 775 | |||
| 776 | =back | ||
| 777 | |||
| 778 | |||
| 779 | |||
| 780 | |||
| 781 | =head2 EngineVersion => Str | ||
| 782 | |||
| 783 | The version number of the database engine to use. | ||
| 784 | |||
| 785 | For a list of valid engine versions, use the | ||
| 786 | C<DescribeDBEngineVersions> action. | ||
| 787 | |||
| 788 | The following are the database engines and links to information about | ||
| 789 | the major and minor versions that are available with Amazon RDS. Not | ||
| 790 | every database engine is available for every Amazon Web Services | ||
| 791 | Region. | ||
| 792 | |||
| 793 | B<Amazon Aurora> | ||
| 794 | |||
| 795 | Not applicable. The version number of the database engine to be used by | ||
| 796 | the DB instance is managed by the DB cluster. | ||
| 797 | |||
| 798 | B<MariaDB> | ||
| 799 | |||
| 800 | See MariaDB on Amazon RDS Versions | ||
| 801 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) | ||
| 802 | in the I<Amazon RDS User Guide.> | ||
| 803 | |||
| 804 | B<Microsoft SQL Server> | ||
| 805 | |||
| 806 | See Microsoft SQL Server Versions on Amazon RDS | ||
| 807 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) | ||
| 808 | in the I<Amazon RDS User Guide.> | ||
| 809 | |||
| 810 | B<MySQL> | ||
| 811 | |||
| 812 | See MySQL on Amazon RDS Versions | ||
| 813 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) | ||
| 814 | in the I<Amazon RDS User Guide.> | ||
| 815 | |||
| 816 | B<Oracle> | ||
| 817 | |||
| 818 | See Oracle Database Engine Release Notes | ||
| 819 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) | ||
| 820 | in the I<Amazon RDS User Guide.> | ||
| 821 | |||
| 822 | B<PostgreSQL> | ||
| 823 | |||
| 824 | See Amazon RDS for PostgreSQL versions and extensions | ||
| 825 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) | ||
| 826 | in the I<Amazon RDS User Guide.> | ||
| 827 | |||
| 828 | |||
| 829 | |||
| 830 | =head2 Iops => Int | ||
| 831 | |||
| 832 | The amount of Provisioned IOPS (input/output operations per second) to | ||
| 833 | be initially allocated for the DB instance. For information about valid | ||
| 834 | Iops values, see Amazon RDS Provisioned IOPS Storage to Improve | ||
| 835 | Performance | ||
| 836 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) | ||
| 837 | in the I<Amazon RDS User Guide>. | ||
| 838 | |||
| 839 | Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, | ||
| 840 | must be a multiple between .5 and 50 of the storage amount for the DB | ||
| 841 | instance. For SQL Server DB instances, must be a multiple between 1 and | ||
| 842 | 50 of the storage amount for the DB instance. | ||
| 843 | |||
| 844 | |||
| 845 | |||
| 846 | =head2 KmsKeyId => Str | ||
| 847 | |||
| 848 | The Amazon Web Services KMS key identifier for an encrypted DB | ||
| 849 | instance. | ||
| 850 | |||
| 851 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 852 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 853 | master key (CMK). To use a CMK in a different Amazon Web Services | ||
| 854 | account, specify the key ARN or alias ARN. | ||
| 855 | |||
| 856 | B<Amazon Aurora> | ||
| 857 | |||
| 858 | Not applicable. The Amazon Web Services KMS key identifier is managed | ||
| 859 | by the DB cluster. For more information, see C<CreateDBCluster>. | ||
| 860 | |||
| 861 | If C<StorageEncrypted> is enabled, and you do not specify a value for | ||
| 862 | the C<KmsKeyId> parameter, then Amazon RDS uses your default CMK. There | ||
| 863 | is a default CMK for your Amazon Web Services account. Your Amazon Web | ||
| 864 | Services account has a different default CMK for each Amazon Web | ||
| 865 | Services Region. | ||
| 866 | |||
| 867 | |||
| 868 | |||
| 869 | =head2 LicenseModel => Str | ||
| 870 | |||
| 871 | License model information for this DB instance. | ||
| 872 | |||
| 873 | Valid values: C<license-included> | C<bring-your-own-license> | | ||
| 874 | C<general-public-license> | ||
| 875 | |||
| 876 | |||
| 877 | |||
| 878 | =head2 MasterUsername => Str | ||
| 879 | |||
| 880 | The name for the master user. | ||
| 881 | |||
| 882 | B<Amazon Aurora> | ||
| 883 | |||
| 884 | Not applicable. The name for the master user is managed by the DB | ||
| 885 | cluster. | ||
| 886 | |||
| 887 | B<MariaDB> | ||
| 888 | |||
| 889 | Constraints: | ||
| 890 | |||
| 891 | =over | ||
| 892 | |||
| 893 | =item * | ||
| 894 | |||
| 895 | Required for MariaDB. | ||
| 896 | |||
| 897 | =item * | ||
| 898 | |||
| 899 | Must be 1 to 16 letters or numbers. | ||
| 900 | |||
| 901 | =item * | ||
| 902 | |||
| 903 | Can't be a reserved word for the chosen database engine. | ||
| 904 | |||
| 905 | =back | ||
| 906 | |||
| 907 | B<Microsoft SQL Server> | ||
| 908 | |||
| 909 | Constraints: | ||
| 910 | |||
| 911 | =over | ||
| 912 | |||
| 913 | =item * | ||
| 914 | |||
| 915 | Required for SQL Server. | ||
| 916 | |||
| 917 | =item * | ||
| 918 | |||
| 919 | Must be 1 to 128 letters or numbers. | ||
| 920 | |||
| 921 | =item * | ||
| 922 | |||
| 923 | The first character must be a letter. | ||
| 924 | |||
| 925 | =item * | ||
| 926 | |||
| 927 | Can't be a reserved word for the chosen database engine. | ||
| 928 | |||
| 929 | =back | ||
| 930 | |||
| 931 | B<MySQL> | ||
| 932 | |||
| 933 | Constraints: | ||
| 934 | |||
| 935 | =over | ||
| 936 | |||
| 937 | =item * | ||
| 938 | |||
| 939 | Required for MySQL. | ||
| 940 | |||
| 941 | =item * | ||
| 942 | |||
| 943 | Must be 1 to 16 letters or numbers. | ||
| 944 | |||
| 945 | =item * | ||
| 946 | |||
| 947 | First character must be a letter. | ||
| 948 | |||
| 949 | =item * | ||
| 950 | |||
| 951 | Can't be a reserved word for the chosen database engine. | ||
| 952 | |||
| 953 | =back | ||
| 954 | |||
| 955 | B<Oracle> | ||
| 956 | |||
| 957 | Constraints: | ||
| 958 | |||
| 959 | =over | ||
| 960 | |||
| 961 | =item * | ||
| 962 | |||
| 963 | Required for Oracle. | ||
| 964 | |||
| 965 | =item * | ||
| 966 | |||
| 967 | Must be 1 to 30 letters or numbers. | ||
| 968 | |||
| 969 | =item * | ||
| 970 | |||
| 971 | First character must be a letter. | ||
| 972 | |||
| 973 | =item * | ||
| 974 | |||
| 975 | Can't be a reserved word for the chosen database engine. | ||
| 976 | |||
| 977 | =back | ||
| 978 | |||
| 979 | B<PostgreSQL> | ||
| 980 | |||
| 981 | Constraints: | ||
| 982 | |||
| 983 | =over | ||
| 984 | |||
| 985 | =item * | ||
| 986 | |||
| 987 | Required for PostgreSQL. | ||
| 988 | |||
| 989 | =item * | ||
| 990 | |||
| 991 | Must be 1 to 63 letters or numbers. | ||
| 992 | |||
| 993 | =item * | ||
| 994 | |||
| 995 | First character must be a letter. | ||
| 996 | |||
| 997 | =item * | ||
| 998 | |||
| 999 | Can't be a reserved word for the chosen database engine. | ||
| 1000 | |||
| 1001 | =back | ||
| 1002 | |||
| 1003 | |||
| 1004 | |||
| 1005 | |||
| 1006 | =head2 MasterUserPassword => Str | ||
| 1007 | |||
| 1008 | The password for the master user. The password can include any | ||
| 1009 | printable ASCII character except "/", """, or "@". | ||
| 1010 | |||
| 1011 | B<Amazon Aurora> | ||
| 1012 | |||
| 1013 | Not applicable. The password for the master user is managed by the DB | ||
| 1014 | cluster. | ||
| 1015 | |||
| 1016 | B<MariaDB> | ||
| 1017 | |||
| 1018 | Constraints: Must contain from 8 to 41 characters. | ||
| 1019 | |||
| 1020 | B<Microsoft SQL Server> | ||
| 1021 | |||
| 1022 | Constraints: Must contain from 8 to 128 characters. | ||
| 1023 | |||
| 1024 | B<MySQL> | ||
| 1025 | |||
| 1026 | Constraints: Must contain from 8 to 41 characters. | ||
| 1027 | |||
| 1028 | B<Oracle> | ||
| 1029 | |||
| 1030 | Constraints: Must contain from 8 to 30 characters. | ||
| 1031 | |||
| 1032 | B<PostgreSQL> | ||
| 1033 | |||
| 1034 | Constraints: Must contain from 8 to 128 characters. | ||
| 1035 | |||
| 1036 | |||
| 1037 | |||
| 1038 | =head2 MaxAllocatedStorage => Int | ||
| 1039 | |||
| 1040 | The upper limit to which Amazon RDS can automatically scale the storage | ||
| 1041 | of the DB instance. | ||
| 1042 | |||
| 1043 | For more information about this setting, including limitations that | ||
| 1044 | apply to it, see Managing capacity automatically with Amazon RDS | ||
| 1045 | storage autoscaling | ||
| 1046 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) | ||
| 1047 | in the I<Amazon RDS User Guide>. | ||
| 1048 | |||
| 1049 | |||
| 1050 | |||
| 1051 | =head2 MonitoringInterval => Int | ||
| 1052 | |||
| 1053 | The interval, in seconds, between points when Enhanced Monitoring | ||
| 1054 | metrics are collected for the DB instance. To disable collecting | ||
| 1055 | Enhanced Monitoring metrics, specify 0. The default is 0. | ||
| 1056 | |||
| 1057 | If C<MonitoringRoleArn> is specified, then you must also set | ||
| 1058 | C<MonitoringInterval> to a value other than 0. | ||
| 1059 | |||
| 1060 | Valid Values: C<0, 1, 5, 10, 15, 30, 60> | ||
| 1061 | |||
| 1062 | |||
| 1063 | |||
| 1064 | =head2 MonitoringRoleArn => Str | ||
| 1065 | |||
| 1066 | The ARN for the IAM role that permits RDS to send enhanced monitoring | ||
| 1067 | metrics to Amazon CloudWatch Logs. For example, | ||
| 1068 | C<arn:aws:iam:123456789012:role/emaccess>. For information on creating | ||
| 1069 | a monitoring role, go to Setting Up and Enabling Enhanced Monitoring | ||
| 1070 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) | ||
| 1071 | in the I<Amazon RDS User Guide>. | ||
| 1072 | |||
| 1073 | If C<MonitoringInterval> is set to a value other than 0, then you must | ||
| 1074 | supply a C<MonitoringRoleArn> value. | ||
| 1075 | |||
| 1076 | |||
| 1077 | |||
| 1078 | =head2 MultiAZ => Bool | ||
| 1079 | |||
| 1080 | A value that indicates whether the DB instance is a Multi-AZ | ||
| 1081 | deployment. You can't set the C<AvailabilityZone> parameter if the DB | ||
| 1082 | instance is a Multi-AZ deployment. | ||
| 1083 | |||
| 1084 | |||
| 1085 | |||
| 1086 | =head2 NcharCharacterSetName => Str | ||
| 1087 | |||
| 1088 | The name of the NCHAR character set for the Oracle DB instance. | ||
| 1089 | |||
| 1090 | |||
| 1091 | |||
| 1092 | =head2 OptionGroupName => Str | ||
| 1093 | |||
| 1094 | A value that indicates that the DB instance should be associated with | ||
| 1095 | the specified option group. | ||
| 1096 | |||
| 1097 | Permanent options, such as the TDE option for Oracle Advanced Security | ||
| 1098 | TDE, can't be removed from an option group. Also, that option group | ||
| 1099 | can't be removed from a DB instance once it is associated with a DB | ||
| 1100 | instance | ||
| 1101 | |||
| 1102 | |||
| 1103 | |||
| 1104 | =head2 PerformanceInsightsKMSKeyId => Str | ||
| 1105 | |||
| 1106 | The Amazon Web Services KMS key identifier for encryption of | ||
| 1107 | Performance Insights data. | ||
| 1108 | |||
| 1109 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 1110 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 1111 | master key (CMK). | ||
| 1112 | |||
| 1113 | If you do not specify a value for C<PerformanceInsightsKMSKeyId>, then | ||
| 1114 | Amazon RDS uses your default CMK. There is a default CMK for your | ||
| 1115 | Amazon Web Services account. Your Amazon Web Services account has a | ||
| 1116 | different default CMK for each Amazon Web Services Region. | ||
| 1117 | |||
| 1118 | |||
| 1119 | |||
| 1120 | =head2 PerformanceInsightsRetentionPeriod => Int | ||
| 1121 | |||
| 1122 | The amount of time, in days, to retain Performance Insights data. Valid | ||
| 1123 | values are 7 or 731 (2 years). | ||
| 1124 | |||
| 1125 | |||
| 1126 | |||
| 1127 | =head2 Port => Int | ||
| 1128 | |||
| 1129 | The port number on which the database accepts connections. | ||
| 1130 | |||
| 1131 | B<MySQL> | ||
| 1132 | |||
| 1133 | Default: C<3306> | ||
| 1134 | |||
| 1135 | Valid values: C<1150-65535> | ||
| 1136 | |||
| 1137 | Type: Integer | ||
| 1138 | |||
| 1139 | B<MariaDB> | ||
| 1140 | |||
| 1141 | Default: C<3306> | ||
| 1142 | |||
| 1143 | Valid values: C<1150-65535> | ||
| 1144 | |||
| 1145 | Type: Integer | ||
| 1146 | |||
| 1147 | B<PostgreSQL> | ||
| 1148 | |||
| 1149 | Default: C<5432> | ||
| 1150 | |||
| 1151 | Valid values: C<1150-65535> | ||
| 1152 | |||
| 1153 | Type: Integer | ||
| 1154 | |||
| 1155 | B<Oracle> | ||
| 1156 | |||
| 1157 | Default: C<1521> | ||
| 1158 | |||
| 1159 | Valid values: C<1150-65535> | ||
| 1160 | |||
| 1161 | B<SQL Server> | ||
| 1162 | |||
| 1163 | Default: C<1433> | ||
| 1164 | |||
| 1165 | Valid values: C<1150-65535> except C<1234>, C<1434>, C<3260>, C<3343>, | ||
| 1166 | C<3389>, C<47001>, and C<49152-49156>. | ||
| 1167 | |||
| 1168 | B<Amazon Aurora> | ||
| 1169 | |||
| 1170 | Default: C<3306> | ||
| 1171 | |||
| 1172 | Valid values: C<1150-65535> | ||
| 1173 | |||
| 1174 | Type: Integer | ||
| 1175 | |||
| 1176 | |||
| 1177 | |||
| 1178 | =head2 PreferredBackupWindow => Str | ||
| 1179 | |||
| 1180 | The daily time range during which automated backups are created if | ||
| 1181 | automated backups are enabled, using the C<BackupRetentionPeriod> | ||
| 1182 | parameter. The default is a 30-minute window selected at random from an | ||
| 1183 | 8-hour block of time for each Amazon Web Services Region. For more | ||
| 1184 | information, see Backup window | ||
| 1185 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) | ||
| 1186 | in the I<Amazon RDS User Guide>. | ||
| 1187 | |||
| 1188 | B<Amazon Aurora> | ||
| 1189 | |||
| 1190 | Not applicable. The daily time range for creating automated backups is | ||
| 1191 | managed by the DB cluster. | ||
| 1192 | |||
| 1193 | Constraints: | ||
| 1194 | |||
| 1195 | =over | ||
| 1196 | |||
| 1197 | =item * | ||
| 1198 | |||
| 1199 | Must be in the format C<hh24:mi-hh24:mi>. | ||
| 1200 | |||
| 1201 | =item * | ||
| 1202 | |||
| 1203 | Must be in Universal Coordinated Time (UTC). | ||
| 1204 | |||
| 1205 | =item * | ||
| 1206 | |||
| 1207 | Must not conflict with the preferred maintenance window. | ||
| 1208 | |||
| 1209 | =item * | ||
| 1210 | |||
| 1211 | Must be at least 30 minutes. | ||
| 1212 | |||
| 1213 | =back | ||
| 1214 | |||
| 1215 | |||
| 1216 | |||
| 1217 | |||
| 1218 | =head2 PreferredMaintenanceWindow => Str | ||
| 1219 | |||
| 1220 | The time range each week during which system maintenance can occur, in | ||
| 1221 | Universal Coordinated Time (UTC). For more information, see Amazon RDS | ||
| 1222 | Maintenance Window | ||
| 1223 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance). | ||
| 1224 | |||
| 1225 | Format: C<ddd:hh24:mi-ddd:hh24:mi> | ||
| 1226 | |||
| 1227 | The default is a 30-minute window selected at random from an 8-hour | ||
| 1228 | block of time for each Amazon Web Services Region, occurring on a | ||
| 1229 | random day of the week. | ||
| 1230 | |||
| 1231 | Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. | ||
| 1232 | |||
| 1233 | Constraints: Minimum 30-minute window. | ||
| 1234 | |||
| 1235 | |||
| 1236 | |||
| 1237 | =head2 ProcessorFeatures => ArrayRef[L<Paws::RDS::ProcessorFeature>] | ||
| 1238 | |||
| 1239 | The number of CPU cores and the number of threads per core for the DB | ||
| 1240 | instance class of the DB instance. | ||
| 1241 | |||
| 1242 | |||
| 1243 | |||
| 1244 | =head2 PromotionTier => Int | ||
| 1245 | |||
| 1246 | A value that specifies the order in which an Aurora Replica is promoted | ||
| 1247 | to the primary instance after a failure of the existing primary | ||
| 1248 | instance. For more information, see Fault Tolerance for an Aurora DB | ||
| 1249 | Cluster | ||
| 1250 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) | ||
| 1251 | in the I<Amazon Aurora User Guide>. | ||
| 1252 | |||
| 1253 | Default: 1 | ||
| 1254 | |||
| 1255 | Valid Values: 0 - 15 | ||
| 1256 | |||
| 1257 | |||
| 1258 | |||
| 1259 | =head2 PubliclyAccessible => Bool | ||
| 1260 | |||
| 1261 | A value that indicates whether the DB instance is publicly accessible. | ||
| 1262 | |||
| 1263 | When the DB instance is publicly accessible, its DNS endpoint resolves | ||
| 1264 | to the private IP address from within the DB instance's VPC, and to the | ||
| 1265 | public IP address from outside of the DB instance's VPC. Access to the | ||
| 1266 | DB instance is ultimately controlled by the security group it uses, and | ||
| 1267 | that public access is not permitted if the security group assigned to | ||
| 1268 | the DB instance doesn't permit it. | ||
| 1269 | |||
| 1270 | When the DB instance isn't publicly accessible, it is an internal DB | ||
| 1271 | instance with a DNS name that resolves to a private IP address. | ||
| 1272 | |||
| 1273 | Default: The default behavior varies depending on whether | ||
| 1274 | C<DBSubnetGroupName> is specified. | ||
| 1275 | |||
| 1276 | If C<DBSubnetGroupName> isn't specified, and C<PubliclyAccessible> | ||
| 1277 | isn't specified, the following applies: | ||
| 1278 | |||
| 1279 | =over | ||
| 1280 | |||
| 1281 | =item * | ||
| 1282 | |||
| 1283 | If the default VPC in the target region doesnE<rsquo>t have an Internet | ||
| 1284 | gateway attached to it, the DB instance is private. | ||
| 1285 | |||
| 1286 | =item * | ||
| 1287 | |||
| 1288 | If the default VPC in the target region has an Internet gateway | ||
| 1289 | attached to it, the DB instance is public. | ||
| 1290 | |||
| 1291 | =back | ||
| 1292 | |||
| 1293 | If C<DBSubnetGroupName> is specified, and C<PubliclyAccessible> isn't | ||
| 1294 | specified, the following applies: | ||
| 1295 | |||
| 1296 | =over | ||
| 1297 | |||
| 1298 | =item * | ||
| 1299 | |||
| 1300 | If the subnets are part of a VPC that doesnE<rsquo>t have an Internet | ||
| 1301 | gateway attached to it, the DB instance is private. | ||
| 1302 | |||
| 1303 | =item * | ||
| 1304 | |||
| 1305 | If the subnets are part of a VPC that has an Internet gateway attached | ||
| 1306 | to it, the DB instance is public. | ||
| 1307 | |||
| 1308 | =back | ||
| 1309 | |||
| 1310 | |||
| 1311 | |||
| 1312 | |||
| 1313 | =head2 StorageEncrypted => Bool | ||
| 1314 | |||
| 1315 | A value that indicates whether the DB instance is encrypted. By | ||
| 1316 | default, it isn't encrypted. | ||
| 1317 | |||
| 1318 | B<Amazon Aurora> | ||
| 1319 | |||
| 1320 | Not applicable. The encryption for DB instances is managed by the DB | ||
| 1321 | cluster. | ||
| 1322 | |||
| 1323 | |||
| 1324 | |||
| 1325 | =head2 StorageType => Str | ||
| 1326 | |||
| 1327 | Specifies the storage type to be associated with the DB instance. | ||
| 1328 | |||
| 1329 | Valid values: C<standard | gp2 | io1> | ||
| 1330 | |||
| 1331 | If you specify C<io1>, you must also include a value for the C<Iops> | ||
| 1332 | parameter. | ||
| 1333 | |||
| 1334 | Default: C<io1> if the C<Iops> parameter is specified, otherwise C<gp2> | ||
| 1335 | |||
| 1336 | |||
| 1337 | |||
| 1338 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 1339 | |||
| 1340 | Tags to assign to the DB instance. | ||
| 1341 | |||
| 1342 | |||
| 1343 | |||
| 1344 | =head2 TdeCredentialArn => Str | ||
| 1345 | |||
| 1346 | The ARN from the key store with which to associate the instance for TDE | ||
| 1347 | encryption. | ||
| 1348 | |||
| 1349 | |||
| 1350 | |||
| 1351 | =head2 TdeCredentialPassword => Str | ||
| 1352 | |||
| 1353 | The password for the given ARN from the key store in order to access | ||
| 1354 | the device. | ||
| 1355 | |||
| 1356 | |||
| 1357 | |||
| 1358 | =head2 Timezone => Str | ||
| 1359 | |||
| 1360 | The time zone of the DB instance. The time zone parameter is currently | ||
| 1361 | supported only by Microsoft SQL Server | ||
| 1362 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). | ||
| 1363 | |||
| 1364 | |||
| 1365 | |||
| 1366 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 1367 | |||
| 1368 | A list of Amazon EC2 VPC security groups to associate with this DB | ||
| 1369 | instance. | ||
| 1370 | |||
| 1371 | B<Amazon Aurora> | ||
| 1372 | |||
| 1373 | Not applicable. The associated list of EC2 VPC security groups is | ||
| 1374 | managed by the DB cluster. | ||
| 1375 | |||
| 1376 | Default: The default EC2 VPC security group for the DB subnet group's | ||
| 1377 | VPC. | ||
| 1378 | |||
| 1379 | |||
| 1380 | |||
| 1381 | |||
| 1382 | =head1 SEE ALSO | ||
| 1383 | |||
| 1384 | This class forms part of L<Paws>, documenting arguments for method CreateDBInstance in L<Paws::RDS> | ||
| 1385 | |||
| 1386 | =head1 BUGS and CONTRIBUTIONS | ||
| 1387 | |||
| 1388 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 1389 | |||
| 1390 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 1391 | |||
| 1392 | =cut | ||
| 1393 |