RDS / Client / disable_http_endpoint

disable_http_endpoint#

RDS.Client.disable_http_endpoint(**kwargs)#

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 PostgreSQL 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.

See also: AWS API Documentation

Request Syntax

response = client.disable_http_endpoint(
    ResourceArn='string'
)
Parameters:

ResourceArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ResourceArn': 'string',
    'HttpEndpointEnabled': True|False
}

Response Structure

  • (dict) –

    • ResourceArn (string) –

      The ARN of the DB cluster.

    • HttpEndpointEnabled (boolean) –

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

Exceptions