DockerImageFunction.Builder

java.lang.Object
- software.amazon.awscdk.services.lambda.DockerImageFunction.Builder

Enclosing class:: DockerImageFunction

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

A fluent builder for DockerImageFunction.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DockerImageFunction.Builder`	`allowAllOutbound(java.lang.Boolean allowAllOutbound)` Whether to allow the Lambda to send all network traffic.
`DockerImageFunction.Builder`	`allowPublicSubnet(java.lang.Boolean allowPublicSubnet)` Lambda Functions in a public subnet can NOT access the internet.
`DockerImageFunction.Builder`	`architecture(Architecture architecture)` The system architectures compatible with this lambda function.
`DockerImageFunction.Builder`	`architectures(java.util.List<? extends Architecture> architectures)` Deprecated. use `architecture`
`DockerImageFunction`	`build()`
`DockerImageFunction.Builder`	`code(DockerImageCode code)` The source code of your Lambda function.
`DockerImageFunction.Builder`	`codeSigningConfig(ICodeSigningConfig codeSigningConfig)` Code signing config associated with this function.
`static DockerImageFunction.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`DockerImageFunction.Builder`	`currentVersionOptions(VersionOptions currentVersionOptions)` Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.
`DockerImageFunction.Builder`	`deadLetterQueue(IQueue deadLetterQueue)` The SQS queue to use if DLQ is enabled.
`DockerImageFunction.Builder`	`deadLetterQueueEnabled(java.lang.Boolean deadLetterQueueEnabled)` Enabled DLQ.
`DockerImageFunction.Builder`	`deadLetterTopic(ITopic deadLetterTopic)` The SNS topic to use as a DLQ.
`DockerImageFunction.Builder`	`description(java.lang.String description)` A description of the function.
`DockerImageFunction.Builder`	`environment(java.util.Map<java.lang.String,java.lang.String> environment)` Key-value pairs that Lambda caches and makes available for your Lambda functions.
`DockerImageFunction.Builder`	`environmentEncryption(IKey environmentEncryption)` The AWS KMS key that's used to encrypt your function's environment variables.
`DockerImageFunction.Builder`	`ephemeralStorageSize(Size ephemeralStorageSize)` The size of the function’s /tmp directory in MiB.
`DockerImageFunction.Builder`	`events(java.util.List<? extends IEventSource> events)` Event sources for this function.
`DockerImageFunction.Builder`	`filesystem(FileSystem filesystem)` The filesystem configuration for the lambda function.
`DockerImageFunction.Builder`	`functionName(java.lang.String functionName)` A name for the function.
`DockerImageFunction.Builder`	`initialPolicy(java.util.List<? extends PolicyStatement> initialPolicy)` Initial policy statements to add to the created Lambda Role.
`DockerImageFunction.Builder`	`insightsVersion(LambdaInsightsVersion insightsVersion)` Specify the version of CloudWatch Lambda insights to use for monitoring.
`DockerImageFunction.Builder`	`layers(java.util.List<? extends ILayerVersion> layers)` A list of layers to add to the function's execution environment.
`DockerImageFunction.Builder`	`logRetention(RetentionDays logRetention)` The number of days log events are kept in CloudWatch Logs.
`DockerImageFunction.Builder`	`logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions)` When log retention is specified, a custom resource attempts to create the CloudWatch log group.
`DockerImageFunction.Builder`	`logRetentionRole(IRole logRetentionRole)` The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
`DockerImageFunction.Builder`	`maxEventAge(Duration maxEventAge)` The maximum age of a request that Lambda sends to a function for processing.
`DockerImageFunction.Builder`	`memorySize(java.lang.Number memorySize)` The amount of memory, in MB, that is allocated to your Lambda function.
`DockerImageFunction.Builder`	`onFailure(IDestination onFailure)` The destination for failed invocations.
`DockerImageFunction.Builder`	`onSuccess(IDestination onSuccess)` The destination for successful invocations.
`DockerImageFunction.Builder`	`profiling(java.lang.Boolean profiling)` Enable profiling.
`DockerImageFunction.Builder`	`profilingGroup(IProfilingGroup profilingGroup)` Profiling Group.
`DockerImageFunction.Builder`	`reservedConcurrentExecutions(java.lang.Number reservedConcurrentExecutions)` The maximum of concurrent executions you want to reserve for the function.
`DockerImageFunction.Builder`	`retryAttempts(java.lang.Number retryAttempts)` The maximum number of times to retry when the function returns an error.
`DockerImageFunction.Builder`	`role(IRole role)` Lambda execution role.
`DockerImageFunction.Builder`	`securityGroup(ISecurityGroup securityGroup)` Deprecated. - This property is deprecated, use securityGroups instead
`DockerImageFunction.Builder`	`securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)` The list of security groups to associate with the Lambda's network interfaces.
`DockerImageFunction.Builder`	`timeout(Duration timeout)` The function execution time (in seconds) after which Lambda terminates the function.
`DockerImageFunction.Builder`	`tracing(Tracing tracing)` Enable AWS X-Ray Tracing for Lambda Function.
`DockerImageFunction.Builder`	`vpc(IVpc vpc)` VPC network to place Lambda network interfaces.
`DockerImageFunction.Builder`	`vpcSubnets(SubnetSelection vpcSubnets)` Where to place the network interfaces within the VPC.

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

