All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDBInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-11T15:56:04.664Z") @Stability(Stable) public interface CfnDBInstanceProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDBInstance.

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.*;
 CfnDBInstanceProps cfnDBInstanceProps = CfnDBInstanceProps.builder()
         .allocatedStorage("allocatedStorage")
         .allowMajorVersionUpgrade(false)
         .associatedRoles(List.of(DBInstanceRoleProperty.builder()
                 .featureName("featureName")
                 .roleArn("roleArn")
                 .build()))
         .automaticBackupReplicationKmsKeyId("automaticBackupReplicationKmsKeyId")
         .automaticBackupReplicationRegion("automaticBackupReplicationRegion")
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .backupRetentionPeriod(123)
         .caCertificateIdentifier("caCertificateIdentifier")
         .certificateDetails(CertificateDetailsProperty.builder()
                 .caIdentifier("caIdentifier")
                 .validTill("validTill")
                 .build())
         .certificateRotationRestart(false)
         .characterSetName("characterSetName")
         .copyTagsToSnapshot(false)
         .customIamInstanceProfile("customIamInstanceProfile")
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterSnapshotIdentifier("dbClusterSnapshotIdentifier")
         .dbInstanceClass("dbInstanceClass")
         .dbInstanceIdentifier("dbInstanceIdentifier")
         .dbName("dbName")
         .dbParameterGroupName("dbParameterGroupName")
         .dbSecurityGroups(List.of("dbSecurityGroups"))
         .dbSnapshotIdentifier("dbSnapshotIdentifier")
         .dbSubnetGroupName("dbSubnetGroupName")
         .dedicatedLogVolume(false)
         .deleteAutomatedBackups(false)
         .deletionProtection(false)
         .domain("domain")
         .domainAuthSecretArn("domainAuthSecretArn")
         .domainDnsIps(List.of("domainDnsIps"))
         .domainFqdn("domainFqdn")
         .domainIamRoleName("domainIamRoleName")
         .domainOu("domainOu")
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .enableIamDatabaseAuthentication(false)
         .enablePerformanceInsights(false)
         .endpoint(EndpointProperty.builder()
                 .address("address")
                 .hostedZoneId("hostedZoneId")
                 .port("port")
                 .build())
         .engine("engine")
         .engineLifecycleSupport("engineLifecycleSupport")
         .engineVersion("engineVersion")
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .licenseModel("licenseModel")
         .manageMasterUserPassword(false)
         .masterUsername("masterUsername")
         .masterUserPassword("masterUserPassword")
         .masterUserSecret(MasterUserSecretProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .secretArn("secretArn")
                 .build())
         .maxAllocatedStorage(123)
         .monitoringInterval(123)
         .monitoringRoleArn("monitoringRoleArn")
         .multiAz(false)
         .ncharCharacterSetName("ncharCharacterSetName")
         .networkType("networkType")
         .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)
         .replicaMode("replicaMode")
         .restoreTime("restoreTime")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .sourceDbInstanceAutomatedBackupsArn("sourceDbInstanceAutomatedBackupsArn")
         .sourceDbInstanceIdentifier("sourceDbInstanceIdentifier")
         .sourceDbiResourceId("sourceDbiResourceId")
         .sourceRegion("sourceRegion")
         .storageEncrypted(false)
         .storageThroughput(123)
         .storageType("storageType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tdeCredentialArn("tdeCredentialArn")
         .tdeCredentialPassword("tdeCredentialPassword")
         .timezone("timezone")
         .useDefaultProcessorFeatures(false)
         .useLatestRestorableTime(false)
         .vpcSecurityGroups(List.of("vpcSecurityGroups"))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnDBInstanceProps.Builder

A builder for CfnDBInstanceProps

static final class

CfnDBInstanceProps.Jsii$Proxy

An implementation for CfnDBInstanceProps
Method Summary

Modifier and Type

Method

Description

static CfnDBInstanceProps.Builder

builder()

default String

getAllocatedStorage()

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

default Object

getAllowMajorVersionUpgrade()

A value that indicates whether major version upgrades are allowed.

default Object

getAssociatedRoles()

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

default String

getAutomaticBackupReplicationKmsKeyId()

The AWS KMS key identifier for encryption of the replicated automated backups.

default String

getAutomaticBackupReplicationRegion()

The AWS Region associated with the automated backup.

default Object

getAutoMinorVersionUpgrade()

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

default String

getAvailabilityZone()

The Availability Zone (AZ) where the database will be created.

default Number

getBackupRetentionPeriod()

The number of days for which automated backups are retained.

default String

getCaCertificateIdentifier()

The identifier of the CA certificate for this DB instance.

default Object

getCertificateDetails()

The details of the DB instance's server certificate.

default Object

getCertificateRotationRestart()

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

default String

getCharacterSetName()

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

default Object

getCopyTagsToSnapshot()

Specifies whether to copy tags from the DB instance to snapshots of the DB instance.

default String

getCustomIamInstanceProfile()

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

default String

getDbClusterIdentifier()

The identifier of the DB cluster that this DB instance will belong to.

default String

getDbClusterSnapshotIdentifier()

The identifier for the Multi-AZ DB cluster snapshot to restore from.

default String

getDbInstanceClass()

The compute and memory capacity of the DB instance, for example db.m5.large .

default String

getDbInstanceIdentifier()

A name for the DB instance.

default String

getDbName()

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

default String

getDbParameterGroupName()

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

default List<String>

getDbSecurityGroups()

A list of the DB security groups to assign to the DB instance.

default String

getDbSnapshotIdentifier()

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.

default String

getDbSubnetGroupName()

A DB subnet group to associate with the DB instance.

default Object

getDedicatedLogVolume()

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

default Object

getDeleteAutomatedBackups()

A value that indicates whether to remove automated backups immediately after the DB instance is deleted.

default Object

getDeletionProtection()

Specifies whether the DB instance has deletion protection enabled.

default String

getDomain()

The Active Directory directory ID to create the DB instance in.

default String

getDomainAuthSecretArn()

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

default List<String>

getDomainDnsIps()

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

default String

getDomainFqdn()

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

default String

getDomainIamRoleName()

The name of the IAM role to use when making API calls to the Directory Service.

default String

getDomainOu()

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

default List<String>

getEnableCloudwatchLogsExports()

The list of log types that need to be enabled for exporting to CloudWatch Logs.

default Object

getEnableIamDatabaseAuthentication()

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

default Object

getEnablePerformanceInsights()

Specifies whether to enable Performance Insights for the DB instance.

default Object

getEndpoint()

The connection endpoint for the DB instance.

default String

getEngine()

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

default String

getEngineLifecycleSupport()

The life cycle type for this DB instance.

default String

getEngineVersion()

The version number of the database engine to use.

default Number

getIops()

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

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

default String

getLicenseModel()

License model information for this DB instance.

default Object

getManageMasterUserPassword()

Specifies whether to manage the master user password with AWS Secrets Manager.

default String

getMasterUsername()

The master user name for the DB instance.

default String

getMasterUserPassword()

The password for the master user.

default Object

getMasterUserSecret()

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

default Number

getMaxAllocatedStorage()

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

default Number

getMonitoringInterval()

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

default String

getMonitoringRoleArn()

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

default Object

getMultiAz()

Specifies whether the DB instance is a Multi-AZ deployment.

default String

getNcharCharacterSetName()

The name of the NCHAR character set for the Oracle DB instance.

default String

getNetworkType()

The network type of the DB instance.

default String

getOptionGroupName()

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

default String

getPerformanceInsightsKmsKeyId()

The AWS KMS key identifier for encryption of Performance Insights data.

default Number

getPerformanceInsightsRetentionPeriod()

The number of days to retain Performance Insights data.

default String

getPort()

The port number on which the database accepts connections.

default String

getPreferredBackupWindow()

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

default String

getPreferredMaintenanceWindow()

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

default Object

getProcessorFeatures()

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

default Number

getPromotionTier()

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

default Object

getPubliclyAccessible()

Indicates whether the DB instance is an internet-facing instance.

default String

getReplicaMode()

The open mode of an Oracle read replica.

default String

getRestoreTime()

The date and time to restore from.

default String

getSourceDbClusterIdentifier()

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.

default String

getSourceDbInstanceAutomatedBackupsArn()

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .

default String

getSourceDbInstanceIdentifier()

If you want to create a read replica DB instance, specify the ID of the source DB instance.

default String

getSourceDbiResourceId()

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

default String

getSourceRegion()

The ID of the region that contains the source DB instance for the read replica.

default Object

getStorageEncrypted()

A value that indicates whether the DB instance is encrypted.

default Number

getStorageThroughput()

Specifies the storage throughput value for the DB instance.

default String

getStorageType()

The storage type to associate with the DB instance.

default List<CfnTag>

getTags()

Tags to assign to the DB instance.

default String

getTdeCredentialArn()

Deprecated.
this property has been deprecated

default String

getTdeCredentialPassword()

Deprecated.
this property has been deprecated

default String

getTimezone()

The time zone of the DB instance.

default Object

getUseDefaultProcessorFeatures()

Specifies whether the DB instance class of the DB instance uses its default processor features.

default Object

getUseLatestRestorableTime()

Specifies whether the DB instance is restored from the latest backup time.

default List<String>

getVpcSecurityGroups()

A list of the VPC security group IDs to assign to the DB instance.

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

Method Details
- getAllocatedStorage
  
  @Stability(Stable) @Nullable default String getAllocatedStorage()
  The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
  
  If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments).
  
  Amazon Aurora
  Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
  Db2
  Constraints to the amount of storage for each storage type are the following:
  
  General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
  
  Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.
  
  MySQL
  Constraints to the amount of storage for each storage type are the following:
  
  General Purpose (SSD) storage (gp2): Must be an integer 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-allocatedstorage
