class CfnDeploymentPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnDeploymentPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnDeploymentPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDeploymentPropsMixin
Python	aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDeploymentPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigateway » mixins » CfnDeploymentPropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.

The stage acts as an environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.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 apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnDeploymentPropsMixin = new apigateway_mixins.CfnDeploymentPropsMixin({
  deploymentCanarySettings: {
    percentTraffic: 123,
    stageVariableOverrides: {
      stageVariableOverridesKey: 'stageVariableOverrides',
    },
    useStageCache: false,
  },
  description: 'description',
  restApiId: 'restApiId',
  stageDescription: {
    accessLogSetting: {
      destinationArn: 'destinationArn',
      format: 'format',
    },
    cacheClusterEnabled: false,
    cacheClusterSize: 'cacheClusterSize',
    cacheDataEncrypted: false,
    cacheTtlInSeconds: 123,
    cachingEnabled: false,
    canarySetting: {
      percentTraffic: 123,
      stageVariableOverrides: {
        stageVariableOverridesKey: 'stageVariableOverrides',
      },
      useStageCache: false,
    },
    clientCertificateId: 'clientCertificateId',
    dataTraceEnabled: false,
    description: 'description',
    documentationVersion: 'documentationVersion',
    loggingLevel: 'loggingLevel',
    methodSettings: [{
      cacheDataEncrypted: false,
      cacheTtlInSeconds: 123,
      cachingEnabled: false,
      dataTraceEnabled: false,
      httpMethod: 'httpMethod',
      loggingLevel: 'loggingLevel',
      metricsEnabled: false,
      resourcePath: 'resourcePath',
      throttlingBurstLimit: 123,
      throttlingRateLimit: 123,
    }],
    metricsEnabled: false,
    tags: [{
      key: 'key',
      value: 'value',
    }],
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
    tracingEnabled: false,
    variables: {
      variablesKey: 'variables',
    },
  },
  stageName: 'stageName',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDeploymentPropsMixin(props: CfnDeploymentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::ApiGateway::Deployment.

Properties

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

---

props

Type: CfnDeploymentMixinProps

---

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.