Class CfnDBInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:08.415Z") @Stability(Stable) public class CfnDBInstance extends CfnResource implements IInspectable, ITaggable
The AWS::RDS::DBInstance resource creates an Amazon DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide .

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .

If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.

If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an 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 .

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, 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 can delete the DBSnapshotIdentifier property. 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()))
         .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:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnDBInstance

      protected CfnDBInstance(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnDBInstance

      protected CfnDBInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnDBInstance

      @Stability(Stable) public CfnDBInstance(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDBInstanceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.
    • CfnDBInstance

      @Stability(Stable) public CfnDBInstance(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrCertificateDetailsCaIdentifier

      @Stability(Stable) @NotNull public String getAttrCertificateDetailsCaIdentifier()
      The CA identifier of the CA certificate used for the DB instance's server certificate.
    • getAttrCertificateDetailsValidTill

      @Stability(Stable) @NotNull public String getAttrCertificateDetailsValidTill()
      The expiration date of the DB instance’s server certificate.
    • getAttrDbInstanceArn

      @Stability(Stable) @NotNull public String getAttrDbInstanceArn()
      The Amazon Resource Name (ARN) for the DB instance.
    • getAttrDbiResourceId

      @Stability(Stable) @NotNull public String getAttrDbiResourceId()
      The AWS Region-unique, immutable identifier for the DB instance.

      This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

    • getAttrDbSystemId

      @Stability(Stable) @NotNull public String getAttrDbSystemId()
      The Oracle system ID (Oracle SID) for a container database (CDB).

      The Oracle SID is also the name of the CDB.

      This setting is valid for RDS Custom only.

    • getAttrEndpointAddress

      @Stability(Stable) @NotNull public String getAttrEndpointAddress()
      The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.

      For Aurora Serverless DB clusters, the connection endpoint only applies to the DB cluster.

    • getAttrEndpointHostedZoneId

      @Stability(Stable) @NotNull public String getAttrEndpointHostedZoneId()
      The ID that Amazon Route 53 assigns when you create a hosted zone.
    • getAttrEndpointPort

      @Stability(Stable) @NotNull public String getAttrEndpointPort()
      The port number on which the database accepts connections.

      For example: 3306

    • getAttrMasterUserSecretSecretArn

      @Stability(Stable) @NotNull public String getAttrMasterUserSecretSecretArn()
      The Amazon Resource Name (ARN) of the secret.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable
    • getAllocatedStorage

      @Stability(Stable) @Nullable public String getAllocatedStorage()
      The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
    • setAllocatedStorage

      @Stability(Stable) public void setAllocatedStorage(@Nullable String value)
      The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
    • getAllowMajorVersionUpgrade

      @Stability(Stable) @Nullable public Object getAllowMajorVersionUpgrade()
      A value that indicates whether major version upgrades are allowed.
    • setAllowMajorVersionUpgrade

      @Stability(Stable) public void setAllowMajorVersionUpgrade(@Nullable Boolean value)
      A value that indicates whether major version upgrades are allowed.
    • setAllowMajorVersionUpgrade

      @Stability(Stable) public void setAllowMajorVersionUpgrade(@Nullable IResolvable value)
      A value that indicates whether major version upgrades are allowed.
    • getAssociatedRoles

      @Stability(Stable) @Nullable public Object getAssociatedRoles()
      The AWS Identity and Access Management (IAM) roles associated with the DB instance.
    • setAssociatedRoles

      @Stability(Stable) public void setAssociatedRoles(@Nullable IResolvable value)
      The AWS Identity and Access Management (IAM) roles associated with the DB instance.
    • setAssociatedRoles

      @Stability(Stable) public void setAssociatedRoles(@Nullable List<Object> value)
      The AWS Identity and Access Management (IAM) roles associated with the DB instance.
    • getAutomaticBackupReplicationKmsKeyId

      @Stability(Stable) @Nullable public String getAutomaticBackupReplicationKmsKeyId()
      The AWS KMS key identifier for encryption of the replicated automated backups.
    • setAutomaticBackupReplicationKmsKeyId

      @Stability(Stable) public void setAutomaticBackupReplicationKmsKeyId(@Nullable String value)
      The AWS KMS key identifier for encryption of the replicated automated backups.
    • getAutomaticBackupReplicationRegion

      @Stability(Stable) @Nullable public String getAutomaticBackupReplicationRegion()
      The destination region for the backup replication of the DB instance.
    • setAutomaticBackupReplicationRegion

      @Stability(Stable) public void setAutomaticBackupReplicationRegion(@Nullable String value)
      The destination region for the backup replication of the DB instance.
    • getAutoMinorVersionUpgrade

      @Stability(Stable) @Nullable public Object getAutoMinorVersionUpgrade()
      A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
    • setAutoMinorVersionUpgrade

      @Stability(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.
    • setAutoMinorVersionUpgrade

      @Stability(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.
    • getAvailabilityZone

      @Stability(Stable) @Nullable public String getAvailabilityZone()
      The Availability Zone (AZ) where the database will be created.
    • setAvailabilityZone

      @Stability(Stable) public void setAvailabilityZone(@Nullable String value)
      The Availability Zone (AZ) where the database will be created.
    • getBackupRetentionPeriod

      @Stability(Stable) @Nullable public Number getBackupRetentionPeriod()
      The number of days for which automated backups are retained.
    • setBackupRetentionPeriod

      @Stability(Stable) public void setBackupRetentionPeriod(@Nullable Number value)
      The number of days for which automated backups are retained.
    • getCaCertificateIdentifier

      @Stability(Stable) @Nullable public String getCaCertificateIdentifier()
      The identifier of the CA certificate for this DB instance.
    • setCaCertificateIdentifier

      @Stability(Stable) public void setCaCertificateIdentifier(@Nullable String value)
      The identifier of the CA certificate for this DB instance.
    • getCertificateDetails

      @Stability(Stable) @Nullable public Object getCertificateDetails()
      The details of the DB instance's server certificate.
    • setCertificateDetails

      @Stability(Stable) public void setCertificateDetails(@Nullable IResolvable value)
      The details of the DB instance's server certificate.
    • setCertificateDetails

      @Stability(Stable) public void setCertificateDetails(@Nullable CfnDBInstance.CertificateDetailsProperty value)
      The details of the DB instance's server certificate.
    • getCertificateRotationRestart

      @Stability(Stable) @Nullable public Object getCertificateRotationRestart()
      Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
    • setCertificateRotationRestart

      @Stability(Stable) public void setCertificateRotationRestart(@Nullable Boolean value)
      Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
    • setCertificateRotationRestart

      @Stability(Stable) public void setCertificateRotationRestart(@Nullable IResolvable value)
      Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
    • getCharacterSetName

      @Stability(Stable) @Nullable public String getCharacterSetName()
      For supported engines, indicates that the DB instance should be associated with the specified character set.
    • setCharacterSetName

      @Stability(Stable) public void setCharacterSetName(@Nullable String value)
      For supported engines, indicates that the DB instance should be associated with the specified character set.
    • getCopyTagsToSnapshot

      @Stability(Stable) @Nullable public Object getCopyTagsToSnapshot()
      Specifies whether to copy tags from the DB instance to snapshots of the DB instance.
    • setCopyTagsToSnapshot

      @Stability(Stable) public void setCopyTagsToSnapshot(@Nullable Boolean value)
      Specifies whether to copy tags from the DB instance to snapshots of the DB instance.
    • setCopyTagsToSnapshot

      @Stability(Stable) public void setCopyTagsToSnapshot(@Nullable IResolvable value)
      Specifies whether to copy tags from the DB instance to snapshots of the DB instance.
    • getCustomIamInstanceProfile

      @Stability(Stable) @Nullable public String getCustomIamInstanceProfile()
      The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
    • setCustomIamInstanceProfile

      @Stability(Stable) public void setCustomIamInstanceProfile(@Nullable String value)
      The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
    • getDbClusterIdentifier

      @Stability(Stable) @Nullable public String getDbClusterIdentifier()
      The identifier of the DB cluster that the instance will belong to.
    • setDbClusterIdentifier

      @Stability(Stable) public void setDbClusterIdentifier(@Nullable String value)
      The identifier of the DB cluster that the instance will belong to.
    • getDbClusterSnapshotIdentifier

      @Stability(Stable) @Nullable public String getDbClusterSnapshotIdentifier()
      The identifier for the Multi-AZ DB cluster snapshot to restore from.
    • setDbClusterSnapshotIdentifier

      @Stability(Stable) public void setDbClusterSnapshotIdentifier(@Nullable String value)
      The identifier for the Multi-AZ DB cluster snapshot to restore from.
    • getDbInstanceClass

      @Stability(Stable) @Nullable public 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 .
    • setDbInstanceClass

      @Stability(Stable) public void setDbInstanceClass(@Nullable String value)
      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 .
    • getDbInstanceIdentifier

      @Stability(Stable) @Nullable public String getDbInstanceIdentifier()
      A name for the DB instance.
    • setDbInstanceIdentifier

      @Stability(Stable) public void setDbInstanceIdentifier(@Nullable String value)
      A name for the DB instance.
    • getDbName

      @Stability(Stable) @Nullable public String getDbName()
      The meaning of this parameter differs according to the database engine you use.
    • setDbName

      @Stability(Stable) public void setDbName(@Nullable String value)
      The meaning of this parameter differs according to the database engine you use.
    • getDbParameterGroupName

      @Stability(Stable) @Nullable public String getDbParameterGroupName()
      The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.
    • setDbParameterGroupName

      @Stability(Stable) public void setDbParameterGroupName(@Nullable String value)
      The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.
    • getDbSecurityGroups

      @Stability(Stable) @Nullable public List<String> getDbSecurityGroups()
      A list of the DB security groups to assign to the DB instance.
    • setDbSecurityGroups

      @Stability(Stable) public void setDbSecurityGroups(@Nullable List<String> value)
      A list of the DB security groups to assign to the DB instance.
    • getDbSnapshotIdentifier

      @Stability(Stable) @Nullable public String getDbSnapshotIdentifier()
      The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
    • setDbSnapshotIdentifier

      @Stability(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.
    • getDbSubnetGroupName

      @Stability(Stable) @Nullable public String getDbSubnetGroupName()
      A DB subnet group to associate with the DB instance.
    • setDbSubnetGroupName

      @Stability(Stable) public void setDbSubnetGroupName(@Nullable String value)
      A DB subnet group to associate with the DB instance.
    • getDedicatedLogVolume

      @Stability(Stable) @Nullable public Object getDedicatedLogVolume()
      Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    • setDedicatedLogVolume

      @Stability(Stable) public void setDedicatedLogVolume(@Nullable Boolean value)
      Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    • setDedicatedLogVolume

      @Stability(Stable) public void setDedicatedLogVolume(@Nullable IResolvable value)
      Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
    • getDeleteAutomatedBackups

      @Stability(Stable) @Nullable public Object getDeleteAutomatedBackups()
      A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
    • setDeleteAutomatedBackups

      @Stability(Stable) public void setDeleteAutomatedBackups(@Nullable Boolean value)
      A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
    • setDeleteAutomatedBackups

      @Stability(Stable) public void setDeleteAutomatedBackups(@Nullable IResolvable value)
      A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      A value that indicates whether the DB instance has deletion protection enabled.
    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      A value that indicates whether the DB instance has deletion protection enabled.
    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      A value that indicates whether the DB instance has deletion protection enabled.
    • getDomain

      @Stability(Stable) @Nullable public String getDomain()
      The Active Directory directory ID to create the DB instance in.
    • setDomain

      @Stability(Stable) public void setDomain(@Nullable String value)
      The Active Directory directory ID to create the DB instance in.
    • getDomainAuthSecretArn

      @Stability(Stable) @Nullable public String getDomainAuthSecretArn()
      The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
    • setDomainAuthSecretArn

      @Stability(Stable) public void setDomainAuthSecretArn(@Nullable String value)
      The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
    • getDomainDnsIps

      @Stability(Stable) @Nullable public List<String> getDomainDnsIps()
      The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
    • setDomainDnsIps

      @Stability(Stable) public void setDomainDnsIps(@Nullable List<String> value)
      The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
    • getDomainFqdn

      @Stability(Stable) @Nullable public String getDomainFqdn()
      The fully qualified domain name (FQDN) of an Active Directory domain.
    • setDomainFqdn

      @Stability(Stable) public void setDomainFqdn(@Nullable String value)
      The fully qualified domain name (FQDN) of an Active Directory domain.
    • getDomainIamRoleName

      @Stability(Stable) @Nullable public String getDomainIamRoleName()
      The name of the IAM role to use when making API calls to the Directory Service.
    • setDomainIamRoleName

      @Stability(Stable) public void setDomainIamRoleName(@Nullable String value)
      The name of the IAM role to use when making API calls to the Directory Service.
    • getDomainOu

      @Stability(Stable) @Nullable public String getDomainOu()
      The Active Directory organizational unit for your DB instance to join.
    • setDomainOu

      @Stability(Stable) public void setDomainOu(@Nullable String value)
      The Active Directory organizational unit for your DB instance to join.
    • getEnableCloudwatchLogsExports

      @Stability(Stable) @Nullable public List<String> getEnableCloudwatchLogsExports()
      The list of log types that need to be enabled for exporting to CloudWatch Logs.
    • setEnableCloudwatchLogsExports

      @Stability(Stable) public void setEnableCloudwatchLogsExports(@Nullable List<String> value)
      The list of log types that need to be enabled for exporting to CloudWatch Logs.
    • getEnableIamDatabaseAuthentication

      @Stability(Stable) @Nullable public Object getEnableIamDatabaseAuthentication()
      A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
    • setEnableIamDatabaseAuthentication

      @Stability(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.
    • setEnableIamDatabaseAuthentication

      @Stability(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.
    • getEnablePerformanceInsights

      @Stability(Stable) @Nullable public Object getEnablePerformanceInsights()
      Specifies whether to enable Performance Insights for the DB instance.
    • setEnablePerformanceInsights

      @Stability(Stable) public void setEnablePerformanceInsights(@Nullable Boolean value)
      Specifies whether to enable Performance Insights for the DB instance.
    • setEnablePerformanceInsights

      @Stability(Stable) public void setEnablePerformanceInsights(@Nullable IResolvable value)
      Specifies whether to enable Performance Insights for the DB instance.
    • getEndpoint

      @Stability(Stable) @Nullable public Object getEndpoint()
      The connection endpoint for the DB instance.
    • setEndpoint

      @Stability(Stable) public void setEndpoint(@Nullable IResolvable value)
      The connection endpoint for the DB instance.
    • setEndpoint

      @Stability(Stable) public void setEndpoint(@Nullable CfnDBInstance.EndpointProperty value)
      The connection endpoint for the DB instance.
    • getEngine

      @Stability(Stable) @Nullable public String getEngine()
      The name of the database engine to use for this DB instance.
    • setEngine

      @Stability(Stable) public void setEngine(@Nullable String value)
      The name of the database engine to use for this DB instance.
    • getEngineLifecycleSupport

      @Stability(Stable) @Nullable public String getEngineLifecycleSupport()
      The life cycle type for this DB instance.
    • setEngineLifecycleSupport

      @Stability(Stable) public void setEngineLifecycleSupport(@Nullable String value)
      The life cycle type for this DB instance.
    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The version number of the database engine to use.
    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The version number of the database engine to use.
    • getIops

      @Stability(Stable) @Nullable public Number getIops()
      The number of I/O operations per second (IOPS) that the database provisions.
    • setIops

      @Stability(Stable) public void setIops(@Nullable Number value)
      The number of I/O operations per second (IOPS) that the database provisions.
    • getKmsKeyId

      @Stability(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 .
    • setKmsKeyId

      @Stability(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 .
    • getLicenseModel

      @Stability(Stable) @Nullable public String getLicenseModel()
      License model information for this DB instance.
    • setLicenseModel

      @Stability(Stable) public void setLicenseModel(@Nullable String value)
      License model information for this DB instance.
    • getManageMasterUserPassword

      @Stability(Stable) @Nullable public Object getManageMasterUserPassword()
      Specifies whether to manage the master user password with AWS Secrets Manager.
    • setManageMasterUserPassword

      @Stability(Stable) public void setManageMasterUserPassword(@Nullable Boolean value)
      Specifies whether to manage the master user password with AWS Secrets Manager.
    • setManageMasterUserPassword

      @Stability(Stable) public void setManageMasterUserPassword(@Nullable IResolvable value)
      Specifies whether to manage the master user password with AWS Secrets Manager.
    • getMasterUsername

      @Stability(Stable) @Nullable public String getMasterUsername()
      The master user name for the DB instance.
    • setMasterUsername

      @Stability(Stable) public void setMasterUsername(@Nullable String value)
      The master user name for the DB instance.
    • getMasterUserPassword

      @Stability(Stable) @Nullable public String getMasterUserPassword()
      The password for the master user.

      The password can include any printable ASCII character except "/", """, or "@".

    • setMasterUserPassword

      @Stability(Stable) public void setMasterUserPassword(@Nullable String value)
      The password for the master user.

      The password can include any printable ASCII character except "/", """, or "@".

    • getMasterUserSecret

      @Stability(Stable) @Nullable public Object getMasterUserSecret()
      The secret managed by RDS in AWS Secrets Manager for the master user password.
    • setMasterUserSecret

      @Stability(Stable) public void setMasterUserSecret(@Nullable IResolvable value)
      The secret managed by RDS in AWS Secrets Manager for the master user password.
    • setMasterUserSecret

      @Stability(Stable) public void setMasterUserSecret(@Nullable CfnDBInstance.MasterUserSecretProperty value)
      The secret managed by RDS in AWS Secrets Manager for the master user password.
    • getMaxAllocatedStorage

      @Stability(Stable) @Nullable public Number getMaxAllocatedStorage()
      The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
    • setMaxAllocatedStorage

      @Stability(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.
    • getMonitoringInterval

      @Stability(Stable) @Nullable public Number getMonitoringInterval()
      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
    • setMonitoringInterval

      @Stability(Stable) public void setMonitoringInterval(@Nullable Number value)
      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
    • getMonitoringRoleArn

      @Stability(Stable) @Nullable public String getMonitoringRoleArn()
      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
    • setMonitoringRoleArn

      @Stability(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.
    • getMultiAz

      @Stability(Stable) @Nullable public Object getMultiAz()
      Specifies whether the database instance is a Multi-AZ DB instance deployment.
    • setMultiAz

      @Stability(Stable) public void setMultiAz(@Nullable Boolean value)
      Specifies whether the database instance is a Multi-AZ DB instance deployment.
    • setMultiAz

      @Stability(Stable) public void setMultiAz(@Nullable IResolvable value)
      Specifies whether the database instance is a Multi-AZ DB instance deployment.
    • getNcharCharacterSetName

      @Stability(Stable) @Nullable public String getNcharCharacterSetName()
      The name of the NCHAR character set for the Oracle DB instance.
    • setNcharCharacterSetName

      @Stability(Stable) public void setNcharCharacterSetName(@Nullable String value)
      The name of the NCHAR character set for the Oracle DB instance.
    • getNetworkType

      @Stability(Stable) @Nullable public String getNetworkType()
      The network type of the DB instance.
    • setNetworkType

      @Stability(Stable) public void setNetworkType(@Nullable String value)
      The network type of the DB instance.
    • getOptionGroupName

      @Stability(Stable) @Nullable public String getOptionGroupName()
      Indicates that the DB instance should be associated with the specified option group.
    • setOptionGroupName

      @Stability(Stable) public void setOptionGroupName(@Nullable String value)
      Indicates that the DB instance should be associated with the specified option group.
    • getPerformanceInsightsKmsKeyId

      @Stability(Stable) @Nullable public String getPerformanceInsightsKmsKeyId()
      The AWS KMS key identifier for encryption of Performance Insights data.
    • setPerformanceInsightsKmsKeyId

      @Stability(Stable) public void setPerformanceInsightsKmsKeyId(@Nullable String value)
      The AWS KMS key identifier for encryption of Performance Insights data.
    • getPerformanceInsightsRetentionPeriod

      @Stability(Stable) @Nullable public Number getPerformanceInsightsRetentionPeriod()
      The number of days to retain Performance Insights data.
    • setPerformanceInsightsRetentionPeriod

      @Stability(Stable) public void setPerformanceInsightsRetentionPeriod(@Nullable Number value)
      The number of days to retain Performance Insights data.
    • getPort

      @Stability(Stable) @Nullable public String getPort()
      The port number on which the database accepts connections.
    • setPort

      @Stability(Stable) public void setPort(@Nullable String value)
      The port number on which the database accepts connections.
    • getPreferredBackupWindow

      @Stability(Stable) @Nullable public String getPreferredBackupWindow()
      The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
    • setPreferredBackupWindow

      @Stability(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.
    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable public String getPreferredMaintenanceWindow()
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    • getProcessorFeatures

      @Stability(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.
    • setProcessorFeatures

      @Stability(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.
    • setProcessorFeatures

      @Stability(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.
    • getPromotionTier

      @Stability(Stable) @Nullable public 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.
    • setPromotionTier

      @Stability(Stable) public void setPromotionTier(@Nullable Number value)
      The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
    • getPubliclyAccessible

      @Stability(Stable) @Nullable public Object getPubliclyAccessible()
      Indicates whether the DB instance is an internet-facing instance.
    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable Boolean value)
      Indicates whether the DB instance is an internet-facing instance.
    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable IResolvable value)
      Indicates whether the DB instance is an internet-facing instance.
    • getReplicaMode

      @Stability(Stable) @Nullable public String getReplicaMode()
      The open mode of an Oracle read replica.
    • setReplicaMode

      @Stability(Stable) public void setReplicaMode(@Nullable String value)
      The open mode of an Oracle read replica.
    • getRestoreTime

      @Stability(Stable) @Nullable public String getRestoreTime()
      The date and time to restore from.
    • setRestoreTime

      @Stability(Stable) public void setRestoreTime(@Nullable String value)
      The date and time to restore from.
    • getSourceDbClusterIdentifier

      @Stability(Stable) @Nullable public String getSourceDbClusterIdentifier()
      The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.
    • setSourceDbClusterIdentifier

      @Stability(Stable) public void setSourceDbClusterIdentifier(@Nullable String value)
      The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.
    • getSourceDbInstanceAutomatedBackupsArn

      @Stability(Stable) @Nullable public 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 .
    • setSourceDbInstanceAutomatedBackupsArn

      @Stability(Stable) public void setSourceDbInstanceAutomatedBackupsArn(@Nullable String value)
      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 .
    • getSourceDbInstanceIdentifier

      @Stability(Stable) @Nullable public String getSourceDbInstanceIdentifier()
      If you want to create a read replica DB instance, specify the ID of the source DB instance.
    • setSourceDbInstanceIdentifier

      @Stability(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.
    • getSourceDbiResourceId

      @Stability(Stable) @Nullable public String getSourceDbiResourceId()
      The resource ID of the source DB instance from which to restore.
    • setSourceDbiResourceId

      @Stability(Stable) public void setSourceDbiResourceId(@Nullable String value)
      The resource ID of the source DB instance from which to restore.
    • getSourceRegion

      @Stability(Stable) @Nullable public String getSourceRegion()
      The ID of the region that contains the source DB instance for the read replica.
    • setSourceRegion

      @Stability(Stable) public void setSourceRegion(@Nullable String value)
      The ID of the region that contains the source DB instance for the read replica.
    • getStorageEncrypted

      @Stability(Stable) @Nullable public Object getStorageEncrypted()
      A value that indicates whether the DB instance is encrypted.

      By default, it isn't encrypted.

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable Boolean value)
      A value that indicates whether the DB instance is encrypted.

      By default, it isn't encrypted.

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable IResolvable value)
      A value that indicates whether the DB instance is encrypted.

      By default, it isn't encrypted.

    • getStorageThroughput

      @Stability(Stable) @Nullable public Number getStorageThroughput()
      Specifies the storage throughput value for the DB instance.

      This setting applies only to the gp3 storage type.

    • setStorageThroughput

      @Stability(Stable) public void setStorageThroughput(@Nullable Number value)
      Specifies the storage throughput value for the DB instance.

      This setting applies only to the gp3 storage type.

    • getStorageType

      @Stability(Stable) @Nullable public String getStorageType()
      The storage type to associate with the DB instance.
    • setStorageType

      @Stability(Stable) public void setStorageType(@Nullable String value)
      The storage type to associate with the DB instance.
    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An optional array of key-value pairs to apply to this DB instance.
    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An optional array of key-value pairs to apply to this DB instance.
    • getTdeCredentialArn

      @Stability(Deprecated) @Deprecated @Nullable public String getTdeCredentialArn()
      Deprecated.
      this property has been deprecated
    • setTdeCredentialArn

      @Stability(Deprecated) @Deprecated public void setTdeCredentialArn(@Nullable String value)
      Deprecated.
      this property has been deprecated
    • getTdeCredentialPassword

      @Stability(Deprecated) @Deprecated @Nullable public String getTdeCredentialPassword()
      Deprecated.
      this property has been deprecated
    • setTdeCredentialPassword

      @Stability(Deprecated) @Deprecated public void setTdeCredentialPassword(@Nullable String value)
      Deprecated.
      this property has been deprecated
    • getTimezone

      @Stability(Stable) @Nullable public String getTimezone()
      The time zone of the DB instance.
    • setTimezone

      @Stability(Stable) public void setTimezone(@Nullable String value)
      The time zone of the DB instance.
    • getUseDefaultProcessorFeatures

      @Stability(Stable) @Nullable public Object getUseDefaultProcessorFeatures()
      Specifies whether the DB instance class of the DB instance uses its default processor features.
    • setUseDefaultProcessorFeatures

      @Stability(Stable) public void setUseDefaultProcessorFeatures(@Nullable Boolean value)
      Specifies whether the DB instance class of the DB instance uses its default processor features.
    • setUseDefaultProcessorFeatures

      @Stability(Stable) public void setUseDefaultProcessorFeatures(@Nullable IResolvable value)
      Specifies whether the DB instance class of the DB instance uses its default processor features.
    • getUseLatestRestorableTime

      @Stability(Stable) @Nullable public Object getUseLatestRestorableTime()
      Specifies whether the DB instance is restored from the latest backup time.
    • setUseLatestRestorableTime

      @Stability(Stable) public void setUseLatestRestorableTime(@Nullable Boolean value)
      Specifies whether the DB instance is restored from the latest backup time.
    • setUseLatestRestorableTime

      @Stability(Stable) public void setUseLatestRestorableTime(@Nullable IResolvable value)
      Specifies whether the DB instance is restored from the latest backup time.
    • getVpcSecurityGroups

      @Stability(Stable) @Nullable public List<String> getVpcSecurityGroups()
      A list of the VPC security group IDs to assign to the DB instance.
    • setVpcSecurityGroups

      @Stability(Stable) public void setVpcSecurityGroups(@Nullable List<String> value)
      A list of the VPC security group IDs to assign to the DB instance.