CfnStage

class aws_cdk.aws_apigatewayv2.CfnStage(scope, id, *, api_id, stage_name, access_log_settings=None, access_policy_id=None, auto_deploy=None, client_certificate_id=None, default_route_settings=None, deployment_id=None, description=None, route_settings=None, stage_variables=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ApiGatewayV2::Stage.

The AWS::ApiGatewayV2::Stage resource specifies a stage for an API. Each stage is a named reference to a deployment of the API and is made available for client applications to call. To learn more, see Working with stages for HTTP APIs and Deploy a WebSocket API in API Gateway .

CloudformationResource

AWS::ApiGatewayV2::Stage

Link

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

# route_settings: Any
# stage_variables: Any
# tags: Any

cfn_stage = apigatewayv2.CfnStage(self, "MyCfnStage",
    api_id="apiId",
    stage_name="stageName",

    # the properties below are optional
    access_log_settings=apigatewayv2.CfnStage.AccessLogSettingsProperty(
        destination_arn="destinationArn",
        format="format"
    ),
    access_policy_id="accessPolicyId",
    auto_deploy=False,
    client_certificate_id="clientCertificateId",
    default_route_settings=apigatewayv2.CfnStage.RouteSettingsProperty(
        data_trace_enabled=False,
        detailed_metrics_enabled=False,
        logging_level="loggingLevel",
        throttling_burst_limit=123,
        throttling_rate_limit=123
    ),
    deployment_id="deploymentId",
    description="description",
    route_settings=route_settings,
    stage_variables=stage_variables,
    tags=tags
)

Create a new AWS::ApiGatewayV2::Stage.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • api_id (str) – The API identifier.

  • stage_name (str) – The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.

  • access_log_settings (Union[IResolvable, AccessLogSettingsProperty, Dict[str, Any], None]) – Settings for logging access in this stage.

  • access_policy_id (Optional[str]) – This parameter is not currently supported.

  • auto_deploy (Union[bool, IResolvable, None]) – Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

  • client_certificate_id (Optional[str]) – The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.

  • default_route_settings (Union[IResolvable, RouteSettingsProperty, Dict[str, Any], None]) – The default route settings for the stage.

  • deployment_id (Optional[str]) – The deployment identifier for the API stage. Can’t be updated if autoDeploy is enabled.

  • description (Optional[str]) – The description for the API stage.

  • route_settings (Optional[Any]) – Route settings for the stage.

  • stage_variables (Optional[Any]) – A map that defines the stage variables for a Stage . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

  • tags (Optional[Any]) – The collection of tags. Each tag element is associated with a given resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ApiGatewayV2::Stage'
access_log_settings

Settings for logging access in this stage.

Link

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

Return type

Union[IResolvable, AccessLogSettingsProperty, None]

access_policy_id

This parameter is not currently supported.

Link

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

Return type

Optional[str]

api_id

The API identifier.

Link

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

Return type

str

auto_deploy

Specifies whether updates to an API automatically trigger a new deployment.

The default value is false .

Link

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

Return type

Union[bool, IResolvable, None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

client_certificate_id

The identifier of a client certificate for a Stage .

Supported only for WebSocket APIs.

Link

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

Return type

Optional[str]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

default_route_settings

The default route settings for the stage.

Link

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

Return type

Union[IResolvable, RouteSettingsProperty, None]

deployment_id

The deployment identifier for the API stage.

Can’t be updated if autoDeploy is enabled.

Link

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

Return type

Optional[str]

description

The description for the API stage.

Link

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

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

route_settings

Route settings for the stage.

Link

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

Return type

Any

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

stage_name

The stage name.

Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.

Link

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

Return type

str

stage_variables

A map that defines the stage variables for a Stage .

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Link

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

Return type

Any

tags

The collection of tags.

Each tag element is associated with a given resource.

Link

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

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AccessLogSettingsProperty

class CfnStage.AccessLogSettingsProperty(*, destination_arn=None, format=None)

Bases: object

Settings for logging access in a stage.

Parameters
  • destination_arn (Optional[str]) – The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.

  • format (Optional[str]) – A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.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

access_log_settings_property = apigatewayv2.CfnStage.AccessLogSettingsProperty(
    destination_arn="destinationArn",
    format="format"
)

Attributes

destination_arn

The ARN of the CloudWatch Logs log group to receive access logs.

This parameter is required to enable access logging.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-destinationarn

Return type

Optional[str]

format

A single line format of the access logs of data, as specified by selected $context variables.

The format must include at least $context.requestId. This parameter is required to enable access logging.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-format

Return type

Optional[str]

RouteSettingsProperty

class CfnStage.RouteSettingsProperty(*, data_trace_enabled=None, detailed_metrics_enabled=None, logging_level=None, throttling_burst_limit=None, throttling_rate_limit=None)

Bases: object

Represents a collection of route settings.

Parameters
  • data_trace_enabled (Union[bool, IResolvable, None]) – Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

  • detailed_metrics_enabled (Union[bool, IResolvable, None]) – Specifies whether detailed metrics are enabled.

  • logging_level (Optional[str]) – Specifies the logging level for this route: INFO , ERROR , or OFF . This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

  • throttling_burst_limit (Union[int, float, None]) – Specifies the throttling burst limit.

  • throttling_rate_limit (Union[int, float, None]) – Specifies the throttling rate limit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.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

route_settings_property = apigatewayv2.CfnStage.RouteSettingsProperty(
    data_trace_enabled=False,
    detailed_metrics_enabled=False,
    logging_level="loggingLevel",
    throttling_burst_limit=123,
    throttling_rate_limit=123
)

Attributes

data_trace_enabled

Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route.

This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-datatraceenabled

Return type

Union[bool, IResolvable, None]

detailed_metrics_enabled

Specifies whether detailed metrics are enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-detailedmetricsenabled

Return type

Union[bool, IResolvable, None]

logging_level

INFO , ERROR , or OFF .

This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-logginglevel

Type

Specifies the logging level for this route

Return type

Optional[str]

throttling_burst_limit

Specifies the throttling burst limit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingburstlimit

Return type

Union[int, float, None]

throttling_rate_limit

Specifies the throttling rate limit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingratelimit

Return type

Union[int, float, None]