CfnDBClusterPropsMixin

class aws_cdk.mixins_preview.aws_docdb.mixins.CfnDBClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::DocDB::DBCluster Amazon 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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html
CloudformationResource:: AWS::DocDB::DBCluster
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_docdb import mixins as docdb_mixins

cfn_dBCluster_props_mixin = docdb_mixins.CfnDBClusterPropsMixin(docdb_mixins.CfnDBClusterMixinProps(
    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",
    global_cluster_identifier="globalClusterIdentifier",
    kms_key_id="kmsKeyId",
    manage_master_user_password=False,
    master_username="masterUsername",
    master_user_password="masterUserPassword",
    master_user_secret_kms_key_id="masterUserSecretKmsKeyId",
    network_type="networkType",
    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_mixins.CfnDBClusterPropsMixin.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"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DocDB::DBCluster.

Parameters:

props (Union[CfnDBClusterMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['availabilityZones', 'backupRetentionPeriod', 'copyTagsToSnapshot', 'dbClusterIdentifier', 'dbClusterParameterGroupName', 'dbSubnetGroupName', 'deletionProtection', 'enableCloudwatchLogsExports', 'engineVersion', 'globalClusterIdentifier', 'kmsKeyId', 'manageMasterUserPassword', 'masterUsername', 'masterUserPassword', 'masterUserSecretKmsKeyId', 'networkType', 'port', 'preferredBackupWindow', 'preferredMaintenanceWindow', 'restoreToTime', 'restoreType', 'rotateMasterUserPassword', 'serverlessV2ScalingConfiguration', 'snapshotIdentifier', 'sourceDbClusterIdentifier', 'storageEncrypted', 'storageType', 'tags', 'useLatestRestorableTime', 'vpcSecurityGroupIds']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ServerlessV2ScalingConfigurationProperty

class CfnDBClusterPropsMixin.ServerlessV2ScalingConfigurationProperty(*, max_capacity=None, min_capacity=None)

Bases: object

Sets the scaling configuration of an Amazon DocumentDB Serverless cluster.

Parameters:

max_capacity (Union[int, float, None]) – The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
min_capacity (Union[int, float, None]) – The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration.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.mixins_preview.aws_docdb import mixins as docdb_mixins

serverless_v2_scaling_configuration_property = docdb_mixins.CfnDBClusterPropsMixin.ServerlessV2ScalingConfigurationProperty(
    max_capacity=123,
    min_capacity=123
)

Attributes

max_capacity

The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.

You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.

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

min_capacity

The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.

You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

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