Class CfnUrlProps
Properties for defining a CfnUrl
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.AWS.Lambda.dll
Syntax (csharp)
public class CfnUrlProps : Object, ICfnUrlProps
Syntax (vb)
Public Class CfnUrlProps
Inherits Object
Implements ICfnUrlProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html
ExampleMetadata: fixture=_generated
Examples
// 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"
};
Synopsis
Constructors
CfnUrlProps() |
Properties
AuthType | The type of authentication that your function URL uses. |
Cors | The Cross-Origin Resource Sharing (CORS) settings for your function URL. |
InvokeMode | Use one of the following options:. |
Qualifier | The alias name. |
TargetFunctionArn | The name of the Lambda function. |
Constructors
CfnUrlProps()
public CfnUrlProps()
Properties
AuthType
The type of authentication that your function URL uses.
public string AuthType { get; set; }
Property Value
System.String
Remarks
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 .
Cors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
public object Cors { get; set; }
Property Value
System.Object
Remarks
InvokeMode
Use one of the following options:.
public string InvokeMode { get; set; }
Property Value
System.String
Remarks
Qualifier
The alias name.
public string Qualifier { get; set; }
Property Value
System.String
Remarks
TargetFunctionArn
The name of the Lambda function.
public string TargetFunctionArn { get; set; }
Property Value
System.String
Remarks
Name formats - Function name - 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.