stage

Gets an individual stage resource

Overview

Name	stage
Type	Resource
Description	stage
Id	awscc.apigateway.stage

Fields

Name	Datatype	Description
access_log_setting	object	Access log settings, including the access log format and access log destination ARN.
cache_cluster_enabled	boolean	Specifies whether a cache cluster is enabled for the stage.
cache_cluster_size	string	The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
canary_setting	object	Settings for the canary deployment in this stage.
client_certificate_id	string	The identifier of a client certificate for an API stage.
deployment_id	string	The identifier of the Deployment that the stage points to.
description	string	The stage's description.
documentation_version	string	The version of the associated API documentation.
method_settings	array	A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\*/\*`` for overriding all methods in the stage.
rest_api_id	string	The string identifier of the associated RestApi.
stage_name	string	The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags	array	The collection of tags. Each tag element is associated with a given resource.
tracing_enabled	boolean	Specifies whether active tracing with X-ray is enabled for the Stage.
variables	object	A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
access_log_setting,
cache_cluster_enabled,
cache_cluster_size,
canary_setting,
client_certificate_id,
deployment_id,
description,
documentation_version,
method_settings,
rest_api_id,
stage_name,
tags,
tracing_enabled,
variables
FROM awscc.apigateway.stage
WHERE data__Identifier = '<RestApiId>|<StageName>';

Permissions

To operate on the stage resource, the following permissions are required:

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PATCH,
apigateway:PUT,
apigateway:DELETE

Delete

apigateway:DELETE