CfnDBInstance (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.rds.CfnDBInstance

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
```
@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.376Z")
 @Stability(value=Stable)
public class CfnDBInstance
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::RDS::DBInstance`.
The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance.
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 update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see Prevent Updates to Stack Resources .

This topic covers the resource for Amazon RDS DB instances. For the documentation on the resource for Amazon Aurora DB clusters, see AWS::RDS::DBCluster .
Updating DB instances
When properties labeled " Update requires: Replacement " are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
- Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
- Create a snapshot of the DB instance. For more information about creating DB snapshots, see Creating a DB Snapshot .
- If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.
After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
- Update the stack.
For more information about updating other properties of this resource, see [ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) . For more information about updating stacks, see AWS CloudFormation Stacks Updates .
Deleting DB instances
For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to retain the DB instance, to delete the DB instance, or to create a snapshot of the DB instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property:
- For AWS::RDS::DBInstance resources that don't specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance.
- For AWS::RDS::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance.
For more information, see DeletionPolicy Attribute .
Example:
```
 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 CfnDBInstance cfnDBInstance = CfnDBInstance.Builder.create(this, "MyCfnDBInstance")
         .allocatedStorage("allocatedStorage")
         .allowMajorVersionUpgrade(false)
         .associatedRoles(List.of(DBInstanceRoleProperty.builder()
                 .featureName("featureName")
                 .roleArn("roleArn")
                 .build()))
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .backupRetentionPeriod(123)
         .caCertificateIdentifier("caCertificateIdentifier")
         .characterSetName("characterSetName")
         .copyTagsToSnapshot(false)
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbInstanceClass("dbInstanceClass")
         .dbInstanceIdentifier("dbInstanceIdentifier")
         .dbName("dbName")
         .dbParameterGroupName("dbParameterGroupName")
         .dbSecurityGroups(List.of("dbSecurityGroups"))
         .dbSnapshotIdentifier("dbSnapshotIdentifier")
         .dbSubnetGroupName("dbSubnetGroupName")
         .deleteAutomatedBackups(false)
         .deletionProtection(false)
         .domain("domain")
         .domainIamRoleName("domainIamRoleName")
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .enableIamDatabaseAuthentication(false)
         .enablePerformanceInsights(false)
         .engine("engine")
         .engineVersion("engineVersion")
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .licenseModel("licenseModel")
         .masterUsername("masterUsername")
         .masterUserPassword("masterUserPassword")
         .maxAllocatedStorage(123)
         .monitoringInterval(123)
         .monitoringRoleArn("monitoringRoleArn")
         .multiAz(false)
         .optionGroupName("optionGroupName")
         .performanceInsightsKmsKeyId("performanceInsightsKmsKeyId")
         .performanceInsightsRetentionPeriod(123)
         .port("port")
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .processorFeatures(List.of(ProcessorFeatureProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .promotionTier(123)
         .publiclyAccessible(false)
         .sourceDbInstanceIdentifier("sourceDbInstanceIdentifier")
         .sourceRegion("sourceRegion")
         .storageEncrypted(false)
         .storageType("storageType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timezone("timezone")
         .useDefaultProcessorFeatures(false)
         .vpcSecurityGroups(List.of("vpcSecurityGroups"))
         .build();
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnDBInstance.Builder` A fluent builder for `CfnDBInstance`.
`static interface`	`CfnDBInstance.DBInstanceRoleProperty` Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance.
`static interface`	`CfnDBInstance.EndpointProperty` Example:
`static interface`	`CfnDBInstance.ProcessorFeatureProperty` The `ProcessorFeature` property type specifies the processor features of a DB instance class status.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDBInstance(software.constructs.Construct scope, String id)` Create a new `AWS::RDS::DBInstance`.
	`CfnDBInstance(software.constructs.Construct scope, String id, CfnDBInstanceProps props)` Create a new `AWS::RDS::DBInstance`.
`protected`	`CfnDBInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnDBInstance(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAllocatedStorage()` The amount of storage (in gigabytes) to be initially allocated for the database instance.
`Object`	`getAllowMajorVersionUpgrade()` A value that indicates whether major version upgrades are allowed.
`Object`	`getAssociatedRoles()` The AWS Identity and Access Management (IAM) roles associated with the DB instance.
`String`	`getAttrEndpointAddress()` The connection endpoint for the database.
`String`	`getAttrEndpointHostedZoneId()`
`String`	`getAttrEndpointPort()` The port number on which the database accepts connections.
`Object`	`getAutoMinorVersionUpgrade()` A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
`String`	`getAvailabilityZone()` The Availability Zone (AZ) where the database will be created.
`Number`	`getBackupRetentionPeriod()` The number of days for which automated backups are retained.
`String`	`getCaCertificateIdentifier()` The identifier of the CA certificate for this DB instance.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getCharacterSetName()` For supported engines, indicates that the DB instance should be associated with the specified character set.
`Object`	`getCopyTagsToSnapshot()` A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
`String`	`getDbClusterIdentifier()` The identifier of the DB cluster that the instance will belong to.
`String`	`getDbInstanceClass()` The compute and memory capacity of the DB instance, for example, `db.m4.large` .
`String`	`getDbInstanceIdentifier()` A name for the DB instance.
`String`	`getDbName()` The meaning of this parameter differs according to the database engine you use.
`String`	`getDbParameterGroupName()` The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
`List<String>`	`getDbSecurityGroups()` A list of the DB security groups to assign to the DB instance.
`String`	`getDbSnapshotIdentifier()` The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
`String`	`getDbSubnetGroupName()` A DB subnet group to associate with the DB instance.
`Object`	`getDeleteAutomatedBackups()` A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
`Object`	`getDeletionProtection()` A value that indicates whether the DB instance has deletion protection enabled.
`String`	`getDomain()` The Active Directory directory ID to create the DB instance in.
`String`	`getDomainIamRoleName()` Specify the name of the IAM role to be used when making API calls to the Directory Service.
`List<String>`	`getEnableCloudwatchLogsExports()` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`Object`	`getEnableIamDatabaseAuthentication()` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`Object`	`getEnablePerformanceInsights()` A value that indicates whether to enable Performance Insights for the DB instance.
`String`	`getEngine()` The name of the database engine that you want to use for this DB instance.
`String`	`getEngineVersion()` The version number of the database engine to use.
`Number`	`getIops()` The number of I/O operations per second (IOPS) that the database provisions.
`String`	`getKmsKeyId()` 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` .
`String`	`getLicenseModel()` License model information for this DB instance.
`String`	`getMasterUsername()` The master user name for the DB instance.
`String`	`getMasterUserPassword()` The password for the master user.
`Number`	`getMaxAllocatedStorage()` The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
`Number`	`getMonitoringInterval()` The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
`String`	`getMonitoringRoleArn()` The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
`Object`	`getMultiAz()` Specifies whether the database instance is a Multi-AZ DB instance deployment.
`String`	`getOptionGroupName()` Indicates that the DB instance should be associated with the specified option group.
`String`	`getPerformanceInsightsKmsKeyId()` The AWS KMS key identifier for encryption of Performance Insights data.
`Number`	`getPerformanceInsightsRetentionPeriod()` The amount of time, in days, to retain Performance Insights data.
`String`	`getPort()` The port number on which the database accepts connections.
`String`	`getPreferredBackupWindow()` The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.
`String`	`getPreferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`Object`	`getProcessorFeatures()` The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
`Number`	`getPromotionTier()` A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
`Object`	`getPubliclyAccessible()` Indicates whether the DB instance is an internet-facing instance.
`String`	`getSourceDbInstanceIdentifier()` If you want to create a read replica DB instance, specify the ID of the source DB instance.
`String`	`getSourceRegion()` The ID of the region that contains the source DB instance for the read replica.
`Object`	`getStorageEncrypted()` A value that indicates whether the DB instance is encrypted.
`String`	`getStorageType()` Specifies the storage type to be associated with the DB instance.
`TagManager`	`getTags()` Tags to assign to the DB instance.
`String`	`getTimezone()` The time zone of the DB instance.
`Object`	`getUseDefaultProcessorFeatures()` A value that indicates whether the DB instance class of the DB instance uses its default processor features.
`List<String>`	`getVpcSecurityGroups()` A list of the VPC security group IDs to assign to the DB instance.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAllocatedStorage(String value)` The amount of storage (in gigabytes) to be initially allocated for the database instance.
`void`	`setAllowMajorVersionUpgrade(Boolean value)` A value that indicates whether major version upgrades are allowed.
`void`	`setAllowMajorVersionUpgrade(IResolvable value)` A value that indicates whether major version upgrades are allowed.
`void`	`setAssociatedRoles(IResolvable value)` The AWS Identity and Access Management (IAM) roles associated with the DB instance.
`void`	`setAssociatedRoles(List<Object> value)` The AWS Identity and Access Management (IAM) roles associated with the DB instance.
`void`	`setAutoMinorVersionUpgrade(Boolean value)` A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
`void`	`setAutoMinorVersionUpgrade(IResolvable value)` A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
`void`	`setAvailabilityZone(String value)` The Availability Zone (AZ) where the database will be created.
`void`	`setBackupRetentionPeriod(Number value)` The number of days for which automated backups are retained.
`void`	`setCaCertificateIdentifier(String value)` The identifier of the CA certificate for this DB instance.
`void`	`setCharacterSetName(String value)` For supported engines, indicates that the DB instance should be associated with the specified character set.
`void`	`setCopyTagsToSnapshot(Boolean value)` A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
`void`	`setCopyTagsToSnapshot(IResolvable value)` A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
`void`	`setDbClusterIdentifier(String value)` The identifier of the DB cluster that the instance will belong to.
`void`	`setDbInstanceClass(String value)` The compute and memory capacity of the DB instance, for example, `db.m4.large` .
`void`	`setDbInstanceIdentifier(String value)` A name for the DB instance.
`void`	`setDbName(String value)` The meaning of this parameter differs according to the database engine you use.
`void`	`setDbParameterGroupName(String value)` The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
`void`	`setDbSecurityGroups(List<String> value)` A list of the DB security groups to assign to the DB instance.
`void`	`setDbSnapshotIdentifier(String value)` The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
`void`	`setDbSubnetGroupName(String value)` A DB subnet group to associate with the DB instance.
`void`	`setDeleteAutomatedBackups(Boolean value)` A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
`void`	`setDeleteAutomatedBackups(IResolvable value)` A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
`void`	`setDeletionProtection(Boolean value)` A value that indicates whether the DB instance has deletion protection enabled.
`void`	`setDeletionProtection(IResolvable value)` A value that indicates whether the DB instance has deletion protection enabled.
`void`	`setDomain(String value)` The Active Directory directory ID to create the DB instance in.
`void`	`setDomainIamRoleName(String value)` Specify the name of the IAM role to be used when making API calls to the Directory Service.
`void`	`setEnableCloudwatchLogsExports(List<String> value)` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`void`	`setEnableIamDatabaseAuthentication(Boolean value)` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`void`	`setEnableIamDatabaseAuthentication(IResolvable value)` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`void`	`setEnablePerformanceInsights(Boolean value)` A value that indicates whether to enable Performance Insights for the DB instance.
`void`	`setEnablePerformanceInsights(IResolvable value)` A value that indicates whether to enable Performance Insights for the DB instance.
`void`	`setEngine(String value)` The name of the database engine that you want to use for this DB instance.
`void`	`setEngineVersion(String value)` The version number of the database engine to use.
`void`	`setIops(Number value)` The number of I/O operations per second (IOPS) that the database provisions.
`void`	`setKmsKeyId(String value)` 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` .
`void`	`setLicenseModel(String value)` License model information for this DB instance.
`void`	`setMasterUsername(String value)` The master user name for the DB instance.
`void`	`setMasterUserPassword(String value)` The password for the master user.
`void`	`setMaxAllocatedStorage(Number value)` The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
`void`	`setMonitoringInterval(Number value)` The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
`void`	`setMonitoringRoleArn(String value)` The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
`void`	`setMultiAz(Boolean value)` Specifies whether the database instance is a Multi-AZ DB instance deployment.
`void`	`setMultiAz(IResolvable value)` Specifies whether the database instance is a Multi-AZ DB instance deployment.
`void`	`setOptionGroupName(String value)` Indicates that the DB instance should be associated with the specified option group.
`void`	`setPerformanceInsightsKmsKeyId(String value)` The AWS KMS key identifier for encryption of Performance Insights data.
`void`	`setPerformanceInsightsRetentionPeriod(Number value)` The amount of time, in days, to retain Performance Insights data.
`void`	`setPort(String value)` The port number on which the database accepts connections.
`void`	`setPreferredBackupWindow(String value)` The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.
`void`	`setPreferredMaintenanceWindow(String value)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`void`	`setProcessorFeatures(IResolvable value)` The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
`void`	`setProcessorFeatures(List<Object> value)` The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
`void`	`setPromotionTier(Number value)` A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
`void`	`setPubliclyAccessible(Boolean value)` Indicates whether the DB instance is an internet-facing instance.
`void`	`setPubliclyAccessible(IResolvable value)` Indicates whether the DB instance is an internet-facing instance.
`void`	`setSourceDbInstanceIdentifier(String value)` If you want to create a read replica DB instance, specify the ID of the source DB instance.
`void`	`setSourceRegion(String value)` The ID of the region that contains the source DB instance for the read replica.
`void`	`setStorageEncrypted(Boolean value)` A value that indicates whether the DB instance is encrypted.
`void`	`setStorageEncrypted(IResolvable value)` A value that indicates whether the DB instance is encrypted.
`void`	`setStorageType(String value)` Specifies the storage type to be associated with the DB instance.
`void`	`setTimezone(String value)` The time zone of the DB instance.
`void`	`setUseDefaultProcessorFeatures(Boolean value)` A value that indicates whether the DB instance class of the DB instance uses its default processor features.
`void`	`setUseDefaultProcessorFeatures(IResolvable value)` A value that indicates whether the DB instance class of the DB instance uses its default processor features.
`void`	`setVpcSecurityGroups(List<String> value)` A list of the VPC security group IDs to assign to the DB instance.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDBInstance
```
protected CfnDBInstance(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDBInstance
```
protected CfnDBInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDBInstance
```
@Stability(value=Stable)
public CfnDBInstance(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @Nullable
                                              CfnDBInstanceProps props)
```
    Create a new `AWS::RDS::DBInstance`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnDBInstance
```
@Stability(value=Stable)
public CfnDBInstance(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id)
```
    Create a new `AWS::RDS::DBInstance`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrEndpointAddress
```
@Stability(value=Stable)
 @NotNull
public String getAttrEndpointAddress()
```
    The connection endpoint for the database.
    For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
  - getAttrEndpointHostedZoneId
```
@Stability(value=Stable)
 @NotNull
public String getAttrEndpointHostedZoneId()
```
  - getAttrEndpointPort
```
@Stability(value=Stable)
 @NotNull
public String getAttrEndpointPort()
```
    The port number on which the database accepts connections.
    For example: 3306
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    Tags to assign to the DB instance.
  - getAllocatedStorage
```
@Stability(value=Stable)
 @Nullable
public String getAllocatedStorage()
```
    The amount of storage (in gigabytes) 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.
    MySQL
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
    - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
    - Magnetic storage (standard): Must be an integer from 5 to 3072.
    MariaDB
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
    - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
    - Magnetic storage (standard): Must be an integer from 5 to 3072.
    PostgreSQL
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
    - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
    - Magnetic storage (standard): Must be an integer from 5 to 3072.
    Oracle
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
    - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
    - Magnetic storage (standard): Must be an integer from 10 to 3072.
    SQL Server
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2):
    - Enterprise and Standard editions: Must be an integer from 20 to 16384.
    - Web and Express editions: Must be an integer from 20 to 16384.
    - Provisioned IOPS storage (io1):
    - Enterprise and Standard editions: Must be an integer from 20 to 16384.
    - Web and Express editions: Must be an integer from 20 to 16384.
    - Magnetic storage (standard):
    - Enterprise and Standard editions: Must be an integer from 20 to 1024.
    - Web and Express editions: Must be an integer from 20 to 1024.
  - setAllocatedStorage
```
@Stability(value=Stable)
public void setAllocatedStorage(@Nullable
                                                         String value)
```
    The amount of storage (in gigabytes) 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.
    MySQL
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
    - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
    - Magnetic storage (standard): Must be an integer from 5 to 3072.
    MariaDB
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
    - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
    - Magnetic storage (standard): Must be an integer from 5 to 3072.
    PostgreSQL
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
    - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
    - Magnetic storage (standard): Must be an integer from 5 to 3072.
    Oracle
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
    - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
    - Magnetic storage (standard): Must be an integer from 10 to 3072.
    SQL Server
    Constraints to the amount of storage for each storage type are the following:
    - General Purpose (SSD) storage (gp2):
    - Enterprise and Standard editions: Must be an integer from 20 to 16384.
    - Web and Express editions: Must be an integer from 20 to 16384.
    - Provisioned IOPS storage (io1):
    - Enterprise and Standard editions: Must be an integer from 20 to 16384.
    - Web and Express editions: Must be an integer from 20 to 16384.
    - Magnetic storage (standard):
    - Enterprise and Standard editions: Must be an integer from 20 to 1024.
    - Web and Express editions: Must be an integer from 20 to 1024.
  - getAllowMajorVersionUpgrade
```
@Stability(value=Stable)
 @Nullable
public Object getAllowMajorVersionUpgrade()
```
    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.
  - setAllowMajorVersionUpgrade
```
@Stability(value=Stable)
public void setAllowMajorVersionUpgrade(@Nullable
                                                                 Boolean value)
```
    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.
  - setAllowMajorVersionUpgrade
```
@Stability(value=Stable)
public void setAllowMajorVersionUpgrade(@Nullable
                                                                 IResolvable value)
```
    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.
  - getAssociatedRoles
```
@Stability(value=Stable)
 @Nullable
public Object getAssociatedRoles()
```
    The AWS Identity and Access Management (IAM) roles associated with the DB instance.
    Amazon Aurora
    Not applicable. The associated roles are managed by the DB cluster.
  - setAssociatedRoles
```
@Stability(value=Stable)
public void setAssociatedRoles(@Nullable
                                                        IResolvable value)
```
    The AWS Identity and Access Management (IAM) roles associated with the DB instance.
    Amazon Aurora
    Not applicable. The associated roles are managed by the DB cluster.
  - setAssociatedRoles
```
@Stability(value=Stable)
public void setAssociatedRoles(@Nullable
                                                        List<Object> value)
```
    The AWS Identity and Access Management (IAM) roles associated with the DB instance.
    Amazon Aurora
    Not applicable. The associated roles are managed by the DB cluster.
  - getAutoMinorVersionUpgrade
```
@Stability(value=Stable)
 @Nullable
public Object getAutoMinorVersionUpgrade()
```
    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.
  - setAutoMinorVersionUpgrade
```
@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                Boolean value)
```
    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.
  - setAutoMinorVersionUpgrade
```
@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                IResolvable value)
```
    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.
  - getAvailabilityZone
```
@Stability(value=Stable)
 @Nullable
public String getAvailabilityZone()
```
    The Availability Zone (AZ) where the database will be created.
    For information on AWS Regions and Availability Zones, see Regions and Availability Zones .
    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 .
    Example: us-east-1d
    Constraint: 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.
  - setAvailabilityZone
```
@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
                                                         String value)