- getAllowMajorVersionUpgrade
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-allowmajorversionupgrade
- getAssociatedRoles
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-associatedroles
- getAutomaticBackupReplicationKmsKeyId
  
  @Stability(Stable) @Nullable default String getAutomaticBackupReplicationKmsKeyId()
  
  The AWS KMS key identifier for encryption of the replicated automated backups.
  The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region , for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-automaticbackupreplicationkmskeyid
- getAutomaticBackupReplicationRegion
  
  @Stability(Stable) @Nullable default String getAutomaticBackupReplicationRegion()
  
  The AWS Region associated with the automated backup.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-automaticbackupreplicationregion
- getAutoMinorVersionUpgrade
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-autominorversionupgrade
- getAvailabilityZone
  
  @Stability(Stable) @Nullable default 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 .
  For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
  Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .
  Constraints:
  
  The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
  
  The specified Availability Zone must be in the same AWS Region as the current endpoint.
  
  Example: us-east-1d
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-availabilityzone
- getBackupRetentionPeriod
  
  @Stability(Stable) @Nullable default 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
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-backupretentionperiod
- getCaCertificateIdentifier
  
  @Stability(Stable) @Nullable default String getCaCertificateIdentifier()
  
  The identifier of the CA certificate for this DB instance.
  For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-cacertificateidentifier
