CfnDBCluster
- class aws_cdk.aws_docdb.CfnDBCluster(scope, id, *, 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:
CfnResourceA CloudFormation
AWS::DocDB::DBCluster.The
AWS::DocDB::DBClusterAmazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster. Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster in the Amazon DocumentDB Developer Guide .- CloudformationResource:
AWS::DocDB::DBCluster
- 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 = docdb.CfnDBCluster(self, "MyCfnDBCluster", 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"] )
Create a new
AWS::DocDB::DBCluster.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
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-clusterdb_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:mySubnetgroupdeletion_protection (
Union[bool,IResolvable,None]) – Protects clusters from being accidentally deleted. If enabled, the cluster cannot be deleted unless it is modified andDeletionProtectionis 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-versionwill 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 theStorageEncryptedparameter 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 theBackupRetentionPeriodparameter. 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:miThe 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]) –AWS::DocDB::DBCluster.RestoreToTime.restore_type (
Optional[str]) –AWS::DocDB::DBCluster.RestoreType.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]) –AWS::DocDB::DBCluster.SourceDBClusterIdentifier.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]) –AWS::DocDB::DBCluster.UseLatestRestorableTime.vpc_security_group_ids (
Optional[Sequence[str]]) – A list of EC2 VPC security groups to associate with this cluster.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::DocDB::DBCluster'
- attr_cluster_resource_id
The resource id for the cluster;
for example:
cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.- CloudformationAttribute:
ClusterResourceId
- attr_endpoint
The connection endpoint for the cluster, such as
sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com.- CloudformationAttribute:
Endpoint
- attr_port
The port number on which the cluster accepts connections.
For example:
27017.- CloudformationAttribute:
Port
- attr_read_endpoint
The reader endpoint for the cluster.
For example:
sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com.- CloudformationAttribute:
ReadEndpoint
- 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.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- copy_tags_to_snapshot
AWS::DocDB::DBCluster.CopyTagsToSnapshot.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- 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
DeletionProtectionis 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-versionwill 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
StorageEncryptedparameter 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 .
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- 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.
- node
The construct tree node associated with this construct.
- 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
BackupRetentionPeriodparameter.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:miThe 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.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- restore_to_time
AWS::DocDB::DBCluster.RestoreToTime.
- restore_type
AWS::DocDB::DBCluster.RestoreType.
- 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
AWS::DocDB::DBCluster.SourceDBClusterIdentifier.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- storage_encrypted
Specifies whether the cluster is encrypted.
- tags
The tags to be assigned to the cluster.
- use_latest_restorable_time
AWS::DocDB::DBCluster.UseLatestRestorableTime.
- vpc_security_group_ids
A list of EC2 VPC security groups to associate with this cluster.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool