Enable Http Endpoint

rds_enable_http_endpoint

R Documentation

Enables the HTTP endpoint for the DB cluster

Description

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.

This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the enable_http_endpoint parameter of the modify_db_cluster operation.

Usage

rds_enable_http_endpoint(ResourceArn)

Arguments

ResourceArn

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

Value

A list with the following syntax:

list(
  ResourceArn = "string",
  HttpEndpointEnabled = TRUE|FALSE
)

Request syntax

svc$enable_http_endpoint(
  ResourceArn = "string"
)