Package software.amazon.awscdk.services.lambda.go.alpha

Class GoFunctionProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.go.alpha.GoFunctionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GoFunctionProps>

Enclosing interface:

GoFunctionProps

@Stability(Experimental)
public static final class GoFunctionProps.Builder
extends Object
implements software.amazon.jsii.Builder<GoFunctionProps>

A builder for GoFunctionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GoFunctionProps.Builder	adotInstrumentation(AdotInstrumentationConfig adotInstrumentation)	Sets the value of FunctionOptions.getAdotInstrumentation()
GoFunctionProps.Builder	allowAllOutbound(Boolean allowAllOutbound)	Sets the value of FunctionOptions.getAllowAllOutbound()
GoFunctionProps.Builder	allowPublicSubnet(Boolean allowPublicSubnet)	Sets the value of FunctionOptions.getAllowPublicSubnet()
GoFunctionProps.Builder	architecture(Architecture architecture)	Sets the value of FunctionOptions.getArchitecture()
GoFunctionProps	build()	Builds the configured instance.
GoFunctionProps.Builder	bundling(BundlingOptions bundling)	Sets the value of GoFunctionProps.getBundling()
GoFunctionProps.Builder	codeSigningConfig(ICodeSigningConfig codeSigningConfig)	Sets the value of FunctionOptions.getCodeSigningConfig()
GoFunctionProps.Builder	currentVersionOptions(VersionOptions currentVersionOptions)	Sets the value of FunctionOptions.getCurrentVersionOptions()
GoFunctionProps.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of FunctionOptions.getDeadLetterQueue()
GoFunctionProps.Builder	deadLetterQueueEnabled(Boolean deadLetterQueueEnabled)	Sets the value of FunctionOptions.getDeadLetterQueueEnabled()
GoFunctionProps.Builder	deadLetterTopic(ITopic deadLetterTopic)	Sets the value of FunctionOptions.getDeadLetterTopic()
GoFunctionProps.Builder	description(String description)	Sets the value of FunctionOptions.getDescription()
GoFunctionProps.Builder	entry(String entry)	Sets the value of GoFunctionProps.getEntry()
GoFunctionProps.Builder	environment(Map<String,String> environment)	Sets the value of FunctionOptions.getEnvironment()
GoFunctionProps.Builder	environmentEncryption(IKey environmentEncryption)	Sets the value of FunctionOptions.getEnvironmentEncryption()
GoFunctionProps.Builder	ephemeralStorageSize(Size ephemeralStorageSize)	Sets the value of FunctionOptions.getEphemeralStorageSize()
GoFunctionProps.Builder	events(List<? extends IEventSource> events)	Sets the value of FunctionOptions.getEvents()
GoFunctionProps.Builder	filesystem(FileSystem filesystem)	Sets the value of FunctionOptions.getFilesystem()
GoFunctionProps.Builder	functionName(String functionName)	Sets the value of FunctionOptions.getFunctionName()
GoFunctionProps.Builder	initialPolicy(List<? extends PolicyStatement> initialPolicy)	Sets the value of FunctionOptions.getInitialPolicy()
GoFunctionProps.Builder	insightsVersion(LambdaInsightsVersion insightsVersion)	Sets the value of FunctionOptions.getInsightsVersion()
GoFunctionProps.Builder	layers(List<? extends ILayerVersion> layers)	Sets the value of FunctionOptions.getLayers()
GoFunctionProps.Builder	logRetention(RetentionDays logRetention)	Sets the value of FunctionOptions.getLogRetention()
GoFunctionProps.Builder	logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions)	Sets the value of FunctionOptions.getLogRetentionRetryOptions()
GoFunctionProps.Builder	logRetentionRole(IRole logRetentionRole)	Sets the value of FunctionOptions.getLogRetentionRole()
GoFunctionProps.Builder	maxEventAge(Duration maxEventAge)	Sets the value of EventInvokeConfigOptions.getMaxEventAge()
GoFunctionProps.Builder	memorySize(Number memorySize)	Sets the value of FunctionOptions.getMemorySize()
GoFunctionProps.Builder	moduleDir(String moduleDir)	Sets the value of GoFunctionProps.getModuleDir()
GoFunctionProps.Builder	onFailure(IDestination onFailure)	Sets the value of EventInvokeConfigOptions.getOnFailure()
GoFunctionProps.Builder	onSuccess(IDestination onSuccess)	Sets the value of EventInvokeConfigOptions.getOnSuccess()
GoFunctionProps.Builder	paramsAndSecrets(ParamsAndSecretsLayerVersion paramsAndSecrets)	Sets the value of FunctionOptions.getParamsAndSecrets()
GoFunctionProps.Builder	profiling(Boolean profiling)	Sets the value of FunctionOptions.getProfiling()
GoFunctionProps.Builder	profilingGroup(IProfilingGroup profilingGroup)	Sets the value of FunctionOptions.getProfilingGroup()
GoFunctionProps.Builder	reservedConcurrentExecutions(Number reservedConcurrentExecutions)	Sets the value of FunctionOptions.getReservedConcurrentExecutions()
GoFunctionProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of EventInvokeConfigOptions.getRetryAttempts()
GoFunctionProps.Builder	role(IRole role)	Sets the value of FunctionOptions.getRole()
GoFunctionProps.Builder	runtime(Runtime runtime)	Sets the value of GoFunctionProps.getRuntime()
GoFunctionProps.Builder	runtimeManagementMode(RuntimeManagementMode runtimeManagementMode)	Sets the value of FunctionOptions.getRuntimeManagementMode()
GoFunctionProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of FunctionOptions.getSecurityGroups()
GoFunctionProps.Builder	timeout(Duration timeout)	Sets the value of FunctionOptions.getTimeout()
GoFunctionProps.Builder	tracing(Tracing tracing)	Sets the value of FunctionOptions.getTracing()
GoFunctionProps.Builder	vpc(IVpc vpc)	Sets the value of FunctionOptions.getVpc()
GoFunctionProps.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 Details

