Package software.amazon.awscdk.cfnpropertymixins.services.lambda

Class CfnUrlPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.lambda.CfnUrlPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUrlPropsMixin>

Enclosing class:

CfnUrlPropsMixin

@Stability(Stable)
public static final class CfnUrlPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUrlPropsMixin>

A fluent builder for CfnUrlPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnUrlPropsMixin.Builder	authType(String authType)	The type of authentication that your function URL uses.
CfnUrlPropsMixin	build()
CfnUrlPropsMixin.Builder	cors(CfnUrlPropsMixin.CorsProperty cors)	The Cross-Origin Resource Sharing (CORS) settings for your function URL.
CfnUrlPropsMixin.Builder	cors(IResolvable cors)	The Cross-Origin Resource Sharing (CORS) settings for your function URL.
static CfnUrlPropsMixin.Builder	create()
static CfnUrlPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnUrlPropsMixin.Builder	invokeMode(String invokeMode)	Use one of the following options:.
CfnUrlPropsMixin.Builder	qualifier(String qualifier)	The alias name.
CfnUrlPropsMixin.Builder	targetFunctionArn(String targetFunctionArn)	The name of the Lambda function.
CfnUrlPropsMixin.Builder	targetFunctionArn(IFunctionRef targetFunctionArn)	The name of the Lambda function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnUrlPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnUrlPropsMixin.Builder.

create

@Stability(Stable)
public static CfnUrlPropsMixin.Builder create()

Returns:

a new instance of CfnUrlPropsMixin.Builder.

authType

@Stability(Stable)
public CfnUrlPropsMixin.Builder authType(String authType)

The type of authentication that your function URL uses.

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 .

Parameters:

authType - The type of authentication that your function URL uses. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype

cors

@Stability(Stable)
public CfnUrlPropsMixin.Builder cors(IResolvable cors)

The Cross-Origin Resource Sharing (CORS) settings for your function URL.

Parameters:

cors - The Cross-Origin Resource Sharing (CORS) settings for your function URL. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-cors

cors

@Stability(Stable)
public CfnUrlPropsMixin.Builder cors(CfnUrlPropsMixin.CorsProperty cors)

The Cross-Origin Resource Sharing (CORS) settings for your function URL.

Parameters:

cors - The Cross-Origin Resource Sharing (CORS) settings for your function URL. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-cors

invokeMode

@Stability(Stable)
public CfnUrlPropsMixin.Builder invokeMode(String invokeMode)

Use one of the following options:.

• BUFFERED – This is the default option. Lambda invokes your function using the Invoke API 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 the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

Parameters:

invokeMode - Use one of the following options:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode

qualifier

@Stability(Stable)
public CfnUrlPropsMixin.Builder qualifier(String qualifier)

The alias name.

Parameters:

qualifier - The alias name. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-qualifier

targetFunctionArn

@Stability(Stable)
public CfnUrlPropsMixin.Builder targetFunctionArn(String targetFunctionArn)

The name of the Lambda function.

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.

Parameters:

targetFunctionArn - The name of the Lambda function. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-targetfunctionarn

targetFunctionArn

@Stability(Stable)
public CfnUrlPropsMixin.Builder targetFunctionArn(IFunctionRef targetFunctionArn)

The name of the Lambda function.

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.

Parameters:

targetFunctionArn - The name of the Lambda function. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-targetfunctionarn

build

@Stability(Stable)
public CfnUrlPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUrlPropsMixin>

Returns:

a newly built instance of CfnUrlPropsMixin.