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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.486Z")
 @Stability(value=Stable)
public interface SingletonFunctionProps
extends software.amazon.jsii.JsiiSerializable, FunctionProps

Properties for a newly created singleton Lambda.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.codeguruprofiler.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.sqs.*;
 Architecture architecture;
 Code code;
 CodeSigningConfig codeSigningConfig;
 IDestination destination;
 IEventSource eventSource;
 FileSystem fileSystem;
 Key key;
 LambdaInsightsVersion lambdaInsightsVersion;
 LayerVersion layerVersion;
 PolicyStatement policyStatement;
 ProfilingGroup profilingGroup;
 Queue queue;
 Role role;
 Runtime runtime;
 SecurityGroup securityGroup;
 Size size;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Topic topic;
 Vpc vpc;
 SingletonFunctionProps singletonFunctionProps = SingletonFunctionProps.builder()
         .code(code)
         .handler("handler")
         .runtime(runtime)
         .uuid("uuid")
         // the properties below are optional
         .allowAllOutbound(false)
         .allowPublicSubnet(false)
         .architecture(architecture)
         .codeSigningConfig(codeSigningConfig)
         .currentVersionOptions(VersionOptions.builder()
                 .codeSha256("codeSha256")
                 .description("description")
                 .maxEventAge(Duration.minutes(30))
                 .onFailure(destination)
                 .onSuccess(destination)
                 .provisionedConcurrentExecutions(123)
                 .removalPolicy(RemovalPolicy.DESTROY)
                 .retryAttempts(123)
                 .build())
         .deadLetterQueue(queue)
         .deadLetterQueueEnabled(false)
         .deadLetterTopic(topic)
         .description("description")
         .environment(Map.of(
                 "environmentKey", "environment"))
         .environmentEncryption(key)
         .ephemeralStorageSize(size)
         .events(List.of(eventSource))
         .filesystem(fileSystem)
         .functionName("functionName")
         .initialPolicy(List.of(policyStatement))
         .insightsVersion(lambdaInsightsVersion)
         .lambdaPurpose("lambdaPurpose")
         .layers(List.of(layerVersion))
         .logRetention(RetentionDays.ONE_DAY)
         .logRetentionRetryOptions(LogRetentionRetryOptions.builder()
                 .base(Duration.minutes(30))
                 .maxRetries(123)
                 .build())
         .logRetentionRole(role)
         .maxEventAge(Duration.minutes(30))
         .memorySize(123)
         .onFailure(destination)
         .onSuccess(destination)
         .profiling(false)
         .profilingGroup(profilingGroup)
         .reservedConcurrentExecutions(123)
         .retryAttempts(123)
         .role(role)
         .securityGroups(List.of(securityGroup))
         .timeout(Duration.minutes(30))
         .tracing(Tracing.ACTIVE)
         .vpc(vpc)
         .vpcSubnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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.FunctionProps

getCode, getHandler, getRuntime

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

getAllowAllOutbound, getAllowPublicSubnet, getArchitecture, getCodeSigningConfig, getCurrentVersionOptions, getDeadLetterQueue, getDeadLetterQueueEnabled, getDeadLetterTopic, getDescription, getEnvironment, getEnvironmentEncryption, getEphemeralStorageSize, getEvents, getFilesystem, getFunctionName, getInitialPolicy, getInsightsVersion, getLayers, getLogRetention, getLogRetentionRetryOptions, getLogRetentionRole, getMemorySize, getProfiling, getProfilingGroup, getReservedConcurrentExecutions, getRole, getSecurityGroups, getTimeout, getTracing, getVpc, getVpcSubnets

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

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getUuid

@Stability(value=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(value=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(value=Stable)
static SingletonFunctionProps.Builder builder()

Specified by:

builder in interface EventInvokeConfigOptions

Specified by:

builder in interface FunctionOptions

Specified by:

builder in interface FunctionProps

Returns:

a SingletonFunctionProps.Builder of SingletonFunctionProps