CfnDeploymentProps Struct
Properties for defining a CfnDeployment.
Example
ts
// 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
deploymentCanarySettingsoptionalIResolvable | CfnDeployment.DeploymentCanarySettingsPropertydeployment_canary_settingsoptionaltyping.Union[IResolvable, DeploymentCanarySettingsProperty]deploymentCanarySettingsoptionalIResolvableDeploymentCanarySettingsoptionalIResolvableDeploymentCanarySettingsoptionalinterface{}#The input configuration for a canary deployment.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description for the Deployment resource to create.
restApiIdstring | IRestApiRefrest_api_idtyping.Union[str, IRestApiRef]restApiIdStringRestApiIdstringRestApiIdinterface{}required#The string identifier of the associated RestApi.
stageDescriptionoptionalIResolvable | CfnDeployment.StageDescriptionPropertystage_descriptionoptionaltyping.Union[IResolvable, StageDescriptionProperty]stageDescriptionoptionalIResolvableStageDescriptionoptionalIResolvableStageDescriptionoptionalinterface{}#The description of the Stage resource for the Deployment resource to create.
To specify a stage description, you must also provide a stage name.
stageNameoptionalstringstage_nameoptionalstrstageNameoptionalStringStageNameoptionalstringStageNameoptional*string#The name of the Stage resource for the Deployment resource to create.