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

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: DatabaseClusterProps.Jsii$Proxy

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

Properties for a new database cluster.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .masterUser(Login.builder()
                 .username("myuser") // NOTE: 'admin' is reserved by DocumentDB
                 .excludeCharacters("\"@/:") // optional, defaults to the set "\"@/" and is also used for eventually created rotations
                 .secretName("/myapp/mydocdb/masteruser")
                 .build())
         .instanceType(InstanceType.of(InstanceClass.MEMORY5, InstanceSize.LARGE))
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PUBLIC)
                 .build())
         .vpc(vpc)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DatabaseClusterProps.Builder` A builder for `DatabaseClusterProps`
`static class`	`DatabaseClusterProps.Jsii$Proxy` An implementation for `DatabaseClusterProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static DatabaseClusterProps.Builder`	`builder()`
`default BackupProps`	`getBackup()` Backup settings.
`default RetentionDays`	`getCloudWatchLogsRetention()` The number of days log events are kept in CloudWatch Logs.
`default IRole`	`getCloudWatchLogsRetentionRole()` The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
`default String`	`getDbClusterName()` An optional identifier for the cluster.
`default Boolean`	`getDeletionProtection()` Specifies whether this cluster can be deleted.
`default String`	`getEngineVersion()` What version of the database to start.
`default Boolean`	`getExportAuditLogsToCloudWatch()` Whether the audit logs should be exported to CloudWatch.
`default Boolean`	`getExportProfilerLogsToCloudWatch()` Whether the profiler logs should be exported to CloudWatch.
`default String`	`getInstanceIdentifierBase()` Base identifier for instances.
`default Number`	`getInstances()` Number of DocDB compute instances.
`InstanceType`	`getInstanceType()` What type of instance to start for the replicas.
`default IKey`	`getKmsKey()` The KMS key for storage encryption.
`Login`	`getMasterUser()` Username and password for the administrative user.
`default IClusterParameterGroup`	`getParameterGroup()` The DB parameter group to associate with the instance.
`default Number`	`getPort()` The port the DocumentDB cluster will listen on.
`default String`	`getPreferredMaintenanceWindow()` A weekly time range in which maintenance should preferably execute.
`default RemovalPolicy`	`getRemovalPolicy()` The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.
`default ISecurityGroup`	`getSecurityGroup()` Security group.
`default Boolean`	`getStorageEncrypted()` Whether to enable storage encryption.
`IVpc`	`getVpc()` What subnets to run the DocumentDB instances in.
`default SubnetSelection`	`getVpcSubnets()` Where to place the instances within the VPC.

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

- Method Detail
  - getInstanceType
```
@Stability(value=Stable)
 @NotNull
InstanceType getInstanceType()
```
    What type of instance to start for the replicas.
  - getMasterUser
```
@Stability(value=Stable)
 @NotNull
Login getMasterUser()
```
    Username and password for the administrative user.
  - getVpc
```
@Stability(value=Stable)
 @NotNull
IVpc getVpc()
```
    What subnets to run the DocumentDB instances in.
    Must be at least 2 subnets in two different AZs.
  - getBackup
```
@Stability(value=Stable)
 @Nullable
default BackupProps getBackup()
```
    Backup settings.
    Default: - Backup retention period for automated backups is 1 day. Backup preferred window is set to 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.
    
    See Also:
    
    https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshots.html#backup-restore.backup-window
  - getCloudWatchLogsRetention
```
@Stability(value=Stable)
 @Nullable
default RetentionDays getCloudWatchLogsRetention()
```
    The number of days log events are kept in CloudWatch Logs.
    When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.
    Default: - logs never expire
  - getCloudWatchLogsRetentionRole
```
@Stability(value=Stable)
 @Nullable
default IRole getCloudWatchLogsRetentionRole()
```
    The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
    Default: - a new role is created.
  - getDbClusterName
```
@Stability(value=Stable)
 @Nullable
default String getDbClusterName()
```
    An optional identifier for the cluster.
    Default: - A name is automatically generated.
  - getDeletionProtection
```
@Stability(value=Stable)
 @Nullable
