@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:55.518Z")
public interface CfnDBClusterProps
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.docdb.*; CfnDBClusterProps cfnDBClusterProps = CfnDBClusterProps.builder() .availabilityZones(List.of("availabilityZones")) .backupRetentionPeriod(123) .copyTagsToSnapshot(false) .dbClusterIdentifier("dbClusterIdentifier") .dbClusterParameterGroupName("dbClusterParameterGroupName") .dbSubnetGroupName("dbSubnetGroupName") .deletionProtection(false) .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports")) .engineVersion("engineVersion") .kmsKeyId("kmsKeyId") .masterUsername("masterUsername") .masterUserPassword("masterUserPassword") .port(123) .preferredBackupWindow("preferredBackupWindow") .preferredMaintenanceWindow("preferredMaintenanceWindow") .restoreToTime("restoreToTime") .restoreType("restoreType") .snapshotIdentifier("snapshotIdentifier") .sourceDbClusterIdentifier("sourceDbClusterIdentifier") .storageEncrypted(false) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .useLatestRestorableTime(false) .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds")) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnDBClusterProps.Builder
A builder for
CfnDBClusterProps |
static class |
CfnDBClusterProps.Jsii$Proxy
An implementation for
CfnDBClusterProps |
Modifier and Type | Method and Description |
---|---|
static CfnDBClusterProps.Builder |
builder() |
default java.util.List<java.lang.String> |
getAvailabilityZones()
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
|
default java.lang.Number |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
default java.lang.Object |
getCopyTagsToSnapshot()
`AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
|
default java.lang.String |
getDbClusterIdentifier()
The cluster identifier.
|
default java.lang.String |
getDbClusterParameterGroupName()
The name of the cluster parameter group to associate with this cluster.
|
default java.lang.String |
getDbSubnetGroupName()
A subnet group to associate with this cluster.
|
default java.lang.Object |
getDeletionProtection()
Protects clusters from being accidentally deleted.
|
default java.util.List<java.lang.String> |
getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
|
default java.lang.String |
getEngineVersion()
The version number of the database engine to use.
|
default java.lang.String |
getKmsKeyId()
The AWS KMS key identifier for an encrypted cluster.
|
default java.lang.String |
getMasterUsername()
The name of the master user for the cluster.
|
default java.lang.String |
getMasterUserPassword()
The password for the master database user.
|
default java.lang.Number |
getPort()
Specifies the port that the database engine is listening on.
|
default java.lang.String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
|
default java.lang.String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
default java.lang.String |
getRestoreToTime()
The date and time to restore the cluster to.
|
default java.lang.String |
getRestoreType()
The type of restore to be performed.
|
default java.lang.String |
getSnapshotIdentifier()
The identifier for the snapshot or cluster snapshot to restore from.
|
default java.lang.String |
getSourceDbClusterIdentifier()
The identifier of the source cluster from which to restore.
|
default java.lang.Object |
getStorageEncrypted()
Specifies whether the cluster is encrypted.
|
default java.util.List<CfnTag> |
getTags()
The tags to be assigned to the cluster.
|
default java.lang.Object |
getUseLatestRestorableTime()
A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise.
|
default java.util.List<java.lang.String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this cluster.
|
default java.util.List<java.lang.String> getAvailabilityZones()
default java.lang.Number getBackupRetentionPeriod()
Default: 1
Constraints:
default java.lang.Object getCopyTagsToSnapshot()
default java.lang.String getDbClusterIdentifier()
Constraints:
Example: my-cluster
default java.lang.String getDbClusterParameterGroupName()
default java.lang.String getDbSubnetGroupName()
Constraints: Must match the name of an existing DBSubnetGroup
. Must not be default.
Example: mySubnetgroup
default java.lang.Object getDeletionProtection()
If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection
is disabled.
default java.util.List<java.lang.String> getEnableCloudwatchLogsExports()
You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .
default java.lang.String getEngineVersion()
The --engine-version
will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
default java.lang.String getKmsKeyId()
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
If an encryption key is not specified in KmsKeyId
:
StorageEncrypted
parameter is true
, Amazon DocumentDB uses your default encryption key.AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .
default java.lang.String getMasterUsername()
Constraints:
default java.lang.String getMasterUserPassword()
This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
default java.lang.Number getPort()
default java.lang.String getPreferredBackupWindow()
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region .
Constraints:
hh24:mi-hh24:mi
.default java.lang.String getPreferredMaintenanceWindow()
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.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
default java.lang.String getRestoreToTime()
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
UseLatestRestorableTime
parameter is not provided.UseLatestRestorableTime
parameter is true
.RestoreType
parameter is copy-on-write
.
Example: 2015-03-07T23:45:00Z
default java.lang.String getRestoreType()
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.
default java.lang.String getSnapshotIdentifier()
You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.
Constraints:
default java.lang.String getSourceDbClusterIdentifier()
Constraints:
DBCluster
.default java.lang.Object getStorageEncrypted()
default java.util.List<CfnTag> getTags()
default java.lang.Object getUseLatestRestorableTime()
Default: false
Constraints: Cannot be specified if the RestoreToTime
parameter is provided.
default java.util.List<java.lang.String> getVpcSecurityGroupIds()
static CfnDBClusterProps.Builder builder()
CfnDBClusterProps.Builder
of CfnDBClusterProps