- getCertificateDetails
  
  @Stability(Stable) @Nullable default Object getCertificateDetails()
  
  The details of the DB instance's server certificate.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-certificatedetails
- getCertificateRotationRestart
  
  @Stability(Stable) @Nullable default Object getCertificateRotationRestart()
  Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
  By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
  
  Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
  
  If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
  
  For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
  
  For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide .
  
  This setting doesn't apply to RDS Custom DB instances.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-certificaterotationrestart
- getCharacterSetName
  
  @Stability(Stable) @Nullable default 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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-charactersetname
- getCopyTagsToSnapshot
  
  @Stability(Stable) @Nullable default Object getCopyTagsToSnapshot()
  
  Specifies whether to copy tags from the DB instance to snapshots of the DB instance.
  By default, tags are not copied.
  This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-copytagstosnapshot
- getCustomIamInstanceProfile
  
  @Stability(Stable) @Nullable default String getCustomIamInstanceProfile()
  The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
  This setting is required for RDS Custom.
  Constraints:
  
  The profile must exist in your account.
  
  The profile must have an IAM role that Amazon EC2 has permissions to assume.
  
  The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom .
  
  For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-customiaminstanceprofile
- getDbClusterIdentifier
  
  @Stability(Stable) @Nullable default String getDbClusterIdentifier()
  
  The identifier of the DB cluster that this DB instance will belong to.
  This setting doesn't apply to RDS Custom DB instances.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclusteridentifier
