Class GoFunctionProps.Jsii$Proxy
- All Implemented Interfaces:
EventInvokeConfigOptions
,FunctionOptions
,GoFunctionProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
GoFunctionProps
GoFunctionProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.go.GoFunctionProps
GoFunctionProps.Builder, GoFunctionProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(GoFunctionProps.Builder builder) Constructor that initializes the object based on literal property values passed by theGoFunctionProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Boolean
Whether to allow the Lambda to send all network traffic.final Boolean
Lambda Functions in a public subnet can NOT access the internet.final Architecture
The system architectures compatible with this lambda function.final List<Architecture>
(deprecated) DEPRECATED.final BundlingOptions
(experimental) Bundling options.final ICodeSigningConfig
Code signing config associated with this function.final VersionOptions
Options for thelambda.Version
resource automatically created by thefn.currentVersion
method.final IQueue
The SQS queue to use if DLQ is enabled.final Boolean
Enabled DLQ.final ITopic
The SNS topic to use as a DLQ.final String
A description of the function.final String
getEntry()
(experimental) The path to the folder or file that contains the main application entry point files for the project.Key-value pairs that Lambda caches and makes available for your Lambda functions.final IKey
The AWS KMS key that's used to encrypt your function's environment variables.final Size
The size of the function’s /tmp directory in MiB.final List<IEventSource>
Event sources for this function.final FileSystem
The filesystem configuration for the lambda function.final String
A name for the function.final List<PolicyStatement>
Initial policy statements to add to the created Lambda Role.final LambdaInsightsVersion
Specify the version of CloudWatch Lambda insights to use for monitoring.final List<ILayerVersion>
A list of layers to add to the function's execution environment.final RetentionDays
The number of days log events are kept in CloudWatch Logs.final LogRetentionRetryOptions
When log retention is specified, a custom resource attempts to create the CloudWatch log group.final IRole
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.final Duration
The maximum age of a request that Lambda sends to a function for processing.final Number
The amount of memory, in MB, that is allocated to your Lambda function.final String
(experimental) Directory containing your go.mod file.final IDestination
The destination for failed invocations.final IDestination
The destination for successful invocations.final Boolean
Enable profiling.final IProfilingGroup
Profiling Group.final Number
The maximum of concurrent executions you want to reserve for the function.final Number
The maximum number of times to retry when the function returns an error.final IRole
getRole()
Lambda execution role.final Runtime
(experimental) The runtime environment.final ISecurityGroup
(deprecated) What security group to associate with the Lambda's network interfaces.final List<ISecurityGroup>
The list of security groups to associate with the Lambda's network interfaces.final Duration
The function execution time (in seconds) after which Lambda terminates the function.final Tracing
Enable AWS X-Ray Tracing for Lambda Function.final IVpc
getVpc()
VPC network to place Lambda network interfaces.final SubnetSelection
Where to place the network interfaces within the VPC.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theGoFunctionProps.Builder
.
-
-
Method Details
-
getEntry
Description copied from interface:GoFunctionProps
(experimental) The path to the folder or file that contains the main application entry point files for the project.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`
- Specified by:
getEntry
in interfaceGoFunctionProps
-
getBundling
Description copied from interface:GoFunctionProps
(experimental) Bundling options.Default: - use default bundling options
- Specified by:
getBundling
in interfaceGoFunctionProps
-
getModuleDir
Description copied from interface:GoFunctionProps
(experimental) Directory containing your go.mod file.This will accept either a directory path containing a
go.mod
file or a filepath to yourgo.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.Default: - the path is found by walking up parent directories searching for a `go.mod` file from the location of `entry`
- Specified by:
getModuleDir
in interfaceGoFunctionProps
-
getRuntime
Description copied from interface:GoFunctionProps
(experimental) The runtime environment.Only runtimes of the Golang family and provided family are supported.
Default: lambda.Runtime.PROVIDED_AL2
- Specified by:
getRuntime
in interfaceGoFunctionProps
-
getAllowAllOutbound
Description copied from interface:FunctionOptions
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
- Specified by:
getAllowAllOutbound
in interfaceFunctionOptions
-
getAllowPublicSubnet
Description copied from interface:FunctionOptions
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
- Specified by:
getAllowPublicSubnet
in interfaceFunctionOptions
- See Also:
-
getArchitecture
Description copied from interface:FunctionOptions
The system architectures compatible with this lambda function.Default: Architecture.X86_64
- Specified by:
getArchitecture
in interfaceFunctionOptions
-
getArchitectures
Description copied from interface:FunctionOptions
(deprecated) DEPRECATED.Default: [Architecture.X86_64]
- Specified by:
getArchitectures
in interfaceFunctionOptions
-
getCodeSigningConfig
Description copied from interface:FunctionOptions
Code signing config associated with this function.Default: - Not Sign the Code
- Specified by:
getCodeSigningConfig
in interfaceFunctionOptions
-
getCurrentVersionOptions
Description copied from interface:FunctionOptions
Options for thelambda.Version
resource automatically created by thefn.currentVersion
method.Default: - default options as described in `VersionOptions`
- Specified by:
getCurrentVersionOptions
in interfaceFunctionOptions
-
getDeadLetterQueue
Description copied from interface:FunctionOptions
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`
- Specified by:
getDeadLetterQueue
in interfaceFunctionOptions
-
getDeadLetterQueueEnabled
Description copied from interface:FunctionOptions
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.
- Specified by:
getDeadLetterQueueEnabled
in interfaceFunctionOptions
-
getDeadLetterTopic
Description copied from interface:FunctionOptions
The SNS topic to use as a DLQ.Note that if
deadLetterQueueEnabled
is set totrue
, 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
- Specified by:
getDeadLetterTopic
in interfaceFunctionOptions
-
getDescription
Description copied from interface:FunctionOptions
A description of the function.Default: - No description.
- Specified by:
getDescription
in interfaceFunctionOptions
-
getEnvironment
Description copied from interface:FunctionOptions
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.
- Specified by:
getEnvironment
in interfaceFunctionOptions
-
getEnvironmentEncryption
Description copied from interface:FunctionOptions
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).
- Specified by:
getEnvironmentEncryption
in interfaceFunctionOptions
-
getEphemeralStorageSize
Description copied from interface:FunctionOptions
The size of the function’s /tmp directory in MiB.Default: 512 MiB
- Specified by:
getEphemeralStorageSize
in interfaceFunctionOptions
-
getEvents
Description copied from interface:FunctionOptions
Event sources for this function.You can also add event sources using
addEventSource
.Default: - No event sources.
- Specified by:
getEvents
in interfaceFunctionOptions
-
getFilesystem
Description copied from interface:FunctionOptions
The filesystem configuration for the lambda function.Default: - will not mount any filesystem
- Specified by:
getFilesystem
in interfaceFunctionOptions
-
getFunctionName
Description copied from interface:FunctionOptions
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.
- Specified by:
getFunctionName
in interfaceFunctionOptions
-
getInitialPolicy
Description copied from interface:FunctionOptions
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.
- Specified by:
getInitialPolicy
in interfaceFunctionOptions
-
getInsightsVersion
Description copied from interface:FunctionOptions
Specify the version of CloudWatch Lambda insights to use for monitoring.Default: - No Lambda Insights
- Specified by:
getInsightsVersion
in interfaceFunctionOptions
- See Also:
-
getLayers
Description copied from interface:FunctionOptions
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.
- Specified by:
getLayers
in interfaceFunctionOptions
-
getLogRetention
Description copied from interface:FunctionOptions
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
- Specified by:
getLogRetention
in interfaceFunctionOptions
-
getLogRetentionRetryOptions
Description copied from interface:FunctionOptions
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.
- Specified by:
getLogRetentionRetryOptions
in interfaceFunctionOptions
-
getLogRetentionRole
Description copied from interface:FunctionOptions
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.Default: - A new role is created.
- Specified by:
getLogRetentionRole
in interfaceFunctionOptions
-
getMemorySize
Description copied from interface:FunctionOptions
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
- Specified by:
getMemorySize
in interfaceFunctionOptions
-
getProfiling
Description copied from interface:FunctionOptions
Enable profiling.Default: - No profiling.
- Specified by:
getProfiling
in interfaceFunctionOptions
- See Also:
-
getProfilingGroup
Description copied from interface:FunctionOptions
Profiling Group.Default: - A new profiling group will be created if `profiling` is set.
- Specified by:
getProfilingGroup
in interfaceFunctionOptions
- See Also:
-
getReservedConcurrentExecutions
Description copied from interface:FunctionOptions
The maximum of concurrent executions you want to reserve for the function.Default: - No specific limit - account limit.
- Specified by:
getReservedConcurrentExecutions
in interfaceFunctionOptions
- See Also:
-
getRole
Description copied from interface:FunctionOptions
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`.
- Specified by:
getRole
in interfaceFunctionOptions
-
getSecurityGroup
Description copied from interface:FunctionOptions
(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.
- Specified by:
getSecurityGroup
in interfaceFunctionOptions
-
getSecurityGroups
Description copied from interface:FunctionOptions
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.
- Specified by:
getSecurityGroups
in interfaceFunctionOptions
-
getTimeout
Description copied from interface:FunctionOptions
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)
- Specified by:
getTimeout
in interfaceFunctionOptions
-
getTracing
Description copied from interface:FunctionOptions
Enable AWS X-Ray Tracing for Lambda Function.Default: Tracing.Disabled
- Specified by:
getTracing
in interfaceFunctionOptions
-
getVpc
Description copied from interface:FunctionOptions
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.
- Specified by:
getVpc
in interfaceFunctionOptions
-
getVpcSubnets
Description copied from interface:FunctionOptions
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
- Specified by:
getVpcSubnets
in interfaceFunctionOptions
-
getMaxEventAge
Description copied from interface:EventInvokeConfigOptions
The maximum age of a request that Lambda sends to a function for processing.Minimum: 60 seconds Maximum: 6 hours
Default: Duration.hours(6)
- Specified by:
getMaxEventAge
in interfaceEventInvokeConfigOptions
-
getOnFailure
Description copied from interface:EventInvokeConfigOptions
The destination for failed invocations.Default: - no destination
- Specified by:
getOnFailure
in interfaceEventInvokeConfigOptions
-
getOnSuccess
Description copied from interface:EventInvokeConfigOptions
The destination for successful invocations.Default: - no destination
- Specified by:
getOnSuccess
in interfaceEventInvokeConfigOptions
-
getRetryAttempts
Description copied from interface:EventInvokeConfigOptions
The maximum number of times to retry when the function returns an error.Minimum: 0 Maximum: 2
Default: 2
- Specified by:
getRetryAttempts
in interfaceEventInvokeConfigOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-