CfnStageProps¶
-
class
aws_cdk.aws_apigateway.
CfnStageProps
(*, rest_api_id, access_log_setting=None, cache_cluster_enabled=None, cache_cluster_size=None, canary_setting=None, client_certificate_id=None, deployment_id=None, description=None, documentation_version=None, method_settings=None, stage_name=None, tags=None, tracing_enabled=None, variables=None)¶ Bases:
object
Properties for defining a
CfnStage
.- Parameters
rest_api_id (
str
) – The ID of theRestApi
resource that you’re deploying with this stage.access_log_setting (
Union
[IResolvable
,AccessLogSettingProperty
,None
]) – Specifies settings for logging access in this stage.cache_cluster_enabled (
Union
[bool
,IResolvable
,None
]) – Indicates whether cache clustering is enabled for the stage.cache_cluster_size (
Optional
[str
]) – The stage’s cache cluster size.canary_setting (
Union
[IResolvable
,CanarySettingProperty
,None
]) – Specifies settings for the canary deployment in this stage.client_certificate_id (
Optional
[str
]) – The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.deployment_id (
Optional
[str
]) – The ID of the deployment that the stage is associated with. This parameter is required to create a stage.description (
Optional
[str
]) – A description of the stage.documentation_version (
Optional
[str
]) – The version ID of the API documentation snapshot.method_settings (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,MethodSettingProperty
]],None
]) – Settings for all methods in the stage.stage_name (
Optional
[str
]) – The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).tags (
Optional
[Sequence
[CfnTag
]]) – An array of arbitrary tags (key-value pairs) to associate with the stage.tracing_enabled (
Union
[bool
,IResolvable
,None
]) – Specifies whether active X-Ray tracing is enabled for this stage. For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .variables (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – 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-._~:/?#&=,]+
.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_apigateway as apigateway cfn_stage_props = apigateway.CfnStageProps( rest_api_id="restApiId", # the properties below are optional access_log_setting=apigateway.CfnStage.AccessLogSettingProperty( destination_arn="destinationArn", format="format" ), cache_cluster_enabled=False, cache_cluster_size="cacheClusterSize", canary_setting=apigateway.CfnStage.CanarySettingProperty( deployment_id="deploymentId", percent_traffic=123, stage_variable_overrides={ "stage_variable_overrides_key": "stageVariableOverrides" }, use_stage_cache=False ), client_certificate_id="clientCertificateId", deployment_id="deploymentId", description="description", documentation_version="documentationVersion", method_settings=[apigateway.CfnStage.MethodSettingProperty( cache_data_encrypted=False, cache_ttl_in_seconds=123, caching_enabled=False, data_trace_enabled=False, http_method="httpMethod", logging_level="loggingLevel", metrics_enabled=False, resource_path="resourcePath", throttling_burst_limit=123, throttling_rate_limit=123 )], stage_name="stageName", tags=[CfnTag( key="key", value="value" )], tracing_enabled=False, variables={ "variables_key": "variables" } )
Attributes
-
access_log_setting
¶ Specifies settings for logging access in this stage.
-
cache_cluster_enabled
¶ Indicates whether cache clustering is enabled for the stage.
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
cache_cluster_size
¶ The stage’s cache cluster size.
-
canary_setting
¶ Specifies settings for the canary deployment in this stage.
-
client_certificate_id
¶ The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
-
deployment_id
¶ The ID of the deployment that the stage is associated with.
This parameter is required to create a stage.
-
description
¶ A description of the stage.
-
documentation_version
¶ The version ID of the API documentation snapshot.
-
method_settings
¶ Settings for all methods in the stage.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,MethodSettingProperty
]],None
]
-
rest_api_id
¶ The ID of the
RestApi
resource that you’re deploying with this stage.
-
stage_name
¶ The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
An array of arbitrary tags (key-value pairs) to associate with the stage.
- Link
- Return type
Optional
[List
[CfnTag
]]
-
tracing_enabled
¶ Specifies whether active X-Ray tracing is enabled for this stage.
For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
variables
¶ 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-._~:/?#&=,]+
.- Link
- Return type
Union
[IResolvable
,Mapping
[str
,str
],None
]