```
    The Availability Zone (AZ) where the database will be created.
    For information on AWS Regions and Availability Zones, see Regions and Availability Zones .
    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 .
    Example: us-east-1d
    Constraint: 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.
  - getBackupRetentionPeriod
```
@Stability(value=Stable)
 @Nullable
public Number getBackupRetentionPeriod()
```
    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
  - setBackupRetentionPeriod
```
@Stability(value=Stable)
public void setBackupRetentionPeriod(@Nullable
                                                              Number value)
```
    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
  - getCaCertificateIdentifier
```
@Stability(value=Stable)
 @Nullable
public String getCaCertificateIdentifier()
```
    The identifier of the CA certificate for this DB instance.
    
    Specifying or updating this property triggers a reboot.
    
    For more information about CA certificate identifiers for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide .
    For more information about CA certificate identifiers for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide .
  - setCaCertificateIdentifier
```
@Stability(value=Stable)
public void setCaCertificateIdentifier(@Nullable
                                                                String value)
```
    The identifier of the CA certificate for this DB instance.
    
    Specifying or updating this property triggers a reboot.
    
    For more information about CA certificate identifiers for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide .
    For more information about CA certificate identifiers for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide .
  - getCharacterSetName
```
@Stability(value=Stable)
 @Nullable
