latest--aws-apigateway-deployment
sharedResource Type definition for AWS::ApiGateway::Deployment. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway
Properties
The ID of the RestApi resource to deploy.
3 nested properties
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. Duplicates are not allowed.
Whether the canary deployment uses the stage cache.
A description of the purpose of the API Gateway deployment.
19 nested properties
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-.
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
Indicates whether cache clustering is enabled for the stage.
The size of the stage's cache cluster.
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
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.
3 nested properties
The percent (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 identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
A description of the purpose of the stage.
The version identifier of the API documentation snapshot.
The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
An array of arbitrary tags (key-value pairs) to associate with the stage.
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.
Specifies whether active tracing with X-ray is enabled for this stage.
A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
Definitions
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-.
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
Indicates whether cache clustering is enabled for the stage.
The size of the stage's cache cluster.
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
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.
3 nested properties
The percent (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 identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
A description of the purpose of the stage.
The version identifier of the API documentation snapshot.
The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
An array of arbitrary tags (key-value pairs) to associate with the stage.
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.
Specifies whether active tracing with X-ray is enabled for this stage.
A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
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. Duplicates are not allowed.
Whether the canary deployment uses the stage cache.
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-.
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
The percent (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 key name of the tag
The value for the tag
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.
The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.
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.