CfnStageProps

class aws_cdk.aws_apigateway.CfnStageProps(*, rest_api_id, access_log_setting=None, cache_cluster_enabled=None, cache_cluster_size=None, canary_setting=None, client_certificate_id=None, deployment_id=None, description=None, documentation_version=None, method_settings=None, stage_name=None, tags=None, tracing_enabled=None, variables=None)

Bases: object

__init__(*, rest_api_id, access_log_setting=None, cache_cluster_enabled=None, cache_cluster_size=None, canary_setting=None, client_certificate_id=None, deployment_id=None, description=None, documentation_version=None, method_settings=None, stage_name=None, tags=None, tracing_enabled=None, variables=None)

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

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

  • access_log_setting (Union[IResolvable, None, AccessLogSettingProperty]) – AWS::ApiGateway::Stage.AccessLogSetting.

  • cache_cluster_enabled (Union[bool, None, IResolvable]) – AWS::ApiGateway::Stage.CacheClusterEnabled.

  • cache_cluster_size (Optional[str]) – AWS::ApiGateway::Stage.CacheClusterSize.

  • canary_setting (Union[IResolvable, None, CanarySettingProperty]) – AWS::ApiGateway::Stage.CanarySetting.

  • client_certificate_id (Optional[str]) – AWS::ApiGateway::Stage.ClientCertificateId.

  • deployment_id (Optional[str]) – AWS::ApiGateway::Stage.DeploymentId.

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

  • documentation_version (Optional[str]) – AWS::ApiGateway::Stage.DocumentationVersion.

  • method_settings (Union[IResolvable, None, List[Union[IResolvable, MethodSettingProperty]]]) – AWS::ApiGateway::Stage.MethodSettings.

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

  • tags (Optional[List[CfnTag]]) – AWS::ApiGateway::Stage.Tags.

  • tracing_enabled (Union[bool, None, IResolvable]) – AWS::ApiGateway::Stage.TracingEnabled.

  • variables (Union[IResolvable, None, Mapping[str, str]]) – AWS::ApiGateway::Stage.Variables.

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

Attributes

access_log_setting

AWS::ApiGateway::Stage.AccessLogSetting.

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

Return type

Union[IResolvable, None, AccessLogSettingProperty]

cache_cluster_enabled

AWS::ApiGateway::Stage.CacheClusterEnabled.

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

Return type

Union[bool, None, IResolvable]

cache_cluster_size

AWS::ApiGateway::Stage.CacheClusterSize.

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

Return type

Optional[str]

canary_setting

AWS::ApiGateway::Stage.CanarySetting.

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

Return type

Union[IResolvable, None, CanarySettingProperty]

client_certificate_id

AWS::ApiGateway::Stage.ClientCertificateId.

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

Return type

Optional[str]

deployment_id

AWS::ApiGateway::Stage.DeploymentId.

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

Return type

Optional[str]

description

AWS::ApiGateway::Stage.Description.

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

Return type

Optional[str]

documentation_version

AWS::ApiGateway::Stage.DocumentationVersion.

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

Return type

Optional[str]

method_settings

AWS::ApiGateway::Stage.MethodSettings.

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

Return type

Union[IResolvable, None, List[Union[IResolvable, MethodSettingProperty]]]

rest_api_id

AWS::ApiGateway::Stage.RestApiId.

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

Return type

str

stage_name

AWS::ApiGateway::Stage.StageName.

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

Return type

Optional[str]

tags

AWS::ApiGateway::Stage.Tags.

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

Return type

Optional[List[CfnTag]]

tracing_enabled

AWS::ApiGateway::Stage.TracingEnabled.

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

Return type

Union[bool, None, IResolvable]

variables

AWS::ApiGateway::Stage.Variables.

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

Return type

Union[IResolvable, None, Mapping[str, str]]