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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ResourceArn
-
The Amazon Resource Name (ARN) of the DB cluster.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- HttpEndpointEnabled
-
Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.
Type: Boolean
- ResourceArn
-
The ARN of the DB cluster.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidResourceStateFault
-
The operation can't be performed because another operation is in progress.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The specified resource ID was not found.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
