CfnDeploymentProps

class aws_cdk.aws_apigateway.CfnDeploymentProps(*, rest_api_id, deployment_canary_settings=None, description=None, stage_description=None, stage_name=None)

Bases: object

__init__(*, rest_api_id, deployment_canary_settings=None, description=None, stage_description=None, stage_name=None)

Properties for defining a AWS::ApiGateway::Deployment.

Parameters
  • rest_api_id (str) – AWS::ApiGateway::Deployment.RestApiId.

  • deployment_canary_settings (Union[IResolvable, None, DeploymentCanarySettingsProperty]) – AWS::ApiGateway::Deployment.DeploymentCanarySettings.

  • description (Optional[str]) – AWS::ApiGateway::Deployment.Description.

  • stage_description (Union[IResolvable, None, StageDescriptionProperty]) – AWS::ApiGateway::Deployment.StageDescription.

  • stage_name (Optional[str]) – AWS::ApiGateway::Deployment.StageName.

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

Attributes

deployment_canary_settings

AWS::ApiGateway::Deployment.DeploymentCanarySettings.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings

Return type

Union[IResolvable, None, DeploymentCanarySettingsProperty]

description

AWS::ApiGateway::Deployment.Description.

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

Return type

Optional[str]

rest_api_id

AWS::ApiGateway::Deployment.RestApiId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid

Return type

str

stage_description

AWS::ApiGateway::Deployment.StageDescription.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription

Return type

Union[IResolvable, None, StageDescriptionProperty]

stage_name

AWS::ApiGateway::Deployment.StageName.

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

Return type

Optional[str]