rds/aws.sdk.kotlin.services.rds.model/CreateDbInstanceRequest/Builder

Builder

Properties

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

availabilityZone

var availabilityZone: String?

The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

backupRetentionPeriod

var backupRetentionPeriod: Int?

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

backupTarget

var backupTarget: String?

The location for storing automated backups and manual snapshots.

caCertificateIdentifier

var caCertificateIdentifier: String?

The CA certificate identifier to use for the DB instance's server certificate.

characterSetName

var characterSetName: String?

For supported engines, the character set (CharacterSet) to associate the DB instance with.

copyTagsToSnapshot

var copyTagsToSnapshot: Boolean?

Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

customIamInstanceProfile

var customIamInstanceProfile: String?

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

dbClusterIdentifier

var dbClusterIdentifier: String?

The identifier of the DB cluster that this DB instance will belong to.

dbInstanceClass

var dbInstanceClass: String?

The compute and memory capacity of the DB instance, for example db.m5.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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.

dbInstanceIdentifier

var dbInstanceIdentifier: String?

The identifier for this DB instance. This parameter is stored as a lowercase string.

dbName

var dbName: String?

The meaning of this parameter differs according to the database engine you use.

dbParameterGroupName

var dbParameterGroupName: String?

The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.

dbSecurityGroups

var dbSecurityGroups: List<String>?

A list of DB security groups to associate with this DB instance.

dbSubnetGroupName

var dbSubnetGroupName: String?

A DB subnet group to associate with this DB instance.

dbSystemId

var dbSystemId: String?

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.

dedicatedLogVolume

var dedicatedLogVolume: Boolean?

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

deletionProtection

var deletionProtection: Boolean?

Specifies whether the DB instance has deletion protection enabled. 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, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances 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 log types to enable for exporting to CloudWatch Logs. 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 DB instance.

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 DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

engine

var engine: String?

The database engine to use for this DB instance.

engineVersion

var engineVersion: String?

The version number of the database engine to use.

iops

var iops: Int?

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.

kmsKeyId

var kmsKeyId: String?

The Amazon Web Services KMS key identifier for an encrypted DB instance.

licenseModel

var licenseModel: String?

The license model information for this DB instance.

manageMasterUserPassword

var manageMasterUserPassword: Boolean?

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

masterUsername

var masterUsername: String?

The name for the master user.

masterUserPassword

var masterUserPassword: String?

The password for the master user.

masterUserSecretKmsKeyId

var masterUserSecretKmsKeyId: String?

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

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 DB instance. To disable collection of Enhanced Monitoring metrics, specify 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, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

multiAz

var multiAz: Boolean?

Specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

multiTenant

var multiTenant: Boolean?

Specifies whether to use the multi-tenant configuration or the single-tenant configuration (default). This parameter only applies to RDS for Oracle container database (CDB) engines.

ncharCharacterSetName

var ncharCharacterSetName: String?

The name of the NCHAR character set for the Oracle DB instance.

networkType

var networkType: String?

The network type of the DB instance.

optionGroupName

var optionGroupName: String?

The option group to associate the DB instance with.

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 on which the database accepts connections.

preferredBackupWindow

var preferredBackupWindow: String?

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

preferredMaintenanceWindow

var preferredMaintenanceWindow: String?

The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

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.

promotionTier

var promotionTier: Int?

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

publiclyAccessible

var publiclyAccessible: Boolean?

Specifies whether the DB instance is publicly accessible.

storageEncrypted

var storageEncrypted: Boolean?

Specifes whether the DB instance is encrypted. By default, it isn't encrypted.

storageThroughput

var storageThroughput: Int?

The storage throughput value for the DB instance.

storageType

var storageType: String?

The storage type to associate with the DB instance.