Skip to content

RDS  >  Operations  >  disable_http_endpoint

disable_http_endpoint

Operation

disable_http_endpoint async 

disable_http_endpoint(input: DisableHttpEndpointInput, plugins: list[Plugin] | None = None) -> DisableHttpEndpointOutput

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.

Note

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:

Name Type Description Default
input DisableHttpEndpointInput

An instance of DisableHttpEndpointInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DisableHttpEndpointOutput

An instance of DisableHttpEndpointOutput.

Input

DisableHttpEndpointInput dataclass

Bases: _SerdeShape

Dataclass for DisableHttpEndpointInput structure.

Attributes

resource_arn class-attribute instance-attribute 
resource_arn: str | None = ...

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

Output

DisableHttpEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for DisableHttpEndpointOutput structure.

Attributes

http_endpoint_enabled class-attribute instance-attribute 
http_endpoint_enabled: bool | None = ...

Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.

resource_arn class-attribute instance-attribute 
resource_arn: str | None = ...

The ARN of the DB cluster.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.