interface CfnDeploymentMixinProps

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

Properties for CfnDeploymentPropsMixin.

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 as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnDeploymentMixinProps: apigateway_mixins.CfnDeploymentMixinProps = {
  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',
};

Properties

Name	Type	Description
deploymentCanarySettings?	IResolvable | DeploymentCanarySettingsProperty	The input configuration for a canary deployment.
description?	string	The description for the Deployment resource to create.
restApiId?	string	The string identifier of the associated RestApi.
stageDescription?	IResolvable | StageDescriptionProperty	The description of the Stage resource for the Deployment resource to create.
stageName?	string	The name of the Stage resource for the Deployment resource to create.

---

deploymentCanarySettings?

Type: IResolvable | DeploymentCanarySettingsProperty (optional)

The input configuration for a canary deployment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings

---

description?

Type: string (optional)

The description for the Deployment resource to create.

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

---

restApiId?

Type: string (optional)

The string identifier of the associated RestApi.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid

---

stageDescription?

Type: IResolvable | StageDescriptionProperty (optional)

The description of the Stage resource for the Deployment resource to create.

To specify a stage description, you must also provide a stage name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription

---

stageName?

Type: string (optional)

The name of the Stage resource for the Deployment resource to create.

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