CfnStageProps

class aws_cdk.aws_apigateway.CfnStageProps(*, 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, rest_api_id, stage_name=None, tags=None, tracing_enabled=None, variables=None)

Bases: object

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

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

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

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

  • canary_setting (Union[IResolvable, CanarySettingProperty, None]) – 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, Sequence[Union[IResolvable, MethodSettingProperty]], None]) – AWS::ApiGateway::Stage.MethodSettings.

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

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

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

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

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

Link

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

Example:

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

cfn_stage_props = apigateway.CfnStageProps(
    rest_api_id="restApiId",

    # the properties below are optional
    access_log_setting=apigateway.CfnStage.AccessLogSettingProperty(
        destination_arn="destinationArn",
        format="format"
    ),
    cache_cluster_enabled=False,
    cache_cluster_size="cacheClusterSize",
    canary_setting=apigateway.CfnStage.CanarySettingProperty(
        deployment_id="deploymentId",
        percent_traffic=123,
        stage_variable_overrides={
            "stage_variable_overrides_key": "stageVariableOverrides"
        },
        use_stage_cache=False
    ),
    client_certificate_id="clientCertificateId",
    deployment_id="deploymentId",
    description="description",
    documentation_version="documentationVersion",
    method_settings=[apigateway.CfnStage.MethodSettingProperty(
        cache_data_encrypted=False,
        cache_ttl_in_seconds=123,
        caching_enabled=False,
        data_trace_enabled=False,
        http_method="httpMethod",
        logging_level="loggingLevel",
        metrics_enabled=False,
        resource_path="resourcePath",
        throttling_burst_limit=123,
        throttling_rate_limit=123
    )],
    stage_name="stageName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tracing_enabled=False,
    variables={
        "variables_key": "variables"
    }
)

Attributes

access_log_setting

AWS::ApiGateway::Stage.AccessLogSetting.

Link

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

Return type

Union[IResolvable, AccessLogSettingProperty, None]

cache_cluster_enabled

AWS::ApiGateway::Stage.CacheClusterEnabled.

Link

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

Return type

Union[bool, IResolvable, None]

cache_cluster_size

AWS::ApiGateway::Stage.CacheClusterSize.

Link

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.

Link

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

Return type

Union[IResolvable, CanarySettingProperty, None]

client_certificate_id

AWS::ApiGateway::Stage.ClientCertificateId.

Link

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.

Link

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.

Link

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.

Link

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.

Link

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

Return type

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

rest_api_id

AWS::ApiGateway::Stage.RestApiId.

Link

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.

Link

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.

Link

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.

Link

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

Return type

Union[bool, IResolvable, None]

variables

AWS::ApiGateway::Stage.Variables.

Link

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

Return type

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