Settings for DB instances

Allocated storage

The amount of storage to allocate for your DB instance (in gibibytes). In some cases, allocating a higher amount of storage for your DB instance than the size of your database can improve I/O performance.

For more information, see Amazon RDS DB instance storage.

CLI option:

--allocated-storage

API parameter:

AllocatedStorage

All

If you choose Oracle multitenant architecture, RDS for Oracle creates a container database (CDB). If you don't choose this option, RDS for Oracle creates a non-CDB. A non-CDB uses the traditional Oracle database architecture. A CDB can contain pluggable databases (PDBs) whereas a non-CDB cannot.

Oracle Database 21c uses the CDB architecture only. Oracle Database 19c can use either the CDB or non-CDB architecture. Releases lower than Oracle Database 19c use the non-CDB architecture only.

For more information, see Overview of RDS for Oracle CDBs.

CLI option:

--engine oracle-ee-cdb (Oracle multitenant)

--engine oracle-se2-cdb (Oracle multitenant)

--engine oracle-ee (traditional)

--engine oracle-se2 (traditional)

API parameter:

Engine

Oracle

These settings are only valid when you choose Oracle multitenant architecture for Architecture settings. Choose either of the following additional settings:

Regardless of which configuration you choose, your CDB contains a single initial PDB. In the multi-tenant configuration, you can create more PDBs later using RDS APIs.

For more information, see Overview of RDS for Oracle CDBs.

CLI option:

--multi-tenant (multi-tenant configuration)

--no-multi-tenant (single-tenant configuration)

API parameter:

MultiTenant

Oracle

Choose Enable auto minor version upgrade to enable your DB instance to receive preferred minor DB engine version upgrades automatically when they become available. This is the default behavior. Amazon RDS performs automatic minor version upgrades in the maintenance window. If you don't choose Enable auto minor version upgrade, your DB instance isn't upgraded automatically when new minor versions become available.

For more information, see Automatically upgrading the minor engine version.

CLI option:

--auto-minor-version-upgrade

--no-auto-minor-version-upgrade

API parameter:

AutoMinorVersionUpgrade

The Availability Zone for your DB instance. Use the default value of No Preference unless you want to specify an Availability Zone.

For more information, see Regions, Availability Zones, and Local Zones.

CLI option:

--availability-zone

API parameter:

AvailabilityZone

AWS KMS key

Only available if Encryption is set to Enable encryption. Choose the AWS KMS key to use for encrypting this DB instance. For more information, see Encrypting Amazon RDS resources.

CLI option:

--kms-key-id

API parameter:

KmsKeyId

Enter a name for an AWS License Manager license configuration. The name must be 100 characters or less, and only include a-z, A-Z, and 0-9.

For more information, see Integrating with AWS License Manager.

CLI option:

For more information, see AWS License Manager CLI.

API parameter:

For more information, see AWS License Manager API.

Choose Enable replication in another AWS Region to create backups in an additional Region for disaster recovery.

Then choose the Destination Region for the additional backups.

Not available when creating a DB instance. For information on enabling cross-Region backups using the AWS CLI or RDS API, see Enabling cross-Region automated backups for Amazon RDS.

Db2

Oracle

PostgreSQL

SQL Server

The number of days that you want automatic backups of your DB instance to be retained. For any nontrivial DB instance, set this value to 1 or greater.

For more information, see Introduction to backups.

CLI option:

--backup-retention-period

API parameter:

BackupRetentionPeriod

Choose AWS Cloud to store automated backups and manual snapshots in the parent AWS Region. Choose Outposts (on-premises) to store them locally on your Outpost.

This option setting applies only to RDS on Outposts. For more information, see Creating DB instances for Amazon RDS on AWS Outposts.

CLI option:

--backup-target

API parameter:

BackupTarget

The time period during which Amazon RDS automatically takes a backup of your DB instance. Unless you have a specific time that you want to have your database backed up, use the default of No Preference.

For more information, see Introduction to backups.

CLI option:

--preferred-backup-window

API parameter:

PreferredBackupWindow

Certificate authority

The certificate authority (CA) for the server certificate used by the DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance or cluster .

CLI option:

--ca-certificate-identifier

RDS API parameter:

CACertificateIdentifier

All

The character set for your DB instance. The default value of AL32UTF8 for the DB character set is for the Unicode 5.0 UTF-8 Universal character set. You can't change the DB character set after you create the DB instance.

In a single-tenant configuration, a non-default DB character set affects only the PDB, not the CDB. For more information, see Single-tenant configuration of the CDB architecture.

The DB character set is different from the national character set, which is called the NCHAR character set. Unlike the DB character set, the NCHAR character set specifies the encoding for NCHAR data types (NCHAR, NVARCHAR2, and NCLOB) columns without affecting database metadata.

For more information, see RDS for Oracle character sets.

CLI option:

--character-set-name

API parameter:

CharacterSetName

A server-level collation for your DB instance.

For more information, see Server-level collation for Microsoft SQL Server.

CLI option:

--character-set-name

API parameter:

CharacterSetName

This option copies any DB instance tags to a DB snapshot when you create a snapshot.

For more information, see Tagging Amazon RDS resources.

CLI option:

--copy-tags-to-snapshot

--no-copy-tags-to-snapshot

RDS API parameter:

CopyTagsToSnapshot

The database authentication option that you want to use.

Choose Password authentication to authenticate database users with database passwords only.

Choose Password and IAM DB authentication to authenticate database users with database passwords and user credentials through users and roles. For more information, see IAM database authentication for MariaDB, MySQL, and PostgreSQL. This option is only supported for MySQL and PostgreSQL.

