DisableHttpEndpoint - Amazon Relational Database Service

DisableHttpEndpoint

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.

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: