interface CfnStageMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnStageMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnStageMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnStageMixinProps |
 Python | aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnStageMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnStageMixinProps |
Properties for CfnStagePropsMixin.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apigatewayv2_mixins } from '@aws-cdk/mixins-preview/aws-apigatewayv2';
declare const routeSettings: any;
declare const stageVariables: any;
declare const tags: any;
const cfnStageMixinProps: apigatewayv2_mixins.CfnStageMixinProps = {
accessLogSettings: {
destinationArn: 'destinationArn',
format: 'format',
},
accessPolicyId: 'accessPolicyId',
apiId: 'apiId',
autoDeploy: false,
clientCertificateId: 'clientCertificateId',
defaultRouteSettings: {
dataTraceEnabled: false,
detailedMetricsEnabled: false,
loggingLevel: 'loggingLevel',
throttlingBurstLimit: 123,
throttlingRateLimit: 123,
},
deploymentId: 'deploymentId',
description: 'description',
routeSettings: routeSettings,
stageName: 'stageName',
stageVariables: stageVariables,
tags: tags,
};
Properties
| Name | Type | Description |
|---|---|---|
| access | IResolvable | Access | Settings for logging access in this stage. |
| access | string | This parameter is not currently supported. |
| api | string | The API identifier. |
| auto | boolean | IResolvable | Specifies whether updates to an API automatically trigger a new deployment. |
| client | string | The identifier of a client certificate for a Stage . |
| default | IResolvable | Route | The default route settings for the stage. |
| deployment | string | The deployment identifier for the API stage. |
| description? | string | The description for the API stage. |
| route | any | Route settings for the stage. |
| stage | string | The stage name. |
| stage | any | A map that defines the stage variables for a Stage . |
| tags? | any | The collection of tags. |
accessLogSettings?
Type:
IResolvable | Access
(optional)
Settings for logging access in this stage.
accessPolicyId?
Type:
string
(optional)
This parameter is not currently supported.
apiId?
Type:
string
(optional)
The API identifier.
autoDeploy?
Type:
boolean | IResolvable
(optional)
Specifies whether updates to an API automatically trigger a new deployment.
The default value is false .
clientCertificateId?
Type:
string
(optional)
The identifier of a client certificate for a Stage .
Supported only for WebSocket APIs.
defaultRouteSettings?
Type:
IResolvable | Route
(optional)
The default route settings for the stage.
deploymentId?
Type:
string
(optional)
The deployment identifier for the API stage.
Can't be updated if autoDeploy is enabled.
description?
Type:
string
(optional)
The description for the API stage.
routeSettings?
Type:
any
(optional)
Route settings for the stage.
stageName?
Type:
string
(optional)
The stage name.
Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
stageVariables?
Type:
any
(optional)
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-._~:/?#&=,]+.
tags?
Type:
any
(optional)
The collection of tags.
Each tag element is associated with a given resource.