Choose Password and Kerberos authentication to authenticate database users with database passwords and Kerberos authentication through an AWS Managed Microsoft AD created with Directory Service. Next, choose the directory or choose Create a new Directory.

For more information, see one of the following:

IAM:

CLI option:

--enable-iam-database-authentication

--no-enable-iam-database-authentication

RDS API parameter:

EnableIAMDatabaseAuthentication

Kerberos:

CLI option:

--domain

--domain-iam-role-name

RDS API parameter:

Domain

DomainIAMRoleName

Varies by authentication type

Choose Amazon RDS if you don't need to customize your environment.

Choose Amazon RDS Custom if you want to customize the database, OS, and infrastructure. For more information, see Amazon RDS Custom.

For the CLI and API, you specify the database engine type.

Oracle

SQL Server

The port that you want to access the DB instance through. The default port is shown.

CLI option:

--port

RDS API parameter:

Port

The version of database engine that you want to use.

CLI option:

--engine-version

RDS API parameter:

EngineVersion

The configuration for your DB instance. For example, a db.t3.small DB instance class has 2 GiB memory, 2 vCPUs, 1 virtual core, a variable ECU, and a moderate I/O capacity.

If possible, choose a DB instance class large enough that a typical query working set can be held in memory. When working sets are held in memory, the system can avoid writing to disk, which improves performance. For more information, see DB instance classes.

In RDS for Oracle, you can select Include additional memory configurations. These configurations are optimized for a high ratio of memory to vCPU. For example, db.r5.6xlarge.tpc2.mem4x is a db.r5.8x DB instance that has 2 threads per core (tpc2) and 4x the memory of a standard db.r5.6xlarge DB instance. For more information, see RDS for Oracle DB instance classes.

CLI option:

--db-instance-class

RDS API parameter:

DBInstanceClass

The name for your DB instance. Name your DB instances in the same way that you name your on-premises servers. Your DB instance identifier can contain up to 63 alphanumeric characters, and must be unique for your account in the AWS Region you chose.

CLI option:

--db-instance-identifier

RDS API parameter:

DBInstanceIdentifier

A parameter group for your DB instance. You can choose the default parameter group, or you can create a custom parameter group.

If you are using the BYOL model for RDS for Db2, before creating a DB instance, you must first create a custom parameter group that contains your IBM Site ID and IBM Customer ID. For more information, see Bring your own license (BYOL) for Db2.

For more information, see Parameter groups for Amazon RDS.

CLI option:

--db-parameter-group-name

RDS API parameter:

DBParameterGroupName

The DB subnet group you want to use for the DB cluster.

Choose Automatic setup to let RDS select a compatible DB subnet group. If none exist, RDS creates a new subnet group for your cluster.

For more information, see Working with DB subnet groups.

CLI option:

--db-subnet-group-name

RDS API parameter:

DBSubnetGroupName

Use a dedicated log volume (DLV) to store database transaction logs on a storage volume that's separate from the volume containing the database tables.

For more information, see Using a dedicated log volume (DLV).

CLI option:

--dedicated-log-volume

RDS API parameter:

DedicatedLogVolume

Enable deletion protection to prevent your DB instance from being deleted. If you create a production DB instance with the AWS Management Console, deletion protection is enabled by default.

For more information, see Deleting a DB instance.

CLI option:

--deletion-protection

--no-deletion-protection

RDS API parameter:

DeletionProtection

Enable Encryption to enable encryption at rest for this DB instance.

For more information, see Encrypting Amazon RDS resources.

CLI option:

--storage-encrypted

--no-storage-encrypted

RDS API parameter:

StorageEncrypted

Enable enhanced monitoring to enable gathering metrics in real time for the operating system that your DB instance runs on.

For more information, see Monitoring OS metrics with Enhanced Monitoring.

CLI options:

--monitoring-interval

--monitoring-role-arn

RDS API parameters:

MonitoringInterval

MonitoringRoleArn

Choose the database engine to be used for this DB instance.

CLI option:

--engine

RDS API parameter:

Engine

The name for the database on your DB instance. If you don't provide a name, Amazon RDS doesn't create a database on the DB instance (except for Oracle and PostgreSQL). The name can't be a word reserved by the database engine, and has other constraints depending on the DB engine.

Db2:

MariaDB and MySQL:

Oracle:

PostgreSQL:

CLI option:

--db-name

RDS API parameter:

DBName

Valid values for the license model:

CLI option:

--license-model

RDS API parameter:

LicenseModel

All

Log exports

The types of database log files to publish to Amazon CloudWatch Logs.

For more information, see Publishing database logs to Amazon CloudWatch Logs.

CLI option:

--enable-cloudwatch-logs-exports

RDS API parameter:

EnableCloudwatchLogsExports

All

The 30-minute window in which pending modifications to your DB instance are applied. If the time period doesn't matter, choose No Preference.

For more information, see Amazon RDS maintenance window.

CLI option:

--preferred-maintenance-window

RDS API parameter:

PreferredMaintenanceWindow

Select Manage master credentials in AWS Secrets Manager to manage the master user password in a secret in Secrets Manager.

Optionally, choose a KMS key to use to protect the secret. Choose from the KMS keys in your account, or enter the key from a different account.

For more information, see Password management with Amazon RDS and AWS Secrets Manager.

CLI option:

--manage-master-user-password | --no-manage-master-user-password

--master-user-secret-kms-key-id

RDS API parameter:

ManageMasterUserPassword

MasterUserSecretKmsKeyId

The password for your master user account. The password has the following number of printable ASCII characters (excluding /, ", a space, and @) depending on the DB engine: