Skip to content

RDS  >  Operations  >  enable_http_endpoint

enable_http_endpoint

Operation

enable_http_endpoint async 

enable_http_endpoint(input: EnableHttpEndpointInput, plugins: list[Plugin] | None = None) -> EnableHttpEndpointOutput

Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.

When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

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 enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.

Parameters:

Name Type Description Default
input EnableHttpEndpointInput

An instance of EnableHttpEndpointInput.

 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
EnableHttpEndpointOutput

An instance of EnableHttpEndpointOutput.

Input

EnableHttpEndpointInput dataclass

Bases: _SerdeShape

Dataclass for EnableHttpEndpointInput structure.

Attributes

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

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

Output

EnableHttpEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for EnableHttpEndpointOutput 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.