CfnWebFunctionEndpointProps

class aws_cdk.aws_lambda.CfnWebFunctionEndpointProps(*, auth_type, endpoint_name, endpoint_type, function_name, description=None, regions=None, revision_weights=None, scaling_config=None, throttle_config=None)

Bases: object

Properties for defining a CfnWebFunctionEndpoint.

Parameters:
  • auth_type (str) – The authentication type for the endpoint.

  • endpoint_name (str) – The name of the endpoint.

  • endpoint_type (str) – The type of the endpoint.

  • function_name (str) – The name of the web function this endpoint belongs to. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • description (Optional[str]) – A description of the endpoint.

  • regions (Optional[Sequence[str]]) – The list of AWS Regions for the endpoint.

  • revision_weights (Union[IResolvable, Sequence[Union[IResolvable, RevisionWeightProperty, Dict[str, Any]]], None]) – List of revision routing entries. 1 or 2 entries. With 1 entry, weight must be 100. With 2 entries, weights must sum to 100.

  • 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.

  • 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.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 import aws_lambda as lambda_

cfn_web_function_endpoint_props = lambda.CfnWebFunctionEndpointProps(
    auth_type="authType",
    endpoint_name="endpointName",
    endpoint_type="endpointType",
    function_name="functionName",

    # the properties below are optional
    description="description",
    regions=["regions"],
    revision_weights=[lambda.CfnWebFunctionEndpoint.RevisionWeightProperty(
        revision_id="revisionId",
        weight=123
    )],
    scaling_config=lambda.CfnWebFunctionEndpoint.ScalingConfigProperty(
        max_environments=123
    ),
    throttle_config=lambda.CfnWebFunctionEndpoint.ThrottleConfigProperty(
        rate_limit=123
    )
)

Attributes

auth_type

The authentication type for the endpoint.

See:

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

description

A description of the endpoint.

See:

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

endpoint_name

The name of the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-endpointname

endpoint_type

The type of the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-endpointtype

function_name

The name of the web function this endpoint belongs to.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-functionname

regions

The list of AWS Regions for the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-regions

revision_weights

List of revision routing entries.

1 or 2 entries. With 1 entry, weight must be 100. With 2 entries, weights must sum to 100.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-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-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-scalingconfig

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-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-throttleconfig