@Stability(value=Experimental) public static final class GoFunctionProps.Builder extends Object implements software.amazon.jsii.Builder<GoFunctionProps>
GoFunctionProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Experimental) public GoFunctionProps.Builder entry(String entry)
GoFunctionProps.getEntry()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`
this@Stability(value=Experimental) public GoFunctionProps.Builder bundling(BundlingOptions bundling)
GoFunctionProps.getBundling()bundling - Bundling options.this@Stability(value=Experimental) public GoFunctionProps.Builder moduleDir(String moduleDir)
GoFunctionProps.getModuleDir()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.
this@Stability(value=Experimental) public GoFunctionProps.Builder runtime(Runtime runtime)
GoFunctionProps.getRuntime()runtime - The runtime environment.
Only runtimes of the Golang family and provided family are supported.this@Stability(value=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder architecture(Architecture architecture)
FunctionOptions.getArchitecture()architecture - The system architectures compatible with this lambda function.this@Stability(value=Deprecated) @Deprecated public GoFunctionProps.Builder architectures(List<? extends Architecture> architectures)
FunctionOptions.getArchitectures()architectures - DEPRECATED.this@Stability(value=Stable) public GoFunctionProps.Builder codeSigningConfig(ICodeSigningConfig codeSigningConfig)
FunctionOptions.getCodeSigningConfig()codeSigningConfig - Code signing config associated with this function.this@Stability(value=Stable) public GoFunctionProps.Builder currentVersionOptions(VersionOptions currentVersionOptions)
FunctionOptions.getCurrentVersionOptions()currentVersionOptions - Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.this@Stability(value=Stable) public GoFunctionProps.Builder deadLetterQueue(software.amazon.awscdk.services.sqs.IQueue deadLetterQueue)
FunctionOptions.getDeadLetterQueue()deadLetterQueue - The SQS queue to use if DLQ is enabled.
If SNS topic is desired, specify deadLetterTopic property instead.this@Stability(value=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder deadLetterTopic(software.amazon.awscdk.services.sns.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@Stability(value=Stable) public GoFunctionProps.Builder description(String description)
FunctionOptions.getDescription()description - A description of the function.this@Stability(value=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder environmentEncryption(software.amazon.awscdk.services.kms.IKey environmentEncryption)
FunctionOptions.getEnvironmentEncryption()environmentEncryption - The AWS KMS key that's used to encrypt your function's environment variables.this@Stability(value=Stable) public GoFunctionProps.Builder ephemeralStorageSize(Size ephemeralStorageSize)
FunctionOptions.getEphemeralStorageSize()ephemeralStorageSize - The size of the function’s /tmp directory in MiB.this@Stability(value=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder filesystem(FileSystem filesystem)
FunctionOptions.getFilesystem()filesystem - The filesystem configuration for the lambda function.this@Stability(value=Stable) public GoFunctionProps.Builder functionName(String functionName)
FunctionOptions.getFunctionName()functionName - A name for the function.this@Stability(value=Stable) public GoFunctionProps.Builder initialPolicy(List<? extends software.amazon.awscdk.services.iam.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=Stable) public GoFunctionProps.Builder insightsVersion(LambdaInsightsVersion insightsVersion)
FunctionOptions.getInsightsVersion()insightsVersion - Specify the version of CloudWatch Lambda insights to use for monitoring.this@Stability(value=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder logRetention(software.amazon.awscdk.services.logs.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=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder logRetentionRole(software.amazon.awscdk.services.iam.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=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder profiling(Boolean profiling)
FunctionOptions.getProfiling()profiling - Enable profiling.this@Stability(value=Stable) public GoFunctionProps.Builder profilingGroup(software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup profilingGroup)
FunctionOptions.getProfilingGroup()profilingGroup - Profiling Group.this@Stability(value=Stable) public GoFunctionProps.Builder reservedConcurrentExecutions(Number reservedConcurrentExecutions)
FunctionOptions.getReservedConcurrentExecutions()reservedConcurrentExecutions - The maximum of concurrent executions you want to reserve for the function.this@Stability(value=Stable) public GoFunctionProps.Builder role(software.amazon.awscdk.services.iam.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=Deprecated) @Deprecated public GoFunctionProps.Builder securityGroup(software.amazon.awscdk.services.ec2.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@Stability(value=Stable) public GoFunctionProps.Builder securityGroups(List<? extends software.amazon.awscdk.services.ec2.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=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder tracing(Tracing tracing)
FunctionOptions.getTracing()tracing - Enable AWS X-Ray Tracing for Lambda Function.this@Stability(value=Stable) public GoFunctionProps.Builder vpc(software.amazon.awscdk.services.ec2.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=Stable) public GoFunctionProps.Builder vpcSubnets(software.amazon.awscdk.services.ec2.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=Stable) public GoFunctionProps.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=Stable) public GoFunctionProps.Builder onFailure(IDestination onFailure)
EventInvokeConfigOptions.getOnFailure()onFailure - The destination for failed invocations.this@Stability(value=Stable) public GoFunctionProps.Builder onSuccess(IDestination onSuccess)
EventInvokeConfigOptions.getOnSuccess()onSuccess - The destination for successful invocations.this@Stability(value=Stable) public GoFunctionProps.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 GoFunctionProps build()
build in interface software.amazon.jsii.Builder<GoFunctionProps>GoFunctionPropsNullPointerException - if any required attribute was not providedCopyright © 2023. All rights reserved.