DbInstance

The amount of storage (in gigabytes) to be initially allocated for the database instance.

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Enables replication of automated backups to a different Amazon Web Services Region.

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.

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.

The identifier of the CA certificate for this DB instance.

Returns the details of the DB instance's server certificate.

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate This setting doesn't apply to RDS Custom.

For supported engines, indicates that the DB instance should be associated with the specified character set.

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not 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 identifier of the DB cluster that the instance will belong to.

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide . Constraints:

The Amazon Resource Name (ARN) for the DB instance.

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.

A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance.

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

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

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

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.

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.

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.

Specify the name of the IAM role to be used when making API calls to the Directory Service.

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

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

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

A value that indicates whether to enable Performance Insights for the DB instance.

Specifies the connection endpoint.

The name of the database engine that you want to use for this DB instance.

The version number of the database engine to use.

The number of I/O operations per second (IOPS) that the database provisions.

The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance.

License model information for this DB instance.

A value that indicates whether to manage the master user password with AWS Secrets Manager.

The master user name for the DB instance.

The password for the master user.

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

The upper limit 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 DB instance. To disable collecting 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.

Specifies whether the database instance is a multiple Availability Zone deployment.

The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.

The network type of the DB cluster.

Indicates that the DB instance should be associated with the specified option group.

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

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

The port number on which the database accepts connections.

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.

The open mode of an Oracle read replica. The default is open-read-only.

The date and time to restore from.

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 Amazon Resource Name (ARN) of the replicated automated backups from which to restore.

If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas.

The resource ID of the source DB instance from which to restore.

The ID of the region that contains the source DB instance for the Read Replica.

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

Specifies the storage throughput for the DB instance.

Specifies the storage type to be associated with the DB instance.

Tags to assign to the DB instance.

The ARN from the key store with which to associate the instance for TDE encryption.

The password for the given ARN from the key store in order to access the device.

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template.