Interface CfnDBClusterProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDBClusterProps.Jsii$Proxy
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.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) .storageType("storageType") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .useLatestRestorableTime(false) .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds")) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDBClusterProps
static final class
An implementation forCfnDBClusterProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDBClusterProps.Builder
builder()
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.default Number
The number of days for which automated backups are retained.default Object
default String
The cluster identifier.default String
The name of the cluster parameter group to associate with this cluster.default String
A subnet group to associate with this cluster.default Object
Protects clusters from being accidentally deleted.The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.default String
The version number of the database engine to use.default String
The AWS KMS key identifier for an encrypted cluster.default String
The name of the master user for the cluster.default String
The password for the master database user.default Number
getPort()
Specifies the port that the database engine is listening on.default String
The daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriod
parameter.default String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).default String
The date and time to restore the cluster to.default String
The type of restore to be performed.default String
The identifier for the snapshot or cluster snapshot to restore from.default String
The identifier of the source cluster from which to restore.default Object
Specifies whether the cluster is encrypted.default String
The storage type to associate with the DB cluster.getTags()
The tags to be assigned to the cluster.default Object
A value that is set totrue
to restore the cluster to the latest restorable backup time, andfalse
otherwise.A list of EC2 VPC security groups to associate with this cluster.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAvailabilityZones
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.- See Also:
-
getBackupRetentionPeriod
The number of days for which automated backups are retained. You must specify a minimum value of 1.Default: 1
Constraints:
- Must be a value from 1 to 35.
- See Also:
-
getCopyTagsToSnapshot
- See Also:
-
getDbClusterIdentifier
The cluster identifier. This parameter is stored as a lowercase string.Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster
- See Also:
-
getDbClusterParameterGroupName
The name of the cluster parameter group to associate with this cluster.- See Also:
-
getDbSubnetGroupName
A subnet group to associate with this cluster.Constraints: Must match the name of an existing
DBSubnetGroup
. Must not be default.Example:
mySubnetgroup
- See Also:
-
getDeletionProtection
Protects clusters from being accidentally deleted.If enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled.- See Also:
-
getEnableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .
- See Also:
-
getEngineVersion
The version number of the database engine to use.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.- See Also:
-
getKmsKeyId
The AWS KMS key identifier for an encrypted cluster.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
:- If the
StorageEncrypted
parameter istrue
, 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 .
- See Also:
- If the
-
getMasterUsername
The name of the master user for the cluster.Constraints:
- Must be from 1 to 63 letters or numbers.
- The first character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- See Also:
-
getMasterUserPassword
The password for the master database user.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.
- See Also:
-
getPort
Specifies the port that the database engine is listening on.- See Also:
-
getPreferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriod
parameter.The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region .
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.
- See Also:
- Must be in the format
-
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.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
- See Also:
-
getRestoreToTime
The date and time to restore the cluster to.Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
- Must be before the latest restorable time for the instance.
- Must be specified if the
UseLatestRestorableTime
parameter is not provided. - Cannot be specified if the
UseLatestRestorableTime
parameter istrue
. - Cannot be specified if the
RestoreType
parameter iscopy-on-write
.
Example:
2015-03-07T23:45:00Z
- See Also:
-
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.- See Also:
-
getSnapshotIdentifier
The identifier for the snapshot or cluster snapshot to restore from.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:
- Must match the identifier of an existing snapshot.
- See Also:
-
getSourceDbClusterIdentifier
The identifier of the source cluster from which to restore.Constraints:
- Must match the identifier of an existing
DBCluster
.
- See Also:
- Must match the identifier of an existing
-
getStorageEncrypted
Specifies whether the cluster is encrypted.- See Also:
-
getStorageType
The storage type to associate with the DB cluster.For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide .
Valid values for storage type -
standard | iopt1
Default value is
standard
When you create a DocumentDB DB cluster with the storage type set to
iopt1
, the storage type is returned in the response. The storage type isn't returned when you set it tostandard
.- See Also:
-
getTags
The tags to be assigned to the cluster.- See Also:
-
getUseLatestRestorableTime
A value that is set totrue
to restore the cluster to the latest restorable backup time, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if the
RestoreToTime
parameter is provided.- See Also:
-
getVpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this cluster.- See Also:
-
builder
- Returns:
- a
CfnDBClusterProps.Builder
ofCfnDBClusterProps
-