- getDbClusterSnapshotIdentifier
  
  @Stability(Stable) @Nullable default String getDbClusterSnapshotIdentifier()
  The identifier for the Multi-AZ DB cluster snapshot to restore from.
  For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide .
  Constraints:
  
  Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  
  Can't be specified when DBSnapshotIdentifier is specified.
  
  Must be specified when DBSnapshotIdentifier isn't specified.
  
  If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  
  Can't be the identifier of an Aurora DB cluster snapshot.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclustersnapshotidentifier
- getDbInstanceClass
  
  @Stability(Stable) @Nullable default String getDbInstanceClass()
  
  The compute and memory capacity of the DB instance, for example db.m5.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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbinstanceclass
- getDbInstanceIdentifier
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbinstanceidentifier
- getDbName
  
  @Stability(Stable) @Nullable default 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.
  Db2
  The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
  Constraints:
  
  Must contain 1 to 64 letters or numbers.
  
  Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
  
  Can't be a word reserved by the specified database engine.
  
  MySQL
  The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
  Constraints:
  
  Must contain 1 to 64 letters or numbers.
  
  Can't be a word reserved by the specified database engine
  
  MariaDB
  The name of the database to create when the DB instance is 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 begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
  
  Must contain 1 to 63 characters.
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbname
- getDbParameterGroupName
  
  @Stability(Stable) @Nullable default String getDbParameterGroupName()
  
  The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.
  To list all of the available DB parameter group names, use the following command:
  aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text
  
  If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
  
  If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbparametergroupname
- getDbSecurityGroups
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsecuritygroups
- getDbSnapshotIdentifier
  
  @Stability(Stable) @Nullable default 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
  
  KmsKeyId
  
  MasterUsername
  
  MasterUserPassword
  
  PromotionTier
  
  SourceDBInstanceIdentifier
  
  SourceRegion
  
  StorageEncrypted (for an unencrypted snapshot)
  
  Timezone
  
  Amazon Aurora
  Not applicable. Snapshot restore is managed by the DB cluster.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsnapshotidentifier
- getDbSubnetGroupName
  
  @Stability(Stable) @Nullable default 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 Amazon VPC and Amazon RDS in the Amazon RDS User Guide .
  This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsubnetgroupname
- getDedicatedLogVolume
  
  @Stability(Stable) @Nullable default Object getDedicatedLogVolume()
  
  Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dedicatedlogvolume
- getDeleteAutomatedBackups
  
  @Stability(Stable) @Nullable default 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.
  Amazon Aurora
  Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deleteautomatedbackups
- getDeletionProtection
  
  @Stability(Stable) @Nullable default Object getDeletionProtection()
  
  Specifies whether the DB instance has deletion protection enabled.
  The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance .
  This setting doesn't apply to Amazon Aurora DB instances. 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deletionprotection
- getDomain
  
  @Stability(Stable) @Nullable default String getDomain()
  
  The Active Directory directory ID to create the DB instance in.
  Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
  For more information, see Kerberos Authentication in the Amazon RDS User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domain
- getDomainAuthSecretArn
  
  @Stability(Stable) @Nullable default String getDomainAuthSecretArn()
  
  The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
  Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainauthsecretarn
- getDomainDnsIps
  
  @Stability(Stable) @Nullable default List<String> getDomainDnsIps()
  The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
  Constraints:
  
  Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
  
  Example: 123.124.125.126,234.235.236.237
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domaindnsips
- getDomainFqdn
  
  @Stability(Stable) @Nullable default String getDomainFqdn()
  The fully qualified domain name (FQDN) of an Active Directory domain.
  Constraints:
  
  Can't be longer than 64 characters.
  
  Example: mymanagedADtest.mymanagedAD.mydomain
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainfqdn
- getDomainIamRoleName
  
  @Stability(Stable) @Nullable default String getDomainIamRoleName()
  The name of the IAM role to use when making API calls to the Directory Service.
  This setting doesn't apply to the following DB instances:
  
  Amazon Aurora (The domain is managed by the DB cluster.)
  
  RDS Custom
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainiamrolename
- getDomainOu
  
  @Stability(Stable) @Nullable default String getDomainOu()
  The Active Directory organizational unit for your DB instance to join.
  Constraints:
  
  Must be in the distinguished name format.
  
  Can't be longer than 64 characters.
  
  Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainou
