@Stability(value=Stable) @Internal public static final class DatabaseClusterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DatabaseClusterProps
DatabaseClusterProps
software.amazon.jsii.JsiiObject.InitializationMode
DatabaseClusterProps.Builder, DatabaseClusterProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(DatabaseClusterProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
DatabaseClusterProps.Builder . |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
BackupProps |
getBackup()
Backup settings.
|
RetentionDays |
getCloudWatchLogsRetention()
The number of days log events are kept in CloudWatch Logs.
|
IRole |
getCloudWatchLogsRetentionRole()
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
|
String |
getDbClusterName()
An optional identifier for the cluster.
|
Boolean |
getDeletionProtection()
Specifies whether this cluster can be deleted.
|
String |
getEngineVersion()
What version of the database to start.
|
Boolean |
getExportAuditLogsToCloudWatch()
Whether the audit logs should be exported to CloudWatch.
|
Boolean |
getExportProfilerLogsToCloudWatch()
Whether the profiler logs should be exported to CloudWatch.
|
String |
getInstanceIdentifierBase()
Base identifier for instances.
|
Number |
getInstances()
Number of DocDB compute instances.
|
InstanceType |
getInstanceType()
What type of instance to start for the replicas.
|
IKey |
getKmsKey()
The KMS key for storage encryption.
|
Login |
getMasterUser()
Username and password for the administrative user.
|
IClusterParameterGroup |
getParameterGroup()
The DB parameter group to associate with the instance.
|
Number |
getPort()
The port the DocumentDB cluster will listen on.
|
String |
getPreferredMaintenanceWindow()
A weekly time range in which maintenance should preferably execute.
|
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.
|
ISecurityGroup |
getSecurityGroup()
Security group.
|
Boolean |
getStorageEncrypted()
Whether to enable storage encryption.
|
IVpc |
getVpc()
What subnets to run the DocumentDB instances in.
|
SubnetSelection |
getVpcSubnets()
Where to place the instances within the VPC.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.protected Jsii$Proxy(DatabaseClusterProps.Builder builder)
DatabaseClusterProps.Builder
.public final InstanceType getInstanceType()
DatabaseClusterProps
getInstanceType
in interface DatabaseClusterProps
public final Login getMasterUser()
DatabaseClusterProps
getMasterUser
in interface DatabaseClusterProps
public final IVpc getVpc()
DatabaseClusterProps
Must be at least 2 subnets in two different AZs.
getVpc
in interface DatabaseClusterProps
public final BackupProps getBackup()
DatabaseClusterProps
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.
public final RetentionDays getCloudWatchLogsRetention()
DatabaseClusterProps
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
getCloudWatchLogsRetention
in interface DatabaseClusterProps
public final IRole getCloudWatchLogsRetentionRole()
DatabaseClusterProps
Default: - a new role is created.
getCloudWatchLogsRetentionRole
in interface DatabaseClusterProps
public final String getDbClusterName()
DatabaseClusterProps
Default: - A name is automatically generated.
getDbClusterName
in interface DatabaseClusterProps
public final Boolean getDeletionProtection()
DatabaseClusterProps
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
getDeletionProtection
in interface DatabaseClusterProps
public final String getEngineVersion()
DatabaseClusterProps
Default: - The default engine version.
getEngineVersion
in interface DatabaseClusterProps
public final Boolean getExportAuditLogsToCloudWatch()
DatabaseClusterProps
Note that you also have to configure the audit log export in the Cluster's Parameter Group.
Default: false
public final Boolean getExportProfilerLogsToCloudWatch()
DatabaseClusterProps
Note that you also have to configure the profiler log export in the Cluster's Parameter Group.
Default: false
getExportProfilerLogsToCloudWatch
in interface DatabaseClusterProps
public final String getInstanceIdentifierBase()
DatabaseClusterProps
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.
getInstanceIdentifierBase
in interface DatabaseClusterProps
public final Number getInstances()
DatabaseClusterProps
Default: 1
getInstances
in interface DatabaseClusterProps
public final IKey getKmsKey()
DatabaseClusterProps
Default: - default master key.
getKmsKey
in interface DatabaseClusterProps
public final IClusterParameterGroup getParameterGroup()
DatabaseClusterProps
Default: no parameter group
getParameterGroup
in interface DatabaseClusterProps
public final Number getPort()
DatabaseClusterProps
Default: DatabaseCluster.DEFAULT_PORT
getPort
in interface DatabaseClusterProps
public final String getPreferredMaintenanceWindow()
DatabaseClusterProps
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.
getPreferredMaintenanceWindow
in interface DatabaseClusterProps
public final RemovalPolicy getRemovalPolicy()
DatabaseClusterProps
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.
getRemovalPolicy
in interface DatabaseClusterProps
public final ISecurityGroup getSecurityGroup()
DatabaseClusterProps
Default: a new security group is created.
getSecurityGroup
in interface DatabaseClusterProps
public final Boolean getStorageEncrypted()
DatabaseClusterProps
Default: true
getStorageEncrypted
in interface DatabaseClusterProps
public final SubnetSelection getVpcSubnets()
DatabaseClusterProps
Default: private subnets
getVpcSubnets
in interface DatabaseClusterProps
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson
in interface software.amazon.jsii.JsiiSerializable
Copyright © 2023. All rights reserved.