awscc.apigateway_stage¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - apigateway:DELETE
update¶
Parent base class for filters and actions.
definitions:
AccessLogSetting:
additionalProperties: false
description: Specifies settings for logging access in this stage.
properties:
DestinationArn:
description: 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.
type: string
Format:
description: 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.
type: string
type: object
CanarySetting:
additionalProperties: false
description: Specifies settings for the canary deployment in this stage.
properties:
DeploymentId:
description: The identifier of the deployment that the stage points to.
type: string
PercentTraffic:
description: The percentage (0-100) of traffic diverted to a canary deployment.
maximum: 100
minimum: 0
type: number
StageVariableOverrides:
additionalProperties: false
description: 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.
patternProperties:
'[a-zA-Z0-9]+':
type: string
type: object
UseStageCache:
description: Whether the canary deployment uses the stage cache or not.
type: boolean
type: object
MethodSetting:
additionalProperties: false
description: Configures settings for all methods in a stage.
properties:
CacheDataEncrypted:
description: Indicates whether the cached responses are encrypted.
type: boolean
CacheTtlInSeconds:
description: The time-to-live (TTL) period, in seconds, that specifies how
long API Gateway caches responses.
type: integer
CachingEnabled:
description: Indicates whether responses are cached and returned for requests.
You must enable a cache cluster on the stage to cache responses.
type: boolean
DataTraceEnabled:
description: Indicates whether data trace logging is enabled for methods in
the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
type: boolean
HttpMethod:
description: The HTTP method. You can use an asterisk (*) as a wildcard to
apply method settings to multiple methods.
type: string
LoggingLevel:
description: 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.
type: string
MetricsEnabled:
description: Indicates whether Amazon CloudWatch metrics are enabled for methods
in the stage.
type: boolean
ResourcePath:
description: 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.
type: string
ThrottlingBurstLimit:
description: The number of burst requests per second that API Gateway permits
across all APIs, stages, and methods in your AWS account.
minimum: 0
type: integer
ThrottlingRateLimit:
description: The number of steady-state requests per second that API Gateway
permits across all APIs, stages, and methods in your AWS account.
minimum: 0
type: number
type: object
Tag:
additionalProperties: false
description: Identify and categorize resources.
properties:
Key:
description: 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:.
maxLength: 128
minLength: 1
type: string
Value:
description: 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:.
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
properties:
AccessLogSetting:
additionalProperties: false
description: Specifies settings for logging access in this stage.
properties:
DestinationArn:
description: 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.
type: string
Format:
description: 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.
type: string
type: object
CacheClusterEnabled:
description: Indicates whether cache clustering is enabled for the stage.
type: boolean
CacheClusterSize:
description: The stage's cache cluster size.
type: string
CanarySetting:
additionalProperties: false
description: Specifies settings for the canary deployment in this stage.
properties:
DeploymentId:
description: The identifier of the deployment that the stage points to.
type: string
PercentTraffic:
description: The percentage (0-100) of traffic diverted to a canary deployment.
maximum: 100
minimum: 0
type: number
StageVariableOverrides:
additionalProperties: false
description: 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.
patternProperties:
'[a-zA-Z0-9]+':
type: string
type: object
UseStageCache:
description: Whether the canary deployment uses the stage cache or not.
type: boolean
type: object
ClientCertificateId:
description: 'The ID of the client certificate that API Gateway uses to call your
integration endpoints in the stage. '
type: string
DeploymentId:
description: 'The ID of the deployment that the stage is associated with. This
parameter is required to create a stage. '
type: string
Description:
description: A description of the stage.
type: string
DocumentationVersion:
description: The version ID of the API documentation snapshot.
type: string
MethodSettings:
description: Settings for all methods in the stage.
insertionOrder: false
items:
additionalProperties: false
description: Configures settings for all methods in a stage.
properties:
CacheDataEncrypted:
description: Indicates whether the cached responses are encrypted.
type: boolean
CacheTtlInSeconds:
description: The time-to-live (TTL) period, in seconds, that specifies how
long API Gateway caches responses.
type: integer
CachingEnabled:
description: Indicates whether responses are cached and returned for requests.
You must enable a cache cluster on the stage to cache responses.
type: boolean
DataTraceEnabled:
description: Indicates whether data trace logging is enabled for methods
in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
type: boolean
HttpMethod:
description: The HTTP method. You can use an asterisk (*) as a wildcard
to apply method settings to multiple methods.
type: string
LoggingLevel:
description: 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.
type: string
MetricsEnabled:
description: Indicates whether Amazon CloudWatch metrics are enabled for
methods in the stage.
type: boolean
ResourcePath:
description: 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.
type: string
ThrottlingBurstLimit:
description: The number of burst requests per second that API Gateway permits
across all APIs, stages, and methods in your AWS account.
minimum: 0
type: integer
ThrottlingRateLimit:
description: The number of steady-state requests per second that API Gateway
permits across all APIs, stages, and methods in your AWS account.
minimum: 0
type: number
type: object
type: array
uniqueItems: true
Tags:
description: An array of arbitrary tags (key-value pairs) to associate with the
stage.
insertionOrder: false
items:
additionalProperties: false
description: Identify and categorize resources.
properties:
Key:
description: 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:.
maxLength: 128
minLength: 1
type: string
Value:
description: 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:.
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
type: array
uniqueItems: false
TracingEnabled:
description: Specifies whether active X-Ray tracing is enabled for this stage.
type: boolean
Variables:
additionalProperties: false
description: 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.
patternProperties:
'[a-zA-Z0-9]+':
type: string
type: object
type:
enum:
- update
Permissions - apigateway:GET, apigateway:PATCH, apigateway:PUT, apigateway:DELETE