public String getCharacterSetName()
```
    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 .
  - setCharacterSetName
```
@Stability(value=Stable)
public void setCharacterSetName(@Nullable
                                                         String value)
```
    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 .
  - getCopyTagsToSnapshot
```
@Stability(value=Stable)
 @Nullable
public Object getCopyTagsToSnapshot()
```
    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
    By default, tags are not copied.
    Amazon Aurora
    Not applicable. 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.
  - setCopyTagsToSnapshot
```
@Stability(value=Stable)
public void setCopyTagsToSnapshot(@Nullable
                                                           Boolean value)
```
    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
    By default, tags are not copied.
    Amazon Aurora
    Not applicable. 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.
  - setCopyTagsToSnapshot
```
@Stability(value=Stable)
public void setCopyTagsToSnapshot(@Nullable
                                                           IResolvable value)
```
    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
    By default, tags are not copied.
    Amazon Aurora
    Not applicable. 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.
  - getDbClusterIdentifier
```
@Stability(value=Stable)
 @Nullable
public String getDbClusterIdentifier()
```
    The identifier of the DB cluster that the instance will belong to.
  - setDbClusterIdentifier
```
@Stability(value=Stable)
public void setDbClusterIdentifier(@Nullable
                                                            String value)
```
    The identifier of the DB cluster that the instance will belong to.
  - getDbInstanceClass
```
@Stability(value=Stable)
 @Nullable
