software.amazon.awscdk.services.rds

Interface CfnDBInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.821Z")
 @Stability(value=Stable)
public interface CfnDBInstanceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::RDS::DBInstance`.

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()
         .dbInstanceClass("dbInstanceClass")
         // the properties below are optional
         .allocatedStorage("allocatedStorage")
         .allowMajorVersionUpgrade(false)
         .associatedRoles(List.of(DBInstanceRoleProperty.builder()
                 .featureName("featureName")
                 .roleArn("roleArn")
                 .build()))
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .backupRetentionPeriod(123)
         .caCertificateIdentifier("caCertificateIdentifier")
         .characterSetName("characterSetName")
         .copyTagsToSnapshot(false)
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbInstanceIdentifier("dbInstanceIdentifier")
         .dbName("dbName")
         .dbParameterGroupName("dbParameterGroupName")
         .dbSecurityGroups(List.of("dbSecurityGroups"))
         .dbSnapshotIdentifier("dbSnapshotIdentifier")
         .dbSubnetGroupName("dbSubnetGroupName")
         .deleteAutomatedBackups(false)
         .deletionProtection(false)
         .domain("domain")
         .domainIamRoleName("domainIamRoleName")
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .enableIamDatabaseAuthentication(false)
         .enablePerformanceInsights(false)
         .engine("engine")
         .engineVersion("engineVersion")
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .licenseModel("licenseModel")
         .masterUsername("masterUsername")
         .masterUserPassword("masterUserPassword")
         .maxAllocatedStorage(123)
         .monitoringInterval(123)
         .monitoringRoleArn("monitoringRoleArn")
         .multiAz(false)
         .optionGroupName("optionGroupName")
         .performanceInsightsKmsKeyId("performanceInsightsKmsKeyId")
         .performanceInsightsRetentionPeriod(123)
         .port("port")
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .processorFeatures(List.of(ProcessorFeatureProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .promotionTier(123)
         .publiclyAccessible(false)
         .sourceDbInstanceIdentifier("sourceDbInstanceIdentifier")
         .sourceRegion("sourceRegion")
         .storageEncrypted(false)
         .storageType("storageType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timezone("timezone")
         .useDefaultProcessorFeatures(false)
         .vpcSecurityGroups(List.of("vpcSecurityGroups"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDBInstanceProps.Builder A builder for CfnDBInstanceProps
static class	CfnDBInstanceProps.Jsii$Proxy An implementation for CfnDBInstanceProps

Method Summary

Modifier and Type	Method and Description
static CfnDBInstanceProps.Builder	builder()
default String	getAllocatedStorage() `AWS::RDS::DBInstance.AllocatedStorage`.
default Object	getAllowMajorVersionUpgrade() `AWS::RDS::DBInstance.AllowMajorVersionUpgrade`.
default Object	getAssociatedRoles() `AWS::RDS::DBInstance.AssociatedRoles`.
default Object	getAutoMinorVersionUpgrade() `AWS::RDS::DBInstance.AutoMinorVersionUpgrade`.
default String	getAvailabilityZone() `AWS::RDS::DBInstance.AvailabilityZone`.
default Number	getBackupRetentionPeriod() `AWS::RDS::DBInstance.BackupRetentionPeriod`.
default String	getCaCertificateIdentifier() `AWS::RDS::DBInstance.CACertificateIdentifier`.
default String	getCharacterSetName() `AWS::RDS::DBInstance.CharacterSetName`.
default Object	getCopyTagsToSnapshot() `AWS::RDS::DBInstance.CopyTagsToSnapshot`.
default String	getDbClusterIdentifier() `AWS::RDS::DBInstance.DBClusterIdentifier`.
String	getDbInstanceClass() `AWS::RDS::DBInstance.DBInstanceClass`.
default String	getDbInstanceIdentifier() `AWS::RDS::DBInstance.DBInstanceIdentifier`.
default String	getDbName() `AWS::RDS::DBInstance.DBName`.
default String	getDbParameterGroupName() `AWS::RDS::DBInstance.DBParameterGroupName`.
default List<String>	getDbSecurityGroups() `AWS::RDS::DBInstance.DBSecurityGroups`.
default String	getDbSnapshotIdentifier() `AWS::RDS::DBInstance.DBSnapshotIdentifier`.
default String	getDbSubnetGroupName() `AWS::RDS::DBInstance.DBSubnetGroupName`.
default Object	getDeleteAutomatedBackups() `AWS::RDS::DBInstance.DeleteAutomatedBackups`.
default Object	getDeletionProtection() `AWS::RDS::DBInstance.DeletionProtection`.
default String	getDomain() `AWS::RDS::DBInstance.Domain`.
default String	getDomainIamRoleName() `AWS::RDS::DBInstance.DomainIAMRoleName`.
default List<String>	getEnableCloudwatchLogsExports() `AWS::RDS::DBInstance.EnableCloudwatchLogsExports`.
default Object	getEnableIamDatabaseAuthentication() `AWS::RDS::DBInstance.EnableIAMDatabaseAuthentication`.
default Object	getEnablePerformanceInsights() `AWS::RDS::DBInstance.EnablePerformanceInsights`.
default String	getEngine() `AWS::RDS::DBInstance.Engine`.
default String	getEngineVersion() `AWS::RDS::DBInstance.EngineVersion`.
default Number	getIops() `AWS::RDS::DBInstance.Iops`.
default String	getKmsKeyId() `AWS::RDS::DBInstance.KmsKeyId`.
default String	getLicenseModel() `AWS::RDS::DBInstance.LicenseModel`.
default String	getMasterUsername() `AWS::RDS::DBInstance.MasterUsername`.
default String	getMasterUserPassword() `AWS::RDS::DBInstance.MasterUserPassword`.
default Number	getMaxAllocatedStorage() `AWS::RDS::DBInstance.MaxAllocatedStorage`.
default Number	getMonitoringInterval() `AWS::RDS::DBInstance.MonitoringInterval`.
default String	getMonitoringRoleArn() `AWS::RDS::DBInstance.MonitoringRoleArn`.
default Object	getMultiAz() `AWS::RDS::DBInstance.MultiAZ`.
default String	getOptionGroupName() `AWS::RDS::DBInstance.OptionGroupName`.
default String	getPerformanceInsightsKmsKeyId() `AWS::RDS::DBInstance.PerformanceInsightsKMSKeyId`.
default Number	getPerformanceInsightsRetentionPeriod() `AWS::RDS::DBInstance.PerformanceInsightsRetentionPeriod`.
default String	getPort() `AWS::RDS::DBInstance.Port`.
default String	getPreferredBackupWindow() `AWS::RDS::DBInstance.PreferredBackupWindow`.
default String	getPreferredMaintenanceWindow() `AWS::RDS::DBInstance.PreferredMaintenanceWindow`.
default Object	getProcessorFeatures() `AWS::RDS::DBInstance.ProcessorFeatures`.
default Number	getPromotionTier() `AWS::RDS::DBInstance.PromotionTier`.
default Object	getPubliclyAccessible() `AWS::RDS::DBInstance.PubliclyAccessible`.
default String	getSourceDbInstanceIdentifier() `AWS::RDS::DBInstance.SourceDBInstanceIdentifier`.
default String	getSourceRegion() `AWS::RDS::DBInstance.SourceRegion`.
default Object	getStorageEncrypted() `AWS::RDS::DBInstance.StorageEncrypted`.
default String	getStorageType() `AWS::RDS::DBInstance.StorageType`.
default List<CfnTag>	getTags() `AWS::RDS::DBInstance.Tags`.
default String	getTimezone() `AWS::RDS::DBInstance.Timezone`.
default Object	getUseDefaultProcessorFeatures() `AWS::RDS::DBInstance.UseDefaultProcessorFeatures`.
default List<String>	getVpcSecurityGroups() `AWS::RDS::DBInstance.VPCSecurityGroups`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllocatedStorage

@Stability(value=Stable)
 @Nullable
default String getAllocatedStorage()

`AWS::RDS::DBInstance.AllocatedStorage`.

getAllowMajorVersionUpgrade

@Stability(value=Stable)
 @Nullable
default Object getAllowMajorVersionUpgrade()

`AWS::RDS::DBInstance.AllowMajorVersionUpgrade`.

getAssociatedRoles

@Stability(value=Stable)
 @Nullable
default Object getAssociatedRoles()

`AWS::RDS::DBInstance.AssociatedRoles`.

getAutoMinorVersionUpgrade

@Stability(value=Stable)
 @Nullable
default Object getAutoMinorVersionUpgrade()

`AWS::RDS::DBInstance.AutoMinorVersionUpgrade`.

getAvailabilityZone

@Stability(value=Stable)
 @Nullable
default String getAvailabilityZone()

`AWS::RDS::DBInstance.AvailabilityZone`.

getBackupRetentionPeriod

@Stability(value=Stable)
 @Nullable
default Number getBackupRetentionPeriod()

`AWS::RDS::DBInstance.BackupRetentionPeriod`.

getCaCertificateIdentifier

@Stability(value=Stable)
 @Nullable
default String getCaCertificateIdentifier()

`AWS::RDS::DBInstance.CACertificateIdentifier`.

getCharacterSetName

@Stability(value=Stable)
 @Nullable
default String getCharacterSetName()

`AWS::RDS::DBInstance.CharacterSetName`.

getCopyTagsToSnapshot

@Stability(value=Stable)
 @Nullable
default Object getCopyTagsToSnapshot()

`AWS::RDS::DBInstance.CopyTagsToSnapshot`.

getDbClusterIdentifier

@Stability(value=Stable)
 @Nullable
default String getDbClusterIdentifier()

`AWS::RDS::DBInstance.DBClusterIdentifier`.

getDbInstanceClass

@Stability(value=Stable)
 @NotNull
String getDbInstanceClass()

`AWS::RDS::DBInstance.DBInstanceClass`.

getDbInstanceIdentifier

@Stability(value=Stable)
 @Nullable
default String getDbInstanceIdentifier()

`AWS::RDS::DBInstance.DBInstanceIdentifier`.

getDbName

@Stability(value=Stable)
 @Nullable
default String getDbName()

`AWS::RDS::DBInstance.DBName`.

getDbParameterGroupName

@Stability(value=Stable)
 @Nullable
default String getDbParameterGroupName()

`AWS::RDS::DBInstance.DBParameterGroupName`.

getDbSecurityGroups

@Stability(value=Stable)
 @Nullable
default List<String> getDbSecurityGroups()

`AWS::RDS::DBInstance.DBSecurityGroups`.

getDbSnapshotIdentifier

@Stability(value=Stable)
 @Nullable
default String getDbSnapshotIdentifier()

`AWS::RDS::DBInstance.DBSnapshotIdentifier`.

getDbSubnetGroupName

@Stability(value=Stable)
 @Nullable
default String getDbSubnetGroupName()

`AWS::RDS::DBInstance.DBSubnetGroupName`.

getDeleteAutomatedBackups

@Stability(value=Stable)
 @Nullable
default Object getDeleteAutomatedBackups()

`AWS::RDS::DBInstance.DeleteAutomatedBackups`.

getDeletionProtection

@Stability(value=Stable)
 @Nullable
default Object getDeletionProtection()

`AWS::RDS::DBInstance.DeletionProtection`.

getDomain

@Stability(value=Stable)
 @Nullable
default String getDomain()

`AWS::RDS::DBInstance.Domain`.

getDomainIamRoleName

@Stability(value=Stable)
 @Nullable
default String getDomainIamRoleName()

`AWS::RDS::DBInstance.DomainIAMRoleName`.

getEnableCloudwatchLogsExports

@Stability(value=Stable)
 @Nullable
default List<String> getEnableCloudwatchLogsExports()

`AWS::RDS::DBInstance.EnableCloudwatchLogsExports`.

getEnableIamDatabaseAuthentication

@Stability(value=Stable)
 @Nullable
default Object getEnableIamDatabaseAuthentication()

`AWS::RDS::DBInstance.EnableIAMDatabaseAuthentication`.

getEnablePerformanceInsights

@Stability(value=Stable)
 @Nullable
default Object getEnablePerformanceInsights()

`AWS::RDS::DBInstance.EnablePerformanceInsights`.

getEngine

@Stability(value=Stable)
 @Nullable
default String getEngine()

`AWS::RDS::DBInstance.Engine`.

getEngineVersion

@Stability(value=Stable)
 @Nullable
default String getEngineVersion()

`AWS::RDS::DBInstance.EngineVersion`.

getIops

@Stability(value=Stable)
 @Nullable
default Number getIops()

`AWS::RDS::DBInstance.Iops`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

`AWS::RDS::DBInstance.KmsKeyId`.

getLicenseModel

@Stability(value=Stable)
 @Nullable
default String getLicenseModel()

`AWS::RDS::DBInstance.LicenseModel`.

getMasterUsername

@Stability(value=Stable)
 @Nullable
default String getMasterUsername()

`AWS::RDS::DBInstance.MasterUsername`.

getMasterUserPassword

@Stability(value=Stable)
 @Nullable
default String getMasterUserPassword()

`AWS::RDS::DBInstance.MasterUserPassword`.

getMaxAllocatedStorage

@Stability(value=Stable)
 @Nullable
default Number getMaxAllocatedStorage()

`AWS::RDS::DBInstance.MaxAllocatedStorage`.

getMonitoringInterval

@Stability(value=Stable)
 @Nullable
default Number getMonitoringInterval()

`AWS::RDS::DBInstance.MonitoringInterval`.

getMonitoringRoleArn

@Stability(value=Stable)
 @Nullable
default String getMonitoringRoleArn()

`AWS::RDS::DBInstance.MonitoringRoleArn`.

getMultiAz

@Stability(value=Stable)
 @Nullable
default Object getMultiAz()

`AWS::RDS::DBInstance.MultiAZ`.

getOptionGroupName

@Stability(value=Stable)
 @Nullable
default String getOptionGroupName()

`AWS::RDS::DBInstance.OptionGroupName`.

getPerformanceInsightsKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getPerformanceInsightsKmsKeyId()

`AWS::RDS::DBInstance.PerformanceInsightsKMSKeyId`.

getPerformanceInsightsRetentionPeriod

@Stability(value=Stable)
 @Nullable
default Number getPerformanceInsightsRetentionPeriod()

`AWS::RDS::DBInstance.PerformanceInsightsRetentionPeriod`.

getPort

@Stability(value=Stable)
 @Nullable
default String getPort()

`AWS::RDS::DBInstance.Port`.

getPreferredBackupWindow

@Stability(value=Stable)
 @Nullable
default String getPreferredBackupWindow()

`AWS::RDS::DBInstance.PreferredBackupWindow`.

getPreferredMaintenanceWindow

@Stability(value=Stable)
 @Nullable
default String getPreferredMaintenanceWindow()

`AWS::RDS::DBInstance.PreferredMaintenanceWindow`.

getProcessorFeatures

@Stability(value=Stable)
 @Nullable
default Object getProcessorFeatures()

`AWS::RDS::DBInstance.ProcessorFeatures`.

getPromotionTier

@Stability(value=Stable)
 @Nullable
default Number getPromotionTier()

`AWS::RDS::DBInstance.PromotionTier`.

getPubliclyAccessible

@Stability(value=Stable)
 @Nullable
default Object getPubliclyAccessible()

`AWS::RDS::DBInstance.PubliclyAccessible`.

getSourceDbInstanceIdentifier

@Stability(value=Stable)
 @Nullable
default String getSourceDbInstanceIdentifier()

`AWS::RDS::DBInstance.SourceDBInstanceIdentifier`.

getSourceRegion

@Stability(value=Stable)
 @Nullable
default String getSourceRegion()

`AWS::RDS::DBInstance.SourceRegion`.

getStorageEncrypted

@Stability(value=Stable)
 @Nullable
default Object getStorageEncrypted()

`AWS::RDS::DBInstance.StorageEncrypted`.

getStorageType

@Stability(value=Stable)
 @Nullable
default String getStorageType()

`AWS::RDS::DBInstance.StorageType`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::RDS::DBInstance.Tags`.

getTimezone

@Stability(value=Stable)
 @Nullable
default String getTimezone()

`AWS::RDS::DBInstance.Timezone`.

getUseDefaultProcessorFeatures

@Stability(value=Stable)
 @Nullable
default Object getUseDefaultProcessorFeatures()

`AWS::RDS::DBInstance.UseDefaultProcessorFeatures`.

getVpcSecurityGroups

@Stability(value=Stable)
 @Nullable
default List<String> getVpcSecurityGroups()

`AWS::RDS::DBInstance.VPCSecurityGroups`.

builder

@Stability(value=Stable)
static CfnDBInstanceProps.Builder builder()

Returns:

a CfnDBInstanceProps.Builder of CfnDBInstanceProps