CfnStageProps Struct
Properties for defining a CfnStage.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
declare const routeSettings: any;
declare const stageVariables: any;
declare const tags: any;
const cfnStageProps: apigatewayv2.CfnStageProps = {
apiId: 'apiId',
stageName: 'stageName',
// the properties below are optional
accessLogSettings: {
destinationArn: 'destinationArn',
format: 'format',
},
accessPolicyId: 'accessPolicyId',
autoDeploy: false,
clientCertificateId: 'clientCertificateId',
defaultRouteSettings: {
dataTraceEnabled: false,
detailedMetricsEnabled: false,
loggingLevel: 'loggingLevel',
throttlingBurstLimit: 123,
throttlingRateLimit: 123,
},
deploymentId: 'deploymentId',
description: 'description',
routeSettings: routeSettings,
stageVariables: stageVariables,
tags: tags,
};
Properties
accessLogSettingsoptionalIResolvable | CfnStage.AccessLogSettingsPropertyaccess_log_settingsoptionaltyping.Union[IResolvable, AccessLogSettingsProperty]accessLogSettingsoptionalIResolvableAccessLogSettingsoptionalIResolvableAccessLogSettingsoptionalinterface{}#Settings for logging access in this stage.
accessPolicyIdoptionalstringaccess_policy_idoptionalstraccessPolicyIdoptionalStringAccessPolicyIdoptionalstringAccessPolicyIdoptional*string#This parameter is not currently supported.
The API identifier.
autoDeployoptionalboolean | IResolvableauto_deployoptionaltyping.Union[bool, IResolvable]autoDeployoptionalBooleanAutoDeployoptionalboolAutoDeployoptionalinterface{}#Specifies whether updates to an API automatically trigger a new deployment.
The default value is false .
clientCertificateIdoptionalstringclient_certificate_idoptionalstrclientCertificateIdoptionalStringClientCertificateIdoptionalstringClientCertificateIdoptional*string#The identifier of a client certificate for a `Stage` .
Supported only for WebSocket APIs.
defaultRouteSettingsoptionalIResolvable | CfnStage.RouteSettingsPropertydefault_route_settingsoptionaltyping.Union[IResolvable, RouteSettingsProperty]defaultRouteSettingsoptionalIResolvableDefaultRouteSettingsoptionalIResolvableDefaultRouteSettingsoptionalinterface{}#The default route settings for the stage.
deploymentIdoptionalstringdeployment_idoptionalstrdeploymentIdoptionalStringDeploymentIdoptionalstringDeploymentIdoptional*string#The deployment identifier for the API stage.
Can't be updated if autoDeploy is enabled.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description for the API stage.
routeSettingsoptionalanyroute_settingsoptionalAnyrouteSettingsoptionalObjectRouteSettingsoptionalobjectRouteSettingsoptionalinterface{}#Route settings for the stage.
The stage name.
Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
stageVariablesoptionalanystage_variablesoptionalAnystageVariablesoptionalObjectStageVariablesoptionalobjectStageVariablesoptionalinterface{}#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.