aws::api-gateway-stage¶

Create a stage.

Example¶

aws::api-gateway-stage example-stage
    api: $(aws::api example-api)
    name: example-stage
    description: "example-desc"
    auto-deploy: false

    default-route-settings
        detailed-metrics-enabled: true
        throttling-burst-limit: 2
        throttling-rate-limit: 2
    end

    route-settings
        key: 'ANY /api/example/route'
        detailed-metrics-enabled: true
        throttling-burst-limit: 2
        throttling-rate-limit: 2
    end

    stage-variables: {
        "exampleKey": "exampleValue"
    }

    tags: {
        "example-key": "example-value"
    }
end

Attributes¶

Attribute	Description
name	The name of the stage. (Required)
access-log-settings subresource	The settings for logging access in this stage. destination-arn The ARN of the CloudWatch Logs log group to receive access logs. (Required) format The format of the access logs of data. (Required)
api	The API associated with the stage. (Required)
auto-deploy	When set to `true`, updates to an API automatically trigger a new deployment.
client-certificate-id	The ID of a client certificate for a Stage.
default-route-settings subresource	The default route settings for the stage. key The route key for which the configure the settings. data-trace-enabled When set to `true`, the data trace logging is enabled for this route. detailed-metrics-enabled When set to `true`, the detailed metrics are enabled. logging-level The logging level for this route. Valid values are `ERROR`, `INFO` or `OFF`. throttling-burst-limit The throttling burst limit of the route. throttling-rate-limit The throttling rate limit of the route.
deployment	The deployment of the stage.
description	The description for the stage.
route-settings list subresource	The route settings (by routeKey) for the stage. key The route key for which the configure the settings. data-trace-enabled When set to `true`, the data trace logging is enabled for this route. detailed-metrics-enabled When set to `true`, the detailed metrics are enabled. logging-level The logging level for this route. Valid values are `ERROR`, `INFO` or `OFF`. throttling-burst-limit The throttling burst limit of the route. throttling-rate-limit The throttling rate limit of the route.
stage-variables map	The stage variables for a Stage.
tags map	The list of tags for the stage.

Outputs¶

Attribute	Description
arn	The ARN of the stage.