CreateDbInstanceReadReplicaRequest
Types
Properties
The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.
Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.
The Availability Zone (AZ) where the read replica will be created.
The location where RDS stores automated backups and manual snapshots.
The CA certificate identifier to use for the read replica's server certificate.
Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren't copied.
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The mode of Database Insights to enable for the read replica.
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 in the Amazon RDS User Guide.
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.
The name of the DB parameter group to associate with this read replica DB instance.
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.
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
The fully qualified domain name (FQDN) of an Active Directory domain.
The name of the IAM role to use when making API calls to the Directory Service.
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 in the Amazon RDS User Guide.
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
Specifies whether to enable Performance Insights for the read replica.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
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 in the Amazon RDS User Guide.
The network type of the DB instance.
The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The number of days to retain Performance Insights data.
When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Specifies whether the DB instance is publicly accessible.
The open mode of the replica database.
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, except for the following engines:
Specifies the storage throughput value for the read replica.
The storage type to associate with the read replica.
Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.
Specifies whether the DB instance class of the DB instance uses its default processor features.
A list of Amazon EC2 VPC security groups to associate with the read replica.