- getEnableCloudwatchLogsExports
  
  @Stability(Stable) @Nullable default 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.
  Db2
  Valid values: diag.log , notify.log
  MariaDB
  Valid values: audit , error , general , slowquery
  Microsoft SQL Server
  Valid values: agent , error
  MySQL
  Valid values: audit , error , general , slowquery
  Oracle
  Valid values: alert , audit , listener , trace , oemagent
  PostgreSQL
  Valid values: postgresql , upgrade
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports
- getEnableIamDatabaseAuthentication
  
  @Stability(Stable) @Nullable default 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.
  This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
  Amazon Aurora
  Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enableiamdatabaseauthentication
- getEnablePerformanceInsights
  
  @Stability(Stable) @Nullable default Object getEnablePerformanceInsights()
  
  Specifies whether to enable Performance Insights for the DB instance.
  For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
  This setting doesn't apply to RDS Custom DB instances.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enableperformanceinsights
- getEndpoint
  
  @Stability(Stable) @Nullable default Object getEndpoint()
  
  The connection endpoint for the DB instance.
  
  The endpoint might not be shown for instances with the status of creating .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-endpoint
- getEngine
  
  @Stability(Stable) @Nullable default String getEngine()
  The name of the database engine to use for this DB instance.
  Not every database engine is available in every AWS Region.
  This property is required when creating a DB instance.
  
  You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb . Converting to the CDB architecture requires an interruption.
  
  Valid Values:
  
  aurora-mysql (for Aurora MySQL DB instances)
  
  aurora-postgresql (for Aurora PostgreSQL DB instances)
  
  custom-oracle-ee (for RDS Custom for Oracle DB instances)
  
  custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
  
  custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
  
  custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
  
  custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
  
  db2-ae
  
  db2-se
  
  mariadb
  
  mysql
  
  oracle-ee
  
  oracle-ee-cdb
  
  oracle-se2
  
  oracle-se2-cdb
  
  postgres
  
  sqlserver-ee
  
  sqlserver-se
  
  sqlserver-ex
  
  sqlserver-web
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-engine
- getEngineLifecycleSupport
  
  @Stability(Stable) @Nullable default String getEngineLifecycleSupport()
  
  The life cycle type for this DB instance.
  
  By default, this value is set to open-source-rds-extended-support , which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled . In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
  
  This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
  You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide .
  Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
  Default: open-source-rds-extended-support
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enginelifecyclesupport
- getEngineVersion
  
  @Stability(Stable) @Nullable default 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.
  Db2
  See Amazon RDS for Db2 in the Amazon RDS User Guide.
  MariaDB
  See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
  Microsoft SQL Server
  See Microsoft SQL Server Versions on Amazon RDS 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-engineversion
- getIops
  
  @Stability(Stable) @Nullable default 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.
  
  Constraints:
  
  For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
  
  For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-iops
- getKmsKeyId
  
  @Stability(Stable) @Nullable default 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 or SourceDbiResourceId 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. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.
  If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified KmsKeyId property is used.
  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 DBSnapshotIdentifier property, don't specify this property. The StorageEncrypted property value is inherited from the snapshot. If the DB instance is encrypted, the specified KmsKeyId property is also inherited from the snapshot.
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-kmskeyid
- getLicenseModel
  
  @Stability(Stable) @Nullable default String getLicenseModel()
  License model information for this DB instance.
  Valid Values:
  
  Aurora MySQL - general-public-license
  
  Aurora PostgreSQL - postgresql-license
  
  RDS for Db2 - bring-your-own-license . For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
  
  RDS for MariaDB - general-public-license
  
  RDS for Microsoft SQL Server - license-included
  
  RDS for MySQL - general-public-license
  
  RDS for Oracle - bring-your-own-license or license-included
  
  RDS for PostgreSQL - postgresql-license
  
  If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-licensemodel
