Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. Stage

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.Stage

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::ApiGateway::Stage resource creates a stage for a deployment.

Create Stage Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Stage(name: string, args: StageArgs, opts?: CustomResourceOptions);
@overload
def Stage(resource_name: str,
          args: StageArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Stage(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          rest_api_id: Optional[str] = None,
          canary_setting: Optional[StageCanarySettingArgs] = None,
          cache_cluster_size: Optional[str] = None,
          access_log_setting: Optional[StageAccessLogSettingArgs] = 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,
          cache_cluster_enabled: Optional[bool] = None,
          stage_name: Optional[str] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
          tracing_enabled: Optional[bool] = None,
          variables: Optional[Mapping[str, str]] = None)
func NewStage(ctx *Context, name string, args StageArgs, opts ...ResourceOption) (*Stage, error)
public Stage(string name, StageArgs args, CustomResourceOptions? opts = null)
public Stage(String name, StageArgs args)
public Stage(String name, StageArgs args, CustomResourceOptions options)

type: aws-native:apigateway:Stage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. StageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Stage resource accepts the following input properties:

RestApiId This property is required. string
The string identifier of the associated RestApi.
AccessLogSetting Pulumi.AwsNative.ApiGateway.Inputs.StageAccessLogSetting
Access log settings, including the access log format and access log destination ARN.
CacheClusterEnabled bool
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
CacheClusterSize string
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
CanarySetting Pulumi.AwsNative.ApiGateway.Inputs.StageCanarySetting
Settings for the canary deployment in this stage.
ClientCertificateId string
The identifier of a client certificate for an API stage.
DeploymentId string
The identifier of the Deployment that the stage points to.
Description string
The stage's description.
DocumentationVersion string
The version of the associated API documentation.
MethodSettings List<Pulumi.AwsNative.ApiGateway.Inputs.StageMethodSetting>
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
StageName string
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
Tags List<Pulumi.AwsNative.Inputs.Tag>
The collection of tags. Each tag element is associated with a given resource.
TracingEnabled bool
Specifies whether active tracing with X-ray is enabled for the Stage.
Variables Dictionary<string, string>
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. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
RestApiId This property is required. string
The string identifier of the associated RestApi.
AccessLogSetting StageAccessLogSettingArgs
Access log settings, including the access log format and access log destination ARN.
CacheClusterEnabled bool
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
CacheClusterSize string
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
CanarySetting StageCanarySettingArgs
Settings for the canary deployment in this stage.
ClientCertificateId string
The identifier of a client certificate for an API stage.
DeploymentId string
The identifier of the Deployment that the stage points to.
Description string
The stage's description.
DocumentationVersion string
The version of the associated API documentation.
MethodSettings []StageMethodSettingArgs
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
StageName string
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
Tags TagArgs
The collection of tags. Each tag element is associated with a given resource.
TracingEnabled bool
Specifies whether active tracing with X-ray is enabled for the Stage.
Variables map[string]string
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. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
restApiId This property is required. String
The string identifier of the associated RestApi.
accessLogSetting StageAccessLogSetting
Access log settings, including the access log format and access log destination ARN.
cacheClusterEnabled Boolean
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
cacheClusterSize String
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
canarySetting StageCanarySetting
Settings for the canary deployment in this stage.
clientCertificateId String
The identifier of a client certificate for an API stage.
deploymentId String
The identifier of the Deployment that the stage points to.
description String
The stage's description.
documentationVersion String
The version of the associated API documentation.
methodSettings List<StageMethodSetting>
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
stageName String
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags List<Tag>
The collection of tags. Each tag element is associated with a given resource.
tracingEnabled Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
variables Map<String,String>
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. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
restApiId This property is required. string
The string identifier of the associated RestApi.
accessLogSetting StageAccessLogSetting
Access log settings, including the access log format and access log destination ARN.
cacheClusterEnabled boolean
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
cacheClusterSize string
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
canarySetting StageCanarySetting
Settings for the canary deployment in this stage.
clientCertificateId string
The identifier of a client certificate for an API stage.
deploymentId string
The identifier of the Deployment that the stage points to.
description string
The stage's description.
documentationVersion string
The version of the associated API documentation.
methodSettings StageMethodSetting[]
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
stageName string
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags Tag[]
The collection of tags. Each tag element is associated with a given resource.
tracingEnabled boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
variables {[key: string]: string}
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. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
rest_api_id This property is required. str
The string identifier of the associated RestApi.
access_log_setting StageAccessLogSettingArgs
Access log settings, including the access log format and access log destination ARN.
cache_cluster_enabled bool
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
cache_cluster_size str
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
canary_setting StageCanarySettingArgs
Settings for the canary deployment in this stage.
client_certificate_id str
The identifier of a client certificate for an API stage.
deployment_id str
The identifier of the Deployment that the stage points to.
description str
The stage's description.
documentation_version str
The version of the associated API documentation.
method_settings Sequence[StageMethodSettingArgs]
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
stage_name str
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags Sequence[TagArgs]
The collection of tags. Each tag element is associated with a given resource.
tracing_enabled bool
Specifies whether active tracing with X-ray is enabled for the Stage.
variables Mapping[str, str]
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. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
restApiId This property is required. String
The string identifier of the associated RestApi.
accessLogSetting Property Map
Access log settings, including the access log format and access log destination ARN.
cacheClusterEnabled Boolean
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
cacheClusterSize String
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
canarySetting Property Map
Settings for the canary deployment in this stage.
clientCertificateId String
The identifier of a client certificate for an API stage.
deploymentId String
The identifier of the Deployment that the stage points to.
description String
The stage's description.
documentationVersion String
The version of the associated API documentation.
methodSettings List<Property Map>
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
stageName String
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags List<Property Map>
The collection of tags. Each tag element is associated with a given resource.
tracingEnabled Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
variables Map<String>
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. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

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
, StageAccessLogSettingArgs

DestinationArn 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. The format must include at least $context.requestId. This parameter is required to enable access logging.
DestinationArn 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. The format must include at least $context.requestId. This parameter is required to enable access logging.
destinationArn 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. The format must include at least $context.requestId. This parameter is required to enable access logging.
destinationArn 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. 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. The format must include at least $context.requestId. This parameter is required to enable access logging.
destinationArn 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. The format must include at least $context.requestId. This parameter is required to enable access logging.

StageCanarySetting
, StageCanarySettingArgs

DeploymentId string
The ID of the canary deployment.
PercentTraffic double
The percent (0-100) of traffic diverted to a canary deployment.
StageVariableOverrides Dictionary<string, string>
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.
UseStageCache bool
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
DeploymentId string
The ID of the canary deployment.
PercentTraffic float64
The percent (0-100) of traffic diverted to a canary deployment.
StageVariableOverrides map[string]string
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.
UseStageCache bool
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
deploymentId String
The ID of the canary deployment.
percentTraffic Double
The percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides Map<String,String>
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.
useStageCache Boolean
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
deploymentId string
The ID of the canary deployment.
percentTraffic number
The percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides {[key: string]: string}
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.
useStageCache boolean
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
deployment_id str
The ID of the canary deployment.
percent_traffic float
The percent (0-100) of traffic diverted to a canary deployment.
stage_variable_overrides Mapping[str, str]
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_cache bool
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
deploymentId String
The ID of the canary deployment.
percentTraffic Number
The percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides Map<String>
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.
useStageCache Boolean
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

StageMethodSetting
, StageMethodSettingArgs

CacheDataEncrypted bool
Specifies whether the cached responses are encrypted.
CacheTtlInSeconds int
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
CachingEnabled bool
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
DataTraceEnabled bool
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
HttpMethod string
The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
LoggingLevel string
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
MetricsEnabled bool
Specifies whether Amazon CloudWatch metrics are enabled for this method.
ResourcePath 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 (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
ThrottlingBurstLimit int
Specifies the throttling burst limit.
ThrottlingRateLimit double
Specifies the throttling rate limit.
CacheDataEncrypted bool
Specifies whether the cached responses are encrypted.
CacheTtlInSeconds int
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
CachingEnabled bool
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
DataTraceEnabled bool
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
HttpMethod string
The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
LoggingLevel string
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
MetricsEnabled bool
Specifies whether Amazon CloudWatch metrics are enabled for this method.
ResourcePath 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 (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
ThrottlingBurstLimit int
Specifies the throttling burst limit.
ThrottlingRateLimit float64
Specifies the throttling rate limit.
cacheDataEncrypted Boolean
Specifies whether the cached responses are encrypted.
cacheTtlInSeconds Integer
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
cachingEnabled Boolean
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
dataTraceEnabled Boolean
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
httpMethod String
The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
loggingLevel String
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
metricsEnabled Boolean
Specifies whether Amazon CloudWatch metrics are enabled for this method.
resourcePath 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 (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
throttlingBurstLimit Integer
Specifies the throttling burst limit.
throttlingRateLimit Double
Specifies the throttling rate limit.
cacheDataEncrypted boolean
Specifies whether the cached responses are encrypted.
cacheTtlInSeconds number
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
cachingEnabled boolean
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
dataTraceEnabled boolean
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
httpMethod string
The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
loggingLevel string
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
metricsEnabled boolean
Specifies whether Amazon CloudWatch metrics are enabled for this method.
resourcePath 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 (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
throttlingBurstLimit number
Specifies the throttling burst limit.
throttlingRateLimit number
Specifies the throttling rate limit.
cache_data_encrypted bool
Specifies whether the cached responses are encrypted.
cache_ttl_in_seconds int
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
caching_enabled bool
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
data_trace_enabled bool
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
http_method str
The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
logging_level str
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
metrics_enabled bool
Specifies whether Amazon CloudWatch metrics are enabled for this method.
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 (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
throttling_burst_limit int
Specifies the throttling burst limit.
throttling_rate_limit float
Specifies the throttling rate limit.
cacheDataEncrypted Boolean
Specifies whether the cached responses are encrypted.
cacheTtlInSeconds Number
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
cachingEnabled Boolean
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
dataTraceEnabled Boolean
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
httpMethod String
The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
loggingLevel String
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
metricsEnabled Boolean
Specifies whether Amazon CloudWatch metrics are enabled for this method.
resourcePath 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 (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
throttlingBurstLimit Number
Specifies the throttling burst limit.
throttlingRateLimit Number
Specifies the throttling rate limit.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native