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

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDBClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.362Z")
 @Stability(value=Stable)
public interface CfnDBClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDBCluster`.

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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnDBClusterProps.Builder`	`builder()`
`default Object`	`getAssociatedRoles()` Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
`default List<String>`	`getAvailabilityZones()` A list of Availability Zones (AZs) where instances in the DB cluster can be created.
`default Number`	`getBacktrackWindow()` The target backtrack window, in seconds.
`default Number`	`getBackupRetentionPeriod()` The number of days for which automated backups are retained.
`default Object`	`getCopyTagsToSnapshot()` A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
`default String`	`getDatabaseName()` The name of your database.
`default String`	`getDbClusterIdentifier()` The DB cluster identifier.
`default String`	`getDbClusterParameterGroupName()` The name of the DB cluster parameter group to associate with this DB cluster.
`default String`	`getDbSubnetGroupName()` A DB subnet group that you want to associate with this DB cluster.
`default Object`	`getDeletionProtection()` A value that indicates whether the DB cluster has deletion protection enabled.
`default List<String>`	`getEnableCloudwatchLogsExports()` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`default Object`	`getEnableHttpEndpoint()` A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
`default Object`	`getEnableIamDatabaseAuthentication()` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`String`	`getEngine()` The name of the database engine to be used for this DB cluster.
`default String`	`getEngineMode()` The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
`default String`	`getEngineVersion()` The version number of the database engine to use.
`default String`	`getGlobalClusterIdentifier()` If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
`default String`	`getKmsKeyId()` The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
`default String`	`getMasterUsername()` The name of the master user for the DB cluster.
`default String`	`getMasterUserPassword()` The master password for the DB instance.
`default Number`	`getPort()` The port number on which the DB instances in the DB cluster accept connections.
`default String`	`getPreferredBackupWindow()` The daily time range during which automated backups are created.
`default String`	`getPreferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`default String`	`getReplicationSourceIdentifier()` The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
`default String`	`getRestoreType()` The type of restore to be performed.
`default Object`	`getScalingConfiguration()` The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
`default String`	`getSnapshotIdentifier()` The identifier for the DB snapshot or DB cluster snapshot to restore from.
`default String`	`getSourceDbClusterIdentifier()` When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
`default String`	`getSourceRegion()` The AWS Region which contains the source DB cluster when replicating a DB cluster.
`default Object`	`getStorageEncrypted()` Indicates whether the DB cluster is encrypted.
`default List<CfnTag>`	`getTags()` Tags to assign to the DB cluster.
`default Object`	`getUseLatestRestorableTime()` A value that indicates whether to restore the DB cluster to the latest restorable backup time.
`default List<String>`	`getVpcSecurityGroupIds()` A list of EC2 VPC security groups to associate with this DB cluster.

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

- Method Detail
  - getEngine
```
@Stability(value=Stable)
 @NotNull
String getEngine()
```
    The name of the database engine to be used for this DB cluster.
    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
  - getAssociatedRoles
```
@Stability(value=Stable)
 @Nullable
default Object getAssociatedRoles()
```
    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
    IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
  - getAvailabilityZones
```
@Stability(value=Stable)
 @Nullable
default List<String> getAvailabilityZones()
```
    A list of Availability Zones (AZs) where instances in the DB cluster can be created.
    For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
  - getBacktrackWindow
```
@Stability(value=Stable)
 @Nullable
default Number getBacktrackWindow()
```
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Currently, Backtrack is only supported for Aurora MySQL DB clusters.
    
    Default: 0
    Constraints:
    - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
  - getBackupRetentionPeriod
```
@Stability(value=Stable)
 @Nullable
default Number getBackupRetentionPeriod()
```
    The number of days for which automated backups are retained.
    Default: 1
    Constraints:
    - Must be a value from 1 to 35
  - getCopyTagsToSnapshot
```
@Stability(value=Stable)
 @Nullable
default Object getCopyTagsToSnapshot()
```
    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
    The default is not to copy them.
  - getDatabaseName
```
@Stability(value=Stable)
 @Nullable
default String getDatabaseName()
```
    The name of your database.
    If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon Aurora User Guide .
  - getDbClusterIdentifier
```
@Stability(value=Stable)
 @Nullable
default String getDbClusterIdentifier()
```
    The DB cluster identifier. This parameter is stored as a lowercase string.
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - First character must be a letter.
    - Can't end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster1
  - getDbClusterParameterGroupName
```
@Stability(value=Stable)
 @Nullable
default String getDbClusterParameterGroupName()
```
    The name of the DB cluster parameter group to associate with this DB cluster.
    
    If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
    If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
    
    To list all of the available DB cluster parameter group names, use the following command:
    aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
  - getDbSubnetGroupName
```
@Stability(value=Stable)
 @Nullable
default String getDbSubnetGroupName()
```
    A DB subnet group that you want to associate with this DB cluster.
    If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
  - getDeletionProtection
```
@Stability(value=Stable)
 @Nullable
