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, manage_master_user_password=None, master_username=None, master_user_password=None, master_user_secret_kms_key_id=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, restore_to_time=None, restore_type=None, rotate_master_user_password=None, serverless_v2_scaling_configuration=None, snapshot_identifier=None, source_db_cluster_identifier=None, storage_encrypted=None, storage_type=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]) – Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false . The default is false .
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 existing DBSubnetGroup . 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 and DeletionProtection 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. Changing the EngineVersion will start an in-place engine version upgrade. Note that in-place engine version upgrade will cause downtime in the cluster. See Amazon DocumentDB in-place major version upgrade before starting an in-place engine version upgrade.
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 in KmsKeyId : - If the 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 .
manage_master_user_password (Union[bool, IResolvable, None]) – Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. Constraint: You can’t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
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.
master_user_secret_kms_key_id (Optional[str]) – The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If you don’t specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
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 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 (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 the UseLatestRestorableTime parameter is not provided. - Cannot be specified if the UseLatestRestorableTime parameter is true . - Cannot be specified if the RestoreType parameter is copy-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 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.
rotate_master_user_password (Union[bool, IResolvable, None]) – Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password. Constraint: You must apply the change immediately when rotating the master user password.
serverless_v2_scaling_configuration (Union[IResolvable, ServerlessV2ScalingConfigurationProperty, Dict[str, Any], None]) –
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 existing DBCluster .
storage_encrypted (Union[bool, IResolvable, None]) – Specifies whether the cluster is encrypted. If you specify SourceDBClusterIdentifier or SnapshotIdentifier and don’t specify StorageEncrypted , the encryption property is inherited from the source cluster or snapshot (unless KMSKeyId is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and StorageEncrypted is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the KMSKeyId property as well). If the source is unencrypted and StorageEncrypted is specified to be true, then the KMSKeyId property must be specified. If the source is encrypted, don’t specify StorageEncrypted to be false as opting out of encryption is not allowed.
storage_type (Optional[str]) – 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 .. epigraph:: 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 to standard .
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 to true to restore the cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be specified if the RestoreToTime parameter is provided.
vpc_security_group_ids (Optional[Sequence[str]]) – A list of EC2 VPC security groups to associate with this cluster.

See:

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.
from aws_cdk import 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",
    manage_master_user_password=False,
    master_username="masterUsername",
    master_user_password="masterUserPassword",
    master_user_secret_kms_key_id="masterUserSecretKmsKeyId",
    port=123,
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    restore_to_time="restoreToTime",
    restore_type="restoreType",
    rotate_master_user_password=False,
    serverless_v2_scaling_configuration=docdb.CfnDBCluster.ServerlessV2ScalingConfigurationProperty(
        max_capacity=123,
        min_capacity=123
    ),
    snapshot_identifier="snapshotIdentifier",
    source_db_cluster_identifier="sourceDbClusterIdentifier",
    storage_encrypted=False,
    storage_type="storageType",
    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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-availabilityzones

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-backupretentionperiod

copy_tags_to_snapshot

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false .

The default is false .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusteridentifier

db_cluster_parameter_group_name

The name of the cluster parameter group to associate with this cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusterparametergroupname

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbsubnetgroupname

deletion_protection

Protects clusters from being accidentally deleted.

If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-deletionprotection

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-enablecloudwatchlogsexports

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.

Changing the EngineVersion will start an in-place engine version upgrade. Note that in-place engine version upgrade will cause downtime in the cluster. See Amazon DocumentDB in-place major version upgrade before starting an in-place engine version upgrade.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-engineversion

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 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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-kmskeyid

manage_master_user_password

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

Constraint: You can’t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-managemasteruserpassword

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masteruserpassword

master_user_secret_kms_key_id

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don’t specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusersecretkmskeyid

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusername

port

Specifies the port that the database engine is listening on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-port

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredbackupwindow

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredmaintenancewindow

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 is true .
Cannot be specified if the RestoreType parameter is copy-on-write .

Example: 2015-03-07T23:45:00Z

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretotime

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretype
Type:: The type of restore to be performed. You can specify one of the following values

rotate_master_user_password

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.

Constraint: You must apply the change immediately when rotating the master user password.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-rotatemasteruserpassword

serverless_v2_scaling_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration

Type:: see

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-snapshotidentifier

source_db_cluster_identifier

The identifier of the source cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-sourcedbclusteridentifier

storage_encrypted

Specifies whether the cluster is encrypted.

If you specify SourceDBClusterIdentifier or SnapshotIdentifier and don’t specify StorageEncrypted , the encryption property is inherited from the source cluster or snapshot (unless KMSKeyId is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and StorageEncrypted is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the KMSKeyId property as well). If the source is unencrypted and StorageEncrypted is specified to be true, then the KMSKeyId property must be specified. If the source is encrypted, don’t specify StorageEncrypted to be false as opting out of encryption is not allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted

storage_type

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 .. epigraph:

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 to ``standard`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storagetype

tags

The tags to be assigned to the cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-tags

use_latest_restorable_time

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-uselatestrestorabletime

vpc_security_group_ids

A list of EC2 VPC security groups to associate with this cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-vpcsecuritygroupids