@Stability(value=Experimental) public static final class FunctionProps.Builder extends Object implements software.amazon.jsii.Builder<FunctionProps>
FunctionProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Experimental) public FunctionProps.Builder code(Code code)
FunctionProps.getCode()code - The source code of your Lambda function. This parameter is required.
You can point to a file in an
Amazon Simple Storage Service (Amazon S3) bucket or specify your source
code as inline text.this@Stability(value=Experimental) public FunctionProps.Builder handler(String handler)
FunctionProps.getHandler()handler - The name of the method within your code that Lambda calls to execute your function. This parameter is required.
The format includes the file name. It can also include
namespaces and other qualifiers, depending on the runtime.
For more information, see https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-features.html#gettingstarted-features-programmingmodel.
Use Handler.FROM_IMAGE when defining a function from a Docker image.
NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler.
this@Stability(value=Experimental) public FunctionProps.Builder runtime(Runtime runtime)
FunctionProps.getRuntime()runtime - The runtime environment for the Lambda function that you are uploading. This parameter is required.
For valid values, see the Runtime property in the AWS Lambda Developer
Guide.
Use Runtime.FROM_IMAGE when when defining a function from a Docker image.
this@Stability(value=Experimental) public FunctionProps.Builder allowAllOutbound(Boolean allowAllOutbound)
FunctionOptions.getAllowAllOutbound()allowAllOutbound - Whether to allow the Lambda to send all network traffic.
If set to false, you must individually add traffic rules to allow the
Lambda to connect to network targets.this@Stability(value=Experimental) public FunctionProps.Builder allowPublicSubnet(Boolean allowPublicSubnet)
FunctionOptions.getAllowPublicSubnet()allowPublicSubnet - Lambda Functions in a public subnet can NOT access the internet.
Use this property to acknowledge this limitation and still place the function in a public subnet.this@Stability(value=Experimental) public FunctionProps.Builder codeSigningConfig(ICodeSigningConfig codeSigningConfig)
FunctionOptions.getCodeSigningConfig()codeSigningConfig - Code signing config associated with this function.this@Stability(value=Experimental) public FunctionProps.Builder currentVersionOptions(VersionOptions currentVersionOptions)
FunctionOptions.getCurrentVersionOptions()currentVersionOptions - Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.this@Stability(value=Experimental) public FunctionProps.Builder deadLetterQueue(IQueue deadLetterQueue)
FunctionOptions.getDeadLetterQueue()deadLetterQueue - The SQS queue to use if DLQ is enabled.this@Stability(value=Experimental) public FunctionProps.Builder deadLetterQueueEnabled(Boolean deadLetterQueueEnabled)
FunctionOptions.getDeadLetterQueueEnabled()deadLetterQueueEnabled - Enabled DLQ.
If deadLetterQueue is undefined,
an SQS queue with default options will be defined for your Function.this@Stability(value=Experimental) public FunctionProps.Builder description(String description)
FunctionOptions.getDescription()description - A description of the function.this@Stability(value=Experimental) public FunctionProps.Builder environment(Map<String,String> environment)
FunctionOptions.getEnvironment()environment - Key-value pairs that Lambda caches and makes available for your Lambda functions.
Use environment variables to apply configuration changes, such
as test and production environment configurations, without changing your
Lambda function source code.this@Stability(value=Experimental) public FunctionProps.Builder environmentEncryption(IKey environmentEncryption)
FunctionOptions.getEnvironmentEncryption()environmentEncryption - The AWS KMS key that's used to encrypt your function's environment variables.this@Stability(value=Experimental) public FunctionProps.Builder events(List<? extends IEventSource> events)
FunctionOptions.getEvents()events - Event sources for this function.
You can also add event sources using addEventSource.this@Stability(value=Experimental) public FunctionProps.Builder filesystem(FileSystem filesystem)
FunctionOptions.getFilesystem()filesystem - The filesystem configuration for the lambda function.this@Stability(value=Experimental) public FunctionProps.Builder functionName(String functionName)
FunctionOptions.getFunctionName()functionName - A name for the function.this@Stability(value=Experimental) public FunctionProps.Builder initialPolicy(List<? extends PolicyStatement> initialPolicy)
FunctionOptions.getInitialPolicy()initialPolicy - Initial policy statements to add to the created Lambda Role.
You can call addToRolePolicy to the created lambda to add statements post creation.this@Stability(value=Experimental) public FunctionProps.Builder layers(List<? extends ILayerVersion> layers)
FunctionOptions.getLayers()layers - A list of layers to add to the function's execution environment.
You can configure your Lambda function to pull in
additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies
that can be used by multiple functions.this@Stability(value=Experimental) public FunctionProps.Builder logRetention(RetentionDays logRetention)
FunctionOptions.getLogRetention()logRetention - The number of days log events are kept in CloudWatch Logs.
When updating
this property, unsetting it doesn't remove the log retention policy. To
remove the retention policy, set the value to INFINITE.this@Stability(value=Experimental) public FunctionProps.Builder logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions)
FunctionOptions.getLogRetentionRetryOptions()logRetentionRetryOptions - When log retention is specified, a custom resource attempts to create the CloudWatch log group.
These options control the retry policy when interacting with CloudWatch APIs.this@Stability(value=Experimental) public FunctionProps.Builder logRetentionRole(IRole logRetentionRole)
FunctionOptions.getLogRetentionRole()logRetentionRole - The IAM role for the Lambda function associated with the custom resource that sets the retention policy.this@Stability(value=Experimental) public FunctionProps.Builder memorySize(Number memorySize)
FunctionOptions.getMemorySize()memorySize - The amount of memory, in MB, that is allocated to your Lambda function.
Lambda uses this value to proportionally allocate the amount of CPU
power. For more information, see Resource Model in the AWS Lambda
Developer Guide.this@Stability(value=Experimental) public FunctionProps.Builder profiling(Boolean profiling)
FunctionOptions.getProfiling()profiling - Enable profiling.this@Stability(value=Experimental) public FunctionProps.Builder profilingGroup(IProfilingGroup profilingGroup)
FunctionOptions.getProfilingGroup()profilingGroup - Profiling Group.this@Stability(value=Experimental) public FunctionProps.Builder reservedConcurrentExecutions(Number reservedConcurrentExecutions)
FunctionOptions.getReservedConcurrentExecutions()reservedConcurrentExecutions - The maximum of concurrent executions you want to reserve for the function.this@Stability(value=Experimental) public FunctionProps.Builder role(IRole role)
FunctionOptions.getRole()role - Lambda execution role.
This is the role that will be assumed by the function upon execution.
It controls the permissions that the function will have. The Role must
be assumable by the 'lambda.amazonaws.com' service principal.
The default Role automatically has permissions granted for Lambda execution. If you provide a Role, you must add the relevant AWS managed policies yourself.
The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and "service-role/AWSLambdaVPCAccessExecutionRole".
this@Stability(value=Experimental) public FunctionProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
FunctionOptions.getSecurityGroups()securityGroups - The list of security groups to associate with the Lambda's network interfaces.
Only used if 'vpc' is supplied.this@Stability(value=Experimental) public FunctionProps.Builder timeout(Duration timeout)
FunctionOptions.getTimeout()timeout - The function execution time (in seconds) after which Lambda terminates the function.
Because the execution time affects cost, set this value
based on the function's expected execution time.this@Stability(value=Experimental) public FunctionProps.Builder tracing(Tracing tracing)
FunctionOptions.getTracing()tracing - Enable AWS X-Ray Tracing for Lambda Function.this@Stability(value=Experimental) public FunctionProps.Builder vpc(IVpc vpc)
FunctionOptions.getVpc()vpc - VPC network to place Lambda network interfaces.
Specify this if the Lambda function needs to access resources in a VPC.this@Stability(value=Experimental) public FunctionProps.Builder vpcSubnets(SubnetSelection vpcSubnets)
FunctionOptions.getVpcSubnets()vpcSubnets - Where to place the network interfaces within the VPC.
Only used if 'vpc' is supplied. Note: internet access for Lambdas
requires a NAT gateway, so picking Public subnets is not allowed.this@Stability(value=Experimental) public FunctionProps.Builder maxEventAge(Duration maxEventAge)
EventInvokeConfigOptions.getMaxEventAge()maxEventAge - The maximum age of a request that Lambda sends to a function for processing.
Minimum: 60 seconds
Maximum: 6 hoursthis@Stability(value=Experimental) public FunctionProps.Builder onFailure(IDestination onFailure)
EventInvokeConfigOptions.getOnFailure()onFailure - The destination for failed invocations.this@Stability(value=Experimental) public FunctionProps.Builder onSuccess(IDestination onSuccess)
EventInvokeConfigOptions.getOnSuccess()onSuccess - The destination for successful invocations.this@Stability(value=Experimental) public FunctionProps.Builder retryAttempts(Number retryAttempts)
EventInvokeConfigOptions.getRetryAttempts()retryAttempts - The maximum number of times to retry when the function returns an error.
Minimum: 0
Maximum: 2this@Stability(value=Experimental) public FunctionProps build()
build in interface software.amazon.jsii.Builder<FunctionProps>FunctionPropsNullPointerException - if any required attribute was not providedCopyright © 2021. All rights reserved.