destroyApiGateway

Exports an async function that tears down the API Gateway.

Source:

(require("destroyApiGateway"))(region, apiName)

Source:

Exports destroyApiGateway

Parameters:
Name Type Description
region String

This is the region of where this AWS service is deployed.

apiName String

This is the name of the API Gateway

Methods

(async, inner) destroyRestApi(apiGateway, restApiId)

Source:

Tear down the API Gateway

Parameters:
Name Type Description
apiGateway APIGatewayClient

This is the API Gateway client.

restApiId String

This is the API Gateway ID.

Throws:

Will throw an error if API Gateway fails to execute its command

(async, inner) getApiId(apiGateway, apiName) → {Number}

Source:

Retrieves the API Gateway ID

Parameters:
Name Type Description
apiGateway APIGatewayClient

This is the API Gateway client.

apiName String

This is the name of the API Gateway

Throws:

Will throw an error if API Gateway fails to execute its command

Returns:

This is the API Gateway ID

Type
Number