Builder

public Builder()

Method Details

entry

@Stability(Experimental)
public GoFunctionProps.Builder entry(String entry)

Sets the value of GoFunctionProps.getEntry()

Parameters:

entry - The path to the folder or file that contains the main application entry point files for the project. This parameter is required. This accepts either a path to a directory or file.

If a directory path is provided then it will assume there is a Go entry file (i.e. main.go) and will construct the build command using the directory path.

For example, if you provide the entry as:

              entry: 'my-lambda-app/cmd/api'
              

Then the go build command would be:

              `go build ./cmd/api`
              

If a path to a file is provided then it will use the filepath in the build command.

For example, if you provide the entry as:

              entry: 'my-lambda-app/cmd/api/main.go'
              

Then the go build command would be:

              `go build ./cmd/api/main.go`
              

Returns:

this

bundling

@Stability(Experimental)
public GoFunctionProps.Builder bundling(BundlingOptions bundling)

Sets the value of GoFunctionProps.getBundling()

Parameters:

bundling - Bundling options.

Returns:

this

moduleDir

@Stability(Experimental)
public GoFunctionProps.Builder moduleDir(String moduleDir)

Sets the value of GoFunctionProps.getModuleDir()

Parameters:

moduleDir - Directory containing your go.mod file. This will accept either a directory path containing a go.mod file or a filepath to your go.mod file (i.e. path/to/go.mod).

This will be used as the source of the volume mounted in the Docker container and will be the directory where it will run go build from.

Returns:

this

runtime

@Stability(Experimental)
public GoFunctionProps.Builder runtime(Runtime runtime)

Sets the value of GoFunctionProps.getRuntime()

Parameters:

runtime - The runtime environment. Only runtimes of the Golang family and provided family are supported.

Returns:

this

adotInstrumentation

@Stability(Stable)
public GoFunctionProps.Builder adotInstrumentation(AdotInstrumentationConfig adotInstrumentation)

Sets the value of FunctionOptions.getAdotInstrumentation()

Parameters:

adotInstrumentation - Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.

Returns:

this

allowAllOutbound

