Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. DbInstance

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.DbInstance

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::RDS::DBInstance resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide. For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide. If you import an existing DB instance, and the template configuration doesn’t match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation. If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an

    Create DbInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DbInstance(name: string, args?: DbInstanceArgs, opts?: CustomResourceOptions);
    @overload
def DbInstance(resource_name: str,
               args: Optional[DbInstanceArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def DbInstance(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               allocated_storage: Optional[str] = None,
               allow_major_version_upgrade: Optional[bool] = None,
               associated_roles: Optional[Sequence[DbInstanceDbInstanceRoleArgs]] = None,
               auto_minor_version_upgrade: Optional[bool] = None,
               automatic_backup_replication_region: Optional[str] = None,
               availability_zone: Optional[str] = None,
               backup_retention_period: Optional[int] = None,
               ca_certificate_identifier: Optional[str] = None,
               certificate_details: Optional[DbInstanceCertificateDetailsArgs] = None,
               certificate_rotation_restart: Optional[bool] = None,
               character_set_name: Optional[str] = None,
               copy_tags_to_snapshot: Optional[bool] = None,
               custom_iam_instance_profile: Optional[str] = None,
               db_cluster_identifier: Optional[str] = None,
               db_cluster_snapshot_identifier: Optional[str] = None,
               db_instance_class: Optional[str] = None,
               db_instance_identifier: Optional[str] = None,
               db_name: Optional[str] = None,
               db_parameter_group_name: Optional[str] = None,
               db_security_groups: Optional[Sequence[str]] = None,
               db_snapshot_identifier: Optional[str] = None,
               db_subnet_group_name: Optional[str] = None,
               dedicated_log_volume: Optional[bool] = None,
               delete_automated_backups: Optional[bool] = None,
               deletion_protection: Optional[bool] = None,
               domain: Optional[str] = None,
               domain_auth_secret_arn: Optional[str] = None,
               domain_dns_ips: Optional[Sequence[str]] = None,
               domain_fqdn: Optional[str] = None,
               domain_iam_role_name: Optional[str] = None,
               domain_ou: Optional[str] = None,
               enable_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
               enable_iam_database_authentication: Optional[bool] = None,
               enable_performance_insights: Optional[bool] = None,
               endpoint: Optional[DbInstanceEndpointArgs] = None,
               engine: Optional[str] = None,
               engine_version: Optional[str] = None,
               iops: Optional[int] = None,
               kms_key_id: Optional[str] = None,
               license_model: Optional[str] = None,
               manage_master_user_password: Optional[bool] = None,
               master_user_password: Optional[str] = None,
               master_user_secret: Optional[DbInstanceMasterUserSecretArgs] = None,
               master_username: Optional[str] = None,
               max_allocated_storage: Optional[int] = None,
               monitoring_interval: Optional[int] = None,
               monitoring_role_arn: Optional[str] = None,
               multi_az: Optional[bool] = None,
               nchar_character_set_name: Optional[str] = None,
               network_type: Optional[str] = None,
               option_group_name: Optional[str] = None,
               performance_insights_kms_key_id: Optional[str] = None,
               performance_insights_retention_period: Optional[int] = None,
               port: Optional[str] = None,
               preferred_backup_window: Optional[str] = None,
               preferred_maintenance_window: Optional[str] = None,
               processor_features: Optional[Sequence[DbInstanceProcessorFeatureArgs]] = None,
               promotion_tier: Optional[int] = None,
               publicly_accessible: Optional[bool] = None,
               replica_mode: Optional[str] = None,
               restore_time: Optional[str] = None,
               source_db_cluster_identifier: Optional[str] = None,
               source_db_instance_automated_backups_arn: Optional[str] = None,
               source_db_instance_identifier: Optional[str] = None,
               source_dbi_resource_id: Optional[str] = None,
               source_region: Optional[str] = None,
               storage_encrypted: Optional[bool] = None,
               storage_throughput: Optional[int] = None,
               storage_type: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
               tde_credential_arn: Optional[str] = None,
               tde_credential_password: Optional[str] = None,
               timezone: Optional[str] = None,
               use_default_processor_features: Optional[bool] = None,
               use_latest_restorable_time: Optional[bool] = None,
               vpc_security_groups: Optional[Sequence[str]] = None)
    func NewDbInstance(ctx *Context, name string, args *DbInstanceArgs, opts ...ResourceOption) (*DbInstance, error)
    public DbInstance(string name, DbInstanceArgs? args = null, CustomResourceOptions? opts = null)
    public DbInstance(String name, DbInstanceArgs args)
public DbInstance(String name, DbInstanceArgs args, CustomResourceOptions options)

    type: aws-native:rds:DbInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DbInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DbInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DbInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const dbInstanceResource = new aws_native.rds.DbInstance("dbInstanceResource", {
    allocatedStorage: "string",
    allowMajorVersionUpgrade: false,
    associatedRoles: [{
        featureName: "string",
        roleArn: "string",
    }],
    autoMinorVersionUpgrade: false,
    automaticBackupReplicationRegion: "string",
    availabilityZone: "string",
    backupRetentionPeriod: 0,
    caCertificateIdentifier: "string",
    certificateDetails: {
        caIdentifier: "string",
        validTill: "string",
    },
    certificateRotationRestart: false,
    characterSetName: "string",
    copyTagsToSnapshot: false,
    customIamInstanceProfile: "string",
    dbClusterIdentifier: "string",
    dbClusterSnapshotIdentifier: "string",
    dbInstanceClass: "string",
    dbInstanceIdentifier: "string",
    dbName: "string",
    dbParameterGroupName: "string",
    dbSecurityGroups: ["string"],
    dbSnapshotIdentifier: "string",
    dbSubnetGroupName: "string",
    dedicatedLogVolume: false,
    deleteAutomatedBackups: false,
    deletionProtection: false,
    domain: "string",
    domainAuthSecretArn: "string",
    domainDnsIps: ["string"],
    domainFqdn: "string",
    domainIamRoleName: "string",
    domainOu: "string",
    enableCloudwatchLogsExports: ["string"],
    enableIamDatabaseAuthentication: false,
    enablePerformanceInsights: false,
    endpoint: {
        address: "string",
        hostedZoneId: "string",
        port: "string",
    },
    engine: "string",
    engineVersion: "string",
    iops: 0,
    kmsKeyId: "string",
    licenseModel: "string",
    manageMasterUserPassword: false,
    masterUserPassword: "string",
    masterUserSecret: {
        kmsKeyId: "string",
        secretArn: "string",
    },
    masterUsername: "string",
    maxAllocatedStorage: 0,
    monitoringInterval: 0,
    monitoringRoleArn: "string",
    multiAz: false,
    ncharCharacterSetName: "string",
    networkType: "string",
    optionGroupName: "string",
    performanceInsightsKmsKeyId: "string",
    performanceInsightsRetentionPeriod: 0,
    port: "string",
    preferredBackupWindow: "string",
    preferredMaintenanceWindow: "string",
    processorFeatures: [{
        name: aws_native.rds.DbInstanceProcessorFeatureName.CoreCount,
        value: "string",
    }],
    promotionTier: 0,
    publiclyAccessible: false,
    replicaMode: "string",
    restoreTime: "string",
    sourceDbClusterIdentifier: "string",
    sourceDbInstanceAutomatedBackupsArn: "string",
    sourceDbInstanceIdentifier: "string",
    sourceDbiResourceId: "string",
    sourceRegion: "string",
    storageEncrypted: false,
    storageThroughput: 0,
    storageType: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    tdeCredentialArn: "string",
    tdeCredentialPassword: "string",
    timezone: "string",
    useDefaultProcessorFeatures: false,
    useLatestRestorableTime: false,
    vpcSecurityGroups: ["string"],
});

    Coming soon!

    DbInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DbInstance resource accepts the following input properties:

    AllocatedStorage string

    The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. 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). Amazon Aurora 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. Db2 Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
    • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

    MySQL Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer fro
    AllowMajorVersionUpgrade bool
    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. 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.
    AssociatedRoles List<Pulumi.AwsNative.Rds.Inputs.DbInstanceDbInstanceRole>
    The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
    AutoMinorVersionUpgrade bool
    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.
    AutomaticBackupReplicationRegion string
    The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
    AvailabilityZone string

    The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. 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. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints:

    • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
    • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

    Example: us-east-1d

    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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints:

    • Must be a value from 0 to 35
    • Can't be set to 0 if the DB instance is a source to read replicas
    CaCertificateIdentifier string
    The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
    CertificateDetails Pulumi.AwsNative.Rds.Inputs.DbInstanceCertificateDetails
    The details of the DB instance's server certificate.
    CertificateRotationRestart bool
    Specifies 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. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. 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:

    CharacterSetName string
    For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
    CopyTagsToSnapshot bool
    Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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.
    CustomIamInstanceProfile string

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints:

    • The profile must exist in your account.
    • The profile must have an IAM role that Amazon EC2 has permissions to assume.
    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    DbClusterIdentifier string
    The identifier of the DB cluster that the instance will belong to.
    DbClusterSnapshotIdentifier string
    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 DB cluster deployments in the Amazon RDS User Guide. Constraints:

    • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
    • Can't be specified when DBSnapshotIdentifier is specified.
    • Must be specified when DBSnapshotIdentifier isn't specified.
    • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
    • Can't be the identifier of an Aurora DB cluster snapshot.
    • Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
    DbInstanceClass 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. For the full list of DB instance classes, and availability for your engine, see DB Instance Class 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.
    DbInstanceIdentifier 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. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.
    DbName string

    The meaning of this parameter differs according to the database engine you use. If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
    • Can't be a word reserved by the specified database engine.

    MySQL 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Can't be a word reserved by the specified database engine

    MariaDB The name of the database to create when the DB instance is

    DbParameterGroupName string
    The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text 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. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
    DbSecurityGroups List<string>
    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. 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. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • BackupRetentionPeriod
    • CharacterSetName
    • DBInstanceClass
    • DBName
    • DBParameterGroupName
    • DBSecurityGroups
    • DBSubnetGroupName
    • Engine
    • EngineVersion
    • Iops
    • LicenseModel
    DbSnapshotIdentifier 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. 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. 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
    DbSubnetGroupName 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. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
    DedicatedLogVolume bool
    Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    DeleteAutomatedBackups bool
    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. Amazon Aurora 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.
    DeletionProtection bool
    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. Amazon Aurora 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. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
    DomainAuthSecretArn string
    The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
    DomainDnsIps List<string>

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

    • 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.

    Example: 123.124.125.126,234.235.236.237

    DomainFqdn string

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

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    DomainIamRoleName string
    The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (The domain is managed by the DB cluster.)
    • RDS Custom
    DomainOu string

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

    • Must be in the distinguished name format.
    • Can't be longer than 64 characters.

    Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    EnableCloudwatchLogsExports List<string>
    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 in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
    EnableIamDatabaseAuthentication bool
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. 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 in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
    EnablePerformanceInsights bool
    Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
    Endpoint Pulumi.AwsNative.Rds.Inputs.DbInstanceEndpoint
    The connection endpoint for the DB instance. 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. Not every database engine is available in every AWS Region. When you are creating a DB instance, the Engine property is required. Valid Values:

    • aurora-mysql (for Aurora MySQL DB instances)
    • aurora-postgresql (for Aurora PostgreSQL DB instances)
    • custom-oracle-ee (for RDS Custom for Oracle DB instances)
    • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
    • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
    • db2-ae
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    EngineVersion string
    The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. 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. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
    Iops int
    The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. 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 in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

    • 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.
    • For RDS for SQL Server - Must be a multip
    KmsKeyId 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. 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. 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. 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
    LicenseModel string

    License model information for this DB instance. Valid Values:

    • Aurora MySQL - general-public-license
    • Aurora PostgreSQL - postgresql-license
    • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license or license-included
    • RDS for PostgreSQL - postgresql-license

    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.

    ManageMasterUserPassword bool
    Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

    • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
    MasterUserPassword string
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
    MasterUserSecret Pulumi.AwsNative.Rds.Inputs.DbInstanceMasterUserSecret
    The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
    MasterUsername string

    The master user name for the DB instance. If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints:

    • Must be 1 to 16 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MariaDB Constraints:

    • Must be 1 to 16 letters or numbers.
    • Can't be a reserved word for the chosen database engine.

    RDS for Microsoft SQL Server Constraints:

    • Must be 1 to 128 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MySQL Constrain

    MaxAllocatedStorage int
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (Storage is managed by the DB cluster.)
    • RDS Custom
    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. The default is 0. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
    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. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom DB instances.
    MultiAz bool
    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. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the MultiAZ option to be set.
    NcharCharacterSetName string
    The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
    NetworkType string

    The network type of the DB instance. Valid values:

    • IPV4
    • DUAL

    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). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    OptionGroupName string
    Indicates that the DB instance should be associated with the specified option group. 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.
    PerformanceInsightsKmsKeyId string
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. 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. For information about enabling Performance Insights, see EnablePerformanceInsights.
    PerformanceInsightsRetentionPeriod int

    The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values:

    • 7
    • 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)
    • 731

    Default: 7 days 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. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value: 50000
    PreferredBackupWindow 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 in the Amazon RDS User Guide. Constraints:

    • Must be in the format hh24:mi-hh24:mi.
    • Must be in Universal Coordinated Time (UTC).
    • Must not conflict with the preferred maintenance window.
    • Must be at least 30 minutes.

    Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi 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 in the Amazon RDS User Guide. 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. Constraints: Minimum 30-minute window.
    ProcessorFeatures List<Pulumi.AwsNative.Rds.Inputs.DbInstanceProcessorFeature>
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
    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. This setting doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
    PubliclyAccessible bool
    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 default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
    ReplicaMode string
    The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
    RestoreTime string

    The date and time to restore from. Constraints:

    • Must be a time in Universal Coordinated Time (UTC) format.
    • Must be before the latest restorable time for the DB instance.
    • Can't be specified if the UseLatestRestorableTime parameter is enabled.

    Example: 2009-09-07T23:45:00Z

    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. Constraints:

    • Must be the identifier of an existing Multi-AZ DB cluster.
    • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
    • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
    • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
    SourceDbInstanceAutomatedBackupsArn 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. This setting doesn't apply to RDS Custom.
    SourceDbInstanceIdentifier 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 in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.

    • 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
    SourceDbiResourceId string
    The resource ID of the source DB instance from which to restore.
    SourceRegion string
    The ID of the region that contains the source DB instance for the read replica.
    StorageEncrypted bool
    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the KmsKeyId property, then you must enable encryption. 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. 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. 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. Amazon Aurora Not applicable. The encrypt
    StorageThroughput int
    Specifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
    StorageType string
    Specifies the storage type to be associated with the DB instance. Valid values: gp2 | gp3 | io1 | standard The standard value is also known as magnetic. If you specify io1 or gp3, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 For more information, see Amazon RDS DB Instance Storage in the Amazon RDS User Guide. Amazon Aurora Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An optional array of key-value pairs to apply to this DB instance.
    TdeCredentialArn string
    TdeCredentialPassword string
    Timezone string
    The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
    UseDefaultProcessorFeatures bool
    Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
    UseLatestRestorableTime bool
    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. Constraints:

    • Can't be specified if the RestoreTime parameter is provided.
    VpcSecurityGroups List<string>
    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. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. 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:

    • You can't revert to using an RDS security group after you establish a VPC security group membership.
    • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc
    AllocatedStorage string

    The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. 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). Amazon Aurora 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. Db2 Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
    • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

    MySQL Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer fro
    AllowMajorVersionUpgrade bool
    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. 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.
    AssociatedRoles []DbInstanceDbInstanceRoleArgs
    The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
    AutoMinorVersionUpgrade bool
    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.
    AutomaticBackupReplicationRegion string
    The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
    AvailabilityZone string

    The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. 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. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints:

    • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
    • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

    Example: us-east-1d

    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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints:

    • Must be a value from 0 to 35
    • Can't be set to 0 if the DB instance is a source to read replicas
    CaCertificateIdentifier string
    The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
    CertificateDetails DbInstanceCertificateDetailsArgs
    The details of the DB instance's server certificate.
    CertificateRotationRestart bool
    Specifies 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. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. 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:

    CharacterSetName string
    For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
    CopyTagsToSnapshot bool
    Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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.
    CustomIamInstanceProfile string

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints:

    • The profile must exist in your account.
    • The profile must have an IAM role that Amazon EC2 has permissions to assume.
    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    DbClusterIdentifier string
    The identifier of the DB cluster that the instance will belong to.
    DbClusterSnapshotIdentifier string
    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 DB cluster deployments in the Amazon RDS User Guide. Constraints:

    • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
    • Can't be specified when DBSnapshotIdentifier is specified.
    • Must be specified when DBSnapshotIdentifier isn't specified.
    • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
    • Can't be the identifier of an Aurora DB cluster snapshot.
    • Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
    DbInstanceClass 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. For the full list of DB instance classes, and availability for your engine, see DB Instance Class 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.
    DbInstanceIdentifier 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. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.
    DbName string

    The meaning of this parameter differs according to the database engine you use. If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
    • Can't be a word reserved by the specified database engine.

    MySQL 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Can't be a word reserved by the specified database engine

    MariaDB The name of the database to create when the DB instance is

    DbParameterGroupName string
    The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text 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. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
    DbSecurityGroups []string
    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. 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. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • BackupRetentionPeriod
    • CharacterSetName
    • DBInstanceClass
    • DBName
    • DBParameterGroupName
    • DBSecurityGroups
    • DBSubnetGroupName
    • Engine
    • EngineVersion
    • Iops
    • LicenseModel
    DbSnapshotIdentifier 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. 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. 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
    DbSubnetGroupName 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. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
    DedicatedLogVolume bool
    Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    DeleteAutomatedBackups bool
    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. Amazon Aurora 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.
    DeletionProtection bool
    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. Amazon Aurora 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. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
    DomainAuthSecretArn string
    The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
    DomainDnsIps []string

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

    • 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.

    Example: 123.124.125.126,234.235.236.237

    DomainFqdn string

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

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    DomainIamRoleName string
    The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (The domain is managed by the DB cluster.)
    • RDS Custom
    DomainOu string

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

    • Must be in the distinguished name format.
    • Can't be longer than 64 characters.

    Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    EnableCloudwatchLogsExports []string
    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 in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
    EnableIamDatabaseAuthentication bool
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. 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 in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
    EnablePerformanceInsights bool
    Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
    Endpoint DbInstanceEndpointArgs
    The connection endpoint for the DB instance. 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. Not every database engine is available in every AWS Region. When you are creating a DB instance, the Engine property is required. Valid Values:

    • aurora-mysql (for Aurora MySQL DB instances)
    • aurora-postgresql (for Aurora PostgreSQL DB instances)
    • custom-oracle-ee (for RDS Custom for Oracle DB instances)
    • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
    • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
    • db2-ae
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    EngineVersion string
    The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. 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. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
    Iops int
    The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. 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 in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

    • 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.
    • For RDS for SQL Server - Must be a multip
    KmsKeyId 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. 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. 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. 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
    LicenseModel string

    License model information for this DB instance. Valid Values:

    • Aurora MySQL - general-public-license
    • Aurora PostgreSQL - postgresql-license
    • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license or license-included
    • RDS for PostgreSQL - postgresql-license

    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.

    ManageMasterUserPassword bool
    Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

    • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
    MasterUserPassword string
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
    MasterUserSecret DbInstanceMasterUserSecretArgs
    The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
    MasterUsername string

    The master user name for the DB instance. If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints:

    • Must be 1 to 16 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MariaDB Constraints:

    • Must be 1 to 16 letters or numbers.
    • Can't be a reserved word for the chosen database engine.

    RDS for Microsoft SQL Server Constraints:

    • Must be 1 to 128 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MySQL Constrain

    MaxAllocatedStorage int
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (Storage is managed by the DB cluster.)
    • RDS Custom
    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. The default is 0. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
    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. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom DB instances.
    MultiAz bool
    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. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the MultiAZ option to be set.
    NcharCharacterSetName string
    The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
    NetworkType string

    The network type of the DB instance. Valid values:

    • IPV4
    • DUAL

    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). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    OptionGroupName string
    Indicates that the DB instance should be associated with the specified option group. 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.
    PerformanceInsightsKmsKeyId string
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. 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. For information about enabling Performance Insights, see EnablePerformanceInsights.
    PerformanceInsightsRetentionPeriod int

    The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values:

    • 7
    • 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)
    • 731

    Default: 7 days 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. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value: 50000
    PreferredBackupWindow 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 in the Amazon RDS User Guide. Constraints:

    • Must be in the format hh24:mi-hh24:mi.
    • Must be in Universal Coordinated Time (UTC).
    • Must not conflict with the preferred maintenance window.
    • Must be at least 30 minutes.

    Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi 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 in the Amazon RDS User Guide. 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. Constraints: Minimum 30-minute window.
    ProcessorFeatures []DbInstanceProcessorFeatureArgs
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
    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. This setting doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
    PubliclyAccessible bool
    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 default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
    ReplicaMode string
    The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
    RestoreTime string

    The date and time to restore from. Constraints:

    • Must be a time in Universal Coordinated Time (UTC) format.
    • Must be before the latest restorable time for the DB instance.
    • Can't be specified if the UseLatestRestorableTime parameter is enabled.

    Example: 2009-09-07T23:45:00Z

    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. Constraints:

    • Must be the identifier of an existing Multi-AZ DB cluster.
    • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
    • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
    • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
    SourceDbInstanceAutomatedBackupsArn 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. This setting doesn't apply to RDS Custom.
    SourceDbInstanceIdentifier 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 in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.

    • 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
    SourceDbiResourceId string
    The resource ID of the source DB instance from which to restore.
    SourceRegion string
    The ID of the region that contains the source DB instance for the read replica.
    StorageEncrypted bool
    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the KmsKeyId property, then you must enable encryption. 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. 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. 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. Amazon Aurora Not applicable. The encrypt
    StorageThroughput int
    Specifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
    StorageType string
    Specifies the storage type to be associated with the DB instance. Valid values: gp2 | gp3 | io1 | standard The standard value is also known as magnetic. If you specify io1 or gp3, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 For more information, see Amazon RDS DB Instance Storage in the Amazon RDS User Guide. Amazon Aurora Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
    Tags TagArgs
    An optional array of key-value pairs to apply to this DB instance.
    TdeCredentialArn string
    TdeCredentialPassword string
    Timezone string
    The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
    UseDefaultProcessorFeatures bool
    Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
    UseLatestRestorableTime bool
    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. Constraints:

    • Can't be specified if the RestoreTime parameter is provided.
    VpcSecurityGroups []string
    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. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. 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:

    • You can't revert to using an RDS security group after you establish a VPC security group membership.
    • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc
    allocatedStorage String

    The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. 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). Amazon Aurora 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. Db2 Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
    • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

    MySQL Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer fro
    allowMajorVersionUpgrade 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. 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.
    associatedRoles List<DbInstanceDbInstanceRole>
    The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
    autoMinorVersionUpgrade 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.
    automaticBackupReplicationRegion String
    The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
    availabilityZone String

    The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. 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. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints:

    • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
    • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

    Example: us-east-1d

    backupRetentionPeriod 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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints:

    • Must be a value from 0 to 35
    • Can't be set to 0 if the DB instance is a source to read replicas
    caCertificateIdentifier String
    The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
    certificateDetails DbInstanceCertificateDetails
    The details of the DB instance's server certificate.
    certificateRotationRestart Boolean
    Specifies 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. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. 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:

    characterSetName String
    For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
    copyTagsToSnapshot Boolean
    Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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.
    customIamInstanceProfile String

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints:

    • The profile must exist in your account.
    • The profile must have an IAM role that Amazon EC2 has permissions to assume.
    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    dbClusterIdentifier String
    The identifier of the DB cluster that the instance will belong to.
    dbClusterSnapshotIdentifier String
    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 DB cluster deployments in the Amazon RDS User Guide. Constraints:

    • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
    • Can't be specified when DBSnapshotIdentifier is specified.
    • Must be specified when DBSnapshotIdentifier isn't specified.
    • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
    • Can't be the identifier of an Aurora DB cluster snapshot.
    • Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
    dbInstanceClass 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. For the full list of DB instance classes, and availability for your engine, see DB Instance Class 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.
    dbInstanceIdentifier 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. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.
    dbName String

    The meaning of this parameter differs according to the database engine you use. If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
    • Can't be a word reserved by the specified database engine.

    MySQL 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Can't be a word reserved by the specified database engine

    MariaDB The name of the database to create when the DB instance is

    dbParameterGroupName String
    The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text 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. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
    dbSecurityGroups List<String>
    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. 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. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • BackupRetentionPeriod
    • CharacterSetName
    • DBInstanceClass
    • DBName
    • DBParameterGroupName
    • DBSecurityGroups
    • DBSubnetGroupName
    • Engine
    • EngineVersion
    • Iops
    • LicenseModel
    dbSnapshotIdentifier 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. 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. 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
    dbSubnetGroupName 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. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
    dedicatedLogVolume Boolean
    Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    deleteAutomatedBackups 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. Amazon Aurora 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.
    deletionProtection 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. Amazon Aurora 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. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
    domainAuthSecretArn String
    The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
    domainDnsIps List<String>

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

    • 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.

    Example: 123.124.125.126,234.235.236.237

    domainFqdn String

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

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    domainIamRoleName String
    The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (The domain is managed by the DB cluster.)
    • RDS Custom
    domainOu String

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

    • Must be in the distinguished name format.
    • Can't be longer than 64 characters.

    Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    enableCloudwatchLogsExports List<String>
    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 in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
    enableIamDatabaseAuthentication 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. 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 in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
    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. This setting doesn't apply to RDS Custom DB instances.
    endpoint DbInstanceEndpoint
    The connection endpoint for the DB instance. 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. Not every database engine is available in every AWS Region. When you are creating a DB instance, the Engine property is required. Valid Values:

    • aurora-mysql (for Aurora MySQL DB instances)
    • aurora-postgresql (for Aurora PostgreSQL DB instances)
    • custom-oracle-ee (for RDS Custom for Oracle DB instances)
    • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
    • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
    • db2-ae
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    engineVersion String
    The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. 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. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
    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. 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 in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

    • 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.
    • For RDS for SQL Server - Must be a multip
    kmsKeyId 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. 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. 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. 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
    licenseModel String

    License model information for this DB instance. Valid Values:

    • Aurora MySQL - general-public-license
    • Aurora PostgreSQL - postgresql-license
    • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license or license-included
    • RDS for PostgreSQL - postgresql-license

    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.

    manageMasterUserPassword Boolean
    Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

    • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
    masterUserPassword String
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
    masterUserSecret DbInstanceMasterUserSecret
    The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
    masterUsername String

    The master user name for the DB instance. If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints:

    • Must be 1 to 16 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MariaDB Constraints:

    • Must be 1 to 16 letters or numbers.
    • Can't be a reserved word for the chosen database engine.

    RDS for Microsoft SQL Server Constraints:

    • Must be 1 to 128 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MySQL Constrain

    maxAllocatedStorage Integer
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (Storage is managed by the DB cluster.)
    • RDS Custom
    monitoringInterval 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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
    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. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom DB instances.
    multiAz 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. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the MultiAZ option to be set.
    ncharCharacterSetName String
    The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
    networkType String

    The network type of the DB instance. Valid values:

    • IPV4
    • DUAL

    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). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    optionGroupName String
    Indicates that the DB instance should be associated with the specified option group. 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.
    performanceInsightsKmsKeyId String
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. 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. For information about enabling Performance Insights, see EnablePerformanceInsights.
    performanceInsightsRetentionPeriod Integer

    The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values:

    • 7
    • 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)
    • 731

    Default: 7 days 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. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value: 50000
    preferredBackupWindow 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 in the Amazon RDS User Guide. Constraints:

    • Must be in the format hh24:mi-hh24:mi.
    • Must be in Universal Coordinated Time (UTC).
    • Must not conflict with the preferred maintenance window.
    • Must be at least 30 minutes.

    Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

    preferredMaintenanceWindow String
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi 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 in the Amazon RDS User Guide. 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. Constraints: Minimum 30-minute window.
    processorFeatures List<DbInstanceProcessorFeature>
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
    promotionTier 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 in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
    publiclyAccessible 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. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
    replicaMode String
    The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
    restoreTime String

    The date and time to restore from. Constraints:

    • Must be a time in Universal Coordinated Time (UTC) format.
    • Must be before the latest restorable time for the DB instance.
    • Can't be specified if the UseLatestRestorableTime parameter is enabled.

    Example: 2009-09-07T23:45:00Z

    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. Constraints:

    • Must be the identifier of an existing Multi-AZ DB cluster.
    • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
    • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
    • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
    sourceDbInstanceAutomatedBackupsArn 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. This setting doesn't apply to RDS Custom.
    sourceDbInstanceIdentifier 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 in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.

    • 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
    sourceDbiResourceId String
    The resource ID of the source DB instance from which to restore.
    sourceRegion String
    The ID of the region that contains the source DB instance for the read replica.
    storageEncrypted Boolean
    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the KmsKeyId property, then you must enable encryption. 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. 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. 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. Amazon Aurora Not applicable. The encrypt
    storageThroughput Integer
    Specifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
    storageType String
    Specifies the storage type to be associated with the DB instance. Valid values: gp2 | gp3 | io1 | standard The standard value is also known as magnetic. If you specify io1 or gp3, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 For more information, see Amazon RDS DB Instance Storage in the Amazon RDS User Guide. Amazon Aurora Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
    tags List<Tag>
    An optional array of key-value pairs to apply to this DB instance.
    tdeCredentialArn String
    tdeCredentialPassword String
    timezone String
    The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
    useDefaultProcessorFeatures Boolean
    Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
    useLatestRestorableTime 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. Constraints:

    • Can't be specified if the RestoreTime parameter is provided.
    vpcSecurityGroups List<String>
    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. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. 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:

    • You can't revert to using an RDS security group after you establish a VPC security group membership.
    • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc
    allocatedStorage string

    The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. 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). Amazon Aurora 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. Db2 Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
    • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

    MySQL Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer fro
    allowMajorVersionUpgrade 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. 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.
    associatedRoles DbInstanceDbInstanceRole[]
    The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
    autoMinorVersionUpgrade 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.
    automaticBackupReplicationRegion string
    The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
    availabilityZone string

    The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. 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. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints:

    • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
    • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

    Example: us-east-1d

    backupRetentionPeriod number
    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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints:

    • Must be a value from 0 to 35
    • Can't be set to 0 if the DB instance is a source to read replicas
    caCertificateIdentifier string
    The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
    certificateDetails DbInstanceCertificateDetails
    The details of the DB instance's server certificate.
    certificateRotationRestart boolean
    Specifies 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. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. 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:

    characterSetName string
    For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
    copyTagsToSnapshot boolean
    Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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.
    customIamInstanceProfile string

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints:

    • The profile must exist in your account.
    • The profile must have an IAM role that Amazon EC2 has permissions to assume.
    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    dbClusterIdentifier string
    The identifier of the DB cluster that the instance will belong to.
    dbClusterSnapshotIdentifier string
    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 DB cluster deployments in the Amazon RDS User Guide. Constraints:

    • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
    • Can't be specified when DBSnapshotIdentifier is specified.
    • Must be specified when DBSnapshotIdentifier isn't specified.
    • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
    • Can't be the identifier of an Aurora DB cluster snapshot.
    • Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
    dbInstanceClass 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. For the full list of DB instance classes, and availability for your engine, see DB Instance Class 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.
    dbInstanceIdentifier 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. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.
    dbName string

    The meaning of this parameter differs according to the database engine you use. If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
    • Can't be a word reserved by the specified database engine.

    MySQL 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Can't be a word reserved by the specified database engine

    MariaDB The name of the database to create when the DB instance is

    dbParameterGroupName string
    The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text 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. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
    dbSecurityGroups string[]
    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. 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. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • BackupRetentionPeriod
    • CharacterSetName
    • DBInstanceClass
    • DBName
    • DBParameterGroupName
    • DBSecurityGroups
    • DBSubnetGroupName
    • Engine
    • EngineVersion
    • Iops
    • LicenseModel
    dbSnapshotIdentifier 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. 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. 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
    dbSubnetGroupName 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. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
    dedicatedLogVolume boolean
    Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    deleteAutomatedBackups 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. Amazon Aurora 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.
    deletionProtection 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. Amazon Aurora 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. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
    domainAuthSecretArn string
    The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
    domainDnsIps string[]

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

    • 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.

    Example: 123.124.125.126,234.235.236.237

    domainFqdn string

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

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    domainIamRoleName string
    The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (The domain is managed by the DB cluster.)
    • RDS Custom
    domainOu string

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

    • Must be in the distinguished name format.
    • Can't be longer than 64 characters.

    Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    enableCloudwatchLogsExports string[]
    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 in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
    enableIamDatabaseAuthentication 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. 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 in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
    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. This setting doesn't apply to RDS Custom DB instances.
    endpoint DbInstanceEndpoint
    The connection endpoint for the DB instance. 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. Not every database engine is available in every AWS Region. When you are creating a DB instance, the Engine property is required. Valid Values:

    • aurora-mysql (for Aurora MySQL DB instances)
    • aurora-postgresql (for Aurora PostgreSQL DB instances)
    • custom-oracle-ee (for RDS Custom for Oracle DB instances)
    • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
    • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
    • db2-ae
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    engineVersion string
    The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. 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. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
    iops number
    The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. 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 in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

    • 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.
    • For RDS for SQL Server - Must be a multip
    kmsKeyId 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. 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. 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. 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
    licenseModel string

    License model information for this DB instance. Valid Values:

    • Aurora MySQL - general-public-license
    • Aurora PostgreSQL - postgresql-license
    • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license or license-included
    • RDS for PostgreSQL - postgresql-license

    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.

    manageMasterUserPassword boolean
    Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

    • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
    masterUserPassword string
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
    masterUserSecret DbInstanceMasterUserSecret
    The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
    masterUsername string

    The master user name for the DB instance. If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints:

    • Must be 1 to 16 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MariaDB Constraints:

    • Must be 1 to 16 letters or numbers.
    • Can't be a reserved word for the chosen database engine.

    RDS for Microsoft SQL Server Constraints:

    • Must be 1 to 128 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MySQL Constrain

    maxAllocatedStorage number
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (Storage is managed by the DB cluster.)
    • RDS Custom
    monitoringInterval number
    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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
    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. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom DB instances.
    multiAz 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. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the MultiAZ option to be set.
    ncharCharacterSetName string
    The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
    networkType string

    The network type of the DB instance. Valid values:

    • IPV4
    • DUAL

    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). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    optionGroupName string
    Indicates that the DB instance should be associated with the specified option group. 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.
    performanceInsightsKmsKeyId string
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. 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. For information about enabling Performance Insights, see EnablePerformanceInsights.
    performanceInsightsRetentionPeriod number

    The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values:

    • 7
    • 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)
    • 731

    Default: 7 days 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. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value: 50000
    preferredBackupWindow 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 in the Amazon RDS User Guide. Constraints:

    • Must be in the format hh24:mi-hh24:mi.
    • Must be in Universal Coordinated Time (UTC).
    • Must not conflict with the preferred maintenance window.
    • Must be at least 30 minutes.

    Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

    preferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi 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 in the Amazon RDS User Guide. 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. Constraints: Minimum 30-minute window.
    processorFeatures DbInstanceProcessorFeature[]
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
    promotionTier number
    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. This setting doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
    publiclyAccessible 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. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
    replicaMode string
    The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
    restoreTime string

    The date and time to restore from. Constraints:

    • Must be a time in Universal Coordinated Time (UTC) format.
    • Must be before the latest restorable time for the DB instance.
    • Can't be specified if the UseLatestRestorableTime parameter is enabled.

    Example: 2009-09-07T23:45:00Z

    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. Constraints:

    • Must be the identifier of an existing Multi-AZ DB cluster.
    • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
    • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
    • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
    sourceDbInstanceAutomatedBackupsArn 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. This setting doesn't apply to RDS Custom.
    sourceDbInstanceIdentifier 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 in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.

    • 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
    sourceDbiResourceId string
    The resource ID of the source DB instance from which to restore.
    sourceRegion string
    The ID of the region that contains the source DB instance for the read replica.
    storageEncrypted boolean
    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the KmsKeyId property, then you must enable encryption. 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. 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. 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. Amazon Aurora Not applicable. The encrypt
    storageThroughput number
    Specifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
    storageType string
    Specifies the storage type to be associated with the DB instance. Valid values: gp2 | gp3 | io1 | standard The standard value is also known as magnetic. If you specify io1 or gp3, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 For more information, see Amazon RDS DB Instance Storage in the Amazon RDS User Guide. Amazon Aurora Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
    tags Tag[]
    An optional array of key-value pairs to apply to this DB instance.
    tdeCredentialArn string
    tdeCredentialPassword string
    timezone string
    The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
    useDefaultProcessorFeatures boolean
    Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
    useLatestRestorableTime 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. Constraints:

    • Can't be specified if the RestoreTime parameter is provided.
    vpcSecurityGroups string[]
    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. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. 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:

    • You can't revert to using an RDS security group after you establish a VPC security group membership.
    • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc
    allocated_storage str

    The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. 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). Amazon Aurora 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. Db2 Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
    • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

    MySQL Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer fro
    allow_major_version_upgrade bool
    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. 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 Sequence[DbInstanceDbInstanceRoleArgs]
    The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
    auto_minor_version_upgrade bool
    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 str
    The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
    availability_zone str

    The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. 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. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints:

    • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
    • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

    Example: us-east-1d

    backup_retention_period 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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints:

    • Must be a value from 0 to 35
    • Can't be set to 0 if the DB instance is a source to read replicas
    ca_certificate_identifier str
    The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
    certificate_details DbInstanceCertificateDetailsArgs
    The details of the DB instance's server certificate.
    certificate_rotation_restart bool
    Specifies 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. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. 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:

    character_set_name str
    For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
    copy_tags_to_snapshot bool
    Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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 str

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints:

    • The profile must exist in your account.
    • The profile must have an IAM role that Amazon EC2 has permissions to assume.
    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    db_cluster_identifier str
    The identifier of the DB cluster that the instance will belong to.
    db_cluster_snapshot_identifier str
    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 DB cluster deployments in the Amazon RDS User Guide. Constraints:

    • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
    • Can't be specified when DBSnapshotIdentifier is specified.
    • Must be specified when DBSnapshotIdentifier isn't specified.
    • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
    • Can't be the identifier of an Aurora DB cluster snapshot.
    • Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
    db_instance_class str
    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. For the full list of DB instance classes, and availability for your engine, see DB Instance Class 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.
    db_instance_identifier str
    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. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.
    db_name str

    The meaning of this parameter differs according to the database engine you use. If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
    • Can't be a word reserved by the specified database engine.

    MySQL 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Can't be a word reserved by the specified database engine

    MariaDB The name of the database to create when the DB instance is

    db_parameter_group_name str
    The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text 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. 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 Sequence[str]
    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. 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. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • BackupRetentionPeriod
    • CharacterSetName
    • DBInstanceClass
    • DBName
    • DBParameterGroupName
    • DBSecurityGroups
    • DBSubnetGroupName
    • Engine
    • EngineVersion
    • Iops
    • LicenseModel
    db_snapshot_identifier str
    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. 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. 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 str
    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. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
    dedicated_log_volume bool
    Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    delete_automated_backups bool
    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. Amazon Aurora 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 bool
    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. Amazon Aurora 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 str
    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. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
    domain_auth_secret_arn str
    The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
    domain_dns_ips Sequence[str]

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

    • 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.

    Example: 123.124.125.126,234.235.236.237

    domain_fqdn str

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

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    domain_iam_role_name str
    The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (The domain is managed by the DB cluster.)
    • RDS Custom
    domain_ou str

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

    • Must be in the distinguished name format.
    • Can't be longer than 64 characters.

    Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    enable_cloudwatch_logs_exports Sequence[str]
    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 in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
    enable_iam_database_authentication bool
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. 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 in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
    enable_performance_insights bool
    Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
    endpoint DbInstanceEndpointArgs
    The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of creating.
    engine str
    The name of the database engine that you want to use for this DB instance. Not every database engine is available in every AWS Region. When you are creating a DB instance, the Engine property is required. Valid Values:

    • aurora-mysql (for Aurora MySQL DB instances)
    • aurora-postgresql (for Aurora PostgreSQL DB instances)
    • custom-oracle-ee (for RDS Custom for Oracle DB instances)
    • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
    • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
    • db2-ae
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    engine_version str
    The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. 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. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
    iops int
    The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. 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 in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

    • 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.
    • For RDS for SQL Server - Must be a multip
    kms_key_id str
    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. 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. 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. 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 str

    License model information for this DB instance. Valid Values:

    • Aurora MySQL - general-public-license
    • Aurora PostgreSQL - postgresql-license
    • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license or license-included
    • RDS for PostgreSQL - postgresql-license

    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.

    manage_master_user_password bool
    Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

    • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
    master_user_password str
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
    master_user_secret DbInstanceMasterUserSecretArgs
    The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
    master_username str

    The master user name for the DB instance. If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints:

    • Must be 1 to 16 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MariaDB Constraints:

    • Must be 1 to 16 letters or numbers.
    • Can't be a reserved word for the chosen database engine.

    RDS for Microsoft SQL Server Constraints:

    • Must be 1 to 128 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MySQL Constrain

    max_allocated_storage int
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (Storage is managed by the DB cluster.)
    • RDS Custom
    monitoring_interval 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. The default is 0. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
    monitoring_role_arn str
    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. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom DB instances.
    multi_az bool
    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. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora 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 str
    The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
    network_type str

    The network type of the DB instance. Valid values:

    • IPV4
    • DUAL

    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). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    option_group_name str
    Indicates that the DB instance should be associated with the specified option group. 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 str
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. 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. For information about enabling Performance Insights, see EnablePerformanceInsights.
    performance_insights_retention_period int

    The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values:

    • 7
    • 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)
    • 731

    Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

    port str
    The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value: 50000
    preferred_backup_window str

    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 in the Amazon RDS User Guide. Constraints:

    • Must be in the format hh24:mi-hh24:mi.
    • Must be in Universal Coordinated Time (UTC).
    • Must not conflict with the preferred maintenance window.
    • Must be at least 30 minutes.

    Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

    preferred_maintenance_window str
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi 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 in the Amazon RDS User Guide. 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. Constraints: Minimum 30-minute window.
    processor_features Sequence[DbInstanceProcessorFeatureArgs]
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
    promotion_tier 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. This setting doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
    publicly_accessible bool
    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 default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
    replica_mode str
    The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
    restore_time str

    The date and time to restore from. Constraints:

    • Must be a time in Universal Coordinated Time (UTC) format.
    • Must be before the latest restorable time for the DB instance.
    • Can't be specified if the UseLatestRestorableTime parameter is enabled.

    Example: 2009-09-07T23:45:00Z

    source_db_cluster_identifier str
    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. Constraints:

    • Must be the identifier of an existing Multi-AZ DB cluster.
    • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
    • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
    • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
    source_db_instance_automated_backups_arn str
    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. This setting doesn't apply to RDS Custom.
    source_db_instance_identifier str
    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 in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.

    • 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_dbi_resource_id str
    The resource ID of the source DB instance from which to restore.
    source_region str
    The ID of the region that contains the source DB instance for the read replica.
    storage_encrypted bool
    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the KmsKeyId property, then you must enable encryption. 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. 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. 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. Amazon Aurora Not applicable. The encrypt
    storage_throughput int
    Specifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
    storage_type str
    Specifies the storage type to be associated with the DB instance. Valid values: gp2 | gp3 | io1 | standard The standard value is also known as magnetic. If you specify io1 or gp3, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 For more information, see Amazon RDS DB Instance Storage in the Amazon RDS User Guide. Amazon Aurora Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
    tags Sequence[TagArgs]
    An optional array of key-value pairs to apply to this DB instance.
    tde_credential_arn str
    tde_credential_password str
    timezone str
    The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
    use_default_processor_features bool
    Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
    use_latest_restorable_time bool
    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. Constraints:

    • Can't be specified if the RestoreTime parameter is provided.
    vpc_security_groups Sequence[str]
    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. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. 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:

    • You can't revert to using an RDS security group after you establish a VPC security group membership.
    • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc
    allocatedStorage String

    The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. 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). Amazon Aurora 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. Db2 Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
    • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

    MySQL Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer fro
    allowMajorVersionUpgrade 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. 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.
    associatedRoles List<Property Map>
    The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
    autoMinorVersionUpgrade 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.
    automaticBackupReplicationRegion String
    The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
    availabilityZone String

    The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. 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. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints:

    • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
    • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

    Example: us-east-1d

    backupRetentionPeriod Number
    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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints:

    • Must be a value from 0 to 35
    • Can't be set to 0 if the DB instance is a source to read replicas
    caCertificateIdentifier String
    The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
    certificateDetails Property Map
    The details of the DB instance's server certificate.
    certificateRotationRestart Boolean
    Specifies 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. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. 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:

    characterSetName String
    For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
    copyTagsToSnapshot Boolean
    Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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.
    customIamInstanceProfile String

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints:

    • The profile must exist in your account.
    • The profile must have an IAM role that Amazon EC2 has permissions to assume.
    • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    dbClusterIdentifier String
    The identifier of the DB cluster that the instance will belong to.
    dbClusterSnapshotIdentifier String
    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 DB cluster deployments in the Amazon RDS User Guide. Constraints:

    • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
    • Can't be specified when DBSnapshotIdentifier is specified.
    • Must be specified when DBSnapshotIdentifier isn't specified.
    • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
    • Can't be the identifier of an Aurora DB cluster snapshot.
    • Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
    dbInstanceClass 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. For the full list of DB instance classes, and availability for your engine, see DB Instance Class 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.
    dbInstanceIdentifier 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. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.
    dbName String

    The meaning of this parameter differs according to the database engine you use. If you specify the DBSnapshotIdentifier property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
    • Can't be a word reserved by the specified database engine.

    MySQL 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. Constraints:

    • Must contain 1 to 64 letters or numbers.
    • Can't be a word reserved by the specified database engine

    MariaDB The name of the database to create when the DB instance is

    dbParameterGroupName String
    The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text 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. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
    dbSecurityGroups List<String>
    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. 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. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

    • AllocatedStorage
    • AutoMinorVersionUpgrade
    • AvailabilityZone
    • BackupRetentionPeriod
    • CharacterSetName
    • DBInstanceClass
    • DBName
    • DBParameterGroupName
    • DBSecurityGroups
    • DBSubnetGroupName
    • Engine
    • EngineVersion
    • Iops
    • LicenseModel
    dbSnapshotIdentifier 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. 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. 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
    dbSubnetGroupName 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. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
    dedicatedLogVolume Boolean
    Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    deleteAutomatedBackups 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. Amazon Aurora 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.
    deletionProtection 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. Amazon Aurora 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. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
    domainAuthSecretArn String
    The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
    domainDnsIps List<String>

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

    • 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.

    Example: 123.124.125.126,234.235.236.237

    domainFqdn String

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

    • Can't be longer than 64 characters.

    Example: mymanagedADtest.mymanagedAD.mydomain

    domainIamRoleName String
    The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (The domain is managed by the DB cluster.)
    • RDS Custom
    domainOu String

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

    • Must be in the distinguished name format.
    • Can't be longer than 64 characters.

    Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    enableCloudwatchLogsExports List<String>
    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 in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
    enableIamDatabaseAuthentication 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. 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 in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
    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. This setting doesn't apply to RDS Custom DB instances.
    endpoint Property Map
    The connection endpoint for the DB instance. 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. Not every database engine is available in every AWS Region. When you are creating a DB instance, the Engine property is required. Valid Values:

    • aurora-mysql (for Aurora MySQL DB instances)
    • aurora-postgresql (for Aurora PostgreSQL DB instances)
    • custom-oracle-ee (for RDS Custom for Oracle DB instances)
    • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
    • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
    • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
    • db2-ae
    • db2-se
    • mariadb
    • mysql
    • oracle-ee
    • oracle-ee-cdb
    • oracle-se2
    • oracle-se2-cdb
    • postgres
    • sqlserver-ee
    • sqlserver-se
    • sqlserver-ex
    • sqlserver-web
    engineVersion String
    The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. 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. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu
    iops Number
    The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. 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 in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

    • 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.
    • For RDS for SQL Server - Must be a multip
    kmsKeyId 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. 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. 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. 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
    licenseModel String

    License model information for this DB instance. Valid Values:

    • Aurora MySQL - general-public-license
    • Aurora PostgreSQL - postgresql-license
    • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
    • RDS for MariaDB - general-public-license
    • RDS for Microsoft SQL Server - license-included
    • RDS for MySQL - general-public-license
    • RDS for Oracle - bring-your-own-license or license-included
    • RDS for PostgreSQL - postgresql-license

    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.

    manageMasterUserPassword Boolean
    Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

    • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
    masterUserPassword String
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
    masterUserSecret Property Map
    The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
    masterUsername String

    The master user name for the DB instance. If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints:

    • Must be 1 to 16 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MariaDB Constraints:

    • Must be 1 to 16 letters or numbers.
    • Can't be a reserved word for the chosen database engine.

    RDS for Microsoft SQL Server Constraints:

    • Must be 1 to 128 letters or numbers.
    • First character must be a letter.
    • Can't be a reserved word for the chosen database engine.

    RDS for MySQL Constrain

    maxAllocatedStorage Number
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances:

    • Amazon Aurora (Storage is managed by the DB cluster.)
    • RDS Custom
    monitoringInterval Number
    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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
    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. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom DB instances.
    multiAz 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. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the MultiAZ option to be set.
    ncharCharacterSetName String
    The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
    networkType String

    The network type of the DB instance. Valid values:

    • IPV4
    • DUAL

    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). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    optionGroupName String
    Indicates that the DB instance should be associated with the specified option group. 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.
    performanceInsightsKmsKeyId String
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. 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. For information about enabling Performance Insights, see EnablePerformanceInsights.
    performanceInsightsRetentionPeriod Number

    The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values:

    • 7
    • 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)
    • 731

    Default: 7 days 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. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value: 50000
    preferredBackupWindow 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 in the Amazon RDS User Guide. Constraints:

    • Must be in the format hh24:mi-hh24:mi.
    • Must be in Universal Coordinated Time (UTC).
    • Must not conflict with the preferred maintenance window.
    • Must be at least 30 minutes.

    Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

    preferredMaintenanceWindow String
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi 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 in the Amazon RDS User Guide. 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. Constraints: Minimum 30-minute window.
    processorFeatures List<Property Map>
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
    promotionTier Number
    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. This setting doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
    publiclyAccessible 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. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
    replicaMode String
    The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
    restoreTime String

    The date and time to restore from. Constraints:

    • Must be a time in Universal Coordinated Time (UTC) format.
    • Must be before the latest restorable time for the DB instance.
    • Can't be specified if the UseLatestRestorableTime parameter is enabled.

    Example: 2009-09-07T23:45:00Z

    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. Constraints:

    • Must be the identifier of an existing Multi-AZ DB cluster.
    • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
    • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
    • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
    sourceDbInstanceAutomatedBackupsArn 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. This setting doesn't apply to RDS Custom.
    sourceDbInstanceIdentifier 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 in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. 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.

    • 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
    sourceDbiResourceId String
    The resource ID of the source DB instance from which to restore.
    sourceRegion String
    The ID of the region that contains the source DB instance for the read replica.
    storageEncrypted Boolean
    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the KmsKeyId property, then you must enable encryption. 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. 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. 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. Amazon Aurora Not applicable. The encrypt
    storageThroughput Number
    Specifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
    storageType String
    Specifies the storage type to be associated with the DB instance. Valid values: gp2 | gp3 | io1 | standard The standard value is also known as magnetic. If you specify io1 or gp3, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 For more information, see Amazon RDS DB Instance Storage in the Amazon RDS User Guide. Amazon Aurora Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
    tags List<Property Map>
    An optional array of key-value pairs to apply to this DB instance.
    tdeCredentialArn String
    tdeCredentialPassword String
    timezone String
    The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
    useDefaultProcessorFeatures Boolean
    Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
    useLatestRestorableTime 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. Constraints:

    • Can't be specified if the RestoreTime parameter is provided.
    vpcSecurityGroups List<String>
    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. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. 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:

    • You can't revert to using an RDS security group after you establish a VPC security group membership.
    • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DbInstance resource produces the following output properties:

    DbInstanceArn string
    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.
    DbiResourceId string
    Id string
    The provider-assigned unique ID for this managed resource.
    DbInstanceArn string
    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.
    DbiResourceId string
    Id string
    The provider-assigned unique ID for this managed resource.
    dbInstanceArn String
    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.
    dbiResourceId String
    id String
    The provider-assigned unique ID for this managed resource.
    dbInstanceArn string
    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.
    dbiResourceId string
    id string
    The provider-assigned unique ID for this managed resource.
    db_instance_arn str
    db_system_id str
    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.
    dbi_resource_id str
    id str
    The provider-assigned unique ID for this managed resource.
    dbInstanceArn String
    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.
    dbiResourceId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DbInstanceCertificateDetails, DbInstanceCertificateDetailsArgs

    CaIdentifier string
    The CA identifier of the CA certificate used for the DB instance's server certificate.
    ValidTill string
    The expiration date of the DB instance’s server certificate.
    CaIdentifier string
    The CA identifier of the CA certificate used for the DB instance's server certificate.
    ValidTill string
    The expiration date of the DB instance’s server certificate.
    caIdentifier String
    The CA identifier of the CA certificate used for the DB instance's server certificate.
    validTill String
    The expiration date of the DB instance’s server certificate.
    caIdentifier string
    The CA identifier of the CA certificate used for the DB instance's server certificate.
    validTill string
    The expiration date of the DB instance’s server certificate.
    ca_identifier str
    The CA identifier of the CA certificate used for the DB instance's server certificate.
    valid_till str
    The expiration date of the DB instance’s server certificate.
    caIdentifier String
    The CA identifier of the CA certificate used for the DB instance's server certificate.
    validTill String
    The expiration date of the DB instance’s server certificate.

    DbInstanceDbInstanceRole, DbInstanceDbInstanceRoleArgs

    FeatureName string
    The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
    FeatureName string
    The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
    featureName String
    The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
    featureName string
    The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
    roleArn string
    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
    feature_name str
    The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
    role_arn str
    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
    featureName String
    The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

    DbInstanceEndpoint, DbInstanceEndpointArgs

    Address string
    Specifies the DNS address of the DB instance.
    HostedZoneId string
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    Port string
    Specifies the port that the database engine is listening on.
    Address string
    Specifies the DNS address of the DB instance.
    HostedZoneId string
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    Port string
    Specifies the port that the database engine is listening on.
    address String
    Specifies the DNS address of the DB instance.
    hostedZoneId String
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    port String
    Specifies the port that the database engine is listening on.
    address string
    Specifies the DNS address of the DB instance.
    hostedZoneId string
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    port string
    Specifies the port that the database engine is listening on.
    address str
    Specifies the DNS address of the DB instance.
    hosted_zone_id str
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    port str
    Specifies the port that the database engine is listening on.
    address String
    Specifies the DNS address of the DB instance.
    hostedZoneId String
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    port String
    Specifies the port that the database engine is listening on.

    DbInstanceMasterUserSecret, DbInstanceMasterUserSecretArgs

    KmsKeyId string
    The AWS KMS key identifier that is used to encrypt the secret.
    SecretArn string
    The Amazon Resource Name (ARN) of the secret.
    KmsKeyId string
    The AWS KMS key identifier that is used to encrypt the secret.
    SecretArn string
    The Amazon Resource Name (ARN) of the secret.
    kmsKeyId String
    The AWS KMS key identifier that is used to encrypt the secret.
    secretArn String
    The Amazon Resource Name (ARN) of the secret.
    kmsKeyId string
    The AWS KMS key identifier that is used to encrypt the secret.
    secretArn string
    The Amazon Resource Name (ARN) of the secret.
    kms_key_id str
    The AWS KMS key identifier that is used to encrypt the secret.
    secret_arn str
    The Amazon Resource Name (ARN) of the secret.
    kmsKeyId String
    The AWS KMS key identifier that is used to encrypt the secret.
    secretArn String
    The Amazon Resource Name (ARN) of the secret.

    DbInstanceProcessorFeature, DbInstanceProcessorFeatureArgs

    Name Pulumi.AwsNative.Rds.DbInstanceProcessorFeatureName
    The name of the processor feature. Valid names are coreCount and threadsPerCore.
    Value string
    The value of a processor feature name.
    Name DbInstanceProcessorFeatureName
    The name of the processor feature. Valid names are coreCount and threadsPerCore.
    Value string
    The value of a processor feature name.
    name DbInstanceProcessorFeatureName
    The name of the processor feature. Valid names are coreCount and threadsPerCore.
    value String
    The value of a processor feature name.
    name DbInstanceProcessorFeatureName
    The name of the processor feature. Valid names are coreCount and threadsPerCore.
    value string
    The value of a processor feature name.
    name DbInstanceProcessorFeatureName
    The name of the processor feature. Valid names are coreCount and threadsPerCore.
    value str
    The value of a processor feature name.
    name "coreCount" | "threadsPerCore"
    The name of the processor feature. Valid names are coreCount and threadsPerCore.
    value String
    The value of a processor feature name.

    DbInstanceProcessorFeatureName, DbInstanceProcessorFeatureNameArgs

    CoreCount
    coreCount
    ThreadsPerCore
    threadsPerCore
    DbInstanceProcessorFeatureNameCoreCount
    coreCount
    DbInstanceProcessorFeatureNameThreadsPerCore
    threadsPerCore
    CoreCount
    coreCount
    ThreadsPerCore
    threadsPerCore
    CoreCount
    coreCount
    ThreadsPerCore
    threadsPerCore
    CORE_COUNT
    coreCount
    THREADS_PER_CORE
    threadsPerCore
    "coreCount"
    coreCount
    "threadsPerCore"
    threadsPerCore

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native