CfnDeploymentProps

class aws_cdk.aws_apigatewayv2.CfnDeploymentProps(*, api_id, description=None, stage_name=None)

Bases: object

Properties for defining a CfnDeployment.

Parameters
  • api_id (str) – The API identifier.

  • description (Optional[str]) – The description for the deployment resource.

  • stage_name (Optional[str]) – The name of an existing stage to associate with the deployment.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

cfn_deployment_props = apigatewayv2.CfnDeploymentProps(
    api_id="apiId",

    # the properties below are optional
    description="description",
    stage_name="stageName"
)

Attributes

api_id

The API identifier.

Link

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

Return type

str

description

The description for the deployment resource.

Link

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

Return type

Optional[str]

stage_name

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

Link

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

Return type

Optional[str]