- getManageMasterUserPassword
  
  @Stability(Stable) @Nullable default Object getManageMasterUserPassword()
  Specifies whether to manage the master user password with AWS Secrets Manager.
  For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide.
  Constraints:
  
  Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-managemasteruserpassword
- getMasterUsername
  
  @Stability(Stable) @Nullable default 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.
  When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.
  
  Amazon Aurora
  Not applicable. The name for the master user is managed by the DB cluster.
  RDS for Db2
  Constraints:
  
  Must be 1 to 16 letters or numbers.
  
  First character must be a letter.
  
  Can't be a reserved word for the chosen database engine.
  
  RDS for MariaDB
  Constraints:
  
  Must be 1 to 16 letters or numbers.
  
  Can't be a reserved word for the chosen database engine.
  
  RDS for Microsoft SQL Server
  Constraints:
  
  Must be 1 to 128 letters or numbers.
  
  First character must be a letter.
  
  Can't be a reserved word for the chosen database engine.
  
  RDS for MySQL
  Constraints:
  
  Must be 1 to 16 letters or numbers.
  
  First character must be a letter.
  
  Can't be a reserved word for the chosen database engine.
  
  RDS for Oracle
  Constraints:
  
  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.
  
  RDS for PostgreSQL
  Constraints:
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masterusername
- getMasterUserPassword
  
  @Stability(Stable) @Nullable default 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.
  RDS for Db2
  Must contain from 8 to 255 characters.
  RDS for MariaDB
  Constraints: Must contain from 8 to 41 characters.
  RDS for Microsoft SQL Server
  Constraints: Must contain from 8 to 128 characters.
  RDS for MySQL
  Constraints: Must contain from 8 to 41 characters.
  RDS for Oracle
  Constraints: Must contain from 8 to 30 characters.
  RDS for PostgreSQL
  Constraints: Must contain from 8 to 128 characters.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masteruserpassword
- getMasterUserSecret
  
  @Stability(Stable) @Nullable default Object getMasterUserSecret()
  
  The secret managed by RDS in AWS Secrets Manager for the master user password.
  For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masterusersecret
- getMaxAllocatedStorage
  
  @Stability(Stable) @Nullable default 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 the following DB instances:
  
  Amazon Aurora (Storage is managed by the DB cluster.)
  
  RDS Custom
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-maxallocatedstorage
- getMonitoringInterval
  
  @Stability(Stable) @Nullable default 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 .
  If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0 .
  This setting doesn't apply to RDS Custom DB instances.
  Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
  Default: 0
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-monitoringinterval
- getMonitoringRoleArn
  
  @Stability(Stable) @Nullable default 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 DB instances.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-monitoringrolearn
- getMultiAz
  
  @Stability(Stable) @Nullable default Object getMultiAz()
  Specifies whether the DB instance is a Multi-AZ deployment.
  You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
  This setting doesn't apply to the following DB instances:
  
  Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
  
  RDS Custom
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-multiaz
- getNcharCharacterSetName
  
  @Stability(Stable) @Nullable default String getNcharCharacterSetName()
  
  The name of the NCHAR character set for the Oracle DB instance.
  This setting doesn't apply to RDS Custom DB instances.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-ncharcharactersetname
- getNetworkType
  
  @Stability(Stable) @Nullable default String getNetworkType()
  The network type of the DB instance.
  Valid values:
  
  IPV4
  
  DUAL
  
  The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( DUAL ).
  For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-networktype
- getOptionGroupName
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-optiongroupname
- getPerformanceInsightsKmsKeyId
  
  @Stability(Stable) @Nullable default 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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightskmskeyid
- getPerformanceInsightsRetentionPeriod
  
  @Stability(Stable) @Nullable default Number getPerformanceInsightsRetentionPeriod()
  The number of days to retain Performance Insights data.
  This setting doesn't apply to RDS Custom DB instances.
  Valid Values:
  
  7
  
  month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  
  731
  
  Default: 7 days
  If you specify a retention period that isn't valid, such as 94 , Amazon RDS returns an error.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod
- getPort
  
  @Stability(Stable) @Nullable default String getPort()
  The port number on which the database accepts connections.
  This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
  Valid Values: 1150-65535
  Default:
  
  RDS for Db2 - 50000
  
  RDS for MariaDB - 3306
  
  RDS for Microsoft SQL Server - 1433
  
  RDS for MySQL - 3306
  
  RDS for Oracle - 1521
  
  RDS for PostgreSQL - 5432
  
  Constraints:
  
  For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , 3343 , 3389 , 47001 , or 49152-49156 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-port
- getPreferredBackupWindow
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-preferredbackupwindow
- getPreferredMaintenanceWindow
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-preferredmaintenancewindow
- getProcessorFeatures
  
  @Stability(Stable) @Nullable default 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 Amazon Aurora or RDS Custom DB instances.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-processorfeatures
- getPromotionTier
  
  @Stability(Stable) @Nullable default Number getPromotionTier()
  
  The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
  For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
  This setting doesn't apply to RDS Custom DB instances.
  Default: 1
  Valid Values: 0 - 15
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-promotiontier
- getPubliclyAccessible
  
  @Stability(Stable) @Nullable default 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 the CreateDBInstance in the Amazon RDS API Reference .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-publiclyaccessible
- getReplicaMode
  
  @Stability(Stable) @Nullable default String getReplicaMode()
  
  The open mode of an Oracle read replica.
  For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
  This setting is only supported in RDS for Oracle.
  Default: open-read-only
  Valid Values: open-read-only or mounted
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-replicamode
- getRestoreTime
  
  @Stability(Stable) @Nullable default String getRestoreTime()
  The date and time to restore from.
  This parameter applies to point-in-time recovery. For more information, see Restoring a DB instance to a specified time in the in the Amazon RDS User Guide .
  Constraints:
  
  Must be a time in Universal Coordinated Time (UTC) format.
  
  Must be before the latest restorable time for the DB instance.
  
  Can't be specified if the UseLatestRestorableTime parameter is enabled.
  
  Example: 2009-09-07T23:45:00Z
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-restoretime
- getSourceDbClusterIdentifier
  
  @Stability(Stable) @Nullable default String getSourceDbClusterIdentifier()
  The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.
  Each DB cluster can have up to 15 read replicas.
  Constraints:
  
  Must be the identifier of an existing Multi-AZ DB cluster.
  
  Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
  
  The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
  
  The source DB cluster must be in the same AWS Region as the read replica. Cross-Region replication isn't supported.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbclusteridentifier
- getSourceDbInstanceAutomatedBackupsArn
  
  @Stability(Stable) @Nullable default String getSourceDbInstanceAutomatedBackupsArn()
  
  The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .
  This setting doesn't apply to RDS Custom.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbinstanceautomatedbackupsarn
- getSourceDbInstanceIdentifier
  
  @Stability(Stable) @Nullable default 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 promotes the read replica to a standalone DB instance.
  If you specify the UseLatestRestorableTime or RestoreTime properties in conjunction with the SourceDBInstanceIdentifier property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.
  
  If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier
- getSourceDbiResourceId
  
  @Stability(Stable) @Nullable default String getSourceDbiResourceId()
  
  The resource ID of the source DB instance from which to restore.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbiresourceid
- getSourceRegion
  
  @Stability(Stable) @Nullable default String getSourceRegion()
  
  The ID of the region that contains the source DB instance for the read replica.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourceregion
- getStorageEncrypted
  
  @Stability(Stable) @Nullable default 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 or SourceDbiResourceId 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 SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup.
  If you specify DBSnapshotIdentifier property, don't specify this property. The value is inherited from the snapshot.
  Amazon Aurora
  Not applicable. The encryption for DB instances is managed by the DB cluster.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storageencrypted
- getStorageThroughput
  
  @Stability(Stable) @Nullable default Number getStorageThroughput()
  
  Specifies the storage throughput value for the DB instance. This setting applies only to the gp3 storage type.
  This setting doesn't apply to RDS Custom or Amazon Aurora.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storagethroughput
