The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

databaseInsightsMode

var databaseInsightsMode: DatabaseInsightsMode?

The mode of Database Insights to enable for the read replica.

dbInstanceClass

var dbInstanceClass: String?

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.

dbInstanceIdentifier

var dbInstanceIdentifier: String?

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.

dbParameterGroupName

var dbParameterGroupName: String?

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

dbSubnetGroupName

var dbSubnetGroupName: String?

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.

dedicatedLogVolume

var dedicatedLogVolume: Boolean?

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

deletionProtection

var deletionProtection: Boolean?

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.

domain

var domain: String?

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.

domainAuthSecretArn

var domainAuthSecretArn: String?

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

domainDnsIps

var domainDnsIps: List<String>?

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

domainFqdn

var domainFqdn: String?

The fully qualified domain name (FQDN) of an Active Directory domain.

domainIamRoleName

var domainIamRoleName: String?

The name of the IAM role to use when making API calls to the Directory Service.

domainOu

var domainOu: String?

The Active Directory organizational unit for your DB instance to join.

enableCloudwatchLogsExports

var enableCloudwatchLogsExports: List<String>?

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.

enableCustomerOwnedIp

var enableCustomerOwnedIp: Boolean?

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.

enableIamDatabaseAuthentication

var enableIamDatabaseAuthentication: Boolean?

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

enablePerformanceInsights

var enablePerformanceInsights: Boolean?

Specifies whether to enable Performance Insights for the read replica.

iops

var iops: Int?

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

kmsKeyId

var kmsKeyId: String?

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

maxAllocatedStorage

var maxAllocatedStorage: Int?

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

monitoringInterval

var monitoringInterval: Int?

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.

monitoringRoleArn

var monitoringRoleArn: String?

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.

multiAz

var multiAz: Boolean?

Specifies whether the read replica is in a Multi-AZ deployment.

networkType

var networkType: String?

The network type of the DB instance.

optionGroupName

var optionGroupName: String?

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.

performanceInsightsKmsKeyId

var performanceInsightsKmsKeyId: String?

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

performanceInsightsRetentionPeriod

var performanceInsightsRetentionPeriod: Int?

The number of days to retain Performance Insights data.

port

var port: Int?

The port number that the DB instance uses for connections.

preSignedUrl

var preSignedUrl: String?

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.

processorFeatures

var processorFeatures: List<ProcessorFeature>?

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

publiclyAccessible

var publiclyAccessible: Boolean?

Specifies whether the DB instance is publicly accessible.

replicaMode

var replicaMode: ReplicaMode?

The open mode of the replica database.

sourceDbClusterIdentifier

var sourceDbClusterIdentifier: String?

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.

sourceDbInstanceIdentifier

var sourceDbInstanceIdentifier: String?

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:

storageThroughput

var storageThroughput: Int?

Specifies the storage throughput value for the read replica.

storageType

var storageType: String?

The storage type to associate with the read replica.