Package software.amazon.awssdk.services.lambda.model

Class FunctionUrlConfig

java.lang.Object

software.amazon.awssdk.services.lambda.model.FunctionUrlConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FunctionUrlConfig.Builder,FunctionUrlConfig>

@Generated("software.amazon.awssdk:codegen")
public final class FunctionUrlConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FunctionUrlConfig.Builder,FunctionUrlConfig>

Details about a Lambda function URL.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FunctionUrlConfig.Builder

Method Summary

Modifier and Type	Method	Description
FunctionUrlAuthType	authType()	The type of authentication that your function URL uses.
String	authTypeAsString()	The type of authentication that your function URL uses.
static FunctionUrlConfig.Builder	builder()
Cors	cors()	The cross-origin resource sharing (CORS) settings for your function URL.
String	creationTime()	When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	functionArn()	The Amazon Resource Name (ARN) of your function.
String	functionUrl()	The HTTP URL endpoint for your function.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InvokeMode	invokeMode()	Use one of the following options:
String	invokeModeAsString()	Use one of the following options:
String	lastModifiedTime()	When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
List<SdkField<?>>	sdkFields()
static Class<? extends FunctionUrlConfig.Builder>	serializableBuilderClass()
FunctionUrlConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

functionUrl

public final String functionUrl()

The HTTP URL endpoint for your function.

Returns:

The HTTP URL endpoint for your function.

functionArn

public final String functionArn()

The Amazon Resource Name (ARN) of your function.

Returns:

The Amazon Resource Name (ARN) of your function.

creationTime

public final String creationTime()

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Returns:

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

lastModifiedTime

public final String lastModifiedTime()

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Returns:

When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

cors

public final Cors cors()

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

Returns:

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

authType

public final FunctionUrlAuthType 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.

If the service returns an enum value that is not available in the current SDK version, authType will return FunctionUrlAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().

Returns:

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.

See Also:

FunctionUrlAuthType

authTypeAsString

public final String authTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, authType will return FunctionUrlAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().

Returns:

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.

See Also:

FunctionUrlAuthType

invokeMode

public final InvokeMode 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 20 MB, however, you can request a quota increase.

If the service returns an enum value that is not available in the current SDK version, invokeMode will return InvokeMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invokeModeAsString().

Returns:

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 20 MB, however, you can request a quota increase.

See Also:

InvokeMode

invokeModeAsString

public final String invokeModeAsString()

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 20 MB, however, you can request a quota increase.

If the service returns an enum value that is not available in the current SDK version, invokeMode will return InvokeMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invokeModeAsString().

Returns:

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 20 MB, however, you can request a quota increase.

See Also:

InvokeMode

toBuilder

public FunctionUrlConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FunctionUrlConfig.Builder,FunctionUrlConfig>

builder

public static FunctionUrlConfig.Builder builder()

serializableBuilderClass

public static Class<? extends FunctionUrlConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo