CfnDBClusterProps
- class aws_cdk.aws_docdb.CfnDBClusterProps(*, availability_zones=None, backup_retention_period=None, copy_tags_to_snapshot=None, db_cluster_identifier=None, db_cluster_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enable_cloudwatch_logs_exports=None, engine_version=None, kms_key_id=None, master_username=None, master_user_password=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, restore_to_time=None, restore_type=None, snapshot_identifier=None, source_db_cluster_identifier=None, storage_encrypted=None, tags=None, use_latest_restorable_time=None, vpc_security_group_ids=None)
Bases:
object
Properties for defining a
CfnDBCluster
.- Parameters
availability_zones (
Optional
[Sequence
[str
]]) – A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.backup_retention_period (
Union
[int
,float
,None
]) – 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.copy_tags_to_snapshot (
Union
[bool
,IResolvable
,None
]) –AWS::DocDB::DBCluster.CopyTagsToSnapshot
.db_cluster_identifier (
Optional
[str
]) – 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
db_cluster_parameter_group_name (
Optional
[str
]) – The name of the cluster parameter group to associate with this cluster.db_subnet_group_name (
Optional
[str
]) – A subnet group to associate with this cluster. Constraints: Must match the name of an existingDBSubnetGroup
. Must not be default. Example:mySubnetgroup
deletion_protection (
Union
[bool
,IResolvable
,None
]) – Protects clusters from being accidentally deleted. If enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.enable_cloudwatch_logs_exports (
Optional
[Sequence
[str
]]) – 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 .engine_version (
Optional
[str
]) – 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.kms_key_id (
Optional
[str
]) – 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 inKmsKeyId
: - If theStorageEncrypted
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 .master_username (
Optional
[str
]) – 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.master_user_password (
Optional
[str
]) – 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.port (
Union
[int
,float
,None
]) – Specifies the port that the database engine is listening on.preferred_backup_window (
Optional
[str
]) – 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 formathh24:mi-hh24:mi
. - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes.preferred_maintenance_window (
Optional
[str
]) – 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.restore_to_time (
Optional
[str
]) – 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 theUseLatestRestorableTime
parameter is not provided. - Cannot be specified if theUseLatestRestorableTime
parameter istrue
. - Cannot be specified if theRestoreType
parameter iscopy-on-write
. Example:2015-03-07T23:45:00Z
restore_type (
Optional
[str
]) – 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 specifycopy-on-write
if the engine version of the source DB cluster is earlier than 1.11. If you don’t specify aRestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.snapshot_identifier (
Optional
[str
]) – 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.source_db_cluster_identifier (
Optional
[str
]) – The identifier of the source cluster from which to restore. Constraints: - Must match the identifier of an existingDBCluster
.storage_encrypted (
Union
[bool
,IResolvable
,None
]) – Specifies whether the cluster is encrypted.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags to be assigned to the cluster.use_latest_restorable_time (
Union
[bool
,IResolvable
,None
]) – 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 theRestoreToTime
parameter is provided.vpc_security_group_ids (
Optional
[Sequence
[str
]]) – A list of EC2 VPC security groups to associate with this cluster.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_docdb as docdb cfn_dBCluster_props = docdb.CfnDBClusterProps( availability_zones=["availabilityZones"], backup_retention_period=123, copy_tags_to_snapshot=False, db_cluster_identifier="dbClusterIdentifier", db_cluster_parameter_group_name="dbClusterParameterGroupName", db_subnet_group_name="dbSubnetGroupName", deletion_protection=False, enable_cloudwatch_logs_exports=["enableCloudwatchLogsExports"], engine_version="engineVersion", kms_key_id="kmsKeyId", master_username="masterUsername", master_user_password="masterUserPassword", port=123, preferred_backup_window="preferredBackupWindow", preferred_maintenance_window="preferredMaintenanceWindow", restore_to_time="restoreToTime", restore_type="restoreType", snapshot_identifier="snapshotIdentifier", source_db_cluster_identifier="sourceDbClusterIdentifier", storage_encrypted=False, tags=[CfnTag( key="key", value="value" )], use_latest_restorable_time=False, vpc_security_group_ids=["vpcSecurityGroupIds"] )
Attributes
- availability_zones
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
- backup_retention_period
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.
- copy_tags_to_snapshot
AWS::DocDB::DBCluster.CopyTagsToSnapshot
.
- db_cluster_identifier
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
- db_cluster_parameter_group_name
The name of the cluster parameter group to associate with this cluster.
- db_subnet_group_name
A subnet group to associate with this cluster.
Constraints: Must match the name of an existing
DBSubnetGroup
. Must not be default.Example:
mySubnetgroup
- deletion_protection
Protects clusters from being accidentally deleted.
If enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled.
- enable_cloudwatch_logs_exports
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 .
- engine_version
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.
- kms_key_id
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 .
- master_user_password
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.
- master_username
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.
- port
Specifies the port that the database engine is listening on.
- preferred_backup_window
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
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.
- preferred_maintenance_window
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.
- restore_to_time
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
- restore_type
.
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.- Link
- Type
The type of restore to be performed. You can specify one of the following values
- snapshot_identifier
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.
- source_db_cluster_identifier
The identifier of the source cluster from which to restore.
Constraints:
Must match the identifier of an existing
DBCluster
.
- storage_encrypted
Specifies whether the cluster is encrypted.
- tags
The tags to be assigned to the cluster.
- use_latest_restorable_time
A value that is set to
true
to restore the cluster to the latest restorable backup time, andfalse
otherwise.Default:
false
Constraints: Cannot be specified if the
RestoreToTime
parameter is provided.
- vpc_security_group_ids
A list of EC2 VPC security groups to associate with this cluster.