@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-25T18:29:05.779Z")
public interface DatabaseClusterProps
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.R5, InstanceSize.LARGE)) .vpcSubnets(SubnetSelection.builder() .subnetType(SubnetType.PUBLIC) .build()) .vpc(vpc) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
DatabaseClusterProps.Builder
A builder for
DatabaseClusterProps |
static class |
DatabaseClusterProps.Jsii$Proxy
An implementation for
DatabaseClusterProps |
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 java.lang.String |
getDbClusterName()
An optional identifier for the cluster.
|
default java.lang.Boolean |
getDeletionProtection()
Specifies whether this cluster can be deleted.
|
default java.lang.String |
getEngineVersion()
What version of the database to start.
|
default java.lang.Boolean |
getExportAuditLogsToCloudWatch()
Whether the audit logs should be exported to CloudWatch.
|
default java.lang.Boolean |
getExportProfilerLogsToCloudWatch()
Whether the profiler logs should be exported to CloudWatch.
|
default java.lang.String |
getInstanceIdentifierBase()
Base identifier for instances.
|
default java.lang.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 java.lang.Number |
getPort()
The port the DocumentDB cluster will listen on.
|
default java.lang.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 java.lang.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.
|
InstanceType getInstanceType()
Login getMasterUser()
IVpc getVpc()
Must be at least 2 subnets in two different AZs.
default BackupProps getBackup()
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.
default RetentionDays getCloudWatchLogsRetention()
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
default IRole getCloudWatchLogsRetentionRole()
Default: - a new role is created.
default java.lang.String getDbClusterName()
Default: - A name is automatically generated.
default java.lang.Boolean getDeletionProtection()
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
default java.lang.String getEngineVersion()
Default: - The default engine version.
default java.lang.Boolean getExportAuditLogsToCloudWatch()
Note that you also have to configure the audit log export in the Cluster's Parameter Group.
Default: false
default java.lang.Boolean getExportProfilerLogsToCloudWatch()
Note that you also have to configure the profiler log export in the Cluster's Parameter Group.
Default: false
default java.lang.String getInstanceIdentifierBase()
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.
default java.lang.Number getInstances()
Default: 1
default IKey getKmsKey()
Default: - default master key.
default IClusterParameterGroup getParameterGroup()
Default: no parameter group
default java.lang.Number getPort()
Default: DatabaseCluster.DEFAULT_PORT
default java.lang.String getPreferredMaintenanceWindow()
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.
default RemovalPolicy getRemovalPolicy()
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.
default ISecurityGroup getSecurityGroup()
Default: a new security group is created.
default java.lang.Boolean getStorageEncrypted()
Default: true
default SubnetSelection getVpcSubnets()
Default: private subnets
static DatabaseClusterProps.Builder builder()
DatabaseClusterProps.Builder
of DatabaseClusterProps