create_option_group ¶

def create_option_group(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    option_group_name: Optional["capo_rds.types.string.String"] = None,
    engine_name: Optional["capo_rds.types.string.String"] = None,
    major_engine_version: Optional["capo_rds.types.string.String"] = None,
    option_group_description: Optional["capo_rds.types.string.String"] = None,
    tags: Optional["capo_rds.types.tag_list.TagList"] = None,
) -> "capo_rds.types.create_option_group_result.CreateOptionGroupResult":
    """<p>Creates a new option group. You can create up to 20 option groups.</p> <p>This command doesn't apply to RDS Custom.</p>

    Args:
        option_group_name: <p>Specifies the name of the option group to be created.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>myoptiongroup</code> </p>
        engine_name: <p>The name of the engine to associate this option group with.</p> <p>Valid Values:</p> <ul> <li> <p> <code>db2-ae</code> </p> </li> <li> <p> <code>db2-ce</code> </p> </li> <li> <p> <code>db2-se</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>
        major_engine_version: <p>Specifies the major version of the engine that this option group should be associated with.</p>
        option_group_description: <p>The description of the option group.</p>
        tags: <p>Tags to assign to the option group.</p>

    Raises:
        capo_rds.errors.option_group_already_exists_fault.OptionGroupAlreadyExistsFault: <p>The option group you are trying to create already exists.</p>
        capo_rds.errors.option_group_quota_exceeded_fault.OptionGroupQuotaExceededFault: <p>The quota of 20 option groups was exceeded for this Amazon Web Services account.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To Create an Amazon RDS option group
        The following example creates a new Amazon RDS option group for Oracle MySQL version 8,0 named MyOptionGroup.

        >>> client.create_option_group(option_group_name='MyOptionGroup', engine_name='mysql', major_engine_version='8.0', option_group_description='MySQL 8.0 option group')
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.create_option_group_message.CreateOptionGroupMessage]",
    ) -> OperationResponse[
        "capo_rds.types.create_option_group_result.CreateOptionGroupResult"
    ]:
        import capo_rds._operations.amazon_rd_sv19.create_option_group

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.create_option_group.create_option_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_rds.types.create_option_group_result.CreateOptionGroupResult",
    ) -> dict[str, Any]:
        import capo_rds.types.create_option_group_result

        return capo_rds.types.create_option_group_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateOptionGroup", redact_output=_redact_output),
    )
    input_: capo_rds.types.create_option_group_message.CreateOptionGroupMessage = {}
    if option_group_name is not None:
        input_["option_group_name"] = option_group_name
    if engine_name is not None:
        input_["engine_name"] = engine_name
    if major_engine_version is not None:
        input_["major_engine_version"] = major_engine_version
    if option_group_description is not None:
        input_["option_group_description"] = option_group_description
    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