latest--aws-apigateway-stage
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-apigateway-stage.json |
| Parent schema | serverless-framework-configuration |
Resource Type definition for AWS::ApiGateway::Stage. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway
Properties
The ID of the RestApi resource that you're deploying with this stage.
Specifies settings for logging access in this stage.
2 nested properties
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. This parameter is required to enable access logging.
A single line format of the access logs of data, as specified by selected $context variables (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least $context.requestId. This parameter is required to enable access logging.
Indicates whether cache clustering is enabled for the stage.
The stage's cache cluster size.
Specifies settings for the canary deployment in this stage.
4 nested properties
The identifier of the deployment that the stage points to.
The percentage (0-100) of traffic diverted to a canary deployment.
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
Whether the canary deployment uses the stage cache or not.
The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
A description of the stage.
The version ID of the API documentation snapshot.
The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
An array of arbitrary tags (key-value pairs) to associate with the stage.
Specifies whether active X-Ray tracing is enabled for this stage.
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.
Definitions
Specifies settings for the canary deployment in this stage.
The identifier of the deployment that the stage points to.
The percentage (0-100) of traffic diverted to a canary deployment.
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
Whether the canary deployment uses the stage cache or not.
Specifies settings for logging access in this stage.
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. This parameter is required to enable access logging.
A single line format of the access logs of data, as specified by selected $context variables (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least $context.requestId. This parameter is required to enable access logging.
Configures settings for all methods in a stage.
Indicates whether the cached responses are encrypted.
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
Identify and categorize resources.
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:.
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.