CfnWebFunctionEndpoint

class aws_cdk.aws_lambda.CfnWebFunctionEndpoint(scope, id, *, auth_type, endpoint_name, endpoint_type, function_name, description=None, regions=None, revision_weights=None, scaling_config=None, throttle_config=None)

Bases: CfnResource

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
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 = lambda_.CfnWebFunctionEndpoint(self, "MyCfnWebFunctionEndpoint",
    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
    )
)

Create a new AWS::Lambda::WebFunctionEndpoint.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.

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_dependency(target)

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

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_depends_on(target)

(deprecated) 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.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

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.

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 intermediate 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

add_resource_dependency(target, reason=None)

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.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:

target (CfnResource)
reason (Optional[str])

Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

The reference strength to use for this resource.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)

Parameters:: cdk_property_name (str)
Return type:: Optional[str]

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:: List[Union[Stack, CfnResource]]

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

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Deprecated:: Use removeResourceDependency instead
Stability:: deprecated
Return type:: None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Lambda::WebFunctionEndpoint'

attr_created_at

The timestamp when the endpoint was created.

CloudformationAttribute:: CreatedAt

attr_domain_name

The domain name of the endpoint.

CloudformationAttribute:: DomainName

attr_endpoint_arn

The Amazon Resource Name (ARN) of the endpoint.

CloudformationAttribute:: EndpointArn

attr_function_arn

The Amazon Resource Name (ARN) of the function.

CloudformationAttribute:: FunctionArn

attr_regional_endpoints

Per-region endpoint status and configuration.

CloudformationAttribute:: RegionalEndpoints

attr_state

The current state of the endpoint.

CloudformationAttribute:: State

attr_state_reason

The reason for the endpoint’s current state.

CloudformationAttribute:: StateReason

attr_update_status

The status of the last update operation.

CloudformationAttribute:: UpdateStatus

attr_update_status_reason

The reason for the update status.

CloudformationAttribute:: UpdateStatusReason

attr_updated_at

The timestamp when the endpoint was last updated.

CloudformationAttribute:: UpdatedAt

auth_type: The authentication type for the endpoint.

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

cfn_resource_type: AWS resource type.

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.

description: A description of the endpoint.

endpoint_name: The name of the endpoint.

endpoint_type: The type of the endpoint.

env

function_name: The name of the web function this endpoint belongs to.

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

Returns:

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

node: The tree node.

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 }).

regions: The list of AWS Regions for the endpoint.

revision_weights: List of revision routing entries.

scaling_config: The scaling configuration for the endpoint.

stack

The stack in which this element is defined.

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

throttle_config: The throttling configuration for the endpoint.

web_function_endpoint_ref: A reference to a WebFunctionEndpoint resource.

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(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_web_function_endpoint(x)

Checks whether the given object is a CfnWebFunctionEndpoint.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

RegionalEndpointProperty

class CfnWebFunctionEndpoint.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 import aws_lambda as lambda_

regional_endpoint_property = lambda.CfnWebFunctionEndpoint.RegionalEndpointProperty(
    auth_type="authType",
    domain_name="domainName",
    revision_weights=[lambda.CfnWebFunctionEndpoint.RevisionWeightProperty(
        revision_id="revisionId",
        weight=123
    )],
    scaling_config=lambda.CfnWebFunctionEndpoint.ScalingConfigProperty(
        max_environments=123
    ),
    state="state",
    state_reason="stateReason",
    throttle_config=lambda.CfnWebFunctionEndpoint.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 CfnWebFunctionEndpoint.RevisionWeightProperty(*, revision_id, weight)

Bases: object

A revision routing entry.

Parameters:

revision_id (str) – The revision identifier.
weight (Union[int, float]) – 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 import aws_lambda as lambda_

revision_weight_property = lambda.CfnWebFunctionEndpoint.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 CfnWebFunctionEndpoint.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 import aws_lambda as lambda_

scaling_config_property = lambda.CfnWebFunctionEndpoint.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 CfnWebFunctionEndpoint.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 import aws_lambda as lambda_

throttle_config_property = lambda.CfnWebFunctionEndpoint.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