Amazon Relational Database Service

2023/12/21 - Amazon Relational Database Service - 2 new api methods

Changes  This release adds support for using RDS Data API with Aurora PostgreSQL Serverless v2 and provisioned DB clusters.

DisableHttpEndpoint (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.disable_http_endpoint(
    ResourceArn='string'
)
type ResourceArn:

string

param ResourceArn:

[REQUIRED]

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

rtype:

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.

EnableHttpEndpoint (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.enable_http_endpoint(
    ResourceArn='string'
)
type ResourceArn:

string

param ResourceArn:

[REQUIRED]

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

rtype:

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.