- Method Detail
  - create
```
public static DockerImageFunction.Builder create(software.constructs.Construct scope,
                                                 java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of DockerImageFunction.Builder.
  - maxEventAge
```
public DockerImageFunction.Builder maxEventAge(Duration maxEventAge)
```
    The maximum age of a request that Lambda sends to a function for processing.
    Minimum: 60 seconds Maximum: 6 hours
    Default: Duration.hours(6)
    
    Parameters:
    
    maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.
    
    Returns:
    
    this
  - onFailure
```
public DockerImageFunction.Builder onFailure(IDestination onFailure)
```
    The destination for failed invocations.
    Default: - no destination
    
    Parameters:
    
    onFailure - The destination for failed invocations. This parameter is required.
    
    Returns:
    
    this
  - onSuccess
```
public DockerImageFunction.Builder onSuccess(IDestination onSuccess)
```
    The destination for successful invocations.
    Default: - no destination
    
    Parameters:
    
    onSuccess - The destination for successful invocations. This parameter is required.
    
    Returns:
    
    this
  - retryAttempts
```
public DockerImageFunction.Builder retryAttempts(java.lang.Number retryAttempts)
```
    The maximum number of times to retry when the function returns an error.
    Minimum: 0 Maximum: 2
    Default: 2
    
    Parameters:
    
    retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.
    
    Returns:
    
    this
  - allowAllOutbound
```
public DockerImageFunction.Builder allowAllOutbound(java.lang.Boolean 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.
    Default: true
    
    Parameters:
    
    allowAllOutbound - Whether to allow the Lambda to send all network traffic. This parameter is required.
    
    Returns:
    
    this
  - allowPublicSubnet
```
public DockerImageFunction.Builder allowPublicSubnet(java.lang.Boolean 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.
    Default: false
    
    Parameters:
    
    allowPublicSubnet - Lambda Functions in a public subnet can NOT access the internet. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841
  - architecture
```
public DockerImageFunction.Builder architecture(Architecture architecture)
```
    The system architectures compatible with this lambda function.
    Default: Architecture.X86_64
    
    Parameters:
    
    architecture - The system architectures compatible with this lambda function. This parameter is required.
    
    Returns:
    
    this
  - architectures
```
@Deprecated
public DockerImageFunction.Builder architectures(java.util.List<? extends Architecture> architectures)
```
    Deprecated. use `architecture`
    
    (deprecated) DEPRECATED.
    Default: [Architecture.X86_64]
    
    Parameters:
    
    architectures - DEPRECATED. This parameter is required.
    
    Returns:
    
    this
  - codeSigningConfig
```
public DockerImageFunction.Builder codeSigningConfig(ICodeSigningConfig codeSigningConfig)
```
    Code signing config associated with this function.
    Default: - Not Sign the Code
    
    Parameters:
    
    codeSigningConfig - Code signing config associated with this function. This parameter is required.
    
    Returns:
    
    this
  - currentVersionOptions
```
public DockerImageFunction.Builder currentVersionOptions(VersionOptions currentVersionOptions)
```
    Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.
    Default: - default options as described in `VersionOptions`
    
    Parameters:
    
    currentVersionOptions - Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method. This parameter is required.
    
    Returns:
    
    this
  - deadLetterQueue
```
public DockerImageFunction.Builder deadLetterQueue(IQueue deadLetterQueue)
```
    The SQS queue to use if DLQ is enabled.
    If SNS topic is desired, specify deadLetterTopic property instead.
    Default: - SQS queue with 14 day retention period if `deadLetterQueueEnabled` is `true`
    
    Parameters:
    
    deadLetterQueue - The SQS queue to use if DLQ is enabled. This parameter is required.
    
    Returns:
    
    this
  - deadLetterQueueEnabled
```
public DockerImageFunction.Builder deadLetterQueueEnabled(java.lang.Boolean deadLetterQueueEnabled)
```
    Enabled DLQ.
    If deadLetterQueue is undefined, an SQS queue with default options will be defined for your Function.
    Default: - false unless `deadLetterQueue` is set, which implies DLQ is enabled.
    
    Parameters:
    
    deadLetterQueueEnabled - Enabled DLQ. This parameter is required.
    
    Returns:
    
    this
  - deadLetterTopic
```
public DockerImageFunction.Builder deadLetterTopic(ITopic 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.
    Default: - no SNS topic
    
    Parameters:
    
    deadLetterTopic - The SNS topic to use as a DLQ. This parameter is required.
    
    Returns:
    
    this
  - description
```
public DockerImageFunction.Builder description(java.lang.String description)
```
    A description of the function.
    Default: - No description.
    
    Parameters:
    
    description - A description of the function. This parameter is required.
    
    Returns:
    
    this
  - environment
```
public DockerImageFunction.Builder environment(java.util.Map<java.lang.String,java.lang.String> 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.
    Default: - No environment variables.
    
    Parameters:
    
    environment - Key-value pairs that Lambda caches and makes available for your Lambda functions. This parameter is required.
    
    Returns:
    
    this
  - environmentEncryption
```
public DockerImageFunction.Builder environmentEncryption(IKey environmentEncryption)
```
    The AWS KMS key that's used to encrypt your function's environment variables.
    Default: - AWS Lambda creates and uses an AWS managed customer master key (CMK).
    
    Parameters:
    
    environmentEncryption - The AWS KMS key that's used to encrypt your function's environment variables. This parameter is required.
    
    Returns:
    
    this
  - ephemeralStorageSize
```
public DockerImageFunction.Builder ephemeralStorageSize(Size ephemeralStorageSize)
```
    The size of the function’s /tmp directory in MiB.
    Default: 512 MiB
    
    Parameters:
    
    ephemeralStorageSize - The size of the function’s /tmp directory in MiB. This parameter is required.
    
    Returns:
    
    this
  - events
```
public DockerImageFunction.Builder events(java.util.List<? extends IEventSource> events)
```
    Event sources for this function.
    You can also add event sources using addEventSource.
    Default: - No event sources.
    
    Parameters:
    
    events - Event sources for this function. This parameter is required.
    
    Returns:
    
    this
  - filesystem
```
public DockerImageFunction.Builder filesystem(FileSystem filesystem)
```
    The filesystem configuration for the lambda function.
    Default: - will not mount any filesystem
    
    Parameters:
    
    filesystem - The filesystem configuration for the lambda function. This parameter is required.
    
    Returns:
    
    this
  - functionName
```
public DockerImageFunction.Builder functionName(java.lang.String functionName)
```
    A name for the function.
    Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.
    
    Parameters:
    
    functionName - A name for the function. This parameter is required.
    
    Returns:
    
    this
  - initialPolicy
```
public DockerImageFunction.Builder initialPolicy(java.util.List<? extends PolicyStatement> initialPolicy)
```
    Initial policy statements to add to the created Lambda Role.
    You can call addToRolePolicy to the created lambda to add statements post creation.
    Default: - No policy statements are added to the created Lambda role.
    
    Parameters:
    
    initialPolicy - Initial policy statements to add to the created Lambda Role. This parameter is required.
    
    Returns:
    
    this
  - insightsVersion
```
public DockerImageFunction.Builder insightsVersion(LambdaInsightsVersion insightsVersion)
```
    Specify the version of CloudWatch Lambda insights to use for monitoring.
    Default: - No Lambda Insights
    
    Parameters:
    
    insightsVersion - Specify the version of CloudWatch Lambda insights to use for monitoring. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html
  - layers
```
public DockerImageFunction.Builder layers(java.util.List<? extends ILayerVersion> 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.
    Default: - No layers.
    
    Parameters:
    
    layers - A list of layers to add to the function's execution environment. This parameter is required.
    
    Returns:
    
    this
  - logRetention
```
public DockerImageFunction.Builder logRetention(RetentionDays 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.
    Default: logs.RetentionDays.INFINITE
    
    Parameters:
    
    logRetention - The number of days log events are kept in CloudWatch Logs. This parameter is required.
    
    Returns:
    
    this
  - logRetentionRetryOptions
```
public DockerImageFunction.Builder logRetentionRetryOptions(LogRetentionRetryOptions 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.
    Default: - Default AWS SDK retry options.
    
    Parameters:
    
    logRetentionRetryOptions - When log retention is specified, a custom resource attempts to create the CloudWatch log group. This parameter is required.
    
    Returns:
    
    this
  - logRetentionRole
```
public DockerImageFunction.Builder logRetentionRole(IRole logRetentionRole)
```
    The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
    Default: - A new role is created.
    
    Parameters:
    
    logRetentionRole - The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This parameter is required.
    
    Returns:
    
    this
  - memorySize
```
public DockerImageFunction.Builder memorySize(java.lang.Number 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.
    Default: 128
    
    Parameters:
    
    memorySize - The amount of memory, in MB, that is allocated to your Lambda function. This parameter is required.
    
    Returns:
    
    this
  - profiling
```
public DockerImageFunction.Builder profiling(java.lang.Boolean profiling)
```
    Enable profiling.
    Default: - No profiling.
    
    Parameters:
    
    profiling - Enable profiling. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
  - profilingGroup
```
public DockerImageFunction.Builder profilingGroup(IProfilingGroup profilingGroup)
```
    Profiling Group.
    Default: - A new profiling group will be created if `profiling` is set.
    
    Parameters:
    
    profilingGroup - Profiling Group. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
  - reservedConcurrentExecutions
```
public DockerImageFunction.Builder reservedConcurrentExecutions(java.lang.Number reservedConcurrentExecutions)
```
    The maximum of concurrent executions you want to reserve for the function.
    Default: - No specific limit - account limit.
    
    Parameters:
    
    reservedConcurrentExecutions - The maximum of concurrent executions you want to reserve for the function. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html
  - role
```
public DockerImageFunction.Builder role(IRole 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".
    Default: - A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling `addToRolePolicy`.
    
    Parameters:
    
    role - Lambda execution role. This parameter is required.
    
    Returns:
    
    this
  - securityGroup
```
@Deprecated
public DockerImageFunction.Builder securityGroup(ISecurityGroup securityGroup)
```
    Deprecated. - This property is deprecated, use securityGroups instead
    
    (deprecated) 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.
    Default: - If the function is placed within a VPC and a security group is not specified, either by this or securityGroups prop, a dedicated security group will be created for this function.
    
    Parameters:
    
    securityGroup - What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead. This parameter is required.
    
    Returns:
    
    this
  - securityGroups
```
public DockerImageFunction.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)
```
    The list of security groups to associate with the Lambda's network interfaces.
    Only used if 'vpc' is supplied.
    Default: - If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function.
    
    Parameters:
    
    securityGroups - The list of security groups to associate with the Lambda's network interfaces. This parameter is required.
    
    Returns:
    
    this
  - timeout
```
public DockerImageFunction.Builder timeout(Duration 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.
    Default: Duration.seconds(3)
    
    Parameters:
    
    timeout - The function execution time (in seconds) after which Lambda terminates the function. This parameter is required.
    
    Returns:
    
    this
  - tracing
```
public DockerImageFunction.Builder tracing(Tracing tracing)
```
    Enable AWS X-Ray Tracing for Lambda Function.
    Default: Tracing.Disabled
    
    Parameters:
    
    tracing - Enable AWS X-Ray Tracing for Lambda Function. This parameter is required.
    
    Returns:
    
    this
  - vpc
```
public DockerImageFunction.Builder vpc(IVpc vpc)
```
    VPC network to place Lambda network interfaces.
    Specify this if the Lambda function needs to access resources in a VPC.
    Default: - Function is not placed within a VPC.
    
    Parameters:
    
    vpc - VPC network to place Lambda network interfaces. This parameter is required.
    
    Returns:
    
    this
  - vpcSubnets
```
public DockerImageFunction.Builder vpcSubnets(SubnetSelection 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.
    Default: - the Vpc default strategy if not specified
    
    Parameters:
    
    vpcSubnets - Where to place the network interfaces within the VPC. This parameter is required.
    
    Returns:
    
    this
  - code
```
public DockerImageFunction.Builder code(DockerImageCode code)
```
    The source code of your Lambda function.
    You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.
    
    Parameters:
    
    code - The source code of your Lambda function. This parameter is required.
    
    Returns:
    
    this
  - build
```
public DockerImageFunction build()
```

Class DockerImageFunction.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

maxEventAge

onFailure

onSuccess

retryAttempts

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

code

build