Skip to content
v2.277.0

WebFunctionEndpointAttributes Struct ​

Attributes for importing an existing WebFunction endpoint.

Example ​

ts
const endpoint = lambda.WebFunctionEndpoint.fromWebFunctionEndpointAttributes(this, 'Endpoint', {
  endpointArn: 'arn:aws:lambda:us-west-2:123456789012:web-function/my-function/endpoint/prod',
  domainName: 'abcd1234.lambda-web.us-west-2.on.aws',
  endpointType: lambda.WebFunctionEndpointType.HOME_REGION,
  authType: lambda.WebFunctionAuthType.IAM_AUTH,
});
python
endpoint = lambda_.WebFunctionEndpoint.from_web_function_endpoint_attributes(self, "Endpoint",
    endpoint_arn="arn:aws:lambda:us-west-2:123456789012:web-function/my-function/endpoint/prod",
    domain_name="abcd1234.lambda-web.us-west-2.on.aws",
    endpoint_type=lambda_.WebFunctionEndpointType.HOME_REGION,
    auth_type=lambda_.WebFunctionAuthType.IAM_AUTH
)
java
IWebFunctionEndpoint endpoint = WebFunctionEndpoint.fromWebFunctionEndpointAttributes(this, "Endpoint", WebFunctionEndpointAttributes.builder()
        .endpointArn("arn:aws:lambda:us-west-2:123456789012:web-function/my-function/endpoint/prod")
        .domainName("abcd1234.lambda-web.us-west-2.on.aws")
        .endpointType(WebFunctionEndpointType.HOME_REGION)
        .authType(WebFunctionAuthType.IAM_AUTH)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
var endpoint = WebFunctionEndpoint.FromWebFunctionEndpointAttributes(this, "Endpoint", new WebFunctionEndpointAttributes {
    EndpointArn = "arn:aws:lambda:us-west-2:123456789012:web-function/my-function/endpoint/prod",
    DomainName = "abcd1234.lambda-web.us-west-2.on.aws",
    EndpointType = WebFunctionEndpointType.HOME_REGION,
    AuthType = WebFunctionAuthType.IAM_AUTH
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
endpoint := lambda.WebFunctionEndpoint_FromWebFunctionEndpointAttributes(this, jsii.String("Endpoint"), &WebFunctionEndpointAttributes{
	EndpointArn: jsii.String("arn:aws:lambda:us-west-2:123456789012:web-function/my-function/endpoint/prod"),
	DomainName: jsii.String("abcd1234.lambda-web.us-west-2.on.aws"),
	EndpointType: lambda.WebFunctionEndpointType_HOME_REGION,
	AuthType: lambda.WebFunctionAuthType_IAM_AUTH,
})

Properties ​

How the endpoint authenticates requests.
notes

For an imported endpoint this is taken as given: it is not verified against the deployed endpoint and must match it, because downstream constructs rely on it for a synth-time security decision. Like domainName, it cannot be derived from the ARN.

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string required #
The domain name of the endpoint.

The service assigns it, so it cannot be derived from the ARN.

endpointArnstringendpoint_arnstrendpointArnStringEndpointArnstringEndpointArn*string required #
The ARN of the endpoint, `arn:<partition>:lambda:<region>:<account>:web-function/<function>/endpoint/<endpoint>`.
The endpoint type.