public String getDbInstanceClass()
```
    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 .
  - setDbInstanceClass
```
@Stability(value=Stable)
public void setDbInstanceClass(@Nullable
                                                        String value)
```
    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 .
  - getDbInstanceIdentifier
```
@Stability(value=Stable)
 @Nullable
public String getDbInstanceIdentifier()
```
    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.
  - setDbInstanceIdentifier
```
@Stability(value=Stable)
public void setDbInstanceIdentifier(@Nullable
                                                             String value)
```
    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.
  - getDbName
```
@Stability(value=Stable)
 @Nullable
public String getDbName()
```
    The meaning of this parameter differs according to the database engine you use.
    
    If you specify the [DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier) property, this property only applies to RDS for Oracle.
    
    Amazon Aurora
    Not applicable. The database name is managed by the DB cluster.
    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 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
    PostgreSQL
    The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.
    Constraints:
    - Must contain 1 to 63 letters, numbers, or underscores.
    - Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
    - Can't be a word reserved by the specified database engine
    Oracle
    The Oracle System ID (SID) of the created DB instance. If you specify null , the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName .
    Default: ORCL
    Constraints:
    - Can't be longer than 8 characters
    SQL Server
    Not applicable. Must be null.
  - setDbName
```
@Stability(value=Stable)
public void setDbName(@Nullable
                                               String value)
```
    The meaning of this parameter differs according to the database engine you use.
    
    If you specify the [DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier) property, this property only applies to RDS for Oracle.
    
    Amazon Aurora
    Not applicable. The database name is managed by the DB cluster.
    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 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
    PostgreSQL
    The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.
    Constraints:
    - Must contain 1 to 63 letters, numbers, or underscores.
    - Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
    - Can't be a word reserved by the specified database engine
    Oracle
    The Oracle System ID (SID) of the created DB instance. If you specify null , the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName .
    Default: ORCL
    Constraints:
    - Can't be longer than 8 characters
    SQL Server
    Not applicable. Must be null.
  - getDbParameterGroupName
```
@Stability(value=Stable)
 @Nullable