default Boolean getDeletionProtection()
```
    Specifies whether this cluster can be deleted.
    If deletionProtection is enabled, the cluster cannot be deleted unless it is modified and deletionProtection is disabled. deletionProtection protects clusters from being accidentally deleted.
    Default: - false
  - getEngineVersion
```
@Stability(value=Stable)
 @Nullable
default String getEngineVersion()
```
    What version of the database to start.
    Default: - The default engine version.
  - getExportAuditLogsToCloudWatch
```
@Stability(value=Stable)
 @Nullable
default Boolean getExportAuditLogsToCloudWatch()
```
    Whether the audit logs should be exported to CloudWatch.
    Note that you also have to configure the audit log export in the Cluster's Parameter Group.
    Default: false
    
    See Also:
    
    https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html#event-auditing-enabling-auditing
  - getExportProfilerLogsToCloudWatch
```
@Stability(value=Stable)
 @Nullable
default Boolean getExportProfilerLogsToCloudWatch()
```
    Whether the profiler logs should be exported to CloudWatch.
    Note that you also have to configure the profiler log export in the Cluster's Parameter Group.
    Default: false
    
    See Also:
    
    https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html#profiling.enable-profiling
  - getInstanceIdentifierBase
```
@Stability(value=Stable)
 @Nullable
default String getInstanceIdentifierBase()
```
    Base identifier for instances.
    Every replica is named by appending the replica number to this string, 1-based.
    Default: - `dbClusterName` is used with the word "Instance" appended. If `dbClusterName` is not provided, the identifier is automatically generated.
  - getInstances
```
@Stability(value=Stable)
 @Nullable
default Number getInstances()
```
    Number of DocDB compute instances.
    Default: 1
  - getKmsKey
```
@Stability(value=Stable)
 @Nullable
default IKey getKmsKey()
```
    The KMS key for storage encryption.
    Default: - default master key.
  - getParameterGroup
```
@Stability(value=Stable)
 @Nullable
default IClusterParameterGroup getParameterGroup()
```
    The DB parameter group to associate with the instance.
    Default: no parameter group
  - getPort
```
@Stability(value=Stable)
 @Nullable
default Number getPort()
```
    The port the DocumentDB cluster will listen on.
    Default: DatabaseCluster.DEFAULT_PORT
  - getPreferredMaintenanceWindow
```
@Stability(value=Stable)
 @Nullable
default String getPreferredMaintenanceWindow()
```
    A weekly time range in which maintenance should preferably execute.
    Must be at least 30 minutes long.
    Example: 'tue:04:17-tue:04:47'
    Default: - 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.
    
    See Also:
    
    https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#maintenance-window
  - getRemovalPolicy
```
@Stability(value=Stable)
 @Nullable
default RemovalPolicy getRemovalPolicy()
```
    The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.
    This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter.
    Default: - Retain cluster.
  - getSecurityGroup
```
@Stability(value=Stable)
 @Nullable
default ISecurityGroup getSecurityGroup()
```
    Security group.
    Default: a new security group is created.
  - getStorageEncrypted
```
@Stability(value=Stable)
 @Nullable
default Boolean getStorageEncrypted()
```
    Whether to enable storage encryption.
    Default: true
  - getVpcSubnets
```
@Stability(value=Stable)
 @Nullable
default SubnetSelection getVpcSubnets()
```
    Where to place the instances within the VPC.
    Default: private subnets
  - builder
```
@Stability(value=Stable)
static DatabaseClusterProps.Builder builder()
```
    Returns:
    
    a DatabaseClusterProps.Builder of DatabaseClusterProps

Interface DatabaseClusterProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getInstanceType

getMasterUser

getVpc

getBackup

getCloudWatchLogsRetention

getCloudWatchLogsRetentionRole

getDbClusterName

getDeletionProtection

getEngineVersion

getExportAuditLogsToCloudWatch

getExportProfilerLogsToCloudWatch

getInstanceIdentifierBase

getInstances

getKmsKey

getParameterGroup

getPort

getPreferredMaintenanceWindow

getRemovalPolicy

getSecurityGroup

getStorageEncrypted

getVpcSubnets

builder