EdgeFunctionProps.Builder

java.lang.Object
- software.amazon.awscdk.services.cloudfront.experimental.EdgeFunctionProps.Builder

Enclosing interface:: EdgeFunctionProps

public static final class EdgeFunctionProps.Builder
extends java.lang.Object

A builder for EdgeFunctionProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`EdgeFunctionProps.Builder`	`allowAllOutbound(java.lang.Boolean allowAllOutbound)` Sets the value of `FunctionOptions.getAllowAllOutbound()`
`EdgeFunctionProps.Builder`	`allowPublicSubnet(java.lang.Boolean allowPublicSubnet)` Sets the value of `FunctionOptions.getAllowPublicSubnet()`
`EdgeFunctionProps.Builder`	`architecture(Architecture architecture)` Sets the value of `FunctionOptions.getArchitecture()`
`EdgeFunctionProps.Builder`	`architectures(java.util.List<? extends Architecture> architectures)` Deprecated. use `architecture`
`EdgeFunctionProps`	`build()` Builds the configured instance.
`EdgeFunctionProps.Builder`	`code(Code code)` Sets the value of `FunctionProps.getCode()`
`EdgeFunctionProps.Builder`	`codeSigningConfig(ICodeSigningConfig codeSigningConfig)` Sets the value of `FunctionOptions.getCodeSigningConfig()`
`EdgeFunctionProps.Builder`	`currentVersionOptions(VersionOptions currentVersionOptions)` Sets the value of `FunctionOptions.getCurrentVersionOptions()`
`EdgeFunctionProps.Builder`	`deadLetterQueue(IQueue deadLetterQueue)` Sets the value of `FunctionOptions.getDeadLetterQueue()`
`EdgeFunctionProps.Builder`	`deadLetterQueueEnabled(java.lang.Boolean deadLetterQueueEnabled)` Sets the value of `FunctionOptions.getDeadLetterQueueEnabled()`
`EdgeFunctionProps.Builder`	`deadLetterTopic(ITopic deadLetterTopic)` Sets the value of `FunctionOptions.getDeadLetterTopic()`
`EdgeFunctionProps.Builder`	`description(java.lang.String description)` Sets the value of `FunctionOptions.getDescription()`
`EdgeFunctionProps.Builder`	`environment(java.util.Map<java.lang.String,java.lang.String> environment)` Sets the value of `FunctionOptions.getEnvironment()`
`EdgeFunctionProps.Builder`	`environmentEncryption(IKey environmentEncryption)` Sets the value of `FunctionOptions.getEnvironmentEncryption()`
`EdgeFunctionProps.Builder`	`ephemeralStorageSize(Size ephemeralStorageSize)` Sets the value of `FunctionOptions.getEphemeralStorageSize()`
`EdgeFunctionProps.Builder`	`events(java.util.List<? extends IEventSource> events)` Sets the value of `FunctionOptions.getEvents()`
`EdgeFunctionProps.Builder`	`filesystem(FileSystem filesystem)` Sets the value of `FunctionOptions.getFilesystem()`
`EdgeFunctionProps.Builder`	`functionName(java.lang.String functionName)` Sets the value of `FunctionOptions.getFunctionName()`
`EdgeFunctionProps.Builder`	`handler(java.lang.String handler)` Sets the value of `FunctionProps.getHandler()`
`EdgeFunctionProps.Builder`	`initialPolicy(java.util.List<? extends PolicyStatement> initialPolicy)` Sets the value of `FunctionOptions.getInitialPolicy()`
`EdgeFunctionProps.Builder`	`insightsVersion(LambdaInsightsVersion insightsVersion)` Sets the value of `FunctionOptions.getInsightsVersion()`
`EdgeFunctionProps.Builder`	`layers(java.util.List<? extends ILayerVersion> layers)` Sets the value of `FunctionOptions.getLayers()`
`EdgeFunctionProps.Builder`	`logRetention(RetentionDays logRetention)` Sets the value of `FunctionOptions.getLogRetention()`
`EdgeFunctionProps.Builder`	`logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions)` Sets the value of `FunctionOptions.getLogRetentionRetryOptions()`
`EdgeFunctionProps.Builder`	`logRetentionRole(IRole logRetentionRole)` Sets the value of `FunctionOptions.getLogRetentionRole()`
`EdgeFunctionProps.Builder`	`maxEventAge(Duration maxEventAge)` Sets the value of `EventInvokeConfigOptions.getMaxEventAge()`
`EdgeFunctionProps.Builder`	`memorySize(java.lang.Number memorySize)` Sets the value of `FunctionOptions.getMemorySize()`
`EdgeFunctionProps.Builder`	`onFailure(IDestination onFailure)` Sets the value of `EventInvokeConfigOptions.getOnFailure()`
`EdgeFunctionProps.Builder`	`onSuccess(IDestination onSuccess)` Sets the value of `EventInvokeConfigOptions.getOnSuccess()`
`EdgeFunctionProps.Builder`	`profiling(java.lang.Boolean profiling)` Sets the value of `FunctionOptions.getProfiling()`
`EdgeFunctionProps.Builder`	`profilingGroup(IProfilingGroup profilingGroup)` Sets the value of `FunctionOptions.getProfilingGroup()`
`EdgeFunctionProps.Builder`	`reservedConcurrentExecutions(java.lang.Number reservedConcurrentExecutions)` Sets the value of `FunctionOptions.getReservedConcurrentExecutions()`
`EdgeFunctionProps.Builder`	`retryAttempts(java.lang.Number retryAttempts)` Sets the value of `EventInvokeConfigOptions.getRetryAttempts()`
`EdgeFunctionProps.Builder`	`role(IRole role)` Sets the value of `FunctionOptions.getRole()`
`EdgeFunctionProps.Builder`	`runtime(Runtime runtime)` Sets the value of `FunctionProps.getRuntime()`
`EdgeFunctionProps.Builder`	`securityGroup(ISecurityGroup securityGroup)` Deprecated. - This property is deprecated, use securityGroups instead
`EdgeFunctionProps.Builder`	`securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)` Sets the value of `FunctionOptions.getSecurityGroups()`
`EdgeFunctionProps.Builder`	`stackId(java.lang.String stackId)` Sets the value of `EdgeFunctionProps.getStackId()`
`EdgeFunctionProps.Builder`	`timeout(Duration timeout)` Sets the value of `FunctionOptions.getTimeout()`
`EdgeFunctionProps.Builder`	`tracing(Tracing tracing)` Sets the value of `FunctionOptions.getTracing()`
`EdgeFunctionProps.Builder`	`vpc(IVpc vpc)` Sets the value of `FunctionOptions.getVpc()`
`EdgeFunctionProps.Builder`	`vpcSubnets(SubnetSelection vpcSubnets)` Sets the value of `FunctionOptions.getVpcSubnets()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - stackId
```
public EdgeFunctionProps.Builder stackId(java.lang.String stackId)
```
    Sets the value of EdgeFunctionProps.getStackId()
    
    Parameters:
    
    stackId - The stack ID of Lambda@Edge function.
    
    Returns:
    
    this
  - code
```
public EdgeFunctionProps.Builder code(Code code)
```
    Sets the value of FunctionProps.getCode()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - handler
```
public EdgeFunctionProps.Builder handler(java.lang.String handler)
```
    Sets the value of FunctionProps.getHandler()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - runtime
```
public EdgeFunctionProps.Builder runtime(Runtime runtime)
```
    Sets the value of FunctionProps.getRuntime()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - allowAllOutbound
```
public EdgeFunctionProps.Builder allowAllOutbound(java.lang.Boolean allowAllOutbound)
```
    Sets the value of FunctionOptions.getAllowAllOutbound()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - allowPublicSubnet
```
public EdgeFunctionProps.Builder allowPublicSubnet(java.lang.Boolean allowPublicSubnet)
```
    Sets the value of FunctionOptions.getAllowPublicSubnet()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - architecture
```
public EdgeFunctionProps.Builder architecture(Architecture architecture)
```
    Sets the value of FunctionOptions.getArchitecture()
    
    Parameters:
    
    architecture - The system architectures compatible with this lambda function.
    
    Returns:
    
    this
  - architectures
```
@Deprecated
public EdgeFunctionProps.Builder architectures(java.util.List<? extends Architecture> architectures)
```
    Deprecated. use `architecture`
    
    Sets the value of FunctionOptions.getArchitectures()
    
    Parameters:
    
    architectures - DEPRECATED.
    
    Returns:
    
    this
  - codeSigningConfig
```
public EdgeFunctionProps.Builder codeSigningConfig(ICodeSigningConfig codeSigningConfig)
```
    Sets the value of FunctionOptions.getCodeSigningConfig()
    
    Parameters:
    
    codeSigningConfig - Code signing config associated with this function.
    
    Returns:
    
    this
  - currentVersionOptions
```
public EdgeFunctionProps.Builder currentVersionOptions(VersionOptions currentVersionOptions)
```
    Sets the value of FunctionOptions.getCurrentVersionOptions()
    
    Parameters:
    
    currentVersionOptions - Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.
    
    Returns:
    
    this
  - deadLetterQueue
```
public EdgeFunctionProps.Builder deadLetterQueue(IQueue deadLetterQueue)
```
    Sets the value of FunctionOptions.getDeadLetterQueue()
    
    Parameters:
    
    deadLetterQueue - The SQS queue to use if DLQ is enabled. If SNS topic is desired, specify deadLetterTopic property instead.
    
    Returns:
    
    this
  - deadLetterQueueEnabled
```
public EdgeFunctionProps.Builder deadLetterQueueEnabled(java.lang.Boolean deadLetterQueueEnabled)
```
    Sets the value of FunctionOptions.getDeadLetterQueueEnabled()
    
    Parameters:
    
    deadLetterQueueEnabled - Enabled DLQ. If deadLetterQueue is undefined, an SQS queue with default options will be defined for your Function.
    
    Returns:
    
    this
  - deadLetterTopic
```
public EdgeFunctionProps.Builder deadLetterTopic(ITopic deadLetterTopic)
```
    Sets the value of FunctionOptions.getDeadLetterTopic()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - description
```
public EdgeFunctionProps.Builder description(java.lang.String description)
```
    Sets the value of FunctionOptions.getDescription()
    
    Parameters:
    
    description - A description of the function.
    
    Returns:
    
    this
  - environment
```
public EdgeFunctionProps.Builder environment(java.util.Map<java.lang.String,java.lang.String> environment)
```
    Sets the value of FunctionOptions.getEnvironment()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - environmentEncryption
```
public EdgeFunctionProps.Builder environmentEncryption(IKey environmentEncryption)
```
    Sets the value of FunctionOptions.getEnvironmentEncryption()
    
    Parameters:
    
    environmentEncryption - The AWS KMS key that's used to encrypt your function's environment variables.
    
    Returns:
    
    this
  - ephemeralStorageSize
```
public EdgeFunctionProps.Builder ephemeralStorageSize(Size ephemeralStorageSize)
```
    Sets the value of FunctionOptions.getEphemeralStorageSize()
    
    Parameters:
    
    ephemeralStorageSize - The size of the function’s /tmp directory in MiB.
    
    Returns:
    
    this
  - events
```
public EdgeFunctionProps.Builder events(java.util.List<? extends IEventSource> events)
```
    Sets the value of FunctionOptions.getEvents()
    
    Parameters:
    
    events - Event sources for this function. You can also add event sources using addEventSource.
    
    Returns:
    
    this
  - filesystem
```
public EdgeFunctionProps.Builder filesystem(FileSystem filesystem)
```
    Sets the value of FunctionOptions.getFilesystem()
    
    Parameters:
    
    filesystem - The filesystem configuration for the lambda function.
    
    Returns:
    
    this
  - functionName
```
public EdgeFunctionProps.Builder functionName(java.lang.String functionName)
```
    Sets the value of FunctionOptions.getFunctionName()
    
    Parameters:
    
    functionName - A name for the function.
    
    Returns:
    
    this
  - initialPolicy
```
public EdgeFunctionProps.Builder initialPolicy(java.util.List<? extends PolicyStatement> initialPolicy)
```
    Sets the value of FunctionOptions.getInitialPolicy()
    
    Parameters:
    
    initialPolicy - Initial policy statements to add to the created Lambda Role. You can call addToRolePolicy to the created lambda to add statements post creation.
    
    Returns:
    
    this
  - insightsVersion
```
public EdgeFunctionProps.Builder insightsVersion(LambdaInsightsVersion insightsVersion)
```
    Sets the value of FunctionOptions.getInsightsVersion()
    
    Parameters:
    
    insightsVersion - Specify the version of CloudWatch Lambda insights to use for monitoring.
    
    Returns:
    
    this
  - layers
```
public EdgeFunctionProps.Builder layers(java.util.List<? extends ILayerVersion> layers)
```
    Sets the value of FunctionOptions.getLayers()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - logRetention
```
public EdgeFunctionProps.Builder logRetention(RetentionDays logRetention)
```
    Sets the value of FunctionOptions.getLogRetention()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - logRetentionRetryOptions
```
public EdgeFunctionProps.Builder logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions)
```
    Sets the value of FunctionOptions.getLogRetentionRetryOptions()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - logRetentionRole
```
public EdgeFunctionProps.Builder logRetentionRole(IRole logRetentionRole)
```
    Sets the value of FunctionOptions.getLogRetentionRole()
    
    Parameters:
    
    logRetentionRole - The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
    
    Returns:
    
    this
  - memorySize
```
public EdgeFunctionProps.Builder memorySize(java.lang.Number memorySize)
```
    Sets the value of FunctionOptions.getMemorySize()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - profiling
```
public EdgeFunctionProps.Builder profiling(java.lang.Boolean profiling)
```
    Sets the value of FunctionOptions.getProfiling()
    
    Parameters:
    
    profiling - Enable profiling.
    
    Returns:
    
    this
  - profilingGroup
```
public EdgeFunctionProps.Builder profilingGroup(IProfilingGroup profilingGroup)
```
    Sets the value of FunctionOptions.getProfilingGroup()
    
    Parameters:
    
    profilingGroup - Profiling Group.
    
    Returns:
    
    this
  - reservedConcurrentExecutions
```
public EdgeFunctionProps.Builder reservedConcurrentExecutions(java.lang.Number reservedConcurrentExecutions)
```
    Sets the value of FunctionOptions.getReservedConcurrentExecutions()
    
    Parameters:
    
    reservedConcurrentExecutions - The maximum of concurrent executions you want to reserve for the function.
    
    Returns:
    
    this
  - role
```
public EdgeFunctionProps.Builder role(IRole role)
```
    Sets the value of FunctionOptions.getRole()
    
    Parameters:
    
    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".
    
    Returns:
    
    this
  - securityGroup
```
@Deprecated
public EdgeFunctionProps.Builder securityGroup(ISecurityGroup securityGroup)
```
    Deprecated. - This property is deprecated, use securityGroups instead
    
    Sets the value of FunctionOptions.getSecurityGroup()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - securityGroups
```
public EdgeFunctionProps.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)
```
    Sets the value of FunctionOptions.getSecurityGroups()
    
    Parameters:
    
    securityGroups - The list of security groups to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied.
    
    Returns:
    
    this
  - timeout
```
public EdgeFunctionProps.Builder timeout(Duration timeout)
```
    Sets the value of FunctionOptions.getTimeout()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - tracing
```
public EdgeFunctionProps.Builder tracing(Tracing tracing)
```
    Sets the value of FunctionOptions.getTracing()
    
    Parameters:
    
    tracing - Enable AWS X-Ray Tracing for Lambda Function.
    
    Returns:
    
    this
  - vpc
```
public EdgeFunctionProps.Builder vpc(IVpc vpc)
```
    Sets the value of FunctionOptions.getVpc()
    
    Parameters:
    
    vpc - VPC network to place Lambda network interfaces. Specify this if the Lambda function needs to access resources in a VPC.
    
    Returns:
    
    this
  - vpcSubnets
```
public EdgeFunctionProps.Builder vpcSubnets(SubnetSelection vpcSubnets)
```
    Sets the value of FunctionOptions.getVpcSubnets()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - maxEventAge
```
public EdgeFunctionProps.Builder maxEventAge(Duration maxEventAge)
```
    Sets the value of EventInvokeConfigOptions.getMaxEventAge()
    
    Parameters:
    
    maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours
    
    Returns:
    
    this
  - onFailure
```
public EdgeFunctionProps.Builder onFailure(IDestination onFailure)
```
    Sets the value of EventInvokeConfigOptions.getOnFailure()
    
    Parameters:
    
    onFailure - The destination for failed invocations.
    
    Returns:
    
    this
  - onSuccess
```
public EdgeFunctionProps.Builder onSuccess(IDestination onSuccess)
```
    Sets the value of EventInvokeConfigOptions.getOnSuccess()
    
    Parameters:
    
    onSuccess - The destination for successful invocations.
    
    Returns:
    
    this
  - retryAttempts
```
public EdgeFunctionProps.Builder retryAttempts(java.lang.Number retryAttempts)
```
    Sets the value of EventInvokeConfigOptions.getRetryAttempts()
    
    Parameters:
    
    retryAttempts - The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2
    
    Returns:
    
    this
  - build
```
public EdgeFunctionProps build()
```
    Builds the configured instance.
    
    Returns:
    
    a new instance of EdgeFunctionProps
    
    Throws:
    
    java.lang.NullPointerException - if any required attribute was not provided

Class EdgeFunctionProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

stackId

code

handler

runtime

allowAllOutbound

allowPublicSubnet

architecture

architectures

codeSigningConfig

currentVersionOptions

deadLetterQueue

deadLetterQueueEnabled

deadLetterTopic

description

environment

environmentEncryption

ephemeralStorageSize

events

filesystem

functionName

initialPolicy

insightsVersion

layers

logRetention

logRetentionRetryOptions

logRetentionRole

memorySize

profiling

profilingGroup

reservedConcurrentExecutions

role

securityGroup

securityGroups

timeout

tracing

vpc

vpcSubnets

maxEventAge

onFailure

onSuccess

retryAttempts

build