public String getDbParameterGroupName()
```
    The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
    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 the DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
  - setDbParameterGroupName
```
@Stability(value=Stable)
public void setDbParameterGroupName(@Nullable
                                                             String value)
```
    The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
    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 the DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
  - getDbSecurityGroups
```
@Stability(value=Stable)
 @Nullable
public List<String> getDbSecurityGroups()
```
    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
    
    MasterUsername
    
    MasterUserPassword
    
    MultiAZ
    
    OptionGroupName
    
    PreferredBackupWindow
    
    PreferredMaintenanceWindow
    
    All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType , StorageEncrypted , or KmsKeyId . If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
  - setDbSecurityGroups
```
@Stability(value=Stable)
public void setDbSecurityGroups(@Nullable
                                                         List<String> value)
```
    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
    
    MasterUsername
    
    MasterUserPassword
    
    MultiAZ
    
    OptionGroupName
    
    PreferredBackupWindow
    
    PreferredMaintenanceWindow
    
    All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType , StorageEncrypted , or KmsKeyId . If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
  - getDbSnapshotIdentifier
```
@Stability(value=Stable)
 @Nullable
public String getDbSnapshotIdentifier()
```
    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 Amazon RDS API Reference .
    After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
    If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
    - CharacterSetName
    - DBClusterIdentifier
    - DBName
    - DeleteAutomatedBackups
    - EnablePerformanceInsights
    - KmsKeyId
    - MasterUsername
    - MasterUserPassword
    - PerformanceInsightsKMSKeyId
    - PerformanceInsightsRetentionPeriod
    - PromotionTier
    - SourceDBInstanceIdentifier
    - SourceRegion
    - StorageEncrypted (for an encrypted snapshot)
    - Timezone
    Amazon Aurora
    Not applicable. Snapshot restore is managed by the DB cluster.
  - setDbSnapshotIdentifier
```
@Stability(value=Stable)
public void setDbSnapshotIdentifier(@Nullable
                                                             String value)
```
    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 Amazon RDS API Reference .
    After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
    If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
    - CharacterSetName
    - DBClusterIdentifier
    - DBName
    - DeleteAutomatedBackups
    - EnablePerformanceInsights
    - KmsKeyId
    - MasterUsername
    - MasterUserPassword
    - PerformanceInsightsKMSKeyId
    - PerformanceInsightsRetentionPeriod
    - PromotionTier
    - SourceDBInstanceIdentifier
    - SourceRegion
    - StorageEncrypted (for an encrypted snapshot)
    - Timezone
    Amazon Aurora
    Not applicable. Snapshot restore is managed by the DB cluster.
  - getDbSubnetGroupName
```
@Stability(value=Stable)
 @Nullable
public String getDbSubnetGroupName()
```
    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.
  - setDbSubnetGroupName
```
@Stability(value=Stable)
public void setDbSubnetGroupName(@Nullable
                                                          String value)
```
    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.
  - getDeleteAutomatedBackups
```
@Stability(value=Stable)
 @Nullable
public Object getDeleteAutomatedBackups()
```
    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.
  - setDeleteAutomatedBackups
```
@Stability(value=Stable)
public void setDeleteAutomatedBackups(@Nullable
                                                               Boolean value)
```
    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.
  - setDeleteAutomatedBackups
```
@Stability(value=Stable)
public void setDeleteAutomatedBackups(@Nullable
                                                               IResolvable value)
```
    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.
  - getDeletionProtection
```
@Stability(value=Stable)
 @Nullable
public Object getDeletionProtection()
```
    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.
  - setDeletionProtection
```
@Stability(value=Stable)
public void setDeletionProtection(@Nullable
                                                           Boolean value)
```
    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.
  - setDeletionProtection
```
@Stability(value=Stable)
public void setDeletionProtection(@Nullable
                                                           IResolvable value)
```
    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.
  - getDomain
```
@Stability(value=Stable)
 @Nullable
public String getDomain()
```
    The Active Directory directory ID to create the DB instance in.
    Currently, only 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 .
  - setDomain
```
@Stability(value=Stable)
public void setDomain(@Nullable
                                               String value)
```
    The Active Directory directory ID to create the DB instance in.
    Currently, only 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 .
  - getDomainIamRoleName
```
@Stability(value=Stable)
 @Nullable
public String getDomainIamRoleName()
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    This setting doesn't apply to RDS Custom.
  - setDomainIamRoleName
```
@Stability(value=Stable)
public void setDomainIamRoleName(@Nullable
                                                          String value)
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    This setting doesn't apply to RDS Custom.
  - getEnableCloudwatchLogsExports
```
@Stability(value=Stable)
 @Nullable
public List<String> getEnableCloudwatchLogsExports()
```
    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.
    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
    PostgreSQL
    Valid values: postgresql , upgrade
  - setEnableCloudwatchLogsExports
```
@Stability(value=Stable)
public void setEnableCloudwatchLogsExports(@Nullable
                                                                    List<String> value)
```
    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.
    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
    PostgreSQL
    Valid values: postgresql , upgrade
  - getEnableIamDatabaseAuthentication
```
@Stability(value=Stable)
 @Nullable
public Object getEnableIamDatabaseAuthentication()
```
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
    By default, mapping is disabled.
    For more information, see IAM Database Authentication for 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.
  - setEnableIamDatabaseAuthentication
```
@Stability(value=Stable)
public void setEnableIamDatabaseAuthentication(@Nullable
                                                                        Boolean value)
```
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
    By default, mapping is disabled.
    For more information, see IAM Database Authentication for 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.
  - setEnableIamDatabaseAuthentication
```
@Stability(value=Stable)
public void setEnableIamDatabaseAuthentication(@Nullable
                                                                        IResolvable value)
```
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
    By default, mapping is disabled.
    For more information, see IAM Database Authentication for 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.
  - getEnablePerformanceInsights
```
@Stability(value=Stable)
 @Nullable
public Object getEnablePerformanceInsights()
```
    A value that indicates 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.
  - setEnablePerformanceInsights
```
@Stability(value=Stable)
public void setEnablePerformanceInsights(@Nullable
                                                                  Boolean value)
