Skip to content

disable_http_endpoint

disable_http_endpoint(
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    resource_arn: Optional[String] = None,
) -> DisableHttpEndpointResponse

Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.

For more information, see Using RDS Data API in the Amazon Aurora User Guide.

This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.

Parameters:

  • resource_arn (Optional[String], default: None ) –

    The Amazon Resource Name (ARN) of the DB cluster.

Raises:

Source code in docs_src/capo_rds/_services/rds.py
def disable_http_endpoint(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    resource_arn: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.disable_http_endpoint_response.DisableHttpEndpointResponse":
    """<p>Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using RDS Data API</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the <code>EnableHttpEndpoint</code> parameter of the <code>ModifyDBCluster</code> operation.</p> </note>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) of the DB cluster.</p>

    Raises:
        capo_rds.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The operation can't be performed because another operation is in progress.</p>
        capo_rds.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The specified resource ID was not found.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.disable_http_endpoint_request.DisableHttpEndpointRequest]",
    ) -> OperationResponse[
        "capo_rds.types.disable_http_endpoint_response.DisableHttpEndpointResponse"
    ]:
        import capo_rds._operations.amazon_rd_sv19.disable_http_endpoint

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisableHttpEndpoint")
    )
    input_: capo_rds.types.disable_http_endpoint_request.DisableHttpEndpointRequest = {}
    if resource_arn is not None:
        input_["resource_arn"] = resource_arn

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