CfnUrlProps Struct
Properties for defining a CfnUrl.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnUrlProps: lambda.CfnUrlProps = {
authType: 'authType',
targetFunctionArn: 'targetFunctionArn',
// the properties below are optional
cors: {
allowCredentials: false,
allowHeaders: ['allowHeaders'],
allowMethods: ['allowMethods'],
allowOrigins: ['allowOrigins'],
exposeHeaders: ['exposeHeaders'],
maxAge: 123,
},
invokeMode: 'invokeMode',
qualifier: 'qualifier',
};
python
# 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_url_props = lambda.CfnUrlProps(
auth_type="authType",
target_function_arn="targetFunctionArn",
# the properties below are optional
cors=lambda.CfnUrl.CorsProperty(
allow_credentials=False,
allow_headers=["allowHeaders"],
allow_methods=["allowMethods"],
allow_origins=["allowOrigins"],
expose_headers=["exposeHeaders"],
max_age=123
),
invoke_mode="invokeMode",
qualifier="qualifier"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lambda.*;
CfnUrlProps cfnUrlProps = CfnUrlProps.builder()
.authType("authType")
.targetFunctionArn("targetFunctionArn")
// the properties below are optional
.cors(CorsProperty.builder()
.allowCredentials(false)
.allowHeaders(List.of("allowHeaders"))
.allowMethods(List.of("allowMethods"))
.allowOrigins(List.of("allowOrigins"))
.exposeHeaders(List.of("exposeHeaders"))
.maxAge(123)
.build())
.invokeMode("invokeMode")
.qualifier("qualifier")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;
var cfnUrlProps = new CfnUrlProps {
AuthType = "authType",
TargetFunctionArn = "targetFunctionArn",
// the properties below are optional
Cors = new CorsProperty {
AllowCredentials = false,
AllowHeaders = new [] { "allowHeaders" },
AllowMethods = new [] { "allowMethods" },
AllowOrigins = new [] { "allowOrigins" },
ExposeHeaders = new [] { "exposeHeaders" },
MaxAge = 123
},
InvokeMode = "invokeMode",
Qualifier = "qualifier"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnUrlProps := &CfnUrlProps{
AuthType: jsii.String("authType"),
TargetFunctionArn: jsii.String("targetFunctionArn"),
// the properties below are optional
Cors: &CorsProperty{
AllowCredentials: jsii.Boolean(false),
AllowHeaders: []*string{
jsii.String("allowHeaders"),
},
AllowMethods: []*string{
jsii.String("allowMethods"),
},
AllowOrigins: []*string{
jsii.String("allowOrigins"),
},
ExposeHeaders: []*string{
jsii.String("exposeHeaders"),
},
MaxAge: jsii.Number(123),
},
InvokeMode: jsii.String("invokeMode"),
Qualifier: jsii.String("qualifier"),
}
Properties
The type of authentication that your function URL uses.
notes
Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs .
corsoptionalIResolvable | CfnUrl.CorsPropertycorsoptionaltyping.Union[IResolvable, CorsProperty]corsoptionalIResolvableCorsoptionalIResolvableCorsoptionalinterface{} #The Cross-Origin Resource Sharing (CORS) settings for your function URL.
invokeModeoptionalstringinvoke_modeoptionalstrinvokeModeoptionalStringInvokeModeoptionalstringInvokeModeoptional*string #Use one of the following options:.
notes
BUFFERED– This is the default option. Lambda invokes your function using theInvokeAPI operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.RESPONSE_STREAM– Your function streams payload results as they become available. Lambda invokes your function using theInvokeWithResponseStreamAPI operation. The maximum response payload size is 200 MB.
qualifieroptionalstringqualifieroptionalstrqualifieroptionalStringQualifieroptionalstringQualifieroptional*string #The alias name.
targetFunctionArnstring | IFunctionReftarget_function_arntyping.Union[str, IFunctionRef]targetFunctionArnStringTargetFunctionArnstringTargetFunctionArninterface{} required #The name of the Lambda function.
notes
Name formats - Function name - my-function .
- Function ARN -
lambda: : :function:my-function. - Partial ARN -
:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.