aws-cdk-lib.aws_apigatewayv2.CfnDeploymentProps

interface CfnDeploymentProps

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnDeploymentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnDeploymentProps
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnDeploymentProps
Pythonaws_cdk.aws_apigatewayv2.CfnDeploymentProps
TypeScript aws-cdk-lib » aws_apigatewayv2 » 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_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const cfnDeploymentProps: apigatewayv2.CfnDeploymentProps = {
  apiId: 'apiId',

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

Properties

NameTypeDescription
apiIdstringThe API identifier.
description?stringThe description for the deployment resource.
stageName?stringThe name of an existing stage to associate with the deployment.

apiId

Type: string

The API identifier.


description?

Type: string (optional)

The description for the deployment resource.


stageName?

Type: string (optional)

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