default Object getDeletionProtection()
```
    A value that indicates whether the DB cluster has deletion protection enabled.
    The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
  - getEnableCloudwatchLogsExports
```
@Stability(value=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 Aurora User Guide .
    Aurora MySQL
    Valid values: audit , error , general , slowquery
    Aurora PostgreSQL
    Valid values: postgresql
  - getEnableHttpEndpoint
```
@Stability(value=Stable)
 @Nullable
default Object getEnableHttpEndpoint()
```
    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
    By default, the HTTP endpoint is disabled.
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
  - getEnableIamDatabaseAuthentication
```
@Stability(value=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.
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
  - getEngineMode
```
@Stability(value=Stable)
 @Nullable
default String getEngineMode()
```
    The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
    The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.
    The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
    The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
    The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
    For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
    Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :
  - getEngineVersion
```
@Stability(value=Stable)
 @Nullable
default String getEngineVersion()
```
    The version number of the database engine to use.
    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
    To list all of the available engine versions for aurora-postgresql , use the following command:
    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
  - getGlobalClusterIdentifier
```
@Stability(value=Stable)
 @Nullable
default String getGlobalClusterIdentifier()
```
    If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
    To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
    If you aren't configuring a global database cluster, don't specify this property.
    
    To remove the DB cluster from a global database cluster, specify an empty value for the GlobalClusterIdentifier property.
    
    For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
  - getKmsKeyId
```
@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()
```
    The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, 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, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true .
    If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
  - getMasterUsername
```
@Stability(value=Stable)
 @Nullable
default String getMasterUsername()
```
    The name of the master user for the DB cluster.
    
    If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
  - getMasterUserPassword
```
@Stability(value=Stable)
 @Nullable
default String getMasterUserPassword()
```
    The master password for the DB instance.
    
    If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
  - getPort
```
@Stability(value=Stable)
 @Nullable
default Number getPort()
```
    The port number on which the DB instances in the DB cluster accept connections.
    Default:
    - When EngineMode is provisioned , 3306 (for both Aurora MySQL and Aurora PostgreSQL)
    - When EngineMode is serverless :
    - 3306 when Engine is aurora or aurora-mysql
    - 5432 when Engine is aurora-postgresql
    The No interruption on update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.
  - getPreferredBackupWindow
```
@Stability(value=Stable)
 @Nullable
default String getPreferredBackupWindow()
```
    The daily time range during which automated backups are created.
    For more information, see Backup Window in the Amazon Aurora 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.
  - getPreferredMaintenanceWindow
```
@Stability(value=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 Cluster Maintenance Window in the Amazon Aurora User Guide.
    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    Constraints: Minimum 30-minute window.
  - getReplicationSourceIdentifier
```
@Stability(value=Stable)
 @Nullable
default String getReplicationSourceIdentifier()
```
    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
  - getRestoreType
```
@Stability(value=Stable)
 @Nullable
default String getRestoreType()
```
    The type of restore to be performed. You can specify one of the following values:.
    - full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
    - copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
    Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
    If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
  - getScalingConfiguration
```
@Stability(value=Stable)
 @Nullable
default Object getScalingConfiguration()
```
    The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
    Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn't support Aurora Serverless v2.
  - getSnapshotIdentifier
```
@Stability(value=Stable)
 @Nullable
default String getSnapshotIdentifier()
```
    The identifier for the DB snapshot or DB cluster snapshot to restore from.
    You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
    After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
    If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:
    - GlobalClusterIdentifier
    - MasterUsername
    - MasterUserPassword
    - ReplicationSourceIdentifier
    - RestoreType
    - SourceDBClusterIdentifier
    - SourceRegion
    - StorageEncrypted (for an encrypted snapshot)
    - UseLatestRestorableTime
    Constraints:
    - Must match the identifier of an existing Snapshot.
  - getSourceDbClusterIdentifier
```
@Stability(value=Stable)
 @Nullable
default String getSourceDbClusterIdentifier()
```
    When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
    Constraints:
    - Must match the identifier of an existing DBCluster.
  - getSourceRegion
```
@Stability(value=Stable)
 @Nullable
default String getSourceRegion()
```
    The AWS Region which contains the source DB cluster when replicating a DB cluster.
    For example, us-east-1 .
  - getStorageEncrypted
```
@Stability(value=Stable)
 @Nullable
default Object getStorageEncrypted()
```
    Indicates whether the DB cluster is encrypted.
    If you specify the KmsKeyId property, then you must enable encryption.
    If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
    If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.
    If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false .
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    Tags to assign to the DB cluster.
  - getUseLatestRestorableTime
```
@Stability(value=Stable)
 @Nullable
default Object getUseLatestRestorableTime()
```
    A value that indicates whether to restore the DB cluster to the latest restorable backup time.
    By default, the DB cluster is not restored to the latest restorable backup time.
  - getVpcSecurityGroupIds
```
@Stability(value=Stable)
 @Nullable
default List<String> getVpcSecurityGroupIds()
```
    A list of EC2 VPC security groups to associate with this DB cluster.
    If you plan to update the resource, don't specify VPC security groups in a shared VPC.
  - builder
```
@Stability(value=Stable)
static CfnDBClusterProps.Builder builder()
```
    Returns:
    
    a CfnDBClusterProps.Builder of CfnDBClusterProps

Interface CfnDBClusterProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getEngine

getAssociatedRoles

getAvailabilityZones

getBacktrackWindow

getBackupRetentionPeriod

getCopyTagsToSnapshot

getDatabaseName

getDbClusterIdentifier

getDbClusterParameterGroupName

getDbSubnetGroupName

getDeletionProtection

getEnableCloudwatchLogsExports

getEnableHttpEndpoint

getEnableIamDatabaseAuthentication

getEngineMode

getEngineVersion

getGlobalClusterIdentifier

getKmsKeyId

getMasterUsername

getMasterUserPassword

getPort

getPreferredBackupWindow

getPreferredMaintenanceWindow

getReplicationSourceIdentifier

getRestoreType

getScalingConfiguration

getSnapshotIdentifier

getSourceDbClusterIdentifier

getSourceRegion

getStorageEncrypted

getTags

getUseLatestRestorableTime

getVpcSecurityGroupIds

builder