```
    A value that indicates 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.
  - setEnablePerformanceInsights
```
@Stability(value=Stable)
public void setEnablePerformanceInsights(@Nullable
                                                                  IResolvable value)
```
    A value that indicates 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.
  - getEngine
```
@Stability(value=Stable)
 @Nullable
public String getEngine()
```
    The name of the database engine that you want to use for this DB instance.
    
    When you are creating a DB instance, the Engine property is required.
    
    Valid Values:
    - aurora (for MySQL 5.6-compatible Aurora)
    - aurora-mysql (for MySQL 5.7-compatible Aurora)
    - aurora-postgresql
    - mariadb
    - mysql
    - oracle-ee
    - oracle-se2
    - oracle-se1
    - oracle-se
    - postgres
    - sqlserver-ee
    - sqlserver-se
    - sqlserver-ex
    - sqlserver-web
  - setEngine
```
@Stability(value=Stable)
public void setEngine(@Nullable
                                               String value)
```
    The name of the database engine that you want to use for this DB instance.
    
    When you are creating a DB instance, the Engine property is required.
    
    Valid Values:
    - aurora (for MySQL 5.6-compatible Aurora)
    - aurora-mysql (for MySQL 5.7-compatible Aurora)
    - aurora-postgresql
    - mariadb
    - mysql
    - oracle-ee
    - oracle-se2
    - oracle-se1
    - oracle-se
    - postgres
    - sqlserver-ee
    - sqlserver-se
    - sqlserver-ex
    - sqlserver-web
  - getEngineVersion
```
@Stability(value=Stable)
 @Nullable
public String getEngineVersion()
```
    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.
    MariaDB
    See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
    Microsoft SQL Server
    See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
    MySQL
    See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
    Oracle
    See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
    PostgreSQL
    See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
  - setEngineVersion
```
@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)
```
    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.
    MariaDB
    See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
    Microsoft SQL Server
    See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
    MySQL
    See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
    Oracle
    See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
    PostgreSQL
    See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
  - getIops
```
@Stability(value=Stable)
 @Nullable
public Number getIops()
```
    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.
  - setIops
```
@Stability(value=Stable)
public void setIops(@Nullable
                                             Number value)
```
    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.
  - getKmsKeyId
```
@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()
```
    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 used.
    If you specify DBSecurityGroups , AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide .
    Amazon Aurora
    Not applicable. The KMS key identifier is managed by the DB cluster.
  - setKmsKeyId
```
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)
```
    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 used.
    If you specify DBSecurityGroups , AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide .
    Amazon Aurora
    Not applicable. The KMS key identifier is managed by the DB cluster.
  - getLicenseModel
```
@Stability(value=Stable)
 @Nullable
public String getLicenseModel()
```
    License model information for this DB instance.
    Valid values:
    - Aurora MySQL - general-public-license
    - Aurora PostgreSQL - postgresql-license
    - MariaDB - general-public-license
    - Microsoft SQL Server - license-included
    - MySQL - general-public-license
    - Oracle - bring-your-own-license or license-included
    - 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.
  - setLicenseModel
```
@Stability(value=Stable)
public void setLicenseModel(@Nullable
                                                     String value)
```
    License model information for this DB instance.
    Valid values:
    - Aurora MySQL - general-public-license
    - Aurora PostgreSQL - postgresql-license
    - MariaDB - general-public-license
    - Microsoft SQL Server - license-included
    - MySQL - general-public-license
    - Oracle - bring-your-own-license or license-included
    - 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.
  - getMasterUsername
```
@Stability(value=Stable)
 @Nullable
public String getMasterUsername()
```
    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.
    
    Amazon Aurora
    Not applicable. The name for the master user is managed by the DB cluster.
    MariaDB
    Constraints:
    - Required for MariaDB.
    - Must be 1 to 16 letters or numbers.
    - Can't be a reserved word for the chosen database engine.
    Microsoft SQL Server
    Constraints:
    - Required for SQL Server.
    - Must be 1 to 128 letters or numbers.
    - The first character must be a letter.
    - Can't be a reserved word for the chosen database engine.
    MySQL
    Constraints:
    - Required for MySQL.
    - 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.
    Oracle
    Constraints:
    - Required for Oracle.
    - Must be 1 to 30 letters or numbers.
    - First character must be a letter.
    - Can't be a reserved word for the chosen database engine.
    PostgreSQL
    Constraints:
    - Required for PostgreSQL.
    - Must be 1 to 63 letters or numbers.
    - First character must be a letter.
    - Can't be a reserved word for the chosen database engine.
  - setMasterUsername
```
@Stability(value=Stable)
public void setMasterUsername(@Nullable
                                                       String value)
```
    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.
    
    Amazon Aurora
    Not applicable. The name for the master user is managed by the DB cluster.
    MariaDB
    Constraints:
    - Required for MariaDB.
    - Must be 1 to 16 letters or numbers.
    - Can't be a reserved word for the chosen database engine.
    Microsoft SQL Server
    Constraints:
    - Required for SQL Server.
    - Must be 1 to 128 letters or numbers.
    - The first character must be a letter.
    - Can't be a reserved word for the chosen database engine.
    MySQL
    Constraints:
    - Required for MySQL.
    - 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.
    Oracle
    Constraints:
    - Required for Oracle.
    - Must be 1 to 30 letters or numbers.
    - First character must be a letter.
    - Can't be a reserved word for the chosen database engine.
    PostgreSQL
    Constraints:
    - Required for PostgreSQL.
    - Must be 1 to 63 letters or numbers.
    - First character must be a letter.
    - Can't be a reserved word for the chosen database engine.
  - getMasterUserPassword
```
@Stability(value=Stable)
 @Nullable
public String getMasterUserPassword()
```
    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.
    MariaDB
    Constraints: Must contain from 8 to 41 characters.
    Microsoft SQL Server
    Constraints: Must contain from 8 to 128 characters.
    MySQL
    Constraints: Must contain from 8 to 41 characters.
    Oracle
    Constraints: Must contain from 8 to 30 characters.
    PostgreSQL
    Constraints: Must contain from 8 to 128 characters.
  - setMasterUserPassword
```
@Stability(value=Stable)
public void setMasterUserPassword(@Nullable
                                                           String value)
