CfnStageProps¶
-
class
aws_cdk.aws_apigatewayv2.
CfnStageProps
(*, api_id, stage_name, access_log_settings=None, access_policy_id=None, auto_deploy=None, client_certificate_id=None, default_route_settings=None, deployment_id=None, description=None, route_settings=None, stage_variables=None, tags=None)¶ Bases:
object
Properties for defining a
CfnStage
.- Parameters
api_id (
str
) – The API identifier.stage_name (
str
) – The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be$default
. Maximum length is 128 characters.access_log_settings (
Union
[IResolvable
,AccessLogSettingsProperty
,Dict
[str
,Any
],None
]) – Settings for logging access in this stage.access_policy_id (
Optional
[str
]) – This parameter is not currently supported.auto_deploy (
Union
[bool
,IResolvable
,None
]) – Specifies whether updates to an API automatically trigger a new deployment. The default value isfalse
.client_certificate_id (
Optional
[str
]) – The identifier of a client certificate for aStage
. Supported only for WebSocket APIs.default_route_settings (
Union
[IResolvable
,RouteSettingsProperty
,Dict
[str
,Any
],None
]) – The default route settings for the stage.deployment_id (
Optional
[str
]) – The deployment identifier for the API stage. Can’t be updated ifautoDeploy
is enabled.description (
Optional
[str
]) – The description for the API stage.route_settings (
Optional
[Any
]) – Route settings for the stage.stage_variables (
Optional
[Any
]) – A map that defines the stage variables for aStage
. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.tags (
Optional
[Any
]) – The collection of tags. Each tag element is associated with a given resource.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-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_apigatewayv2 as apigatewayv2 # route_settings: Any # stage_variables: Any # tags: Any cfn_stage_props = apigatewayv2.CfnStageProps( api_id="apiId", stage_name="stageName", # the properties below are optional access_log_settings=apigatewayv2.CfnStage.AccessLogSettingsProperty( destination_arn="destinationArn", format="format" ), access_policy_id="accessPolicyId", auto_deploy=False, client_certificate_id="clientCertificateId", default_route_settings=apigatewayv2.CfnStage.RouteSettingsProperty( data_trace_enabled=False, detailed_metrics_enabled=False, logging_level="loggingLevel", throttling_burst_limit=123, throttling_rate_limit=123 ), deployment_id="deploymentId", description="description", route_settings=route_settings, stage_variables=stage_variables, tags=tags )
Attributes
-
access_log_settings
¶ Settings for logging access in this stage.
-
access_policy_id
¶ This parameter is not currently supported.
-
api_id
¶ The API identifier.
-
auto_deploy
¶ Specifies whether updates to an API automatically trigger a new deployment.
The default value is
false
.- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
client_certificate_id
¶ The identifier of a client certificate for a
Stage
.Supported only for WebSocket APIs.
-
default_route_settings
¶ The default route settings for the stage.
-
deployment_id
¶ The deployment identifier for the API stage.
Can’t be updated if
autoDeploy
is enabled.
-
description
¶ The description for the API stage.
-
route_settings
¶ Route settings for the stage.
-
stage_name
¶ The stage name.
Stage names can contain only alphanumeric characters, hyphens, and underscores, or be
$default
. Maximum length is 128 characters.
-
stage_variables
¶ A map that defines the stage variables for a
Stage
.Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
The collection of tags.
Each tag element is associated with a given resource.