Skip to content
v2.273.0

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_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const cfnDeploymentProps: apigatewayv2.CfnDeploymentProps = {
  apiId: 'apiId',

  // the properties below are optional
  description: 'description',
  stageName: 'stageName',
};

Properties ​

apiIdstring | IApiRefapi_idtyping.Union[str, IApiRef]apiIdStringApiIdstringApiIdinterface{}required#
The API identifier.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
The description for the deployment resource.
stageNamestringstage_namestrstageNameStringStageNamestringStageName*string#
The name of an existing stage to associate with the deployment.

Used as props by ​