CfnWebFunctionEndpointPropsMixin

class aws_cdk.cfn_property_mixins.aws_lambda.CfnWebFunctionEndpointPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::Lambda::WebFunctionEndpoint.

An endpoint exposes a Lambda web function over HTTPS and routes traffic to one or more revisions. The endpoint type determines how traffic is served and routed across Regions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html
CloudformationResource:: AWS::Lambda::WebFunctionEndpoint
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_lambda as lambda_
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_web_function_endpoint_props_mixin = lambda_.CfnWebFunctionEndpointPropsMixin(lambda.CfnWebFunctionEndpointMixinProps(
    auth_type="authType",
    description="description",
    endpoint_name="endpointName",
    endpoint_type="endpointType",
    function_name="functionName",
    regions=["regions"],
    revision_weights=[lambda.CfnWebFunctionEndpointPropsMixin.RevisionWeightProperty(
        revision_id="revisionId",
        weight=123
    )],
    scaling_config=lambda.CfnWebFunctionEndpointPropsMixin.ScalingConfigProperty(
        max_environments=123
    ),
    throttle_config=lambda.CfnWebFunctionEndpointPropsMixin.ThrottleConfigProperty(
        rate_limit=123
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Lambda::WebFunctionEndpoint.

Parameters:

props (Union[CfnWebFunctionEndpointMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['authType', 'description', 'endpointName', 'endpointType', 'functionName', 'regions', 'revisionWeights', 'scalingConfig', 'throttleConfig']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

RegionalEndpointProperty

class CfnWebFunctionEndpointPropsMixin.RegionalEndpointProperty(*, auth_type=None, domain_name=None, revision_weights=None, scaling_config=None, state=None, state_reason=None, throttle_config=None, update_status=None, update_status_reason=None)

Bases: object

Per-region endpoint information.

Parameters:

auth_type (Optional[str]) – The authentication type for the endpoint.
domain_name (Optional[str]) – The domain name of the endpoint.
revision_weights (Union[IResolvable, Sequence[Union[IResolvable, RevisionWeightProperty, Dict[str, Any]]], None]) – The revision weights for the endpoint.
scaling_config (Union[IResolvable, ScalingConfigProperty, Dict[str, Any], None]) – The scaling configuration for the endpoint. Optionally constrains how many concurrent execution environments the endpoint can use, in addition to your account’s vCPU quota.
state (Optional[str]) – The current state of the endpoint.
state_reason (Optional[str]) – The reason for the current state of the endpoint.
throttle_config (Union[IResolvable, ThrottleConfigProperty, Dict[str, Any], None]) – The throttling configuration for the endpoint. Optionally constrains the request rate that the endpoint accepts, in addition to your account’s rate limit quota.
update_status (Optional[str]) – The status of the most recent update to the endpoint.
update_status_reason (Optional[str]) – The reason for the current update status of the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_lambda as lambda_

regional_endpoint_property = lambda.CfnWebFunctionEndpointPropsMixin.RegionalEndpointProperty(
    auth_type="authType",
    domain_name="domainName",
    revision_weights=[lambda.CfnWebFunctionEndpointPropsMixin.RevisionWeightProperty(
        revision_id="revisionId",
        weight=123
    )],
    scaling_config=lambda.CfnWebFunctionEndpointPropsMixin.ScalingConfigProperty(
        max_environments=123
    ),
    state="state",
    state_reason="stateReason",
    throttle_config=lambda.CfnWebFunctionEndpointPropsMixin.ThrottleConfigProperty(
        rate_limit=123
    ),
    update_status="updateStatus",
    update_status_reason="updateStatusReason"
)

Attributes

auth_type

The authentication type for the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-authtype

domain_name

The domain name of the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-domainname

revision_weights

The revision weights for the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-revisionweights

scaling_config

The scaling configuration for the endpoint.

Optionally constrains how many concurrent execution environments the endpoint can use, in addition to your account’s vCPU quota.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-scalingconfig

state

The current state of the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-state

state_reason

The reason for the current state of the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-statereason

throttle_config

The throttling configuration for the endpoint.

Optionally constrains the request rate that the endpoint accepts, in addition to your account’s rate limit quota.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-throttleconfig

update_status

The status of the most recent update to the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-updatestatus

update_status_reason

The reason for the current update status of the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-regionalendpoint.html#cfn-lambda-webfunctionendpoint-regionalendpoint-updatestatusreason

RevisionWeightProperty

class CfnWebFunctionEndpointPropsMixin.RevisionWeightProperty(*, revision_id=None, weight=None)

Bases: object

A revision routing entry.

Parameters:

revision_id (Optional[str]) – The revision identifier.
weight (Union[int, float, None]) – The traffic weight for this revision.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-revisionweight.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_lambda as lambda_

revision_weight_property = lambda.CfnWebFunctionEndpointPropsMixin.RevisionWeightProperty(
    revision_id="revisionId",
    weight=123
)

Attributes

revision_id

The revision identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-revisionweight.html#cfn-lambda-webfunctionendpoint-revisionweight-revisionid

weight

The traffic weight for this revision.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-revisionweight.html#cfn-lambda-webfunctionendpoint-revisionweight-weight

ScalingConfigProperty

class CfnWebFunctionEndpointPropsMixin.ScalingConfigProperty(*, max_environments=None)

Bases: object

The scaling configuration for the endpoint.

Optionally constrains how many concurrent execution environments the endpoint can use, in addition to your account’s vCPU quota.

Parameters:: max_environments (Union[int, float, None]) – The maximum number of concurrent execution environments for the endpoint. This optional limit further constrains the endpoint’s scaling. When omitted, the endpoint’s scaling is limited only by your account’s vCPU quota.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-scalingconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_lambda as lambda_

scaling_config_property = lambda.CfnWebFunctionEndpointPropsMixin.ScalingConfigProperty(
    max_environments=123
)

Attributes

max_environments

The maximum number of concurrent execution environments for the endpoint.

This optional limit further constrains the endpoint’s scaling. When omitted, the endpoint’s scaling is limited only by your account’s vCPU quota.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-scalingconfig.html#cfn-lambda-webfunctionendpoint-scalingconfig-maxenvironments

ThrottleConfigProperty

class CfnWebFunctionEndpointPropsMixin.ThrottleConfigProperty(*, rate_limit=None)

Bases: object

The throttling configuration for the endpoint.

Optionally constrains the request rate that the endpoint accepts, in addition to your account’s rate limit quota.

Parameters:: rate_limit (Union[int, float, None]) – The maximum request rate per second for the endpoint, up to a maximum of 10000. This optional limit further constrains the endpoint’s request rate. When omitted, the endpoint’s request rate is limited only by your account’s rate limit quota. Specify 0 to reject all new requests. Other supported values are 100 through 1000 in increments of 100, and 2000 through 10000 in increments of 1000. Supported values can vary by Region; if you specify an unsupported value, the error lists the values available in that Region.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-throttleconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_lambda as lambda_

throttle_config_property = lambda.CfnWebFunctionEndpointPropsMixin.ThrottleConfigProperty(
    rate_limit=123
)

Attributes

rate_limit

The maximum request rate per second for the endpoint, up to a maximum of 10000.

This optional limit further constrains the endpoint’s request rate. When omitted, the endpoint’s request rate is limited only by your account’s rate limit quota. Specify 0 to reject all new requests. Other supported values are 100 through 1000 in increments of 100, and 2000 through 10000 in increments of 1000. Supported values can vary by Region; if you specify an unsupported value, the error lists the values available in that Region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-throttleconfig.html#cfn-lambda-webfunctionendpoint-throttleconfig-ratelimit