aws-cdk-lib.aws_apigateway.CfnDeploymentProps

interface CfnDeploymentProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnDeploymentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDeploymentProps
Javasoftware.amazon.awscdk.services.apigateway.CfnDeploymentProps
Pythonaws_cdk.aws_apigateway.CfnDeploymentProps
TypeScript aws-cdk-lib » aws_apigateway » CfnDeploymentProps

Properties for defining a CfnDeployment.

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-lib';
const cfnDeploymentProps: apigateway.CfnDeploymentProps = {
  restApiId: 'restApiId',

  // the properties below are optional
  deploymentCanarySettings: {
    percentTraffic: 123,
    stageVariableOverrides: {
      stageVariableOverridesKey: 'stageVariableOverrides',
    },
    useStageCache: false,
  },
  description: 'description',
  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

NameTypeDescription
restApiIdstringThe string identifier of the associated RestApi.
deploymentCanarySettings?IResolvable | DeploymentCanarySettingsPropertyThe input configuration for a canary deployment.
description?stringThe description for the Deployment resource to create.
stageDescription?IResolvable | StageDescriptionPropertyThe description of the Stage resource for the Deployment resource to create.
stageName?stringThe name of the Stage resource for the Deployment resource to create.

restApiId

Type: string

The string identifier of the associated RestApi.


deploymentCanarySettings?

Type: IResolvable | DeploymentCanarySettingsProperty (optional)

The input configuration for a canary deployment.


description?

Type: string (optional)

The description for the Deployment resource to create.


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.


stageName?

Type: string (optional)

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