create_db_subnet_group ¶

def create_db_subnet_group(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    db_subnet_group_name: Optional["capo_docdb.types.string.String"] = None,
    db_subnet_group_description: Optional["capo_docdb.types.string.String"] = None,
    subnet_ids: Optional[
        "capo_docdb.types.subnet_identifier_list.SubnetIdentifierList"
    ] = None,
    tags: Optional["capo_docdb.types.tag_list.TagList"] = None,
) -> "capo_docdb.types.create_db_subnet_group_result.CreateDBSubnetGroupResult":
    """<p>Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.</p>

    Args:
        db_subnet_group_name: <p>The name for the subnet group. This value is stored as a lowercase string.</p> <p>Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>
        db_subnet_group_description: <p>The description for the subnet group.</p>
        subnet_ids: <p>The Amazon EC2 subnet IDs for the subnet group.</p>
        tags: <p>The tags to be assigned to the subnet group.</p>

    Raises:
        capo_docdb.errors.db_subnet_group_already_exists_fault.DBSubnetGroupAlreadyExistsFault: <p> <code>DBSubnetGroupName</code> is already being used by an existing subnet group. </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_quota_exceeded_fault.DBSubnetGroupQuotaExceededFault: <p>The request would cause you to exceed the allowed number of subnet groups.</p>
        capo_docdb.errors.db_subnet_quota_exceeded_fault.DBSubnetQuotaExceededFault: <p>The request would cause you to exceed the allowed number of subnets in a subnet group.</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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_docdb.types.create_db_subnet_group_message.CreateDBSubnetGroupMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.create_db_subnet_group_result.CreateDBSubnetGroupResult"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.create_db_subnet_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDBSubnetGroup")
    )
    input_: capo_docdb.types.create_db_subnet_group_message.CreateDBSubnetGroupMessage = {}
    if db_subnet_group_name is not None:
        input_["db_subnet_group_name"] = db_subnet_group_name
    if db_subnet_group_description is not None:
        input_["db_subnet_group_description"] = db_subnet_group_description
    if subnet_ids is not None:
        input_["subnet_ids"] = subnet_ids
    if tags is not None:
        input_["tags"] = tags

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