CfnDeploymentProps

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

Bases: object

Properties for defining a CfnDeployment.

Parameters
  • rest_api_id (str) – The ID of the RestApi resource to deploy.

  • deployment_canary_settings (Union[IResolvable, DeploymentCanarySettingsProperty, None]) – Specifies settings for the canary deployment.

  • description (Optional[str]) – A description of the purpose of the API Gateway deployment.

  • stage_description (Union[IResolvable, StageDescriptionProperty, None]) – Configures the stage that API Gateway creates with this deployment.

  • stage_name (Optional[str]) – A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-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_apigateway as apigateway

cfn_deployment_props = apigateway.CfnDeploymentProps(
    rest_api_id="restApiId",

    # the properties below are optional
    deployment_canary_settings=apigateway.CfnDeployment.DeploymentCanarySettingsProperty(
        percent_traffic=123,
        stage_variable_overrides={
            "stage_variable_overrides_key": "stageVariableOverrides"
        },
        use_stage_cache=False
    ),
    description="description",
    stage_description=apigateway.CfnDeployment.StageDescriptionProperty(
        access_log_setting=apigateway.CfnDeployment.AccessLogSettingProperty(
            destination_arn="destinationArn",
            format="format"
        ),
        cache_cluster_enabled=False,
        cache_cluster_size="cacheClusterSize",
        cache_data_encrypted=False,
        cache_ttl_in_seconds=123,
        caching_enabled=False,
        canary_setting=apigateway.CfnDeployment.CanarySettingProperty(
            percent_traffic=123,
            stage_variable_overrides={
                "stage_variable_overrides_key": "stageVariableOverrides"
            },
            use_stage_cache=False
        ),
        client_certificate_id="clientCertificateId",
        data_trace_enabled=False,
        description="description",
        documentation_version="documentationVersion",
        logging_level="loggingLevel",
        method_settings=[apigateway.CfnDeployment.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
        )],
        metrics_enabled=False,
        tags=[CfnTag(
            key="key",
            value="value"
        )],
        throttling_burst_limit=123,
        throttling_rate_limit=123,
        tracing_enabled=False,
        variables={
            "variables_key": "variables"
        }
    ),
    stage_name="stageName"
)

Attributes

deployment_canary_settings

Specifies settings for the canary deployment.

Link

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

Return type

Union[IResolvable, DeploymentCanarySettingsProperty, None]

description

A description of the purpose of the API Gateway deployment.

Link

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

Return type

Optional[str]

rest_api_id

The ID of the RestApi resource to deploy.

Link

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

Return type

str

stage_description

Configures the stage that API Gateway creates with this deployment.

Link

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

Return type

Union[IResolvable, StageDescriptionProperty, None]

stage_name

A name for the stage that API Gateway creates with this deployment.

Use only alphanumeric characters.

Link

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

Return type

Optional[str]