class CfnStagePropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway.CfnStagePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsapigateway#CfnStagePropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnStagePropsMixin
Python	aws_cdk.cfn_property_mixins.aws_apigateway.CfnStagePropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_apigateway » CfnStagePropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::Stage resource creates a stage for a deployment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnStagePropsMixin = new apigateway.CfnStagePropsMixin({
  accessLogSetting: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  cacheClusterEnabled: false,
  cacheClusterSize: 'cacheClusterSize',
  canarySetting: {
    deploymentId: 'deploymentId',
    percentTraffic: 123,
    stageVariableOverrides: {
      stageVariableOverridesKey: 'stageVariableOverrides',
    },
    useStageCache: false,
  },
  clientCertificateId: 'clientCertificateId',
  deploymentId: 'deploymentId',
  description: 'description',
  documentationVersion: 'documentationVersion',
  methodSettings: [{
    cacheDataEncrypted: false,
    cacheTtlInSeconds: 123,
    cachingEnabled: false,
    dataTraceEnabled: false,
    httpMethod: 'httpMethod',
    loggingLevel: 'loggingLevel',
    metricsEnabled: false,
    resourcePath: 'resourcePath',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  }],
  restApiId: 'restApiId',
  stageName: 'stageName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tracingEnabled: false,
  variables: {
    variablesKey: 'variables',
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

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::ApiGateway::Stage.

Properties

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

---

props

Type: CfnStageMixinProps

---

strategy

Type: IMergeStrategy

---

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): void

Parameters

• construct 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.