« blib/lib/Paws/RDS/CreateDBInstance.pm
↑ Summary
blib/lib/Paws/RDS/CreateDBInstanceReadReplicaResult.pm »
| 1 | |||
| 2 | package Paws::RDS::CreateDBInstanceReadReplica; | ||
| 3 | use Moose; | ||
| 4 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 5 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 6 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 7 | has DBInstanceClass => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has DBParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 10 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 11 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 12 | has Domain => (is => 'ro', isa => 'Str'); | ||
| 13 | has DomainIAMRoleName => (is => 'ro', isa => 'Str'); | ||
| 14 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 15 | has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool'); | ||
| 16 | has EnablePerformanceInsights => (is => 'ro', isa => 'Bool'); | ||
| 17 | has Iops => (is => 'ro', isa => 'Int'); | ||
| 18 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 19 | has MaxAllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 20 | has MonitoringInterval => (is => 'ro', isa => 'Int'); | ||
| 21 | has MonitoringRoleArn => (is => 'ro', isa => 'Str'); | ||
| 22 | has MultiAZ => (is => 'ro', isa => 'Bool'); | ||
| 23 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 24 | has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str'); | ||
| 25 | has PerformanceInsightsRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 26 | has Port => (is => 'ro', isa => 'Int'); | ||
| 27 | has PreSignedUrl => (is => 'ro', isa => 'Str'); | ||
| 28 | has ProcessorFeatures => (is => 'ro', isa => 'ArrayRef[Paws::RDS::ProcessorFeature]'); | ||
| 29 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | ||
| 30 | has ReplicaMode => (is => 'ro', isa => 'Str'); | ||
| 31 | has SourceDBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 32 | has StorageType => (is => 'ro', isa => 'Str'); | ||
| 33 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 34 | has UseDefaultProcessorFeatures => (is => 'ro', isa => 'Bool'); | ||
| 35 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 36 | |||
| 37 | use MooseX::ClassAttribute; | ||
| 38 | |||
| 39 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBInstanceReadReplica'); | ||
| 40 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CreateDBInstanceReadReplicaResult'); | ||
| 41 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBInstanceReadReplicaResult'); | ||
| 42 | 1; | ||
| 43 | |||
| 44 | ### main pod documentation begin ### | ||
| 45 | |||
| 46 | =head1 NAME | ||
| 47 | |||
| 48 | Paws::RDS::CreateDBInstanceReadReplica - Arguments for method CreateDBInstanceReadReplica on L<Paws::RDS> | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | This class represents the parameters used for calling the method CreateDBInstanceReadReplica on the | ||
| 53 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 54 | as arguments to method CreateDBInstanceReadReplica. | ||
| 55 | |||
| 56 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBInstanceReadReplica. | ||
| 57 | |||
| 58 | =head1 SYNOPSIS | ||
| 59 | |||
| 60 | my $rds = Paws->service('RDS'); | ||
| 61 | # To create a DB instance read replica. | ||
| 62 | # This example creates a DB instance read replica. | ||
| 63 | my $CreateDBInstanceReadReplicaResult = $rds->CreateDBInstanceReadReplica( | ||
| 64 | 'AvailabilityZone' => 'us-east-1a', | ||
| 65 | 'CopyTagsToSnapshot' => 1, | ||
| 66 | 'DBInstanceClass' => 'db.t2.micro', | ||
| 67 | 'DBInstanceIdentifier' => 'mydbreadreplica', | ||
| 68 | 'PubliclyAccessible' => 1, | ||
| 69 | 'SourceDBInstanceIdentifier' => 'mymysqlinstance', | ||
| 70 | 'StorageType' => 'gp2', | ||
| 71 | 'Tags' => [ | ||
| 72 | |||
| 73 | { | ||
| 74 | 'Key' => 'mydbreadreplicakey', | ||
| 75 | 'Value' => 'mydbreadreplicavalue' | ||
| 76 | } | ||
| 77 | ] | ||
| 78 | ); | ||
| 79 | |||
| 80 | # Results: | ||
| 81 | my $DBInstance = $CreateDBInstanceReadReplicaResult->DBInstance; | ||
| 82 | |||
| 83 | # Returns a L<Paws::RDS::CreateDBInstanceReadReplicaResult> object. | ||
| 84 | |||
| 85 | 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. | ||
| 86 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBInstanceReadReplica> | ||
| 87 | |||
| 88 | =head1 ATTRIBUTES | ||
| 89 | |||
| 90 | |||
| 91 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 92 | |||
| 93 | A value that indicates whether minor engine upgrades are applied | ||
| 94 | automatically to the read replica during the maintenance window. | ||
| 95 | |||
| 96 | Default: Inherits from the source DB instance | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 AvailabilityZone => Str | ||
| 101 | |||
| 102 | The Availability Zone (AZ) where the read replica will be created. | ||
| 103 | |||
| 104 | Default: A random, system-chosen Availability Zone in the endpoint's | ||
| 105 | Amazon Web Services Region. | ||
| 106 | |||
| 107 | Example: C<us-east-1d> | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 CopyTagsToSnapshot => Bool | ||
| 112 | |||
| 113 | A value that indicates whether to copy all tags from the read replica | ||
| 114 | to snapshots of the read replica. By default, tags are not copied. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 DBInstanceClass => Str | ||
| 119 | |||
| 120 | The compute and memory capacity of the read replica, for example, | ||
| 121 | C<db.m4.large>. Not all DB instance classes are available in all Amazon | ||
| 122 | Web Services Regions, or for all database engines. For the full list of | ||
| 123 | DB instance classes, and availability for your engine, see DB Instance | ||
| 124 | Class | ||
| 125 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) | ||
| 126 | in the I<Amazon RDS User Guide.> | ||
| 127 | |||
| 128 | Default: Inherits from the source DB instance. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head2 B<REQUIRED> DBInstanceIdentifier => Str | ||
| 133 | |||
| 134 | The DB instance identifier of the read replica. This identifier is the | ||
| 135 | unique key that identifies a DB instance. This parameter is stored as a | ||
| 136 | lowercase string. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 DBParameterGroupName => Str | ||
| 141 | |||
| 142 | The name of the DB parameter group to associate with this DB instance. | ||
| 143 | |||
| 144 | If you do not specify a value for C<DBParameterGroupName>, then Amazon | ||
| 145 | RDS uses the C<DBParameterGroup> of source DB instance for a same | ||
| 146 | region read replica, or the default C<DBParameterGroup> for the | ||
| 147 | specified DB engine for a cross region read replica. | ||
| 148 | |||
| 149 | Currently, specifying a parameter group for this operation is only | ||
| 150 | supported for Oracle DB instances. | ||
| 151 | |||
| 152 | Constraints: | ||
| 153 | |||
| 154 | =over | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | Must be 1 to 255 letters, numbers, or hyphens. | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | First character must be a letter | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | Can't end with a hyphen or contain two consecutive hyphens | ||
| 167 | |||
| 168 | =back | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | =head2 DBSubnetGroupName => Str | ||
| 174 | |||
| 175 | Specifies a DB subnet group for the DB instance. The new DB instance is | ||
| 176 | created in the VPC associated with the DB subnet group. If no DB subnet | ||
| 177 | group is specified, then the new DB instance isn't created in a VPC. | ||
| 178 | |||
| 179 | Constraints: | ||
| 180 | |||
| 181 | =over | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | Can only be specified if the source DB instance identifier specifies a | ||
| 186 | DB instance in another Amazon Web Services Region. | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | If supplied, must match the name of an existing DBSubnetGroup. | ||
| 191 | |||
| 192 | =item * | ||
| 193 | |||
| 194 | The specified DB subnet group must be in the same Amazon Web Services | ||
| 195 | Region in which the operation is running. | ||
| 196 | |||
| 197 | =item * | ||
| 198 | |||
| 199 | All read replicas in one Amazon Web Services Region that are created | ||
| 200 | from the same source DB instance must either:E<gt> | ||
| 201 | |||
| 202 | =over | ||
| 203 | |||
| 204 | =item * | ||
| 205 | |||
| 206 | Specify DB subnet groups from the same VPC. All these read replicas are | ||
| 207 | created in the same VPC. | ||
| 208 | |||
| 209 | =item * | ||
| 210 | |||
| 211 | Not specify a DB subnet group. All these read replicas are created | ||
| 212 | outside of any VPC. | ||
| 213 | |||
| 214 | =back | ||
| 215 | |||
| 216 | =back | ||
| 217 | |||
| 218 | Example: C<mySubnetgroup> | ||
| 219 | |||
| 220 | |||
| 221 | |||
| 222 | =head2 DeletionProtection => Bool | ||
| 223 | |||
| 224 | A value that indicates whether the DB instance has deletion protection | ||
| 225 | enabled. The database can't be deleted when deletion protection is | ||
| 226 | enabled. By default, deletion protection is disabled. For more | ||
| 227 | information, see Deleting a DB Instance | ||
| 228 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). | ||
| 229 | |||
| 230 | |||
| 231 | |||
| 232 | =head2 Domain => Str | ||
| 233 | |||
| 234 | The Active Directory directory ID to create the DB instance in. | ||
| 235 | Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB | ||
| 236 | instances can be created in an Active Directory Domain. | ||
| 237 | |||
| 238 | For more information, see Kerberos Authentication | ||
| 239 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) | ||
| 240 | in the I<Amazon RDS User Guide>. | ||
| 241 | |||
| 242 | |||
| 243 | |||
| 244 | =head2 DomainIAMRoleName => Str | ||
| 245 | |||
| 246 | Specify the name of the IAM role to be used when making API calls to | ||
| 247 | the Directory Service. | ||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 252 | |||
| 253 | The list of logs that the new DB instance is to export to CloudWatch | ||
| 254 | Logs. The values in the list depend on the DB engine being used. For | ||
| 255 | more information, see Publishing Database Logs to Amazon CloudWatch | ||
| 256 | Logs | ||
| 257 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) | ||
| 258 | in the I<Amazon RDS User Guide>. | ||
| 259 | |||
| 260 | |||
| 261 | |||
| 262 | =head2 EnableIAMDatabaseAuthentication => Bool | ||
| 263 | |||
| 264 | A value that indicates whether to enable mapping of Amazon Web Services | ||
| 265 | Identity and Access Management (IAM) accounts to database accounts. By | ||
| 266 | default, mapping is disabled. | ||
| 267 | |||
| 268 | For more information about IAM database authentication, see IAM | ||
| 269 | Database Authentication for MySQL and PostgreSQL | ||
| 270 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) | ||
| 271 | in the I<Amazon RDS User Guide.> | ||
| 272 | |||
| 273 | |||
| 274 | |||
| 275 | =head2 EnablePerformanceInsights => Bool | ||
| 276 | |||
| 277 | A value that indicates whether to enable Performance Insights for the | ||
| 278 | read replica. | ||
| 279 | |||
| 280 | For more information, see Using Amazon Performance Insights | ||
| 281 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) | ||
| 282 | in the I<Amazon RDS User Guide>. | ||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | =head2 Iops => Int | ||
| 287 | |||
| 288 | The amount of Provisioned IOPS (input/output operations per second) to | ||
| 289 | be initially allocated for the DB instance. | ||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | =head2 KmsKeyId => Str | ||
| 294 | |||
| 295 | The Amazon Web Services KMS key identifier for an encrypted read | ||
| 296 | replica. | ||
| 297 | |||
| 298 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 299 | alias ARN, or alias name for the Amazon Web Services KMS CMK. | ||
| 300 | |||
| 301 | If you create an encrypted read replica in the same Amazon Web Services | ||
| 302 | Region as the source DB instance, then do not specify a value for this | ||
| 303 | parameter. A read replica in the same Region is always encrypted with | ||
| 304 | the same Amazon Web Services KMS CMK as the source DB instance. | ||
| 305 | |||
| 306 | If you create an encrypted read replica in a different Amazon Web | ||
| 307 | Services Region, then you must specify a Amazon Web Services KMS key | ||
| 308 | identifier for the destination Amazon Web Services Region. Amazon Web | ||
| 309 | Services KMS CMKs are specific to the Amazon Web Services Region that | ||
| 310 | they are created in, and you can't use CMKs from one Amazon Web | ||
| 311 | Services Region in another Amazon Web Services Region. | ||
| 312 | |||
| 313 | You can't create an encrypted read replica from an unencrypted DB | ||
| 314 | instance. | ||
| 315 | |||
| 316 | |||
| 317 | |||
| 318 | =head2 MaxAllocatedStorage => Int | ||
| 319 | |||
| 320 | The upper limit to which Amazon RDS can automatically scale the storage | ||
| 321 | of the DB instance. | ||
| 322 | |||
| 323 | For more information about this setting, including limitations that | ||
| 324 | apply to it, see Managing capacity automatically with Amazon RDS | ||
| 325 | storage autoscaling | ||
| 326 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) | ||
| 327 | in the I<Amazon RDS User Guide>. | ||
| 328 | |||
| 329 | |||
| 330 | |||
| 331 | =head2 MonitoringInterval => Int | ||
| 332 | |||
| 333 | The interval, in seconds, between points when Enhanced Monitoring | ||
| 334 | metrics are collected for the read replica. To disable collecting | ||
| 335 | Enhanced Monitoring metrics, specify 0. The default is 0. | ||
| 336 | |||
| 337 | If C<MonitoringRoleArn> is specified, then you must also set | ||
| 338 | C<MonitoringInterval> to a value other than 0. | ||
| 339 | |||
| 340 | Valid Values: C<0, 1, 5, 10, 15, 30, 60> | ||
| 341 | |||
| 342 | |||
| 343 | |||
| 344 | =head2 MonitoringRoleArn => Str | ||
| 345 | |||
| 346 | The ARN for the IAM role that permits RDS to send enhanced monitoring | ||
| 347 | metrics to Amazon CloudWatch Logs. For example, | ||
| 348 | C<arn:aws:iam:123456789012:role/emaccess>. For information on creating | ||
| 349 | a monitoring role, go to To create an IAM role for Amazon RDS Enhanced | ||
| 350 | Monitoring | ||
| 351 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) | ||
| 352 | in the I<Amazon RDS User Guide>. | ||
| 353 | |||
| 354 | If C<MonitoringInterval> is set to a value other than 0, then you must | ||
| 355 | supply a C<MonitoringRoleArn> value. | ||
| 356 | |||
| 357 | |||
| 358 | |||
| 359 | =head2 MultiAZ => Bool | ||
| 360 | |||
| 361 | A value that indicates whether the read replica is in a Multi-AZ | ||
| 362 | deployment. | ||
| 363 | |||
| 364 | You can create a read replica as a Multi-AZ DB instance. RDS creates a | ||
| 365 | standby of your replica in another Availability Zone for failover | ||
| 366 | support for the replica. Creating your read replica as a Multi-AZ DB | ||
| 367 | instance is independent of whether the source database is a Multi-AZ DB | ||
| 368 | instance. | ||
| 369 | |||
| 370 | |||
| 371 | |||
| 372 | =head2 OptionGroupName => Str | ||
| 373 | |||
| 374 | The option group the DB instance is associated with. If omitted, the | ||
| 375 | option group associated with the source instance is used. | ||
| 376 | |||
| 377 | For SQL Server, you must use the option group associated with the | ||
| 378 | source instance. | ||
| 379 | |||
| 380 | |||
| 381 | |||
| 382 | =head2 PerformanceInsightsKMSKeyId => Str | ||
| 383 | |||
| 384 | The Amazon Web Services KMS key identifier for encryption of | ||
| 385 | Performance Insights data. | ||
| 386 | |||
| 387 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 388 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 389 | master key (CMK). | ||
| 390 | |||
| 391 | If you do not specify a value for C<PerformanceInsightsKMSKeyId>, then | ||
| 392 | Amazon RDS uses your default CMK. There is a default CMK for your | ||
| 393 | Amazon Web Services account. Your Amazon Web Services account has a | ||
| 394 | different default CMK for each Amazon Web Services Region. | ||
| 395 | |||
| 396 | |||
| 397 | |||
| 398 | =head2 PerformanceInsightsRetentionPeriod => Int | ||
| 399 | |||
| 400 | The amount of time, in days, to retain Performance Insights data. Valid | ||
| 401 | values are 7 or 731 (2 years). | ||
| 402 | |||
| 403 | |||
| 404 | |||
| 405 | =head2 Port => Int | ||
| 406 | |||
| 407 | The port number that the DB instance uses for connections. | ||
| 408 | |||
| 409 | Default: Inherits from the source DB instance | ||
| 410 | |||
| 411 | Valid Values: C<1150-65535> | ||
| 412 | |||
| 413 | |||
| 414 | |||
| 415 | =head2 PreSignedUrl => Str | ||
| 416 | |||
| 417 | The URL that contains a Signature Version 4 signed request for the | ||
| 418 | C<CreateDBInstanceReadReplica> API action in the source Amazon Web | ||
| 419 | Services Region that contains the source DB instance. | ||
| 420 | |||
| 421 | You must specify this parameter when you create an encrypted read | ||
| 422 | replica from another Amazon Web Services Region by using the Amazon RDS | ||
| 423 | API. Don't specify C<PreSignedUrl> when you are creating an encrypted | ||
| 424 | read replica in the same Amazon Web Services Region. | ||
| 425 | |||
| 426 | The presigned URL must be a valid request for the | ||
| 427 | C<CreateDBInstanceReadReplica> API action that can be executed in the | ||
| 428 | source Amazon Web Services Region that contains the encrypted source DB | ||
| 429 | instance. The presigned URL request must contain the following | ||
| 430 | parameter values: | ||
| 431 | |||
| 432 | =over | ||
| 433 | |||
| 434 | =item * | ||
| 435 | |||
| 436 | C<DestinationRegion> - The Amazon Web Services Region that the | ||
| 437 | encrypted read replica is created in. This Amazon Web Services Region | ||
| 438 | is the same one where the C<CreateDBInstanceReadReplica> action is | ||
| 439 | called that contains this presigned URL. | ||
| 440 | |||
| 441 | For example, if you create an encrypted DB instance in the us-west-1 | ||
| 442 | Amazon Web Services Region, from a source DB instance in the us-east-2 | ||
| 443 | Amazon Web Services Region, then you call the | ||
| 444 | C<CreateDBInstanceReadReplica> action in the us-east-1 Amazon Web | ||
| 445 | Services Region and provide a presigned URL that contains a call to the | ||
| 446 | C<CreateDBInstanceReadReplica> action in the us-west-2 Amazon Web | ||
| 447 | Services Region. For this example, the C<DestinationRegion> in the | ||
| 448 | presigned URL must be set to the us-east-1 Amazon Web Services Region. | ||
| 449 | |||
| 450 | =item * | ||
| 451 | |||
| 452 | C<KmsKeyId> - The Amazon Web Services KMS key identifier for the key to | ||
| 453 | use to encrypt the read replica in the destination Amazon Web Services | ||
| 454 | Region. This is the same identifier for both the | ||
| 455 | C<CreateDBInstanceReadReplica> action that is called in the destination | ||
| 456 | Amazon Web Services Region, and the action contained in the presigned | ||
| 457 | URL. | ||
| 458 | |||
| 459 | =item * | ||
| 460 | |||
| 461 | C<SourceDBInstanceIdentifier> - The DB instance identifier for the | ||
| 462 | encrypted DB instance to be replicated. This identifier must be in the | ||
| 463 | Amazon Resource Name (ARN) format for the source Amazon Web Services | ||
| 464 | Region. For example, if you are creating an encrypted read replica from | ||
| 465 | a DB instance in the us-west-2 Amazon Web Services Region, then your | ||
| 466 | C<SourceDBInstanceIdentifier> looks like the following example: | ||
| 467 | C<arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115>. | ||
| 468 | |||
| 469 | =back | ||
| 470 | |||
| 471 | To learn how to generate a Signature Version 4 signed request, see | ||
| 472 | Authenticating Requests: Using Query Parameters (Amazon Web Services | ||
| 473 | Signature Version 4) | ||
| 474 | (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) | ||
| 475 | and Signature Version 4 Signing Process | ||
| 476 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). | ||
| 477 | |||
| 478 | If you are using an Amazon Web Services SDK tool or the CLI, you can | ||
| 479 | specify C<SourceRegion> (or C<--source-region> for the CLI) instead of | ||
| 480 | specifying C<PreSignedUrl> manually. Specifying C<SourceRegion> | ||
| 481 | autogenerates a presigned URL that is a valid request for the operation | ||
| 482 | that can be executed in the source Amazon Web Services Region. | ||
| 483 | |||
| 484 | C<SourceRegion> isn't supported for SQL Server, because SQL Server on | ||
| 485 | Amazon RDS doesn't support cross-region read replicas. | ||
| 486 | |||
| 487 | |||
| 488 | |||
| 489 | =head2 ProcessorFeatures => ArrayRef[L<Paws::RDS::ProcessorFeature>] | ||
| 490 | |||
| 491 | The number of CPU cores and the number of threads per core for the DB | ||
| 492 | instance class of the DB instance. | ||
| 493 | |||
| 494 | |||
| 495 | |||
| 496 | =head2 PubliclyAccessible => Bool | ||
| 497 | |||
| 498 | A value that indicates whether the DB instance is publicly accessible. | ||
| 499 | |||
| 500 | When the DB instance is publicly accessible, its DNS endpoint resolves | ||
| 501 | to the private IP address from within the DB instance's VPC, and to the | ||
| 502 | public IP address from outside of the DB instance's VPC. Access to the | ||
| 503 | DB instance is ultimately controlled by the security group it uses, and | ||
| 504 | that public access is not permitted if the security group assigned to | ||
| 505 | the DB instance doesn't permit it. | ||
| 506 | |||
| 507 | When the DB instance isn't publicly accessible, it is an internal DB | ||
| 508 | instance with a DNS name that resolves to a private IP address. | ||
| 509 | |||
| 510 | For more information, see CreateDBInstance. | ||
| 511 | |||
| 512 | |||
| 513 | |||
| 514 | =head2 ReplicaMode => Str | ||
| 515 | |||
| 516 | The open mode of the replica database: mounted or read-only. | ||
| 517 | |||
| 518 | This parameter is only supported for Oracle DB instances. | ||
| 519 | |||
| 520 | Mounted DB replicas are included in Oracle Enterprise Edition. The main | ||
| 521 | use case for mounted replicas is cross-Region disaster recovery. The | ||
| 522 | primary database doesn't use Active Data Guard to transmit information | ||
| 523 | to the mounted replica. Because it doesn't accept user connections, a | ||
| 524 | mounted replica can't serve a read-only workload. | ||
| 525 | |||
| 526 | You can create a combination of mounted and read-only DB replicas for | ||
| 527 | the same primary DB instance. For more information, see Working with | ||
| 528 | Oracle Read Replicas for Amazon RDS | ||
| 529 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) | ||
| 530 | in the I<Amazon RDS User Guide>. | ||
| 531 | |||
| 532 | Valid values are: C<"open-read-only">, C<"mounted"> | ||
| 533 | |||
| 534 | =head2 B<REQUIRED> SourceDBInstanceIdentifier => Str | ||
| 535 | |||
| 536 | The identifier of the DB instance that will act as the source for the | ||
| 537 | read replica. Each DB instance can have up to five read replicas. | ||
| 538 | |||
| 539 | Constraints: | ||
| 540 | |||
| 541 | =over | ||
| 542 | |||
| 543 | =item * | ||
| 544 | |||
| 545 | Must be the identifier of an existing MySQL, MariaDB, Oracle, | ||
| 546 | PostgreSQL, or SQL Server DB instance. | ||
| 547 | |||
| 548 | =item * | ||
| 549 | |||
| 550 | Can specify a DB instance that is a MySQL read replica only if the | ||
| 551 | source is running MySQL 5.6 or later. | ||
| 552 | |||
| 553 | =item * | ||
| 554 | |||
| 555 | For the limitations of Oracle read replicas, see Read Replica | ||
| 556 | Limitations with Oracle | ||
| 557 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) | ||
| 558 | in the I<Amazon RDS User Guide>. | ||
| 559 | |||
| 560 | =item * | ||
| 561 | |||
| 562 | For the limitations of SQL Server read replicas, see Read Replica | ||
| 563 | Limitations with Microsoft SQL Server | ||
| 564 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html) | ||
| 565 | in the I<Amazon RDS User Guide>. | ||
| 566 | |||
| 567 | =item * | ||
| 568 | |||
| 569 | Can specify a PostgreSQL DB instance only if the source is running | ||
| 570 | PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region | ||
| 571 | replication). | ||
| 572 | |||
| 573 | =item * | ||
| 574 | |||
| 575 | The specified DB instance must have automatic backups enabled, that is, | ||
| 576 | its backup retention period must be greater than 0. | ||
| 577 | |||
| 578 | =item * | ||
| 579 | |||
| 580 | If the source DB instance is in the same Amazon Web Services Region as | ||
| 581 | the read replica, specify a valid DB instance identifier. | ||
| 582 | |||
| 583 | =item * | ||
| 584 | |||
| 585 | If the source DB instance is in a different Amazon Web Services Region | ||
| 586 | from the read replica, specify a valid DB instance ARN. For more | ||
| 587 | information, see Constructing an ARN for Amazon RDS | ||
| 588 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) | ||
| 589 | in the I<Amazon RDS User Guide>. This doesn't apply to SQL Server, | ||
| 590 | which doesn't support cross-region replicas. | ||
| 591 | |||
| 592 | =back | ||
| 593 | |||
| 594 | |||
| 595 | |||
| 596 | |||
| 597 | =head2 StorageType => Str | ||
| 598 | |||
| 599 | Specifies the storage type to be associated with the read replica. | ||
| 600 | |||
| 601 | Valid values: C<standard | gp2 | io1> | ||
| 602 | |||
| 603 | If you specify C<io1>, you must also include a value for the C<Iops> | ||
| 604 | parameter. | ||
| 605 | |||
| 606 | Default: C<io1> if the C<Iops> parameter is specified, otherwise C<gp2> | ||
| 607 | |||
| 608 | |||
| 609 | |||
| 610 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 611 | |||
| 612 | |||
| 613 | |||
| 614 | |||
| 615 | |||
| 616 | =head2 UseDefaultProcessorFeatures => Bool | ||
| 617 | |||
| 618 | A value that indicates whether the DB instance class of the DB instance | ||
| 619 | uses its default processor features. | ||
| 620 | |||
| 621 | |||
| 622 | |||
| 623 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 624 | |||
| 625 | A list of EC2 VPC security groups to associate with the read replica. | ||
| 626 | |||
| 627 | Default: The default EC2 VPC security group for the DB subnet group's | ||
| 628 | VPC. | ||
| 629 | |||
| 630 | |||
| 631 | |||
| 632 | |||
| 633 | =head1 SEE ALSO | ||
| 634 | |||
| 635 | This class forms part of L<Paws>, documenting arguments for method CreateDBInstanceReadReplica in L<Paws::RDS> | ||
| 636 | |||
| 637 | =head1 BUGS and CONTRIBUTIONS | ||
| 638 | |||
| 639 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 640 | |||
| 641 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 642 | |||
| 643 | =cut | ||
| 644 |