- getStorageType
  
  @Stability(Stable) @Nullable default String getStorageType()
  
  The storage type to associate with the DB instance.
  If you specify io1 , io2 , or gp3 , you must also include a value for the Iops parameter.
  This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
  Valid Values: gp2 | gp3 | io1 | io2 | standard
  Default: io1 , if the Iops parameter is specified. Otherwise, gp2 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storagetype
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  Tags to assign to the DB instance.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-tags
- getTdeCredentialArn
  
  @Stability(Deprecated) @Deprecated @Nullable default String getTdeCredentialArn()
  
  Deprecated.
  this property has been deprecated
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-tdecredentialarn
- getTdeCredentialPassword
  
  @Stability(Deprecated) @Deprecated @Nullable default String getTdeCredentialPassword()
  
  Deprecated.
  this property has been deprecated
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-tdecredentialpassword
- getTimezone
  
  @Stability(Stable) @Nullable default String getTimezone()
  
  The time zone of the DB instance.
  The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-timezone
- getUseDefaultProcessorFeatures
  
  @Stability(Stable) @Nullable default Object getUseDefaultProcessorFeatures()
  
  Specifies whether the DB instance class of the DB instance uses its default processor features.
  This setting doesn't apply to RDS Custom DB instances.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-usedefaultprocessorfeatures
- getUseLatestRestorableTime
  
  @Stability(Stable) @Nullable default Object getUseLatestRestorableTime()
  Specifies whether the DB instance is restored from the latest backup time.
  By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see Restoring a DB instance to a specified time in the in the Amazon RDS User Guide .
  Constraints:
  
  Can't be specified if the RestoreTime parameter is provided.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-uselatestrestorabletime
- getVpcSecurityGroups
  
  @Stability(Stable) @Nullable default 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-vpcsecuritygroups
- builder
  
  @Stability(Stable) static CfnDBInstanceProps.Builder builder()
  
  Returns:
  
  a CfnDBInstanceProps.Builder of CfnDBInstanceProps

Interface CfnDBInstanceProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAllocatedStorage

getAllowMajorVersionUpgrade

getAssociatedRoles

getAutomaticBackupReplicationKmsKeyId

getAutomaticBackupReplicationRegion

getAutoMinorVersionUpgrade

getAvailabilityZone

getBackupRetentionPeriod

getCaCertificateIdentifier

getCertificateDetails

getCertificateRotationRestart

getCharacterSetName

getCopyTagsToSnapshot

getCustomIamInstanceProfile

getDbClusterIdentifier

getDbClusterSnapshotIdentifier

getDbInstanceClass

getDbInstanceIdentifier

getDbName

getDbParameterGroupName

getDbSecurityGroups

getDbSnapshotIdentifier

getDbSubnetGroupName

getDedicatedLogVolume

getDeleteAutomatedBackups

getDeletionProtection

getDomain

getDomainAuthSecretArn

getDomainDnsIps

getDomainFqdn

getDomainIamRoleName

getDomainOu

getEnableCloudwatchLogsExports

getEnableIamDatabaseAuthentication

getEnablePerformanceInsights

getEndpoint

getEngine

getEngineLifecycleSupport

getEngineVersion

getIops

getKmsKeyId

getLicenseModel

getManageMasterUserPassword

getMasterUsername

getMasterUserPassword

getMasterUserSecret

getMaxAllocatedStorage

getMonitoringInterval

getMonitoringRoleArn

getMultiAz

getNcharCharacterSetName

getNetworkType

getOptionGroupName

getPerformanceInsightsKmsKeyId

getPerformanceInsightsRetentionPeriod

getPort

getPreferredBackupWindow

getPreferredMaintenanceWindow

getProcessorFeatures

getPromotionTier

getPubliclyAccessible

getReplicaMode

getRestoreTime

getSourceDbClusterIdentifier

getSourceDbInstanceAutomatedBackupsArn

getSourceDbInstanceIdentifier

getSourceDbiResourceId

getSourceRegion

getStorageEncrypted

getStorageThroughput

getStorageType

getTags

getTdeCredentialArn

getTdeCredentialPassword

getTimezone