interface CfnDeploymentProps

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.CfnDeploymentProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnDeploymentProps
Java	software.amazon.awscdk.services.apigatewayv2.CfnDeploymentProps
Python	aws_cdk.aws_apigatewayv2.CfnDeploymentProps
TypeScript	aws-cdk-lib » aws_apigatewayv2 » CfnDeploymentProps

Properties for defining a CfnDeployment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html

Example

// 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

Name	Type	Description
apiId	string	The API identifier.
description?	string	The description for the deployment resource.
stageName?	string	The name of an existing stage to associate with the deployment.

---

apiId

Type: string

The API identifier.

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

---

description?

Type: string (optional)

The description for the deployment resource.

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

---

stageName?

Type: string (optional)

The name of an existing stage to associate with the deployment.

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