class Aws::RDS::Types::CreateDBInstanceReadReplicaMessage

@note When making an API call, you may pass CreateDBInstanceReadReplicaMessage

data as a hash:

    {
      db_instance_identifier: "String", # required
      source_db_instance_identifier: "String", # required
      db_instance_class: "String",
      availability_zone: "String",
      port: 1,
      multi_az: false,
      auto_minor_version_upgrade: false,
      iops: 1,
      option_group_name: "String",
      db_parameter_group_name: "String",
      publicly_accessible: false,
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
      db_subnet_group_name: "String",
      vpc_security_group_ids: ["String"],
      storage_type: "String",
      copy_tags_to_snapshot: false,
      monitoring_interval: 1,
      monitoring_role_arn: "String",
      kms_key_id: "String",
      pre_signed_url: "String",
      enable_iam_database_authentication: false,
      enable_performance_insights: false,
      performance_insights_kms_key_id: "String",
      performance_insights_retention_period: 1,
      enable_cloudwatch_logs_exports: ["String"],
      processor_features: [
        {
          name: "String",
          value: "String",
        },
      ],
      use_default_processor_features: false,
      deletion_protection: false,
      domain: "String",
      domain_iam_role_name: "String",
      replica_mode: "open-read-only", # accepts open-read-only, mounted
      max_allocated_storage: 1,
      source_region: "String",
    }

@!attribute [rw] db_instance_identifier

The DB instance identifier of the read replica. This identifier is
the unique key that identifies a DB instance. This parameter is
stored as a lowercase string.
@return [String]

@!attribute [rw] source_db_instance_identifier

The identifier of the DB instance that will act as the source for
the read replica. Each DB instance can have up to five read
replicas.

Constraints:

* Must be the identifier of an existing MySQL, MariaDB, Oracle,
  PostgreSQL, or SQL Server DB instance.

* Can specify a DB instance that is a MySQL read replica only if the
  source is running MySQL 5.6 or later.

* For the limitations of Oracle read replicas, see [Read Replica
  Limitations with Oracle][1] in the *Amazon RDS User Guide*.

* For the limitations of SQL Server read replicas, see [Read Replica
  Limitations with Microsoft SQL Server][2] in the *Amazon RDS User
  Guide*.

* Can specify a PostgreSQL DB instance only if the source is running
  PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region
  replication).

* The specified DB instance must have automatic backups enabled,
  that is, its backup retention period must be greater than 0.

* If the source DB instance is in the same Amazon Web Services
  Region as the read replica, specify a valid DB instance
  identifier.

* If the source DB instance is in a different Amazon Web Services
  Region from the read replica, specify a valid DB instance ARN. For
  more information, see [Constructing an ARN for Amazon RDS][3] in
  the *Amazon RDS User Guide*. This doesn't apply to SQL Server,
  which doesn't support cross-region replicas.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
