create_db_cluster ¶

def create_db_cluster(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    availability_zones: Optional[
        "capo_docdb.types.availability_zones.AvailabilityZones"
    ] = None,
    backup_retention_period: Optional[
        "capo_docdb.types.integer_optional.IntegerOptional"
    ] = None,
    db_cluster_identifier: Optional["capo_docdb.types.string.String"] = None,
    db_cluster_parameter_group_name: Optional[
        "capo_docdb.types.string.String"
    ] = None,
    vpc_security_group_ids: Optional[
        "capo_docdb.types.vpc_security_group_id_list.VpcSecurityGroupIdList"
    ] = None,
    db_subnet_group_name: Optional["capo_docdb.types.string.String"] = None,
    engine: Optional["capo_docdb.types.string.String"] = None,
    engine_version: Optional["capo_docdb.types.string.String"] = None,
    port: Optional["capo_docdb.types.integer_optional.IntegerOptional"] = None,
    master_username: Optional["capo_docdb.types.string.String"] = None,
    master_user_password: Optional["capo_docdb.types.string.String"] = None,
    preferred_backup_window: Optional["capo_docdb.types.string.String"] = None,
    preferred_maintenance_window: Optional["capo_docdb.types.string.String"] = None,
    tags: Optional["capo_docdb.types.tag_list.TagList"] = None,
    storage_encrypted: Optional[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ] = None,
    kms_key_id: Optional["capo_docdb.types.string.String"] = None,
    pre_signed_url: Optional["capo_docdb.types.string.String"] = None,
    enable_cloudwatch_logs_exports: Optional[
        "capo_docdb.types.log_type_list.LogTypeList"
    ] = None,
    deletion_protection: Optional[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ] = None,
    global_cluster_identifier: Optional[
        "capo_docdb.types.global_cluster_identifier.GlobalClusterIdentifier"
    ] = None,
    storage_type: Optional["capo_docdb.types.string.String"] = None,
    serverless_v2_scaling_configuration: Optional[
        "capo_docdb.types.serverless_v2_scaling_configuration.ServerlessV2ScalingConfiguration"
    ] = None,
    manage_master_user_password: Optional[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ] = None,
    master_user_secret_kms_key_id: Optional[
        "capo_docdb.types.string.String"
    ] = None,
    network_type: Optional["capo_docdb.types.string.String"] = None,
    copy_tags_to_snapshot: Optional[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "capo_docdb.types.create_db_cluster_result.CreateDBClusterResult":
    """<p>Creates a new Amazon DocumentDB cluster.</p>

    Args:
        availability_zones: <p>A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.</p>
        backup_retention_period: <p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p> <p>Default: 1</p> <p>Constraints:</p> <ul> <li> <p>Must be a value from 1 to 35.</p> </li> </ul>
        db_cluster_identifier: <p>The cluster identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens. </p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens. </p> </li> </ul> <p>Example: <code>my-cluster</code> </p>
        db_cluster_parameter_group_name: <p>The name of the cluster parameter group to associate with this cluster.</p>
        vpc_security_group_ids: <p>A list of EC2 VPC security groups to associate with this cluster. </p>
        db_subnet_group_name: <p>A subnet group to associate with this cluster.</p> <p>Constraints: Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>
        engine: <p>The name of the database engine to be used for this cluster.</p> <p>Valid values: <code>docdb</code> </p>
        engine_version: <p>The version number of the database engine to use. The <code>--engine-version</code> will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.</p>
        port: <p>The port number on which the instances in the cluster accept connections.</p>
        master_username: <p>The name of the master user for the cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 63 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot be a reserved word for the chosen database engine. </p> </li> </ul>
        master_user_password: <p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p> <p>Constraints: Must contain from 8 to 100 characters.</p>
        preferred_backup_window: <p>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window. </p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>
        preferred_maintenance_window: <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.</p> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Minimum 30-minute window.</p>
        tags: <p>The tags to be assigned to the cluster.</p>
        storage_encrypted: <p>Specifies whether the cluster is encrypted.</p>
        kms_key_id: <p>The KMS key identifier for an encrypted cluster.</p> <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.</p> <p>If an encryption key is not specified in <code>KmsKeyId</code>: </p> <ul> <li> <p>If the <code>StorageEncrypted</code> parameter is <code>true</code>, Amazon DocumentDB uses your default encryption key. </p> </li> </ul> <p>KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.</p>
        pre_signed_url: <p>Not currently supported. </p>
        enable_cloudwatch_logs_exports: <p>A 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 <a href="https://docs.aws.amazon.com/documentdb/latest/devguide/event-auditing.html"> Auditing Amazon DocumentDB Events</a> and <a href="https://docs.aws.amazon.com/documentdb/latest/devguide/profiling.html"> Profiling Amazon DocumentDB Operations</a>. </p>
        deletion_protection: <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>
        global_cluster_identifier: <p>The cluster identifier of the new global cluster.</p>
        storage_type: <p>The storage type to associate with the DB cluster.</p> <p>For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p> <p>Valid values for storage type - <code>standard | iopt1</code> </p> <p>Default value is <code>standard </code> </p> <note> <p>When you create an Amazon DocumentDB cluster with the storage type set to <code>iopt1</code>, the storage type is returned in the response. The storage type isn't returned when you set it to <code>standard</code>.</p> </note>
        serverless_v2_scaling_configuration: <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
        manage_master_user_password: <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.</p> <p>Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if <code>MasterUserPassword</code> is specified.</p>
        master_user_secret_kms_key_id: <p>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.</p> <p>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.</p> <p>If you don't specify <code>MasterUserSecretKmsKeyId</code>, then the <code>aws/secretsmanager</code> 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 <code>aws/secretsmanager</code> KMS key to encrypt the secret, and you must use a customer managed KMS key.</p> <p>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.</p>
        network_type: <p>The network type of the cluster.</p> <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the cluster. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p> <p>For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/devguide/vpc-clusters.html">DocumentDB clusters in a VPC</a> in the Amazon DocumentDB Developer Guide.</p> <p>Valid Values: <code>IPV4</code> | <code>DUAL</code> </p>
        copy_tags_to_snapshot: <p>Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.</p>

    Raises:
        capo_docdb.errors.db_cluster_already_exists_fault.DBClusterAlreadyExistsFault: <p>You already have a cluster with the given identifier.</p>
        capo_docdb.errors.db_cluster_not_found_fault.DBClusterNotFoundFault: <p> <code>DBClusterIdentifier</code> doesn't refer to an existing cluster. </p>
        capo_docdb.errors.db_cluster_parameter_group_not_found_fault.DBClusterParameterGroupNotFoundFault: <p> <code>DBClusterParameterGroupName</code> doesn't refer to an existing cluster parameter group. </p>
        capo_docdb.errors.db_cluster_quota_exceeded_fault.DBClusterQuotaExceededFault: <p>The cluster can't be created because you have reached the maximum allowed quota of clusters.</p>
        capo_docdb.errors.db_instance_not_found_fault.DBInstanceNotFoundFault: <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing instance. </p>
        capo_docdb.errors.db_subnet_group_does_not_cover_enough_a_zs.DBSubnetGroupDoesNotCoverEnoughAZs: <p>Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.</p>
        capo_docdb.errors.db_subnet_group_not_found_fault.DBSubnetGroupNotFoundFault: <p> <code>DBSubnetGroupName</code> doesn't refer to an existing subnet group. </p>
        capo_docdb.errors.global_cluster_not_found_fault.GlobalClusterNotFoundFault: <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global cluster.</p>
        capo_docdb.errors.insufficient_storage_cluster_capacity_fault.InsufficientStorageClusterCapacityFault: <p>There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. </p>
        capo_docdb.errors.invalid_db_cluster_state_fault.InvalidDBClusterStateFault: <p>The cluster isn't in a valid state.</p>
        capo_docdb.errors.invalid_db_instance_state_fault.InvalidDBInstanceStateFault: <p> The specified instance isn't in the <i>available</i> state. </p>
        capo_docdb.errors.invalid_db_subnet_group_state_fault.InvalidDBSubnetGroupStateFault: <p>The subnet group can't be deleted because it's in use.</p>
        capo_docdb.errors.invalid_global_cluster_state_fault.InvalidGlobalClusterStateFault: <p>The requested operation can't be performed while the cluster is in this state.</p>
        capo_docdb.errors.invalid_subnet.InvalidSubnet: <p>The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).</p>
        capo_docdb.errors.invalid_vpc_network_state_fault.InvalidVPCNetworkStateFault: <p>The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.</p>
        capo_docdb.errors.kms_key_not_accessible_fault.KMSKeyNotAccessibleFault: <p>An error occurred when accessing an KMS key.</p>
        capo_docdb.errors.network_type_not_supported.NetworkTypeNotSupported: <p>The network type is not supported by either <code>DBSubnetGroup</code> or the DB engine version.</p>
        capo_docdb.errors.storage_quota_exceeded_fault.StorageQuotaExceededFault: <p>The request would cause you to exceed the allowed amount of storage available across all instances.</p>
        capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_docdb.types.create_db_cluster_message.CreateDBClusterMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.create_db_cluster_result.CreateDBClusterResult"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.create_db_cluster

        output, http_response = (
            capo_docdb._operations.amazon_rd_sv19.create_db_cluster.create_db_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDBCluster")
    )
    input_: capo_docdb.types.create_db_cluster_message.CreateDBClusterMessage = {}
    if availability_zones is not None:
        input_["availability_zones"] = availability_zones
    if backup_retention_period is not None:
        input_["backup_retention_period"] = backup_retention_period
    if db_cluster_identifier is not None:
        input_["db_cluster_identifier"] = db_cluster_identifier
    if db_cluster_parameter_group_name is not None:
        input_["db_cluster_parameter_group_name"] = db_cluster_parameter_group_name
    if vpc_security_group_ids is not None:
        input_["vpc_security_group_ids"] = vpc_security_group_ids
    if db_subnet_group_name is not None:
        input_["db_subnet_group_name"] = db_subnet_group_name
    if engine is not None:
        input_["engine"] = engine
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if port is not None:
        input_["port"] = port
    if master_username is not None:
        input_["master_username"] = master_username
    if master_user_password is not None:
        input_["master_user_password"] = master_user_password
    if preferred_backup_window is not None:
        input_["preferred_backup_window"] = preferred_backup_window
    if preferred_maintenance_window is not None:
        input_["preferred_maintenance_window"] = preferred_maintenance_window
    if tags is not None:
        input_["tags"] = tags
    if storage_encrypted is not None:
        input_["storage_encrypted"] = storage_encrypted
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if pre_signed_url is not None:
        input_["pre_signed_url"] = pre_signed_url
    if enable_cloudwatch_logs_exports is not None:
        input_["enable_cloudwatch_logs_exports"] = enable_cloudwatch_logs_exports
    if deletion_protection is not None:
        input_["deletion_protection"] = deletion_protection
    if global_cluster_identifier is not None:
        input_["global_cluster_identifier"] = global_cluster_identifier
    if storage_type is not None:
        input_["storage_type"] = storage_type
    if serverless_v2_scaling_configuration is not None:
        input_["serverless_v2_scaling_configuration"] = (
            serverless_v2_scaling_configuration
        )
    if manage_master_user_password is not None:
        input_["manage_master_user_password"] = manage_master_user_password
    if master_user_secret_kms_key_id is not None:
        input_["master_user_secret_kms_key_id"] = master_user_secret_kms_key_id
    if network_type is not None:
        input_["network_type"] = network_type
    if copy_tags_to_snapshot is not None:
        input_["copy_tags_to_snapshot"] = copy_tags_to_snapshot

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output