AWS CDK

1.204.0

interface CfnStageV2Props ⚠️

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.CfnStageV2Props`
Java	`software.amazon.awscdk.services.apigateway.CfnStageV2Props`
Python	`aws_cdk.aws_apigateway.CfnStageV2Props`
TypeScript (source)	`@aws-cdk/aws-apigateway` » `CfnStageV2Props`

⚠️ Deprecated: moved to package aws-apigatewayv2

Properties for defining a AWS::ApiGatewayV2::Stage.

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 * as apigateway from '@aws-cdk/aws-apigateway';

declare const routeSettings: any;
declare const stageVariables: any;
declare const tags: any;
const cfnStageV2Props: apigateway.CfnStageV2Props = {
  apiId: 'apiId',
  stageName: 'stageName',

  // the properties below are optional
  accessLogSettings: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  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

Name	Type	Description
apiId⚠️	`string`	`AWS::ApiGatewayV2::Stage.ApiId`.
stageName⚠️	`string`	`AWS::ApiGatewayV2::Stage.StageName`.
accessLogSettings?⚠️	`IResolvable` `\|` `AccessLogSettingsProperty`	`AWS::ApiGatewayV2::Stage.AccessLogSettings`.
autoDeploy?⚠️	`boolean \|` `IResolvable`	`AWS::ApiGatewayV2::Stage.AutoDeploy`.
clientCertificateId?⚠️	`string`	`AWS::ApiGatewayV2::Stage.ClientCertificateId`.
defaultRouteSettings?⚠️	`IResolvable` `\|` `RouteSettingsProperty`	`AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.
deploymentId?⚠️	`string`	`AWS::ApiGatewayV2::Stage.DeploymentId`.
description?⚠️	`string`	`AWS::ApiGatewayV2::Stage.Description`.
routeSettings?⚠️	`any`	`AWS::ApiGatewayV2::Stage.RouteSettings`.
stageVariables?⚠️	`any`	`AWS::ApiGatewayV2::Stage.StageVariables`.
tags?⚠️	`any`	`AWS::ApiGatewayV2::Stage.Tags`.

apiId⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::Stage.ApiId.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid

stageName⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string

AWS::ApiGatewayV2::Stage.StageName.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename

accessLogSettings?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: IResolvable | AccessLogSettingsProperty (optional)

AWS::ApiGatewayV2::Stage.AccessLogSettings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings

autoDeploy?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: boolean | IResolvable (optional)

AWS::ApiGatewayV2::Stage.AutoDeploy.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy

clientCertificateId?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Stage.ClientCertificateId.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid

defaultRouteSettings?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: IResolvable | RouteSettingsProperty (optional)

AWS::ApiGatewayV2::Stage.DefaultRouteSettings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings

deploymentId?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Stage.DeploymentId.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid

description?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Stage.Description.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description

routeSettings?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::Stage.RouteSettings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings

stageVariables?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::Stage.StageVariables.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables

tags?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::Stage.Tags.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags

← Previous Next →