[2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html
[3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
@return [String]

@!attribute [rw] db_instance_class

The compute and memory capacity of the read replica, for example,
`db.m4.large`. Not all DB instance classes are available in all
Amazon Web Services Regions, or for all database engines. For the
full list of DB instance classes, and availability for your engine,
see [DB Instance Class][1] in the *Amazon RDS User Guide.*

Default: Inherits from the source DB instance.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
@return [String]

@!attribute [rw] availability_zone

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the
endpoint's Amazon Web Services Region.

Example: `us-east-1d`
@return [String]

@!attribute [rw] port

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: `1150-65535`
@return [Integer]

@!attribute [rw] multi_az

A value that indicates whether the read replica is in a Multi-AZ
deployment.

You can create a read replica as a Multi-AZ DB instance. RDS creates
a standby of your replica in another Availability Zone for failover
support for the replica. Creating your read replica as a Multi-AZ DB
instance is independent of whether the source database is a Multi-AZ
DB instance.
@return [Boolean]

@!attribute [rw] auto_minor_version_upgrade

A value that indicates whether minor engine upgrades are applied
automatically to the read replica during the maintenance window.

Default: Inherits from the source DB instance
@return [Boolean]

@!attribute [rw] iops

The amount of Provisioned IOPS (input/output operations per second)
to be initially allocated for the DB instance.
@return [Integer]

@!attribute [rw] option_group_name

The option group the DB instance is associated with. If omitted, the
option group associated with the source instance is used.

<note markdown="1"> For SQL Server, you must use the option group associated with the
source instance.

 </note>
@return [String]

@!attribute [rw] db_parameter_group_name

The name of the DB parameter group to associate with this DB
instance.

If you do not specify a value for `DBParameterGroupName`, then
Amazon RDS uses the `DBParameterGroup` of source DB instance for a
same region read replica, or the default `DBParameterGroup` for the
specified DB engine for a cross region read replica.

<note markdown="1"> Currently, specifying a parameter group for this operation is only
supported for Oracle DB instances.

 </note>

Constraints:

* Must be 1 to 255 letters, numbers, or hyphens.

* First character must be a letter

* Can't end with a hyphen or contain two consecutive hyphens
@return [String]

@!attribute [rw] publicly_accessible

A value that indicates whether the DB instance is publicly
accessible.

When the DB instance is publicly accessible, its DNS endpoint
resolves to the private IP address from within the DB instance's
VPC, and to the public IP address from outside of the DB instance's
VPC. Access to the DB instance is ultimately controlled by the
security group it uses, and that public access is not permitted if
the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal
DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.
@return [Boolean]

@!attribute [rw] tags

A list of tags. For more information, see [Tagging Amazon RDS
Resources][1] in the *Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
@return [Array<Types::Tag>]

@!attribute [rw] db_subnet_group_name

Specifies a DB subnet group for the DB instance. The new DB instance
is created in the VPC associated with the DB subnet group. If no DB
subnet group is specified, then the new DB instance isn't created
in a VPC.

Constraints:

* Can only be specified if the source DB instance identifier
  specifies a DB instance in another Amazon Web Services Region.

* If supplied, must match the name of an existing DBSubnetGroup.

* The specified DB subnet group must be in the same Amazon Web
  Services Region in which the operation is running.

* All read replicas in one Amazon Web Services Region that are
  created from the same source DB instance must either:&gt;

  * Specify DB subnet groups from the same VPC. All these read
    replicas are created in the same VPC.

  * Not specify a DB subnet group. All these read replicas are
    created outside of any VPC.

Example: `mySubnetgroup`
@return [String]

@!attribute [rw] vpc_security_group_ids

A list of EC2 VPC security groups to associate with the read
replica.

Default: The default EC2 VPC security group for the DB subnet
group's VPC.
@return [Array<String>]

@!attribute [rw] storage_type

Specifies the storage type to be associated with the read replica.

Valid values: `standard | gp2 | io1`

If you specify `io1`, you must also include a value for the `Iops`
parameter.

Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
@return [String]

@!attribute [rw] copy_tags_to_snapshot

A value that indicates whether to copy all tags from the read
replica to snapshots of the read replica. By default, tags are not
copied.
@return [Boolean]

@!attribute [rw] monitoring_interval

The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the read replica. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.

If `MonitoringRoleArn` is specified, then you must also set
`MonitoringInterval` to a value other than 0.

Valid Values: `0, 1, 5, 10, 15, 30, 60`
@return [Integer]

@!attribute [rw] monitoring_role_arn

The ARN for the IAM role that permits RDS to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
`arn:aws:iam:123456789012:role/emaccess`. For information on
creating a monitoring role, go to [To create an IAM role for Amazon
RDS Enhanced Monitoring][1] in the *Amazon RDS User Guide*.

If `MonitoringInterval` is set to a value other than 0, then you
must supply a `MonitoringRoleArn` value.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
@return [String]

@!attribute [rw] kms_key_id

The Amazon Web Services KMS key identifier for an encrypted read
replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web
Services Region as the source DB instance, then do not specify a
value for this parameter. A read replica in the same Region is
always encrypted with the same Amazon Web Services KMS CMK as the
source DB instance.

If you create an encrypted read replica in a different Amazon Web
Services Region, then you must specify a Amazon Web Services KMS key
identifier for the destination Amazon Web Services Region. Amazon
Web Services KMS CMKs are specific to the Amazon Web Services Region
that they are created in, and you can't use CMKs from one Amazon
Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB
instance.
@return [String]

@!attribute [rw] pre_signed_url

The URL that contains a Signature Version 4 signed request for the
`CreateDBInstanceReadReplica` API action in the source Amazon Web
Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read
replica from another Amazon Web Services Region by using the Amazon
RDS API. Don't specify `PreSignedUrl` when you are creating an
encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the
`CreateDBInstanceReadReplica` API action that can be executed in the
source Amazon Web Services Region that contains the encrypted source
DB instance. The presigned URL request must contain the following
parameter values:

* `DestinationRegion` - The Amazon Web Services Region that the
  encrypted read replica is created in. This Amazon Web Services
  Region is the same one where the `CreateDBInstanceReadReplica`
  action is called that contains this presigned URL.

  For example, if you create an encrypted DB instance in the
  us-west-1 Amazon Web Services Region, from a source DB instance in
  the us-east-2 Amazon Web Services Region, then you call the
  `CreateDBInstanceReadReplica` action in the us-east-1 Amazon Web
  Services Region and provide a presigned URL that contains a call
  to the `CreateDBInstanceReadReplica` action in the us-west-2
  Amazon Web Services Region. For this example, the
  `DestinationRegion` in the presigned URL must be set to the
  us-east-1 Amazon Web Services Region.

* `KmsKeyId` - The Amazon Web Services KMS key identifier for the
  key to use to encrypt the read replica in the destination Amazon
  Web Services Region. This is the same identifier for both the
  `CreateDBInstanceReadReplica` action that is called in the
  destination Amazon Web Services Region, and the action contained
  in the presigned URL.

* `SourceDBInstanceIdentifier` - The DB instance identifier for the
  encrypted DB instance to be replicated. This identifier must be in
  the Amazon Resource Name (ARN) format for the source Amazon Web
  Services Region. For example, if you are creating an encrypted
  read replica from a DB instance in the us-west-2 Amazon Web
  Services Region, then your `SourceDBInstanceIdentifier` looks like
  the following example:
  `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.

To learn how to generate a Signature Version 4 signed request, see
[Authenticating Requests: Using Query Parameters (Amazon Web
Services Signature Version 4)][1] and [Signature Version 4 Signing
Process][2].

<note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
specify `SourceRegion` (or `--source-region` for the CLI) instead of
specifying `PreSignedUrl` manually. Specifying `SourceRegion`
autogenerates a presigned URL that is a valid request for the
operation that can be executed in the source Amazon Web Services
Region.

 `SourceRegion` isn't supported for SQL Server, because SQL Server
on Amazon RDS doesn't support cross-region read replicas.

 </note>

[1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
[2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
@return [String]

@!attribute [rw] enable_iam_database_authentication

A value that indicates whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database
accounts. By default, mapping is disabled.

For more information about IAM database authentication, see [ IAM
Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
@return [Boolean]

@!attribute [rw] enable_performance_insights

A value that indicates whether to enable Performance Insights for
the read replica.

For more information, see [Using Amazon Performance Insights][1] in
the *Amazon RDS User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
@return [Boolean]

@!attribute [rw] performance_insights_kms_key_id

The Amazon Web Services KMS key identifier for encryption of
Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS customer
master key (CMK).

If you do not specify a value for `PerformanceInsightsKMSKeyId`,
then Amazon RDS uses your default CMK. There is a default CMK for
your Amazon Web Services account. Your Amazon Web Services account
has a different default CMK for each Amazon Web Services Region.
@return [String]

@!attribute [rw] performance_insights_retention_period

The amount of time, in days, to retain Performance Insights data.
Valid values are 7 or 731 (2 years).
@return [Integer]

@!attribute [rw] enable_cloudwatch_logs_exports

The list of logs that the new DB instance is to export to CloudWatch
Logs. The values in the list depend on the DB engine being used. For
more information, see [Publishing Database Logs to Amazon CloudWatch
Logs ][1] in the *Amazon RDS User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@return [Array<String>]

@!attribute [rw] processor_features

The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance.
@return [Array<Types::ProcessorFeature>]

@!attribute [rw] use_default_processor_features

A value that indicates whether the DB instance class of the DB
instance uses its default processor features.
@return [Boolean]

@!attribute [rw] deletion_protection

A value that indicates whether the DB instance has deletion
protection enabled. The database can't be deleted when deletion
protection is enabled. By default, deletion protection is disabled.
For more information, see [ Deleting a DB Instance][1].

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
@return [Boolean]

@!attribute [rw] domain

The Active Directory directory ID to create the DB instance in.
Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL
DB instances can be created in an Active Directory Domain.

For more information, see [ Kerberos Authentication][1] in the
*Amazon RDS User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
@return [String]

@!attribute [rw] domain_iam_role_name

Specify the name of the IAM role to be used when making API calls to
the Directory Service.
@return [String]

@!attribute [rw] replica_mode

The open mode of the replica database: mounted or read-only.

<note markdown="1"> This parameter is only supported for Oracle DB instances.

 </note>

Mounted DB replicas are included in Oracle Enterprise Edition. The
main use case for mounted replicas is cross-Region disaster
recovery. The primary database doesn't use Active Data Guard to
transmit information to the mounted replica. Because it doesn't
accept user connections, a mounted replica can't serve a read-only
workload.

You can create a combination of mounted and read-only DB replicas
for the same primary DB instance. For more information, see [Working
with Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
@return [String]

@!attribute [rw] max_allocated_storage

The upper limit in gibibytes (GiB) to which Amazon RDS can
automatically scale the storage of the DB instance.

For more information about this setting, including limitations that
apply to it, see [ Managing capacity automatically with Amazon RDS
storage autoscaling][1] in the *Amazon RDS User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
@return [Integer]

@!attribute [rw] source_region

The source region of the snapshot. This is only needed when the
shapshot is encrypted and in a different region.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplicaMessage AWS API Documentation

Constants

SENSITIVE