public static final class EdgeFunctionProps.Builder
extends java.lang.Object
EdgeFunctionProps
Constructor and Description |
---|
Builder() |
public EdgeFunctionProps.Builder stackId(java.lang.String stackId)
EdgeFunctionProps.getStackId()
stackId
- The stack ID of Lambda@Edge function.this
public EdgeFunctionProps.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
public EdgeFunctionProps.Builder handler(java.lang.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
public EdgeFunctionProps.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
public EdgeFunctionProps.Builder allowAllOutbound(java.lang.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
public EdgeFunctionProps.Builder allowPublicSubnet(java.lang.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
public EdgeFunctionProps.Builder architecture(Architecture architecture)
FunctionOptions.getArchitecture()
architecture
- The system architectures compatible with this lambda function.this
@Deprecated public EdgeFunctionProps.Builder architectures(java.util.List<? extends Architecture> architectures)
FunctionOptions.getArchitectures()
architectures
- DEPRECATED.this
public EdgeFunctionProps.Builder codeSigningConfig(ICodeSigningConfig codeSigningConfig)
FunctionOptions.getCodeSigningConfig()
codeSigningConfig
- Code signing config associated with this function.this
public EdgeFunctionProps.Builder currentVersionOptions(VersionOptions currentVersionOptions)
FunctionOptions.getCurrentVersionOptions()
currentVersionOptions
- Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.this
public EdgeFunctionProps.Builder deadLetterQueue(IQueue deadLetterQueue)
FunctionOptions.getDeadLetterQueue()
deadLetterQueue
- The SQS queue to use if DLQ is enabled.
If SNS topic is desired, specify deadLetterTopic
property instead.this
public EdgeFunctionProps.Builder deadLetterQueueEnabled(java.lang.Boolean deadLetterQueueEnabled)
FunctionOptions.getDeadLetterQueueEnabled()
deadLetterQueueEnabled
- Enabled DLQ.
If deadLetterQueue
is undefined,
an SQS queue with default options will be defined for your Function.this
public EdgeFunctionProps.Builder deadLetterTopic(ITopic deadLetterTopic)
FunctionOptions.getDeadLetterTopic()
deadLetterTopic
- The SNS topic to use as a DLQ.
Note that if deadLetterQueueEnabled
is set to true
, an SQS queue will be created
rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly.this
public EdgeFunctionProps.Builder description(java.lang.String description)
FunctionOptions.getDescription()
description
- A description of the function.this
public EdgeFunctionProps.Builder environment(java.util.Map<java.lang.String,java.lang.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
public EdgeFunctionProps.Builder environmentEncryption(IKey environmentEncryption)
FunctionOptions.getEnvironmentEncryption()
environmentEncryption
- The AWS KMS key that's used to encrypt your function's environment variables.this
public EdgeFunctionProps.Builder ephemeralStorageSize(Size ephemeralStorageSize)
FunctionOptions.getEphemeralStorageSize()
ephemeralStorageSize
- The size of the function’s /tmp directory in MiB.this
public EdgeFunctionProps.Builder events(java.util.List<? extends IEventSource> events)
FunctionOptions.getEvents()
events
- Event sources for this function.
You can also add event sources using addEventSource
.this
public EdgeFunctionProps.Builder filesystem(FileSystem filesystem)
FunctionOptions.getFilesystem()
filesystem
- The filesystem configuration for the lambda function.this
public EdgeFunctionProps.Builder functionName(java.lang.String functionName)
FunctionOptions.getFunctionName()
functionName
- A name for the function.this
public EdgeFunctionProps.Builder initialPolicy(java.util.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
public EdgeFunctionProps.Builder insightsVersion(LambdaInsightsVersion insightsVersion)
FunctionOptions.getInsightsVersion()
insightsVersion
- Specify the version of CloudWatch Lambda insights to use for monitoring.this
public EdgeFunctionProps.Builder layers(java.util.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
public EdgeFunctionProps.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
public EdgeFunctionProps.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
public EdgeFunctionProps.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
public EdgeFunctionProps.Builder memorySize(java.lang.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
public EdgeFunctionProps.Builder profiling(java.lang.Boolean profiling)
FunctionOptions.getProfiling()
profiling
- Enable profiling.this
public EdgeFunctionProps.Builder profilingGroup(IProfilingGroup profilingGroup)
FunctionOptions.getProfilingGroup()
profilingGroup
- Profiling Group.this
public EdgeFunctionProps.Builder reservedConcurrentExecutions(java.lang.Number reservedConcurrentExecutions)
FunctionOptions.getReservedConcurrentExecutions()
reservedConcurrentExecutions
- The maximum of concurrent executions you want to reserve for the function.this
public EdgeFunctionProps.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
@Deprecated public EdgeFunctionProps.Builder securityGroup(ISecurityGroup securityGroup)
FunctionOptions.getSecurityGroup()
securityGroup
- What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead.
Only used if 'vpc' is supplied.
Use securityGroups property instead. Function constructor will throw an error if both are specified.
this
public EdgeFunctionProps.Builder securityGroups(java.util.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
public EdgeFunctionProps.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
public EdgeFunctionProps.Builder tracing(Tracing tracing)
FunctionOptions.getTracing()
tracing
- Enable AWS X-Ray Tracing for Lambda Function.this
public EdgeFunctionProps.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
public EdgeFunctionProps.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
public EdgeFunctionProps.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
public EdgeFunctionProps.Builder onFailure(IDestination onFailure)
EventInvokeConfigOptions.getOnFailure()
onFailure
- The destination for failed invocations.this
public EdgeFunctionProps.Builder onSuccess(IDestination onSuccess)
EventInvokeConfigOptions.getOnSuccess()
onSuccess
- The destination for successful invocations.this
public EdgeFunctionProps.Builder retryAttempts(java.lang.Number retryAttempts)
EventInvokeConfigOptions.getRetryAttempts()
retryAttempts
- The maximum number of times to retry when the function returns an error.
Minimum: 0
Maximum: 2this
public EdgeFunctionProps build()
EdgeFunctionProps
java.lang.NullPointerException
- if any required attribute was not provided