interface CfnDeploymentMixinProps

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.ApiGatewayV2.CfnDeploymentMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsapigatewayv2#CfnDeploymentMixinProps`
Java	`software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.CfnDeploymentMixinProps`
Python	`aws_cdk.cfn_property_mixins.aws_apigatewayv2.CfnDeploymentMixinProps`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_apigatewayv2` » `CfnDeploymentMixinProps`

Properties for CfnDeploymentPropsMixin.

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/cfn-property-mixins';
const cfnDeploymentMixinProps: apigatewayv2.CfnDeploymentMixinProps = {
  apiId: 'apiId',
  description: 'description',
  stageName: 'stageName',
};

Properties

Name	Type	Description
apiId?	`string \|` `IApiRef`	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 | IApiRef (optional)

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

AWS CDK