Class FunctionUrlProps

Properties for a FunctionUrl.

Inheritance

object

FunctionUrlProps

Implements

IFunctionUrlProps

IFunctionUrlOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Lambda

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class FunctionUrlProps : IFunctionUrlProps, IFunctionUrlOptions

Syntax (vb)

Public Class FunctionUrlProps 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;
            using Amazon.CDK.AWS.Lambda;

            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)
                },
                InvokeMode = InvokeMode.BUFFERED
            };

Synopsis

Constructors

FunctionUrlProps()

Properties for a FunctionUrl.

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.
InvokeMode	The type of invocation mode that your Lambda function uses.

Constructors

FunctionUrlProps()

Properties for a FunctionUrl.

public FunctionUrlProps()

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

            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)
                },
                InvokeMode = InvokeMode.BUFFERED
            };

Properties

AuthType

The type of authentication that your function URL uses.

public FunctionUrlAuthType? AuthType { get; set; }

Property Value

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.

InvokeMode

The type of invocation mode that your Lambda function uses.

public InvokeMode? InvokeMode { get; set; }

Property Value

InvokeMode?

Remarks

Default: InvokeMode.BUFFERED

Implements

IFunctionUrlProps

IFunctionUrlOptions