Skip to main content

stage_tags

Expands all tag keys and values for stages in a region

Overview

Namestage_tags
TypeResource
DescriptionThe AWS::ApiGateway::Stage resource creates a stage for a deployment.
Idaws.apigateway.stage_tags

Fields

NameDatatypeDescription
access_log_settingobjectThe AccessLogSetting property type specifies settings for logging access in this stage.
AccessLogSetting is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.
cache_cluster_enabledboolean
cache_cluster_sizestring
canary_settingobject
client_certificate_idstring
deployment_idstring
descriptionstring
documentation_versionstring
method_settingsarray
rest_api_idstring
stage_namestring
tracing_enabledboolean
variablesobjectA 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-._~:/?#&=,]+.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all stages in a region.

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,
tracing_enabled,
variables,
tag_key,
tag_value
FROM aws.apigateway.stage_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the stage_tags resource, see stages