AWS Native is in preview. AWS Classic is fully supported.
aws-native.apigateway.Deployment
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::ApiGateway::Deployment
Create Deployment Resource
new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
deployment_canary_settings: Optional[DeploymentCanarySettingsArgs] = None,
description: Optional[str] = None,
rest_api_id: Optional[str] = None,
stage_description: Optional[DeploymentStageDescriptionArgs] = None,
stage_name: Optional[str] = None)
@overload
def Deployment(resource_name: str,
args: DeploymentArgs,
opts: Optional[ResourceOptions] = None)
func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
type: aws-native:apigateway:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeploymentArgs
- 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 DeploymentArgs
- 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 DeploymentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Deployment 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 Deployment resource accepts the following input properties:
- Rest
Api stringId The ID of the RestApi resource to deploy.
- Deployment
Canary Pulumi.Settings Aws Native. Api Gateway. Inputs. Deployment Canary Settings Specifies settings for the canary deployment.
- Description string
A description of the purpose of the API Gateway deployment.
- Stage
Description Pulumi.Aws Native. Api Gateway. Inputs. Deployment Stage Description Configures the stage that API Gateway creates with this deployment.
- Stage
Name string A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
- Rest
Api stringId The ID of the RestApi resource to deploy.
- Deployment
Canary DeploymentSettings Canary Settings Args Specifies settings for the canary deployment.
- Description string
A description of the purpose of the API Gateway deployment.
- Stage
Description DeploymentStage Description Args Configures the stage that API Gateway creates with this deployment.
- Stage
Name string A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
- rest
Api StringId The ID of the RestApi resource to deploy.
- deployment
Canary DeploymentSettings Canary Settings Specifies settings for the canary deployment.
- description String
A description of the purpose of the API Gateway deployment.
- stage
Description DeploymentStage Description Configures the stage that API Gateway creates with this deployment.
- stage
Name String A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
- rest
Api stringId The ID of the RestApi resource to deploy.
- deployment
Canary DeploymentSettings Canary Settings Specifies settings for the canary deployment.
- description string
A description of the purpose of the API Gateway deployment.
- stage
Description DeploymentStage Description Configures the stage that API Gateway creates with this deployment.
- stage
Name string A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
- rest_
api_ strid The ID of the RestApi resource to deploy.
- deployment_
canary_ Deploymentsettings Canary Settings Args Specifies settings for the canary deployment.
- description str
A description of the purpose of the API Gateway deployment.
- stage_
description DeploymentStage Description Args Configures the stage that API Gateway creates with this deployment.
- stage_
name str A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
- rest
Api StringId The ID of the RestApi resource to deploy.
- deployment
Canary Property MapSettings Specifies settings for the canary deployment.
- description String
A description of the purpose of the API Gateway deployment.
- stage
Description Property Map Configures the stage that API Gateway creates with this deployment.
- stage
Name String A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
Outputs
All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:
- Deployment
Id string Primary Id for this resource
- Id string
The provider-assigned unique ID for this managed resource.
- Deployment
Id string Primary Id for this resource
- Id string
The provider-assigned unique ID for this managed resource.
- deployment
Id String Primary Id for this resource
- id String
The provider-assigned unique ID for this managed resource.
- deployment
Id string Primary Id for this resource
- id string
The provider-assigned unique ID for this managed resource.
- deployment_
id str Primary Id for this resource
- id str
The provider-assigned unique ID for this managed resource.
- deployment
Id String Primary Id for this resource
- id String
The provider-assigned unique ID for this managed resource.
Supporting Types
DeploymentAccessLogSetting, DeploymentAccessLogSettingArgs
- 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-.
- Format string
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
- 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-.
- Format string
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
- 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-.
- format String
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
- 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-.
- format string
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
- 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-.
- format str
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
- 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-.
- format String
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
DeploymentCanarySetting, DeploymentCanarySettingArgs
- Percent
Traffic double The percent (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.
- Percent
Traffic float64 The percent (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.
- percent
Traffic Double The percent (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.
- percent
Traffic number The percent (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.
- percent_
traffic float The percent (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.
- percent
Traffic Number The percent (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.
DeploymentCanarySettings, DeploymentCanarySettingsArgs
- 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. Duplicates are not allowed.
- Use
Stage boolCache Whether the canary deployment uses the stage cache.
- 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. Duplicates are not allowed.
- Use
Stage boolCache Whether the canary deployment uses the stage cache.
- 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. Duplicates are not allowed.
- use
Stage BooleanCache Whether the canary deployment uses the stage cache.
- 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. Duplicates are not allowed.
- use
Stage booleanCache Whether the canary deployment uses the stage cache.
- 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. Duplicates are not allowed.
- use_
stage_ boolcache Whether the canary deployment uses the stage cache.
- 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. Duplicates are not allowed.
- use
Stage BooleanCache Whether the canary deployment uses the stage cache.
DeploymentMethodSetting, DeploymentMethodSettingArgs
- 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.
- Logging
Level string The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.
- 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.
- Logging
Level string The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.
- 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.
- logging
Level String The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.
- 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.
- logging
Level string The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.
- 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.
- logging_
level str The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.
- 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.
- logging
Level String The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.
- 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.
DeploymentStageDescription, DeploymentStageDescriptionArgs
- Access
Log Pulumi.Setting Aws Native. Api Gateway. Inputs. Deployment Access Log Setting Specifies settings for logging access in this stage.
- Cache
Cluster boolEnabled Indicates whether cache clustering is enabled for the stage.
- Cache
Cluster stringSize The size of the stage's cache cluster.
- Cache
Data boolEncrypted The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- 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.
- Canary
Setting Pulumi.Aws Native. Api Gateway. Inputs. Deployment Canary Setting Specifies settings for the canary deployment in this stage.
- Client
Certificate stringId The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- Data
Trace boolEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- Description string
A description of the purpose of the stage.
- Documentation
Version string The version identifier of the API documentation snapshot.
- Logging
Level string The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
- Method
Settings List<Pulumi.Aws Native. Api Gateway. Inputs. Deployment Method Setting> Configures settings for all of the stage's methods.
- Metrics
Enabled bool Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- List<Pulumi.
Aws Native. Api Gateway. Inputs. Deployment Tag> An array of arbitrary tags (key-value pairs) to associate with the stage.
- 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.
- Tracing
Enabled bool Specifies whether active tracing with X-ray is enabled for this stage.
- Variables object
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-._~:/?#&=,]+.
- Access
Log DeploymentSetting Access Log Setting Specifies settings for logging access in this stage.
- Cache
Cluster boolEnabled Indicates whether cache clustering is enabled for the stage.
- Cache
Cluster stringSize The size of the stage's cache cluster.
- Cache
Data boolEncrypted The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- 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.
- Canary
Setting DeploymentCanary Setting Specifies settings for the canary deployment in this stage.
- Client
Certificate stringId The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- Data
Trace boolEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- Description string
A description of the purpose of the stage.
- Documentation
Version string The version identifier of the API documentation snapshot.
- Logging
Level string The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
- Method
Settings []DeploymentMethod Setting Configures settings for all of the stage's methods.
- Metrics
Enabled bool Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- []Deployment
Tag An array of arbitrary tags (key-value pairs) to associate with the stage.
- 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.
- Tracing
Enabled bool Specifies whether active tracing with X-ray is enabled for this stage.
- Variables interface{}
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-._~:/?#&=,]+.
- access
Log DeploymentSetting Access Log Setting Specifies settings for logging access in this stage.
- cache
Cluster BooleanEnabled Indicates whether cache clustering is enabled for the stage.
- cache
Cluster StringSize The size of the stage's cache cluster.
- cache
Data BooleanEncrypted The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- 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.
- canary
Setting DeploymentCanary Setting Specifies settings for the canary deployment in this stage.
- client
Certificate StringId The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- data
Trace BooleanEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- description String
A description of the purpose of the stage.
- documentation
Version String The version identifier of the API documentation snapshot.
- logging
Level String The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
- method
Settings List<DeploymentMethod Setting> Configures settings for all of the stage's methods.
- metrics
Enabled Boolean Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- List<Deployment
Tag> An array of arbitrary tags (key-value pairs) to associate with the stage.
- 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.
- tracing
Enabled Boolean Specifies whether active tracing with X-ray is enabled for this stage.
- variables Object
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-._~:/?#&=,]+.
- access
Log DeploymentSetting Access Log Setting Specifies settings for logging access in this stage.
- cache
Cluster booleanEnabled Indicates whether cache clustering is enabled for the stage.
- cache
Cluster stringSize The size of the stage's cache cluster.
- cache
Data booleanEncrypted The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- 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.
- canary
Setting DeploymentCanary Setting Specifies settings for the canary deployment in this stage.
- client
Certificate stringId The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- data
Trace booleanEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- description string
A description of the purpose of the stage.
- documentation
Version string The version identifier of the API documentation snapshot.
- logging
Level string The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
- method
Settings DeploymentMethod Setting[] Configures settings for all of the stage's methods.
- metrics
Enabled boolean Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- Deployment
Tag[] An array of arbitrary tags (key-value pairs) to associate with the stage.
- 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.
- tracing
Enabled boolean Specifies whether active tracing with X-ray is enabled for this stage.
- variables any
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-._~:/?#&=,]+.
- access_
log_ Deploymentsetting Access Log Setting Specifies settings for logging access in this stage.
- cache_
cluster_ boolenabled Indicates whether cache clustering is enabled for the stage.
- cache_
cluster_ strsize The size of the stage's cache cluster.
- cache_
data_ boolencrypted The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- 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.
- canary_
setting DeploymentCanary Setting Specifies settings for the canary deployment in this stage.
- client_
certificate_ strid The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- data_
trace_ boolenabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- description str
A description of the purpose of the stage.
- documentation_
version str The version identifier of the API documentation snapshot.
- logging_
level str The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
- method_
settings Sequence[DeploymentMethod Setting] Configures settings for all of the stage's methods.
- metrics_
enabled bool Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- Sequence[Deployment
Tag] An array of arbitrary tags (key-value pairs) to associate with the stage.
- 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.
- tracing_
enabled bool Specifies whether active tracing with X-ray is enabled for this stage.
- variables Any
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-._~:/?#&=,]+.
- 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 size of the stage's cache cluster.
- cache
Data BooleanEncrypted The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
- 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.
- canary
Setting Property Map Specifies settings for the canary deployment in this stage.
- client
Certificate StringId The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- data
Trace BooleanEnabled Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
- description String
A description of the purpose of the stage.
- documentation
Version String The version identifier of the API documentation snapshot.
- logging
Level String The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.
- method
Settings List<Property Map> Configures settings for all of the stage's methods.
- metrics
Enabled Boolean Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
- List<Property Map>
An array of arbitrary tags (key-value pairs) to associate with the stage.
- 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.
- tracing
Enabled Boolean Specifies whether active tracing with X-ray is enabled for this stage.
- variables Any
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-._~:/?#&=,]+.
DeploymentTag, DeploymentTagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.