AWS Native
Stage
Resource Type definition for AWS::ApiGateway::Stage
Create a Stage Resource
new Stage(name: string, args: StageArgs, opts?: CustomResourceOptions);
@overload
def Stage(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_log_setting: Optional[StageAccessLogSettingArgs] = None,
cache_cluster_enabled: Optional[bool] = None,
cache_cluster_size: Optional[str] = None,
canary_setting: Optional[StageCanarySettingArgs] = None,
client_certificate_id: Optional[str] = None,
deployment_id: Optional[str] = None,
description: Optional[str] = None,
documentation_version: Optional[str] = None,
method_settings: Optional[Sequence[StageMethodSettingArgs]] = None,
rest_api_id: Optional[str] = None,
stage_name: Optional[str] = None,
tags: Optional[Sequence[StageTagArgs]] = None,
tracing_enabled: Optional[bool] = None,
variables: Optional[Any] = None)
@overload
def Stage(resource_name: str,
args: StageArgs,
opts: Optional[ResourceOptions] = None)
func NewStage(ctx *Context, name string, args StageArgs, opts ...ResourceOption) (*Stage, error)
public Stage(string name, StageArgs args, CustomResourceOptions? opts = null)
type: aws-native:apigateway:Stage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StageArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StageArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StageArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Stage Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Stage resource accepts the following input properties:
- Rest
Api stringId The ID of the RestApi resource that you're deploying with this stage.
- Access
Log Pulumi.Setting Aws Native. Api Gateway. Inputs. Stage Access Log Setting Args Specifies settings for logging access in this stage.
- Cache
Cluster boolEnabled Indicates whether cache clustering is enabled for the stage.
- Cache
Cluster stringSize The stage's cache cluster size.
- Canary
Setting Pulumi.Aws Native. Api Gateway. Inputs. Stage Canary Setting Args Specifies settings for the canary deployment in this stage.
- Client
Certificate stringId The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- Deployment
Id string The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
- Description string
A description of the stage.
- Documentation
Version string The version ID of the API documentation snapshot.
- Method
Settings List<Pulumi.Aws Native. Api Gateway. Inputs. Stage Method Setting Args> Settings for all methods in the stage.
- Stage
Name string The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
- List<Pulumi.
Aws Native. Api Gateway. Inputs. Stage Tag Args> An array of arbitrary tags (key-value pairs) to associate with the stage.
- Tracing
Enabled bool Specifies whether active X-Ray tracing is enabled for this stage.
- Variables object
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.
- Rest
Api stringId The ID of the RestApi resource that you're deploying with this stage.
- Access
Log StageSetting Access Log Setting Args Specifies settings for logging access in this stage.
- Cache
Cluster boolEnabled Indicates whether cache clustering is enabled for the stage.
- Cache
Cluster stringSize The stage's cache cluster size.
- Canary
Setting StageCanary Setting Args Specifies settings for the canary deployment in this stage.
- Client
Certificate stringId The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- Deployment
Id string The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
- Description string
A description of the stage.
- Documentation
Version string The version ID of the API documentation snapshot.
- Method
Settings []StageMethod Setting Args Settings for all methods in the stage.
- Stage
Name string The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
- []Stage
Tag Args An array of arbitrary tags (key-value pairs) to associate with the stage.
- Tracing
Enabled bool Specifies whether active X-Ray tracing is enabled for this stage.
- Variables interface{}
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.
- rest
Api StringId The ID of the RestApi resource that you're deploying with this stage.
- access
Log StageSetting Access Log Setting Args Specifies settings for logging access in this stage.
- cache
Cluster BooleanEnabled Indicates whether cache clustering is enabled for the stage.
- cache
Cluster StringSize The stage's cache cluster size.
- canary
Setting StageCanary Setting Args Specifies settings for the canary deployment in this stage.
- client
Certificate StringId The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- deployment
Id String The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
- description String
A description of the stage.
- documentation
Version String The version ID of the API documentation snapshot.
- method
Settings List<StageMethod Setting Args> Settings for all methods in the stage.
- stage
Name String The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
- List<Stage
Tag Args> An array of arbitrary tags (key-value pairs) to associate with the stage.
- tracing
Enabled Boolean Specifies whether active X-Ray tracing is enabled for this stage.
- variables Object
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.
- rest
Api stringId The ID of the RestApi resource that you're deploying with this stage.
- access
Log StageSetting Access Log Setting Args Specifies settings for logging access in this stage.
- cache
Cluster booleanEnabled Indicates whether cache clustering is enabled for the stage.
- cache
Cluster stringSize The stage's cache cluster size.
- canary
Setting StageCanary Setting Args Specifies settings for the canary deployment in this stage.
- client
Certificate stringId The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- deployment
Id string The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
- description string
A description of the stage.
- documentation
Version string The version ID of the API documentation snapshot.
- method
Settings StageMethod Setting Args[] Settings for all methods in the stage.
- stage
Name string The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
- Stage
Tag Args[] An array of arbitrary tags (key-value pairs) to associate with the stage.
- tracing
Enabled boolean Specifies whether active X-Ray tracing is enabled for this stage.
- variables any
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.
- rest_
api_ strid The ID of the RestApi resource that you're deploying with this stage.
- access_
log_ Stagesetting Access Log Setting Args Specifies settings for logging access in this stage.
- cache_
cluster_ boolenabled Indicates whether cache clustering is enabled for the stage.
- cache_
cluster_ strsize The stage's cache cluster size.
- canary_
setting StageCanary Setting Args Specifies settings for the canary deployment in this stage.
- client_
certificate_ strid The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- deployment_
id str The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
- description str
A description of the stage.
- documentation_
version str The version ID of the API documentation snapshot.
- method_
settings Sequence[StageMethod Setting Args] Settings for all methods in the stage.
- stage_
name str The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
- Sequence[Stage
Tag Args] An array of arbitrary tags (key-value pairs) to associate with the stage.
- tracing_
enabled bool Specifies whether active X-Ray tracing is enabled for this stage.
- variables Any
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.
- rest
Api StringId The ID of the RestApi resource that you're deploying with this stage.
- access
Log Property MapSetting Specifies settings for logging access in this stage.
- cache
Cluster BooleanEnabled Indicates whether cache clustering is enabled for the stage.
- cache
Cluster StringSize The stage's cache cluster size.
- canary
Setting Property Map Specifies settings for the canary deployment in this stage.
- client
Certificate StringId The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- deployment
Id String The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
- description String
A description of the stage.
- documentation
Version String The version ID of the API documentation snapshot.
- method
Settings List<Property Map> Settings for all methods in the stage.
- stage
Name String The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
- List<Property Map>
An array of arbitrary tags (key-value pairs) to associate with the stage.
- tracing
Enabled Boolean Specifies whether active X-Ray tracing is enabled for this stage.
- variables Any
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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Stage resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Supporting Types
StageAccessLogSetting
- Destination
Arn string 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.
- Format string
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.
- Destination
Arn string 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.
- Format string
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.
- destination
Arn String 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.
- format String
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.
- destination
Arn string 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.
- format string
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.
- destination_
arn str 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.
- format str
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.
- destination
Arn String 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.
- format String
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.
StageCanarySetting
- Deployment
Id string The identifier of the deployment that the stage points to.
- Percent
Traffic double The percentage (0-100) of traffic diverted to a canary deployment.
- Stage
Variable objectOverrides 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.
- Use
Stage boolCache Whether the canary deployment uses the stage cache or not.
- Deployment
Id string The identifier of the deployment that the stage points to.
- Percent
Traffic float64 The percentage (0-100) of traffic diverted to a canary deployment.
- Stage
Variable interface{}Overrides 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.
- Use
Stage boolCache Whether the canary deployment uses the stage cache or not.
- deployment
Id String The identifier of the deployment that the stage points to.
- percent
Traffic Double The percentage (0-100) of traffic diverted to a canary deployment.
- stage
Variable ObjectOverrides 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.
- use
Stage BooleanCache Whether the canary deployment uses the stage cache or not.
- deployment
Id string The identifier of the deployment that the stage points to.
- percent
Traffic number The percentage (0-100) of traffic diverted to a canary deployment.
- stage
Variable anyOverrides 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.
- use
Stage booleanCache Whether the canary deployment uses the stage cache or not.
- deployment_
id str The identifier of the deployment that the stage points to.
- percent_
traffic float The percentage (0-100) of traffic diverted to a canary deployment.
- stage_
variable_ Anyoverrides 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.
- use_
stage_ boolcache Whether the canary deployment uses the stage cache or not.
- deployment
Id String The identifier of the deployment that the stage points to.
- percent
Traffic Number The percentage (0-100) of traffic diverted to a canary deployment.
- stage
Variable AnyOverrides 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.
- use
Stage BooleanCache Whether the canary deployment uses the stage cache or not.
StageMethodSetting
- Cache
Data boolEncrypted Indicates whether the cached responses are encrypted.
- Cache
Ttl intIn Seconds The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- Caching
Enabled bool Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
- Data
Trace boolEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- Http
Method string The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
- Logging
Level string 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.
- Metrics
Enabled bool Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- Resource
Path string 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.
- Throttling
Burst intLimit The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- Throttling
Rate doubleLimit The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- Cache
Data boolEncrypted Indicates whether the cached responses are encrypted.
- Cache
Ttl intIn Seconds The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- Caching
Enabled bool Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
- Data
Trace boolEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- Http
Method string The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
- Logging
Level string 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.
- Metrics
Enabled bool Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- Resource
Path string 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.
- Throttling
Burst intLimit The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- Throttling
Rate float64Limit The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- cache
Data BooleanEncrypted Indicates whether the cached responses are encrypted.
- cache
Ttl IntegerIn Seconds The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- caching
Enabled Boolean Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
- data
Trace BooleanEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- http
Method String The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
- logging
Level String 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.
- metrics
Enabled Boolean Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- resource
Path String 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.
- throttling
Burst IntegerLimit The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- throttling
Rate DoubleLimit The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- cache
Data booleanEncrypted Indicates whether the cached responses are encrypted.
- cache
Ttl numberIn Seconds The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- caching
Enabled boolean Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
- data
Trace booleanEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- http
Method string The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
- logging
Level string 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.
- metrics
Enabled boolean Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- resource
Path string 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.
- throttling
Burst numberLimit The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- throttling
Rate numberLimit The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- cache_
data_ boolencrypted Indicates whether the cached responses are encrypted.
- cache_
ttl_ intin_ seconds The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- caching_
enabled bool Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
- data_
trace_ boolenabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- http_
method str The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
- logging_
level str 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.
- metrics_
enabled bool Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- resource_
path str 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.
- throttling_
burst_ intlimit The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- throttling_
rate_ floatlimit The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- cache
Data BooleanEncrypted Indicates whether the cached responses are encrypted.
- cache
Ttl NumberIn Seconds The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- caching
Enabled Boolean Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.
- data
Trace BooleanEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- http
Method String The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
- logging
Level String 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.
- metrics
Enabled Boolean Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- resource
Path String 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.
- throttling
Burst NumberLimit The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
- throttling
Rate NumberLimit The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.
StageTag
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws-native
- License
- Apache-2.0