WebFunctionAuthType Enum
Authentication type for WebFunction domain configuration.
| Source | aws-lambda/lib/webfunction-endpoint.ts |
|---|---|
| Type last changed |
Example
ts
import * as s3 from 'aws-cdk-lib/aws-s3';
declare const codeBucket: s3.IBucket;
new lambda.WebFunction(this, 'PerRegionApi', {
code: lambda.WebFunctionCode.fromBucket(codeBucket, 'app.zip', 'version-id'),
runtime: lambda.WebFunctionRuntime.NODEJS_24_X,
defaultEndpointAuth: lambda.WebFunctionAuthType.IAM_AUTH,
defaultEndpoint: {
endpointLocation: lambda.WebFunctionEndpointLocation.perRegion(['us-east-1', 'us-west-2']),
},
});
python
import aws_cdk.aws_s3 as s3
# code_bucket: s3.IBucket
lambda_.WebFunction(self, "PerRegionApi",
code=lambda_.WebFunctionCode.from_bucket(code_bucket, "app.zip", "version-id"),
runtime=lambda_.WebFunctionRuntime.NODEJS_24_X,
default_endpoint_auth=lambda_.WebFunctionAuthType.IAM_AUTH,
default_endpoint=lambda.WebFunctionDefaultEndpointOptions(
endpoint_location=lambda_.WebFunctionEndpointLocation.per_region(["us-east-1", "us-west-2"])
)
)
java
import software.amazon.awscdk.services.s3.*;
IBucket codeBucket;
WebFunction.Builder.create(this, "PerRegionApi")
.code(WebFunctionCode.fromBucket(codeBucket, "app.zip", "version-id"))
.runtime(WebFunctionRuntime.NODEJS_24_X)
.defaultEndpointAuth(WebFunctionAuthType.IAM_AUTH)
.defaultEndpoint(WebFunctionDefaultEndpointOptions.builder()
.endpointLocation(WebFunctionEndpointLocation.perRegion(List.of("us-east-1", "us-west-2")))
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.S3;
IBucket codeBucket;
new WebFunction(this, "PerRegionApi", new WebFunctionProps {
Code = WebFunctionCode.FromBucket(codeBucket, "app.zip", "version-id"),
Runtime = WebFunctionRuntime.NODEJS_24_X,
DefaultEndpointAuth = WebFunctionAuthType.IAM_AUTH,
DefaultEndpoint = new WebFunctionDefaultEndpointOptions {
EndpointLocation = WebFunctionEndpointLocation.PerRegion(new [] { "us-east-1", "us-west-2" })
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import s3 "github.com/aws/aws-cdk-go/awscdk"
var codeBucket IBucket
lambda.NewWebFunction(this, jsii.String("PerRegionApi"), &WebFunctionProps{
Code: lambda.WebFunctionCode_FromBucket(codeBucket, jsii.String("app.zip"), jsii.String("version-id")),
Runtime: lambda.WebFunctionRuntime_NODEJS_24_X(),
DefaultEndpointAuth: lambda.WebFunctionAuthType_IAM_AUTH,
DefaultEndpoint: &WebFunctionDefaultEndpointOptions{
EndpointLocation: lambda.WebFunctionEndpointLocation_PerRegion([]*string{
jsii.String("us-east-1"),
jsii.String("us-west-2"),
}),
},
})
Members
| Member | Description |
|---|---|
APPLICATION_MANAGED | Authentication is managed by the application itself. |
IAM_AUTH | Authentication using AWS IAM. |
Referenced by
IWebFunctionEndpoint.authTypeauth_typeauthTypeAuthTypeAuthTypeWebFunctionEndpoint.authTypeauth_typeauthTypeAuthTypeAuthTypeWebFunctionEndpointAttributes.authTypeauth_typeauthTypeAuthTypeAuthTypeWebFunctionEndpointBase.authTypeauth_typeauthTypeAuthTypeAuthTypeWebFunctionEndpointOptions.authTypeauth_typeauthTypeAuthTypeAuthTypeWebFunctionProps.defaultEndpointAuthdefault_endpoint_authdefaultEndpointAuthDefaultEndpointAuthDefaultEndpointAuth