class CfnStagePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnStagePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnStagePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnStagePropsMixin
Python	aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnStagePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnStagePropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGatewayV2::Stage resource specifies a stage for an API.

Each stage is a named reference to a deployment of the API and is made available for client applications to call. To learn more, see Working with stages for HTTP APIs and Deploy a WebSocket API in API Gateway .

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 } from '@aws-cdk/mixins-preview';
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 cfnStagePropsMixin = new apigatewayv2_mixins.CfnStagePropsMixin({
  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,
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnStagePropsMixin(props: CfnStageMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnStageMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ApiGatewayV2::Stage.

Properties

Name	Type	Description
props	CfnStageMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnStageMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.