Class CfnFunction.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFunction>
- Enclosing class:
CfnFunction
CfnFunction
.-
Method Summary
Modifier and TypeMethodDescriptionarchitectures
(List<String> architectures) The instruction set architecture that the function supports.build()
code
(IResolvable code) The deployment package for a Lambda function.code
(CfnFunction.CodeProperty code) The deployment package for a Lambda function.codeSigningConfigArn
(String codeSigningConfigArn) To enable code signing for this function, specify the ARN of a code-signing configuration.static CfnFunction.Builder
deadLetterConfig
(IResolvable deadLetterConfig) The dead-letter queue for failed asynchronous invocations.deadLetterConfig
(CfnFunction.DeadLetterConfigProperty deadLetterConfig) The dead-letter queue for failed asynchronous invocations.description
(String description) A description of the function.environment
(IResolvable environment) A function's environment variable settings.environment
(CfnFunction.EnvironmentProperty environment) A function's environment variable settings.ephemeralStorage
(IResolvable ephemeralStorage) The size of the function's/tmp
directory in MB.ephemeralStorage
(CfnFunction.EphemeralStorageProperty ephemeralStorage) The size of the function's/tmp
directory in MB.fileSystemConfigs
(List<? extends Object> fileSystemConfigs) Connection settings for an Amazon EFS file system.fileSystemConfigs
(IResolvable fileSystemConfigs) Connection settings for an Amazon EFS file system.functionName
(String functionName) The name of the Lambda function, up to 64 characters in length.The name of the method within your code that Lambda calls to run your function.imageConfig
(IResolvable imageConfig) Configuration values that override the container image Dockerfile settings.imageConfig
(CfnFunction.ImageConfigProperty imageConfig) Configuration values that override the container image Dockerfile settings.The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables.A list of function layers to add to the function's execution environment.loggingConfig
(IResolvable loggingConfig) The function's Amazon CloudWatch Logs configuration settings.loggingConfig
(CfnFunction.LoggingConfigProperty loggingConfig) The function's Amazon CloudWatch Logs configuration settings.memorySize
(Number memorySize) The amount of memory available to the function at runtime.packageType
(String packageType) The type of deployment package.recursiveLoop
(String recursiveLoop) This property is set to terminate unintended recursions.reservedConcurrentExecutions
(Number reservedConcurrentExecutions) The number of simultaneous executions to reserve for the function.The Amazon Resource Name (ARN) of the function's execution role.The identifier of the function's runtime.runtimeManagementConfig
(IResolvable runtimeManagementConfig) Sets the runtime management configuration for a function's version.runtimeManagementConfig
(CfnFunction.RuntimeManagementConfigProperty runtimeManagementConfig) Sets the runtime management configuration for a function's version.snapStart
(IResolvable snapStart) The function's SnapStart setting.snapStart
(CfnFunction.SnapStartProperty snapStart) The function's SnapStart setting.A list of tags to apply to the function.The amount of time (in seconds) that Lambda allows a function to run before stopping it.tracingConfig
(IResolvable tracingConfig) tracingConfig
(CfnFunction.TracingConfigProperty tracingConfig) vpcConfig
(IResolvable vpcConfig) The VPC security groups and subnets that are attached to a Lambda function.vpcConfig
(CfnFunction.VpcConfigProperty vpcConfig) The VPC security groups and subnets that are attached to a Lambda function.
-
Method Details
-
create
@Stability(Stable) public static CfnFunction.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnFunction.Builder
.
-
code
The deployment package for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.- Parameters:
code
- The deployment package for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template. This parameter is required.- Returns:
this
- See Also:
-
code
The deployment package for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.- Parameters:
code
- The deployment package for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template. This parameter is required.- Returns:
this
- See Also:
-
role
The Amazon Resource Name (ARN) of the function's execution role.- Parameters:
role
- The Amazon Resource Name (ARN) of the function's execution role. This parameter is required.- Returns:
this
- See Also:
-
architectures
The instruction set architecture that the function supports.Enter a string array with one of the valid values (arm64 or x86_64). The default value is
x86_64
.- Parameters:
architectures
- The instruction set architecture that the function supports. This parameter is required.- Returns:
this
- See Also:
-
codeSigningConfigArn
To enable code signing for this function, specify the ARN of a code-signing configuration.A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
- Parameters:
codeSigningConfigArn
- To enable code signing for this function, specify the ARN of a code-signing configuration. This parameter is required.- Returns:
this
- See Also:
-
deadLetterConfig
The dead-letter queue for failed asynchronous invocations.- Parameters:
deadLetterConfig
- The dead-letter queue for failed asynchronous invocations. This parameter is required.- Returns:
this
- See Also:
-
deadLetterConfig
@Stability(Stable) public CfnFunction.Builder deadLetterConfig(CfnFunction.DeadLetterConfigProperty deadLetterConfig) The dead-letter queue for failed asynchronous invocations.- Parameters:
deadLetterConfig
- The dead-letter queue for failed asynchronous invocations. This parameter is required.- Returns:
this
- See Also:
-
description
A description of the function.- Parameters:
description
- A description of the function. This parameter is required.- Returns:
this
- See Also:
-
environment
A function's environment variable settings.You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
- Parameters:
environment
- A function's environment variable settings. This parameter is required.- Returns:
this
- See Also:
-
environment
@Stability(Stable) public CfnFunction.Builder environment(CfnFunction.EnvironmentProperty environment) A function's environment variable settings.You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
- Parameters:
environment
- A function's environment variable settings. This parameter is required.- Returns:
this
- See Also:
-
ephemeralStorage
The size of the function's/tmp
directory in MB.The default value is 512, but it can be any whole number between 512 and 10,240 MB.
- Parameters:
ephemeralStorage
- The size of the function's/tmp
directory in MB. This parameter is required.- Returns:
this
- See Also:
-
ephemeralStorage
@Stability(Stable) public CfnFunction.Builder ephemeralStorage(CfnFunction.EphemeralStorageProperty ephemeralStorage) The size of the function's/tmp
directory in MB.The default value is 512, but it can be any whole number between 512 and 10,240 MB.
- Parameters:
ephemeralStorage
- The size of the function's/tmp
directory in MB. This parameter is required.- Returns:
this
- See Also:
-
fileSystemConfigs
Connection settings for an Amazon EFS file system.To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a
DependsOn
attribute to ensure that the mount target is created or updated before the function. For more information about using theDependsOn
attribute, see DependsOn Attribute.- Parameters:
fileSystemConfigs
- Connection settings for an Amazon EFS file system. This parameter is required.- Returns:
this
- See Also:
-
fileSystemConfigs
@Stability(Stable) public CfnFunction.Builder fileSystemConfigs(List<? extends Object> fileSystemConfigs) Connection settings for an Amazon EFS file system.To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a
DependsOn
attribute to ensure that the mount target is created or updated before the function. For more information about using theDependsOn
attribute, see DependsOn Attribute.- Parameters:
fileSystemConfigs
- Connection settings for an Amazon EFS file system. This parameter is required.- Returns:
this
- See Also:
-
functionName
The name of the Lambda function, up to 64 characters in length.If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Parameters:
functionName
- The name of the Lambda function, up to 64 characters in length. This parameter is required.- Returns:
this
- See Also:
-
handler
The name of the method within your code that Lambda calls to run your function.Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.
- Parameters:
handler
- The name of the method within your code that Lambda calls to run your function. This parameter is required.- Returns:
this
- See Also:
-
imageConfig
Configuration values that override the container image Dockerfile settings.For more information, see Container image settings.
- Parameters:
imageConfig
- Configuration values that override the container image Dockerfile settings. This parameter is required.- Returns:
this
- See Also:
-
imageConfig
@Stability(Stable) public CfnFunction.Builder imageConfig(CfnFunction.ImageConfigProperty imageConfig) Configuration values that override the container image Dockerfile settings.For more information, see Container image settings.
- Parameters:
imageConfig
- Configuration values that override the container image Dockerfile settings. This parameter is required.- Returns:
this
- See Also:
-
kmsKeyArn
The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.- Parameters:
kmsKeyArn
- The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key. This parameter is required.- Returns:
this
- See Also:
-
layers
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.- Parameters:
layers
- A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. This parameter is required.- Returns:
this
- See Also:
-
loggingConfig
The function's Amazon CloudWatch Logs configuration settings.- Parameters:
loggingConfig
- The function's Amazon CloudWatch Logs configuration settings. This parameter is required.- Returns:
this
- See Also:
-
loggingConfig
@Stability(Stable) public CfnFunction.Builder loggingConfig(CfnFunction.LoggingConfigProperty loggingConfig) The function's Amazon CloudWatch Logs configuration settings.- Parameters:
loggingConfig
- The function's Amazon CloudWatch Logs configuration settings. This parameter is required.- Returns:
this
- See Also:
-
memorySize
The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.- Parameters:
memorySize
- The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase. This parameter is required.- Returns:
this
- See Also:
-
packageType
The type of deployment package.Set to
Image
for container image and setZip
for .zip file archive.- Parameters:
packageType
- The type of deployment package. This parameter is required.- Returns:
this
- See Also:
-
recursiveLoop
This property is set to terminate unintended recursions.If set to
Terminate
, Lambda detects and terminates unitended recursive loops. If set toAllow
Lambda lets recursions be and does not terminate it.- Parameters:
recursiveLoop
- This property is set to terminate unintended recursions. This parameter is required.- Returns:
this
- See Also:
-
reservedConcurrentExecutions
@Stability(Stable) public CfnFunction.Builder reservedConcurrentExecutions(Number reservedConcurrentExecutions) The number of simultaneous executions to reserve for the function.- Parameters:
reservedConcurrentExecutions
- The number of simultaneous executions to reserve for the function. This parameter is required.- Returns:
this
- See Also:
-
runtime
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation. For a list of all currently supported runtimes, see Supported runtimes.- Parameters:
runtime
- The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation. For a list of all currently supported runtimes, see Supported runtimes. This parameter is required.- Returns:
this
- See Also:
-
runtimeManagementConfig
@Stability(Stable) public CfnFunction.Builder runtimeManagementConfig(IResolvable runtimeManagementConfig) Sets the runtime management configuration for a function's version.For more information, see Runtime updates.
- Parameters:
runtimeManagementConfig
- Sets the runtime management configuration for a function's version. This parameter is required.- Returns:
this
- See Also:
-
runtimeManagementConfig
@Stability(Stable) public CfnFunction.Builder runtimeManagementConfig(CfnFunction.RuntimeManagementConfigProperty runtimeManagementConfig) Sets the runtime management configuration for a function's version.For more information, see Runtime updates.
- Parameters:
runtimeManagementConfig
- Sets the runtime management configuration for a function's version. This parameter is required.- Returns:
this
- See Also:
-
snapStart
The function's SnapStart setting.- Parameters:
snapStart
- The function's SnapStart setting. This parameter is required.- Returns:
this
- See Also:
-
snapStart
The function's SnapStart setting.- Parameters:
snapStart
- The function's SnapStart setting. This parameter is required.- Returns:
this
- See Also:
-
tags
A list of tags to apply to the function.- Parameters:
tags
- A list of tags to apply to the function. This parameter is required.- Returns:
this
- See Also:
-
timeout
The amount of time (in seconds) that Lambda allows a function to run before stopping it.The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
- Parameters:
timeout
- The amount of time (in seconds) that Lambda allows a function to run before stopping it. This parameter is required.- Returns:
this
- See Also:
-
tracingConfig
-
tracingConfig
@Stability(Stable) public CfnFunction.Builder tracingConfig(CfnFunction.TracingConfigProperty tracingConfig) -
vpcConfig
The VPC security groups and subnets that are attached to a Lambda function.When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings. When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the
ec2:DescribeNetworkInterfaces
permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.- Parameters:
vpcConfig
- The VPC security groups and subnets that are attached to a Lambda function. This parameter is required.- Returns:
this
- See Also:
-
vpcConfig
The VPC security groups and subnets that are attached to a Lambda function.When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings. When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the
ec2:DescribeNetworkInterfaces
permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.- Parameters:
vpcConfig
- The VPC security groups and subnets that are attached to a Lambda function. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnFunction>
- Returns:
- a newly built instance of
CfnFunction
.
-