software.amazon.awscdk.services.rds

Interface CfnDBClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBClusterProps.Jsii$Proxy

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

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

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.*;
 CfnDBClusterProps cfnDBClusterProps = CfnDBClusterProps.builder()
         .engine("engine")
         // the properties below are optional
         .associatedRoles(List.of(DBClusterRoleProperty.builder()
                 .roleArn("roleArn")
                 // the properties below are optional
                 .featureName("featureName")
                 .build()))
         .availabilityZones(List.of("availabilityZones"))
         .backtrackWindow(123)
         .backupRetentionPeriod(123)
         .copyTagsToSnapshot(false)
         .databaseName("databaseName")
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .dbSubnetGroupName("dbSubnetGroupName")
         .deletionProtection(false)
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .enableHttpEndpoint(false)
         .enableIamDatabaseAuthentication(false)
         .engineMode("engineMode")
         .engineVersion("engineVersion")
         .globalClusterIdentifier("globalClusterIdentifier")
         .kmsKeyId("kmsKeyId")
         .masterUsername("masterUsername")
         .masterUserPassword("masterUserPassword")
         .port(123)
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .replicationSourceIdentifier("replicationSourceIdentifier")
         .restoreType("restoreType")
         .scalingConfiguration(ScalingConfigurationProperty.builder()
                 .autoPause(false)
                 .maxCapacity(123)
                 .minCapacity(123)
                 .secondsUntilAutoPause(123)
                 .build())
         .snapshotIdentifier("snapshotIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .sourceRegion("sourceRegion")
         .storageEncrypted(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useLatestRestorableTime(false)
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDBClusterProps.Builder	builder()
default Object	getAssociatedRoles() `AWS::RDS::DBCluster.AssociatedRoles`.
default List<String>	getAvailabilityZones() `AWS::RDS::DBCluster.AvailabilityZones`.
default Number	getBacktrackWindow() `AWS::RDS::DBCluster.BacktrackWindow`.
default Number	getBackupRetentionPeriod() `AWS::RDS::DBCluster.BackupRetentionPeriod`.
default Object	getCopyTagsToSnapshot() `AWS::RDS::DBCluster.CopyTagsToSnapshot`.
default String	getDatabaseName() `AWS::RDS::DBCluster.DatabaseName`.
default String	getDbClusterIdentifier() `AWS::RDS::DBCluster.DBClusterIdentifier`.
default String	getDbClusterParameterGroupName() `AWS::RDS::DBCluster.DBClusterParameterGroupName`.
default String	getDbSubnetGroupName() `AWS::RDS::DBCluster.DBSubnetGroupName`.
default Object	getDeletionProtection() `AWS::RDS::DBCluster.DeletionProtection`.
default List<String>	getEnableCloudwatchLogsExports() `AWS::RDS::DBCluster.EnableCloudwatchLogsExports`.
default Object	getEnableHttpEndpoint() `AWS::RDS::DBCluster.EnableHttpEndpoint`.
default Object	getEnableIamDatabaseAuthentication() `AWS::RDS::DBCluster.EnableIAMDatabaseAuthentication`.
String	getEngine() `AWS::RDS::DBCluster.Engine`.
default String	getEngineMode() `AWS::RDS::DBCluster.EngineMode`.
default String	getEngineVersion() `AWS::RDS::DBCluster.EngineVersion`.
default String	getGlobalClusterIdentifier() `AWS::RDS::DBCluster.GlobalClusterIdentifier`.
default String	getKmsKeyId() `AWS::RDS::DBCluster.KmsKeyId`.
default String	getMasterUsername() `AWS::RDS::DBCluster.MasterUsername`.
default String	getMasterUserPassword() `AWS::RDS::DBCluster.MasterUserPassword`.
default Number	getPort() `AWS::RDS::DBCluster.Port`.
default String	getPreferredBackupWindow() `AWS::RDS::DBCluster.PreferredBackupWindow`.
default String	getPreferredMaintenanceWindow() `AWS::RDS::DBCluster.PreferredMaintenanceWindow`.
default String	getReplicationSourceIdentifier() `AWS::RDS::DBCluster.ReplicationSourceIdentifier`.
default String	getRestoreType() `AWS::RDS::DBCluster.RestoreType`.
default Object	getScalingConfiguration() `AWS::RDS::DBCluster.ScalingConfiguration`.
default String	getSnapshotIdentifier() `AWS::RDS::DBCluster.SnapshotIdentifier`.
default String	getSourceDbClusterIdentifier() `AWS::RDS::DBCluster.SourceDBClusterIdentifier`.
default String	getSourceRegion() `AWS::RDS::DBCluster.SourceRegion`.
default Object	getStorageEncrypted() `AWS::RDS::DBCluster.StorageEncrypted`.
default List<CfnTag>	getTags() `AWS::RDS::DBCluster.Tags`.
default Object	getUseLatestRestorableTime() `AWS::RDS::DBCluster.UseLatestRestorableTime`.
default List<String>	getVpcSecurityGroupIds() `AWS::RDS::DBCluster.VpcSecurityGroupIds`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAssociatedRoles

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

`AWS::RDS::DBCluster.AssociatedRoles`.

getAvailabilityZones

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

`AWS::RDS::DBCluster.AvailabilityZones`.

getBacktrackWindow

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

`AWS::RDS::DBCluster.BacktrackWindow`.

getBackupRetentionPeriod

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

`AWS::RDS::DBCluster.BackupRetentionPeriod`.

getCopyTagsToSnapshot

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

`AWS::RDS::DBCluster.CopyTagsToSnapshot`.

getDatabaseName

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

`AWS::RDS::DBCluster.DatabaseName`.

getDbClusterIdentifier

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

`AWS::RDS::DBCluster.DBClusterIdentifier`.

getDbClusterParameterGroupName

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

`AWS::RDS::DBCluster.DBClusterParameterGroupName`.

getDbSubnetGroupName

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

`AWS::RDS::DBCluster.DBSubnetGroupName`.

getDeletionProtection

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

`AWS::RDS::DBCluster.DeletionProtection`.

getEnableCloudwatchLogsExports

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

`AWS::RDS::DBCluster.EnableCloudwatchLogsExports`.

getEnableHttpEndpoint

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

`AWS::RDS::DBCluster.EnableHttpEndpoint`.

getEnableIamDatabaseAuthentication

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

`AWS::RDS::DBCluster.EnableIAMDatabaseAuthentication`.

getEngine

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

`AWS::RDS::DBCluster.Engine`.

getEngineMode

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

`AWS::RDS::DBCluster.EngineMode`.

getEngineVersion

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

`AWS::RDS::DBCluster.EngineVersion`.

getGlobalClusterIdentifier

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

`AWS::RDS::DBCluster.GlobalClusterIdentifier`.

getKmsKeyId

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

`AWS::RDS::DBCluster.KmsKeyId`.

getMasterUsername

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

`AWS::RDS::DBCluster.MasterUsername`.

getMasterUserPassword

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

`AWS::RDS::DBCluster.MasterUserPassword`.

getPort

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

`AWS::RDS::DBCluster.Port`.

getPreferredBackupWindow

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

`AWS::RDS::DBCluster.PreferredBackupWindow`.

getPreferredMaintenanceWindow

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

`AWS::RDS::DBCluster.PreferredMaintenanceWindow`.

getReplicationSourceIdentifier

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

`AWS::RDS::DBCluster.ReplicationSourceIdentifier`.

getRestoreType

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

`AWS::RDS::DBCluster.RestoreType`.

getScalingConfiguration

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

`AWS::RDS::DBCluster.ScalingConfiguration`.

getSnapshotIdentifier

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

`AWS::RDS::DBCluster.SnapshotIdentifier`.

getSourceDbClusterIdentifier

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

`AWS::RDS::DBCluster.SourceDBClusterIdentifier`.

getSourceRegion

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

`AWS::RDS::DBCluster.SourceRegion`.

getStorageEncrypted

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

`AWS::RDS::DBCluster.StorageEncrypted`.

getTags

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

`AWS::RDS::DBCluster.Tags`.

getUseLatestRestorableTime

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

`AWS::RDS::DBCluster.UseLatestRestorableTime`.

getVpcSecurityGroupIds

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

`AWS::RDS::DBCluster.VpcSecurityGroupIds`.

builder

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

Returns:

a CfnDBClusterProps.Builder of CfnDBClusterProps