Package software.amazon.awscdk.services.lambda

Interface SingletonFunctionProps

All Superinterfaces:

EventInvokeConfigOptions, FunctionOptions, FunctionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SingletonFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.290Z")
@Stability(Stable)
public interface SingletonFunctionProps
extends software.amazon.jsii.JsiiSerializable, FunctionProps

Properties for a newly created singleton Lambda.

Example:

 SingletonFunction fn = new SingletonFunction(this, "MyProvider", functionProps);
 CustomResource.Builder.create(this, "MyResource")
         .serviceToken(fn.getFunctionArn())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SingletonFunctionProps.Builder	A builder for SingletonFunctionProps
static final class	SingletonFunctionProps.Jsii$Proxy	An implementation for SingletonFunctionProps

Method Summary

Modifier and Type	Method	Description
static SingletonFunctionProps.Builder	builder()
default String	getLambdaPurpose()	A descriptive name for the purpose of this Lambda.
String	getUuid()	A unique identifier to identify this lambda.

Methods inherited from interface software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Methods inherited from interface software.amazon.awscdk.services.lambda.FunctionOptions

getAdotInstrumentation, getAllowAllOutbound, getAllowPublicSubnet, getApplicationLogLevel, getArchitecture, getCodeSigningConfig, getCurrentVersionOptions, getDeadLetterQueue, getDeadLetterQueueEnabled, getDeadLetterTopic, getDescription, getEnvironment, getEnvironmentEncryption, getEphemeralStorageSize, getEvents, getFilesystem, getFunctionName, getInitialPolicy, getInsightsVersion, getIpv6AllowedForDualStack, getLayers, getLogFormat, getLoggingFormat, getLogGroup, getLogRetention, getLogRetentionRetryOptions, getLogRetentionRole, getMemorySize, getParamsAndSecrets, getProfiling, getProfilingGroup, getReservedConcurrentExecutions, getRole, getRuntimeManagementMode, getSecurityGroups, getSnapStart, getSystemLogLevel, getTimeout, getTracing, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.awscdk.services.lambda.FunctionProps

getCode, getHandler, getRuntime

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUuid

@Stability(Stable)
@NotNull
String getUuid()

A unique identifier to identify this lambda.

The identifier should be unique across all custom resource providers. We recommend generating a UUID per provider.

getLambdaPurpose

@Stability(Stable)
@Nullable
default String getLambdaPurpose()

A descriptive name for the purpose of this Lambda.

If the Lambda does not have a physical name, this string will be reflected its generated name. The combination of lambdaPurpose and uuid must be unique.

Default: SingletonLambda

builder

@Stability(Stable)
static SingletonFunctionProps.Builder builder()

Returns:

a SingletonFunctionProps.Builder of SingletonFunctionProps