```
    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.
    MariaDB
    Constraints: Must contain from 8 to 41 characters.
    Microsoft SQL Server
    Constraints: Must contain from 8 to 128 characters.
    MySQL
    Constraints: Must contain from 8 to 41 characters.
    Oracle
    Constraints: Must contain from 8 to 30 characters.
    PostgreSQL
    Constraints: Must contain from 8 to 128 characters.
  - getMaxAllocatedStorage
```
@Stability(value=Stable)
 @Nullable
public Number getMaxAllocatedStorage()
```
    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 RDS Custom.
  - setMaxAllocatedStorage
```
@Stability(value=Stable)
public void setMaxAllocatedStorage(@Nullable
                                                            Number value)
```
    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 RDS Custom.
  - getMonitoringInterval
```
@Stability(value=Stable)
 @Nullable
public Number getMonitoringInterval()
```
    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
  - setMonitoringInterval
```
@Stability(value=Stable)
public void setMonitoringInterval(@Nullable
                                                           Number value)
```
    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
  - getMonitoringRoleArn
```
@Stability(value=Stable)
 @Nullable
public String getMonitoringRoleArn()
```
    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.
  - setMonitoringRoleArn
```
@Stability(value=Stable)
public void setMonitoringRoleArn(@Nullable
                                                          String value)
```
    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.
  - getMultiAz
```
@Stability(value=Stable)
 @Nullable
public Object getMultiAz()
```
    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.
    Currently, you can't use AWS CloudFormation to create a Multi-AZ DB cluster deployment.
    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.
  - setMultiAz
```
@Stability(value=Stable)
public void setMultiAz(@Nullable
                                                Boolean value)
```
    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.
    Currently, you can't use AWS CloudFormation to create a Multi-AZ DB cluster deployment.
    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.
  - setMultiAz
```
@Stability(value=Stable)
public void setMultiAz(@Nullable
                                                IResolvable value)
```
    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.
    Currently, you can't use AWS CloudFormation to create a Multi-AZ DB cluster deployment.
    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.
  - getOptionGroupName
```
@Stability(value=Stable)
 @Nullable
public String getOptionGroupName()
```
    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.
  - setOptionGroupName
```
@Stability(value=Stable)
public void setOptionGroupName(@Nullable
                                                        String value)
```
    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.
  - getPerformanceInsightsKmsKeyId
```
@Stability(value=Stable)
 @Nullable
public String getPerformanceInsightsKmsKeyId()
```
    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 .
  - setPerformanceInsightsKmsKeyId
```
@Stability(value=Stable)
public void setPerformanceInsightsKmsKeyId(@Nullable
                                                                    String value)
```
    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 .
  - getPerformanceInsightsRetentionPeriod
```
@Stability(value=Stable)
 @Nullable
public Number getPerformanceInsightsRetentionPeriod()
```
    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
    For information about enabling Performance Insights, see EnablePerformanceInsights .
  - setPerformanceInsightsRetentionPeriod
```
@Stability(value=Stable)
public void setPerformanceInsightsRetentionPeriod(@Nullable
                                                                           Number value)
```
    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
    For information about enabling Performance Insights, see EnablePerformanceInsights .
  - getPort
```
@Stability(value=Stable)
 @Nullable
public String getPort()
```
    The port number on which the database accepts connections.
    Amazon Aurora
    Not applicable. The port number is managed by the DB cluster.
  - setPort
```
@Stability(value=Stable)
public void setPort(@Nullable
                                             String value)
```
    The port number on which the database accepts connections.
    Amazon Aurora
    Not applicable. The port number is managed by the DB cluster.
  - getPreferredBackupWindow
```
@Stability(value=Stable)
 @Nullable
public String getPreferredBackupWindow()
```
    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.
  - setPreferredBackupWindow
```
@Stability(value=Stable)
public void setPreferredBackupWindow(@Nullable
                                                              String value)
```
    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.
  - getPreferredMaintenanceWindow
```
@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()
```
    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.
  - setPreferredMaintenanceWindow
```
@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)
```
    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.
  - getProcessorFeatures
```
@Stability(value=Stable)
 @Nullable
public Object getProcessorFeatures()
```
    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 RDS Custom.
  - setProcessorFeatures
```
@Stability(value=Stable)
public void setProcessorFeatures(@Nullable
                                                          IResolvable value)
```
    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 RDS Custom.
  - setProcessorFeatures
```
@Stability(value=Stable)
public void setProcessorFeatures(@Nullable
                                                          List<Object> value)
```
    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 RDS Custom.
  - getPromotionTier
```
@Stability(value=Stable)
 @Nullable
public Number getPromotionTier()
```
    A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
    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.
    Default: 1
    Valid Values: 0 - 15
  - setPromotionTier
```
@Stability(value=Stable)
public void setPromotionTier(@Nullable
                                                      Number value)
```
    A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
    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.
    Default: 1
    Valid Values: 0 - 15
  - getPubliclyAccessible
```
@Stability(value=Stable)
 @Nullable
public Object getPubliclyAccessible()
```
    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 CreateDBInstance in the Amazon RDS API Reference .
    If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment. For more information, see DependsOn Attribute .
    
    If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide .
  - setPubliclyAccessible
```
@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           Boolean value)
```
    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 CreateDBInstance in the Amazon RDS API Reference .
    If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment. For more information, see DependsOn Attribute .
    
    If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide .
  - setPubliclyAccessible
```
@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           IResolvable value)
```
    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 CreateDBInstance in the Amazon RDS API Reference .
    If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment. For more information, see DependsOn Attribute .
    
    If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide .
  - getSourceDbInstanceIdentifier
```
@Stability(value=Stable)
 @Nullable
public String getSourceDbInstanceIdentifier()
```
    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 deletes the Read Replica and creates a new DB instance (not a read replica).
    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 property, the read replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
    
    Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
    
    If you specify SourceDBInstanceIdentifier , don't specify the DBSnapshotIdentifier property. You can't create a read replica from a snapshot.
    
    Don't set the BackupRetentionPeriod , DBName , MasterUsername , MasterUserPassword , and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
    
    If the source DB instance is in a different region than the read replica, specify the source region in SourceRegion , and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier . For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide .
    
    For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
  - setSourceDbInstanceIdentifier
```
@Stability(value=Stable)
public void setSourceDbInstanceIdentifier(@Nullable
                                                                   String value)
```
    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 deletes the Read Replica and creates a new DB instance (not a read replica).
    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 property, the read replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
    
    Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
    
    If you specify SourceDBInstanceIdentifier , don't specify the DBSnapshotIdentifier property. You can't create a read replica from a snapshot.
    
    Don't set the BackupRetentionPeriod , DBName , MasterUsername , MasterUserPassword , and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
    
    If the source DB instance is in a different region than the read replica, specify the source region in SourceRegion , and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier . For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide .
    
    For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
  - getSourceRegion
```
@Stability(value=Stable)
 @Nullable
public String getSourceRegion()
```
    The ID of the region that contains the source DB instance for the read replica.
  - setSourceRegion
```
@Stability(value=Stable)
public void setSourceRegion(@Nullable
                                                     String value)
```
    The ID of the region that contains the source DB instance for the read replica.
  - getStorageEncrypted
```
@Stability(value=Stable)
 @Nullable
public Object getStorageEncrypted()
```
    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 SnapshotIdentifier 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 SnapshotIdentifier 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 encryption for DB instances is managed by the DB cluster.
  - setStorageEncrypted
```
@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
                                                         Boolean value)
```
    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 SnapshotIdentifier 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 SnapshotIdentifier 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 encryption for DB instances is managed by the DB cluster.
  - setStorageEncrypted
```
@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
                                                         IResolvable value)
```
    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 SnapshotIdentifier 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 SnapshotIdentifier 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 encryption for DB instances is managed by the DB cluster.
  - getStorageType
```
@Stability(value=Stable)
 @Nullable
public String getStorageType()
```
    Specifies the storage type to be associated with the DB instance.
    Valid values: standard | gp2 | io1
    The standard value is also known as magnetic.
    If you specify io1 , you must also include a value for the Iops parameter.
    Default: io1 if the Iops parameter is specified, otherwise standard
    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).
  - setStorageType
```
@Stability(value=Stable)
public void setStorageType(@Nullable
                                                    String value)
```
    Specifies the storage type to be associated with the DB instance.
    Valid values: standard | gp2 | io1
    The standard value is also known as magnetic.
    If you specify io1 , you must also include a value for the Iops parameter.
    Default: io1 if the Iops parameter is specified, otherwise standard
    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).
  - getTimezone
```
@Stability(value=Stable)
 @Nullable
public String getTimezone()
```
    The time zone of the DB instance.
    The time zone parameter is currently supported only by Microsoft SQL Server .
  - setTimezone
```
@Stability(value=Stable)
public void setTimezone(@Nullable
                                                 String value)
```
    The time zone of the DB instance.
    The time zone parameter is currently supported only by Microsoft SQL Server .
  - getUseDefaultProcessorFeatures
```
@Stability(value=Stable)
 @Nullable
public Object getUseDefaultProcessorFeatures()
```
    A value that indicates whether the DB instance class of the DB instance uses its default processor features.
    This setting doesn't apply to RDS Custom.
  - setUseDefaultProcessorFeatures
```
@Stability(value=Stable)
public void setUseDefaultProcessorFeatures(@Nullable
                                                                    Boolean value)
```
    A value that indicates whether the DB instance class of the DB instance uses its default processor features.
    This setting doesn't apply to RDS Custom.
  - setUseDefaultProcessorFeatures
```
@Stability(value=Stable)
public void setUseDefaultProcessorFeatures(@Nullable
                                                                    IResolvable value)
```
    A value that indicates whether the DB instance class of the DB instance uses its default processor features.
    This setting doesn't apply to RDS Custom.
  - getVpcSecurityGroups
```
@Stability(value=Stable)
 @Nullable
public List<String> getVpcSecurityGroups()
```
    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 instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
    
    To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.
    To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.
    Amazon Aurora
    Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
  - setVpcSecurityGroups
```
@Stability(value=Stable)
public void setVpcSecurityGroups(@Nullable
                                                          List<String> value)
```
    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 instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
    
    To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.
    To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.
    Amazon Aurora
    Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

Class CfnDBInstance

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDBInstance

CfnDBInstance

CfnDBInstance

CfnDBInstance

Method Detail

inspect

renderProperties

getAttrEndpointAddress

getAttrEndpointHostedZoneId

getAttrEndpointPort

getCfnProperties

getTags

getAllocatedStorage

setAllocatedStorage

getAllowMajorVersionUpgrade

setAllowMajorVersionUpgrade

setAllowMajorVersionUpgrade

getAssociatedRoles

setAssociatedRoles

setAssociatedRoles

getAutoMinorVersionUpgrade

setAutoMinorVersionUpgrade

setAutoMinorVersionUpgrade

getAvailabilityZone

setAvailabilityZone

getBackupRetentionPeriod

setBackupRetentionPeriod

getCaCertificateIdentifier

setCaCertificateIdentifier

getCharacterSetName

setCharacterSetName

getCopyTagsToSnapshot

setCopyTagsToSnapshot

setCopyTagsToSnapshot

getDbClusterIdentifier

setDbClusterIdentifier

getDbInstanceClass

setDbInstanceClass

getDbInstanceIdentifier

setDbInstanceIdentifier

getDbName

setDbName

getDbParameterGroupName

setDbParameterGroupName

getDbSecurityGroups

setDbSecurityGroups

getDbSnapshotIdentifier

setDbSnapshotIdentifier

getDbSubnetGroupName

setDbSubnetGroupName

getDeleteAutomatedBackups

setDeleteAutomatedBackups

setDeleteAutomatedBackups

getDeletionProtection

setDeletionProtection

setDeletionProtection

getDomain

setDomain

getDomainIamRoleName

setDomainIamRoleName

getEnableCloudwatchLogsExports

setEnableCloudwatchLogsExports