@Stability(Stable)
public GoFunctionProps.Builder allowAllOutbound(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

@Stability(Stable)
public GoFunctionProps.Builder allowPublicSubnet(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

@Stability(Stable)
public GoFunctionProps.Builder architecture(Architecture architecture)

Sets the value of FunctionOptions.getArchitecture()

Parameters:

architecture - The system architectures compatible with this lambda function.

Returns:

this

codeSigningConfig

@Stability(Stable)
public GoFunctionProps.Builder codeSigningConfig(ICodeSigningConfig codeSigningConfig)

Sets the value of FunctionOptions.getCodeSigningConfig()

Parameters:

codeSigningConfig - Code signing config associated with this function.

Returns:

this

currentVersionOptions

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.Builder deadLetterQueueEnabled(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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.Builder description(String description)

Sets the value of FunctionOptions.getDescription()

Parameters:

description - A description of the function.

Returns:

this

environment

@Stability(Stable)
public GoFunctionProps.Builder environment(Map<String,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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.Builder events(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

@Stability(Stable)
public GoFunctionProps.Builder filesystem(FileSystem filesystem)

Sets the value of FunctionOptions.getFilesystem()

Parameters:

filesystem - The filesystem configuration for the lambda function.

Returns:

this

functionName

@Stability(Stable)
public GoFunctionProps.Builder functionName(String functionName)

Sets the value of FunctionOptions.getFunctionName()

Parameters:

functionName - A name for the function.

Returns:

this

initialPolicy

@Stability(Stable)
public GoFunctionProps.Builder initialPolicy(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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.Builder layers(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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.Builder memorySize(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

paramsAndSecrets

@Stability(Stable)
public GoFunctionProps.Builder paramsAndSecrets(ParamsAndSecretsLayerVersion paramsAndSecrets)

Sets the value of FunctionOptions.getParamsAndSecrets()

Parameters:

paramsAndSecrets - Specify the configuration of Parameters and Secrets Extension.

Returns:

this

profiling

@Stability(Stable)
public GoFunctionProps.Builder profiling(Boolean profiling)

Sets the value of FunctionOptions.getProfiling()

Parameters:

profiling - Enable profiling.

Returns:

this

profilingGroup

@Stability(Stable)
public GoFunctionProps.Builder profilingGroup(IProfilingGroup profilingGroup)

Sets the value of FunctionOptions.getProfilingGroup()

Parameters:

profilingGroup - Profiling Group.

Returns:

this

reservedConcurrentExecutions

@Stability(Stable)
public GoFunctionProps.Builder reservedConcurrentExecutions(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

@Stability(Stable)
public GoFunctionProps.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

runtimeManagementMode

@Stability(Stable)
public GoFunctionProps.Builder runtimeManagementMode(RuntimeManagementMode runtimeManagementMode)

Sets the value of FunctionOptions.getRuntimeManagementMode()

Parameters:

runtimeManagementMode - Sets the runtime management configuration for a function's version.

Returns:

this

securityGroups

@Stability(Stable)
public GoFunctionProps.Builder securityGroups(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

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.Builder tracing(Tracing tracing)

Sets the value of FunctionOptions.getTracing()

Parameters:

tracing - Enable AWS X-Ray Tracing for Lambda Function.

Returns:

this

vpc

@Stability(Stable)
public GoFunctionProps.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. This is required when vpcSubnets is specified.

Returns:

this

vpcSubnets

@Stability(Stable)
public GoFunctionProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of FunctionOptions.getVpcSubnets()

Parameters:

vpcSubnets - Where to place the network interfaces within the VPC. This requires vpc to be specified in order for interfaces to actually be placed in the subnets. If vpc is not specify, this will raise an error.

Note: Internet access for Lambda Functions requires a NAT Gateway, so picking public subnets is not allowed (unless allowPublicSubnet is set to true).

Returns:

this

maxEventAge

@Stability(Stable)
public GoFunctionProps.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

@Stability(Stable)
public GoFunctionProps.Builder onFailure(IDestination onFailure)

Sets the value of EventInvokeConfigOptions.getOnFailure()

Parameters:

onFailure - The destination for failed invocations.

Returns:

this

onSuccess

@Stability(Stable)
public GoFunctionProps.Builder onSuccess(IDestination onSuccess)

Sets the value of EventInvokeConfigOptions.getOnSuccess()

Parameters:

onSuccess - The destination for successful invocations.

Returns:

this

retryAttempts

@Stability(Stable)
public GoFunctionProps.Builder retryAttempts(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

@Stability(Experimental)
public GoFunctionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GoFunctionProps>

Returns:

a new instance of GoFunctionProps

Throws:

NullPointerException - if any required attribute was not provided