db_instance
Gets an individual db_instance resource
Overview
| Name | db_instance |
| Type | Resource |
| Description | db_instance |
| Id | awscc.rds.db_instance |
Fields
| Name | Datatype | Description |
|---|---|---|
allocated_storage | string | The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.<br/> If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). <br/> *Amazon Aurora* <br/> Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.<br/> *Db2* <br/> Constraints to the amount of storage for each storage type are the following:<br/> + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.<br/> + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.<br/> <br/> *MySQL* <br/> Constraints to the amount of storage for each storage type are the following: <br/> + General Purpose (SSD) storage (gp2): Must be an integer fro |
allow_major_version_upgrade | boolean | 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.<br/> Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. |
associated_roles | array | The IAMlong (IAM) roles associated with the DB instance. <br/> *Amazon Aurora* <br/> Not applicable. The associated roles are managed by the DB cluster. |
auto_minor_version_upgrade | boolean | 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. |
automatic_backup_replication_region | string | The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*. |
availability_zone | string | The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).<br/> For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.<br/> Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.<br/> Constraints:<br/> + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment.<br/> + The specified Availability Zone must be in the same AWS-Region as the current endpoint.<br/> <br/> Example: ``us-east-1d`` |
backup_retention_period | integer | 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.<br/> *Amazon Aurora*<br/> Not applicable. The retention period for automated backups is managed by the DB cluster.<br/> Default: 1<br/> Constraints:<br/> + Must be a value from 0 to 35<br/> + Can't be set to 0 if the DB instance is a source to read replicas |
ca_certificate_identifier | string | The identifier of the CA certificate for this DB instance.<br/> Specifying or updating this property triggers a reboot. For more information about CA certificate identifiers for RDS DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide*. For more information about CA certificate identifiers for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. |
certificate_details | object | The details of the DB instance's server certificate. |
certificate_rotation_restart | boolean | Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.<br/> 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.<br/> Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.<br/> 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:<br/> + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* <br/> + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Gui |
character_set_name | string | For supported engines, indicates that the DB instance should be associated with the specified character set.<br/> *Amazon Aurora* <br/> Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html). |
copy_tags_to_snapshot | boolean | Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.<br/> This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. |
custom_iam_instance_profile | string | The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.<br/> This setting is required for RDS Custom.<br/> Constraints:<br/> + The profile must exist in your account.<br/> + The profile must have an IAM role that Amazon EC2 has permissions to assume.<br/> + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.<br/> <br/> For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. |
db_cluster_identifier | string | The identifier of the DB cluster that the instance will belong to. |
db_cluster_snapshot_identifier | string | The identifier for the Multi-AZ DB cluster snapshot to restore from.<br/> For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.<br/> Constraints:<br/> + Must match the identifier of an existing Multi-AZ DB cluster snapshot.<br/> + Can't be specified when ``DBSnapshotIdentifier`` is specified.<br/> + Must be specified when ``DBSnapshotIdentifier`` isn't specified.<br/> + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.<br/> + Can't be the identifier of an Aurora DB cluster snapshot. |
db_instance_arn | string | |
db_instance_class | string | 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.<br/> For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/). |
db_instance_identifier | string | 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. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.<br/> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. |
dbi_resource_id | string | |
db_name | string | The meaning of this parameter differs according to the database engine you use.<br/> If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.<br/> *Amazon Aurora* <br/> Not applicable. The database name is managed by the DB cluster.<br/> *Db2* <br/> The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.<br/> Constraints:<br/> + Must contain 1 to 64 letters or numbers.<br/> + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).<br/> + Can't be a word reserved by the specified database engine.<br/> <br/> *MySQL* <br/> The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.<br/> Constraints:<br/> + Must contain 1 to 64 letters or numbers.<br/> + Can't be a word reserved by the specified database engine<br/> <br/> *MariaDB* <br/> The name of the database to create when the DB instance is |
db_parameter_group_name | string | The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.<br/> To list all of the available DB parameter group names, use the following command:<br/> ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text``<br/> If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.<br/> If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. |
db_security_groups | array | 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.<br/> If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.<br/> If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:<br/> + ``AllocatedStorage``<br/> + ``AutoMinorVersionUpgrade``<br/> + ``AvailabilityZone``<br/> + ``BackupRetentionPeriod``<br/> + ``CharacterSetName``<br/> + ``DBInstanceClass``<br/> + ``DBName``<br/> + ``DBParameterGroupName``<br/> + ``DBSecurityGroups``<br/> + ``DBSubnetGroupName``<br/> + ``Engine``<br/> + ``EngineVersion``<br/> + ``Iops``<br/> + ``LicenseModel``<br/> + |
db_snapshot_identifier | string | 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.<br/> By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.<br/> Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazo |
db_subnet_group_name | string | 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. <br/> If there's no DB subnet group, then the DB instance isn't a VPC DB instance.<br/> For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. <br/> *Amazon Aurora*<br/> Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. |
db_system_id | 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. |
dedicated_log_volume | boolean | Indicates whether the DB instance has a dedicated log volume (DLV) enabled. |
delete_automated_backups | boolean | 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.<br/> *Amazon Aurora*<br/> Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted. |
deletion_protection | boolean | 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. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). <br/> *Amazon Aurora* <br/> Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. |
domain | string | The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.<br/> For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*. |
domain_auth_secret_arn | string | The ARN for the Secrets Manager secret with the credentials for the user joining the domain.<br/> Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`` |
domain_dns_ips | array | The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.<br/> Constraints:<br/> + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.<br/> <br/> Example: ``123.124.125.126,234.235.236.237`` |
domain_fqdn | string | The fully qualified domain name (FQDN) of an Active Directory domain.<br/> Constraints:<br/> + Can't be longer than 64 characters.<br/> <br/> Example: ``mymanagedADtest.mymanagedAD.mydomain`` |
domain_iam_role_name | string | The name of the IAM role to use when making API calls to the Directory Service.<br/> This setting doesn't apply to the following DB instances:<br/> + Amazon Aurora (The domain is managed by the DB cluster.)<br/> + RDS Custom |
domain_ou | string | The Active Directory organizational unit for your DB instance to join.<br/> Constraints:<br/> + Must be in the distinguished name format.<br/> + Can't be longer than 64 characters.<br/> <br/> Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`` |
enable_cloudwatch_logs_exports | array | 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. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. CloudWatch Logs exports are managed by the DB cluster. <br/> *Db2* <br/> Valid values: ``diag.log``, ``notify.log`` <br/> *MariaDB* <br/> Valid values: ``audit``, ``error``, ``general``, ``slowquery`` <br/> *Microsoft SQL Server* <br/> Valid values: ``agent``, ``error`` <br/> *MySQL* <br/> Valid values: ``audit``, ``error``, ``general``, ``slowquery`` <br/> *Oracle* <br/> Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` <br/> *PostgreSQL* <br/> Valid values: ``postgresql``, ``upgrade`` |
enable_iam_database_authentication | boolean | A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.<br/> This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* <br/> *Amazon Aurora* <br/> Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. |
enable_performance_insights | boolean | Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.<br/> This setting doesn't apply to RDS Custom DB instances. |
endpoint | object | The connection endpoint for the DB instance.<br/> The endpoint might not be shown for instances with the status of ``creating``. |
engine | string | The name of the database engine that you want to use for this DB instance.<br/> Not every database engine is available in every AWS Region.<br/> When you are creating a DB instance, the ``Engine`` property is required.<br/> Valid Values:<br/> + ``aurora-mysql`` (for Aurora MySQL DB instances)<br/> + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances)<br/> + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances)<br/> + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances)<br/> + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances)<br/> + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances)<br/> + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances)<br/> + ``db2-ae``<br/> + ``db2-se``<br/> + ``mariadb``<br/> + ``mysql``<br/> + ``oracle-ee``<br/> + ``oracle-ee-cdb``<br/> + ``oracle-se2``<br/> + ``oracle-se2-cdb``<br/> + ``postgres``<br/> + ``sqlserver-ee``<br/> + ``sqlserver-se``<br/> + ``sqlserver-ex``<br/> + ``sqlserver-web`` |
engine_version | string | The version number of the database engine to use.<br/> For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.<br/> The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.<br/> *Amazon Aurora* <br/> Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.<br/> *Db2* <br/> See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*<br/> *MariaDB*<br/> See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*<br/> *Microsoft SQL Server*<br/> See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu |
manage_master_user_password | boolean | Specifies whether to manage the master user password with AWS Secrets Manager.<br/> For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* <br/> Constraints:<br/> + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. |
iops | integer | The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. <br/> If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.<br/> If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.<br/> Constraints:<br/> + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.<br/> + For RDS for SQL Server - Must be a multip |
kms_key_id | string | The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. <br/> If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region.<br/> If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.<br/> If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is us |
license_model | string | License model information for this DB instance.<br/> Valid Values:<br/> + Aurora MySQL - ``general-public-license``<br/> + Aurora PostgreSQL - ``postgresql-license``<br/> + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*<br/> + RDS for MariaDB - ``general-public-license``<br/> + RDS for Microsoft SQL Server - ``license-included``<br/> + RDS for MySQL - ``general-public-license``<br/> + RDS for Oracle - ``bring-your-own-license`` or ``license-included``<br/> + RDS for PostgreSQL - ``postgresql-license``<br/> <br/> If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. |
master_username | string | The master user name for the DB instance.<br/> If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.<br/> When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.<br/> *Amazon Aurora* <br/> Not applicable. The name for the master user is managed by the DB cluster. <br/> *RDS for Db2* <br/> Constraints:<br/> + Must be 1 to 16 letters or numbers.<br/> + First character must be a letter.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for MariaDB* <br/> Constraints:<br/> + Must be 1 to 16 letters or numbers.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for Microsoft SQL Server* <br/> Constraints:<br/> + Must be 1 to 128 letters or numbers.<br/> + First character must be a letter.<br/> + Can't be a reserved word for the chosen database engine.<br/> <br/> *RDS for MySQL* <br/> Constrain |
master_user_password | string | The password for the master user. The password can include any printable ASCII character except "/", """, or "@".<br/> *Amazon Aurora* <br/> Not applicable. The password for the master user is managed by the DB cluster.<br/> *RDS for Db2* <br/> Must contain from 8 to 255 characters.<br/> *RDS for MariaDB* <br/> Constraints: Must contain from 8 to 41 characters.<br/> *RDS for Microsoft SQL Server* <br/> Constraints: Must contain from 8 to 128 characters.<br/> *RDS for MySQL* <br/> Constraints: Must contain from 8 to 41 characters.<br/> *RDS for Oracle* <br/> Constraints: Must contain from 8 to 30 characters.<br/> *RDS for PostgreSQL* <br/> Constraints: Must contain from 8 to 128 characters. |
master_user_secret | object | The secret managed by RDS in AWS Secrets Manager for the master user password.<br/> For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* |
max_allocated_storage | integer | The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.<br/> For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.<br/> This setting doesn't apply to the following DB instances:<br/> + Amazon Aurora (Storage is managed by the DB cluster.)<br/> + RDS Custom |
monitoring_interval | integer | 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. The default is 0.<br/> If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0.<br/> This setting doesn't apply to RDS Custom.<br/> Valid Values: ``0, 1, 5, 10, 15, 30, 60`` |
monitoring_role_arn | 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.<br/> If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.<br/> This setting doesn't apply to RDS Custom DB instances. |
multi_az | boolean | Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. <br/> For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set. |
nchar_character_set_name | string | The name of the NCHAR character set for the Oracle DB instance.<br/> This setting doesn't apply to RDS Custom DB instances. |
network_type | string | The network type of the DB instance.<br/> Valid values:<br/> + ``IPV4`` <br/> + ``DUAL`` <br/> <br/> The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).<br/> For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* |
option_group_name | string | Indicates that the DB instance should be associated with the specified option group.<br/> Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. |
performance_insights_kms_key_id | string | The AWS KMS key identifier for encryption of Performance Insights data.<br/> The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.<br/> If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.<br/> For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights). |
performance_insights_retention_period | integer | The number of days to retain Performance Insights data.<br/> This setting doesn't apply to RDS Custom DB instances.<br/> Valid Values:<br/> + ``7`` <br/> + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)<br/> + ``731`` <br/> <br/> Default: ``7`` days<br/> If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error. |
port | string | The port number on which the database accepts connections.<br/> *Amazon Aurora* <br/> Not applicable. The port number is managed by the DB cluster.<br/> *Db2* <br/> Default value: ``50000`` |
preferred_backup_window | string | The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* <br/> Constraints:<br/> + Must be in the format ``hh24:mi-hh24:mi``.<br/> + Must be in Universal Coordinated Time (UTC).<br/> + Must not conflict with the preferred maintenance window.<br/> + Must be at least 30 minutes.<br/> <br/> *Amazon Aurora* <br/> Not applicable. The daily time range for creating automated backups is managed by the DB cluster. |
preferred_maintenance_window | string | The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).<br/> Format: ``ddd:hh24:mi-ddd:hh24:mi`` <br/> The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* <br/> This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.<br/> Constraints: Minimum 30-minute window. |
processor_features | array | The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.<br/> This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. |
promotion_tier | integer | 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.<br/> This setting doesn't apply to RDS Custom DB instances.<br/> Default: ``1`` <br/> Valid Values: ``0 - 15`` |
publicly_accessible | boolean | 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. <br/> The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. |
replica_mode | string | The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.<br/> This setting is only supported in RDS for Oracle.<br/> Default: ``open-read-only``<br/> Valid Values: ``open-read-only`` or ``mounted`` |
restore_time | string | The date and time to restore from.<br/> Constraints:<br/> + Must be a time in Universal Coordinated Time (UTC) format.<br/> + Must be before the latest restorable time for the DB instance.<br/> + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled.<br/> <br/> Example: ``2009-09-07T23:45:00Z`` |
source_db_cluster_identifier | 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.<br/> Constraints:<br/> + Must be the identifier of an existing Multi-AZ DB cluster.<br/> + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.<br/> + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.<br/> + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. |
source_dbi_resource_id | string | The resource ID of the source DB instance from which to restore. |
source_db_instance_automated_backups_arn | string | The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``.<br/> This setting doesn't apply to RDS Custom. |
source_db_instance_identifier | string | 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. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.<br/> For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.<br/> The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance.<br/> + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the |
source_region | string | The ID of the region that contains the source DB instance for the read replica. |
storage_encrypted | boolean | A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.<br/> If you specify the ``KmsKeyId`` property, then you must enable encryption.<br/> If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used.<br/> If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used.<br/> If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``.<br/> *Amazon Aurora*<br/> Not applicable. The encrypt |
storage_type | string | Specifies the storage type to be associated with the DB instance.<br/> Valid values: ``gp2 | gp3 | io1 | standard`` <br/> The ``standard`` value is also known as magnetic.<br/> If you specify ``io1`` or ``gp3``, you must also include a value for the ``Iops`` parameter. <br/> Default: ``io1`` if the ``Iops`` parameter is specified, otherwise ``gp2`` <br/> For more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*.<br/> *Amazon Aurora* <br/> Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs). |
storage_throughput | integer | Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. <br/> This setting doesn't apply to RDS Custom or Amazon Aurora. |
tags | array | An optional array of key-value pairs to apply to this DB instance. |
tde_credential_arn | string | |
tde_credential_password | string | |
timezone | string | The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). |
use_default_processor_features | boolean | Specifies whether the DB instance class of the DB instance uses its default processor features.<br/> This setting doesn't apply to RDS Custom DB instances. |
use_latest_restorable_time | boolean | Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.<br/> Constraints:<br/> + Can't be specified if the ``RestoreTime`` parameter is provided. |
vpc_security_groups | array | 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.<br/> If you plan to update the resource, don't specify VPC security groups in a shared VPC.<br/> If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.<br/> You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:<br/> + You can't revert to using an RDS security group after you establish a VPC security group membership.<br/> + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc |
region | string | AWS region. |
Methods
Currently only SELECT is supported for this resource resource.
Example
SELECT
region,
allocated_storage,
allow_major_version_upgrade,
associated_roles,
auto_minor_version_upgrade,
automatic_backup_replication_region,
availability_zone,
backup_retention_period,
ca_certificate_identifier,
certificate_details,
certificate_rotation_restart,
character_set_name,
copy_tags_to_snapshot,
custom_iam_instance_profile,
db_cluster_identifier,
db_cluster_snapshot_identifier,
db_instance_arn,
db_instance_class,
db_instance_identifier,
dbi_resource_id,
db_name,
db_parameter_group_name,
db_security_groups,
db_snapshot_identifier,
db_subnet_group_name,
db_system_id,
dedicated_log_volume,
delete_automated_backups,
deletion_protection,
domain,
domain_auth_secret_arn,
domain_dns_ips,
domain_fqdn,
domain_iam_role_name,
domain_ou,
enable_cloudwatch_logs_exports,
enable_iam_database_authentication,
enable_performance_insights,
endpoint,
engine,
engine_version,
manage_master_user_password,
iops,
kms_key_id,
license_model,
master_username,
master_user_password,
master_user_secret,
max_allocated_storage,
monitoring_interval,
monitoring_role_arn,
multi_az,
nchar_character_set_name,
network_type,
option_group_name,
performance_insights_kms_key_id,
performance_insights_retention_period,
port,
preferred_backup_window,
preferred_maintenance_window,
processor_features,
promotion_tier,
publicly_accessible,
replica_mode,
restore_time,
source_db_cluster_identifier,
source_dbi_resource_id,
source_db_instance_automated_backups_arn,
source_db_instance_identifier,
source_region,
storage_encrypted,
storage_type,
storage_throughput,
tags,
tde_credential_arn,
tde_credential_password,
timezone,
use_default_processor_features,
use_latest_restorable_time,
vpc_security_groups
FROM awscc.rds.db_instance
WHERE data__Identifier = '<DBInstanceIdentifier>';
Permissions
To operate on the db_instance resource, the following permissions are required:
Read
ec2:DescribeAccountAttributes,
ec2:DescribeAvailabilityZones,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcAttribute,
ec2:DescribeVpcs,
rds:DescribeDBInstances
Update
ec2:DescribeAccountAttributes,
ec2:DescribeAvailabilityZones,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcAttribute,
ec2:DescribeVpcs,
iam:CreateServiceLinkedRole,
iam:GetRole,
iam:ListRoles,
iam:PassRole,
kms:CreateGrant,
kms:DescribeKey,
rds:AddRoleToDBInstance,
rds:AddTagsToResource,
rds:DescribeDBClusters,
rds:DescribeDBEngineVersions,
rds:DescribeDBInstances,
rds:DescribeDBParameterGroups,
rds:DescribeEvents,
rds:ModifyDBInstance,
rds:PromoteReadReplica,
rds:RebootDBInstance,
rds:RemoveRoleFromDBInstance,
rds:RemoveTagsFromResource,
rds:StartDBInstanceAutomatedBackupsReplication,
rds:StopDBInstanceAutomatedBackupsReplication,
secretsmanager:CreateSecret,
secretsmanager:TagResource
Delete
rds:CreateDBSnapshot,
rds:DeleteDBInstance,
rds:DescribeDBInstances