Show / Hide Table of Contents

Class FunctionUrlProps

Properties for a FunctionUrl.

Inheritance
System.Object
FunctionUrlProps
Implements
IFunctionUrlProps
IFunctionUrlOptions
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.AWS.Lambda.dll
Syntax (csharp)
public class FunctionUrlProps : Object, IFunctionUrlProps, IFunctionUrlOptions
Syntax (vb)
Public Class FunctionUrlProps
    Inherits Object
    Implements IFunctionUrlProps, IFunctionUrlOptions
Remarks

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;
using Amazon.CDK;

Function function_;
var functionUrlProps = new FunctionUrlProps {
    Function = function_,

    // the properties below are optional
    AuthType = FunctionUrlAuthType.AWS_IAM,
    Cors = new FunctionUrlCorsOptions {
        AllowCredentials = false,
        AllowedHeaders = new [] { "allowedHeaders" },
        AllowedMethods = new [] { HttpMethod.GET },
        AllowedOrigins = new [] { "allowedOrigins" },
        ExposedHeaders = new [] { "exposedHeaders" },
        MaxAge = Duration.Minutes(30)
    }
};

Synopsis

Constructors

FunctionUrlProps()

Properties

AuthType

The type of authentication that your function URL uses.

Cors

The cross-origin resource sharing (CORS) settings for your function URL.

Function

The function to which this url refers.

Constructors

FunctionUrlProps()

public FunctionUrlProps()

Properties

AuthType

The type of authentication that your function URL uses.

public Nullable<FunctionUrlAuthType> AuthType { get; set; }
Property Value

System.Nullable<FunctionUrlAuthType>

Remarks

Default: FunctionUrlAuthType.AWS_IAM

Cors

The cross-origin resource sharing (CORS) settings for your function URL.

public IFunctionUrlCorsOptions Cors { get; set; }
Property Value

IFunctionUrlCorsOptions

Remarks

Default: - No CORS configuration.

Function

The function to which this url refers.

public IFunction Function { get; set; }
Property Value

IFunction

Remarks

It can also be an Alias but not a Version.

Implements

IFunctionUrlProps
IFunctionUrlOptions
Back to top Generated by DocFX