Skip to main content

aws.apigateway.stage

Supported Platform

  • aws

Description

Amazon API Gateway REST API resource provides an object representing an individual stage configured on an API Gateway

The aws.apigateway.stage resource provides fields representing an individual stage configured on a REST API. For usage see the aws.apigateway resource documentation.

Fields

IDTYPEDESCRIPTION
arnstringARN for the rest api stage
namestringname for the stage
tracingEnabledboolbool that denotes if tracing is enabled for the stage
descriptionstringdescription for the stage
deploymentIdstringid of the deployment the stage is attached to
methodSettingsdictmethod settings for the stage

Examples

Return a list of AWS API Gateway REST APIs configured across all enabled regions in the AWS account and the values for the arn and stages

aws.apigateway.restApis {
arn
stages
}