Package io.github.cdklabs.awslambdarust

Class RustFunction.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<RustFunction>
    Enclosing class:
    RustFunction
    @Stability(Experimental)
public static final class RustFunction.Builder
extends Object
implements software.amazon.jsii.Builder<RustFunction>
    (experimental) A fluent builder for RustFunction.

    • Method Detail

      • create

        @Stability(Experimental)
public static RustFunction.Builder create​(software.constructs.Construct scope,
                                          String id)
        Parameters:
        scope - This parameter is required.
        id - This parameter is required.
        Returns:
        a new instance of RustFunction.Builder.

      • maxEventAge

        @Stability(Stable)
public RustFunction.Builder maxEventAge​(software.amazon.awscdk.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

        @Stability(Stable)
public RustFunction.Builder onFailure​(software.amazon.awscdk.services.lambda.IDestination onFailure)
        The destination for failed invocations.

        Default: - no destination

        Parameters:
        onFailure - The destination for failed invocations. This parameter is required.
        Returns:
        this

      • onSuccess

        @Stability(Stable)
public RustFunction.Builder onSuccess​(software.amazon.awscdk.services.lambda.IDestination onSuccess)
        The destination for successful invocations.

        Default: - no destination

        Parameters:
        onSuccess - The destination for successful invocations. This parameter is required.
        Returns:
        this

      • retryAttempts

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

      • adotInstrumentation

        @Stability(Stable)
public RustFunction.Builder adotInstrumentation​(software.amazon.awscdk.services.lambda.AdotInstrumentationConfig adotInstrumentation)
        Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.

        Default: - No ADOT instrumentation

        Parameters:
        adotInstrumentation - Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. This parameter is required.
        Returns:
        this
        See Also:
        https://aws-otel.github.io/docs/getting-started/lambda

      • allowAllOutbound

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

        Do not specify this property if the securityGroups or securityGroup property is set. Instead, configure allowAllOutbound directly on the security group.

        Default: true

        Parameters:
        allowAllOutbound - Whether to allow the Lambda to send all network traffic. This parameter is required.
        Returns:
        this

      • applicationLogLevel

        @Stability(Stable)
public RustFunction.Builder applicationLogLevel​(String applicationLogLevel)
        Sets the application log level for the function.

        Default: INFO

        Parameters:
        applicationLogLevel - Sets the application log level for the function. This parameter is required.
        Returns:
        this

      • architecture

        @Stability(Stable)
public RustFunction.Builder architecture​(software.amazon.awscdk.services.lambda.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

      • codeSigningConfig

        @Stability(Stable)
public RustFunction.Builder codeSigningConfig​(software.amazon.awscdk.services.lambda.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

        @Stability(Stable)
public RustFunction.Builder currentVersionOptions​(software.amazon.awscdk.services.lambda.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

        @Stability(Stable)
public RustFunction.Builder deadLetterQueue​(software.amazon.awscdk.services.sqs.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

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

        @Stability(Stable)
public RustFunction.Builder deadLetterTopic​(software.amazon.awscdk.services.sns.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

        @Stability(Stable)
public RustFunction.Builder description​(String description)
        A description of the function.

        Default: - No description.

        Parameters:
        description - A description of the function. This parameter is required.
        Returns:
        this

      • environment

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

        @Stability(Stable)
public RustFunction.Builder environmentEncryption​(software.amazon.awscdk.services.kms.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

        @Stability(Stable)
public RustFunction.Builder ephemeralStorageSize​(software.amazon.awscdk.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

        @Stability(Stable)
public RustFunction.Builder events​(List<? extends software.amazon.awscdk.services.lambda.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

        @Stability(Stable)
public RustFunction.Builder filesystem​(software.amazon.awscdk.services.lambda.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

        @Stability(Stable)
public RustFunction.Builder functionName​(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

        @Stability(Stable)
public RustFunction.Builder initialPolicy​(List<? extends software.amazon.awscdk.services.iam.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

      • layers

        @Stability(Stable)
public RustFunction.Builder layers​(List<? extends software.amazon.awscdk.services.lambda.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

      • logFormat

        @Stability(Stable)
public RustFunction.Builder logFormat​(String logFormat)
        Sets the logFormat for the function.

        Default: Text format

        Parameters:
        logFormat - Sets the logFormat for the function. This parameter is required.
        Returns:
        this

      • logGroup

        @Stability(Stable)
public RustFunction.Builder logGroup​(software.amazon.awscdk.services.logs.ILogGroup logGroup)
        Sets the log group name for the function.

        Default: `/aws/lambda/${this.functionName}` default log group name created by Lambda

        Parameters:
        logGroup - Sets the log group name for the function. This parameter is required.
        Returns:
        this

      • logRetention

        @Stability(Stable)
public RustFunction.Builder logRetention​(software.amazon.awscdk.services.logs.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

        @Stability(Stable)
public RustFunction.Builder logRetentionRetryOptions​(software.amazon.awscdk.services.lambda.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

        @Stability(Stable)
public RustFunction.Builder logRetentionRole​(software.amazon.awscdk.services.iam.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

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

      • reservedConcurrentExecutions

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

        @Stability(Stable)
public RustFunction.Builder role​(software.amazon.awscdk.services.iam.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

      • runtimeManagementMode

        @Stability(Stable)
public RustFunction.Builder runtimeManagementMode​(software.amazon.awscdk.services.lambda.RuntimeManagementMode runtimeManagementMode)
        Sets the runtime management configuration for a function's version.

        Default: Auto

        Parameters:
        runtimeManagementMode - Sets the runtime management configuration for a function's version. This parameter is required.
        Returns:
        this

      • securityGroups

        @Stability(Stable)
public RustFunction.Builder securityGroups​(List<? extends software.amazon.awscdk.services.ec2.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

      • snapStart

        @Stability(Stable)
public RustFunction.Builder snapStart​(software.amazon.awscdk.services.lambda.SnapStartConf snapStart)
        Enable SnapStart for Lambda Function.

        SnapStart is currently supported only for Java 11, 17 runtime

        Default: - No snapstart

        Parameters:
        snapStart - Enable SnapStart for Lambda Function. This parameter is required.
        Returns:
        this

      • systemLogLevel

        @Stability(Stable)
public RustFunction.Builder systemLogLevel​(String systemLogLevel)
        Sets the system log level for the function.

        Default: INFO

        Parameters:
        systemLogLevel - Sets the system log level for the function. This parameter is required.
        Returns:
        this

      • timeout

        @Stability(Stable)
public RustFunction.Builder timeout​(software.amazon.awscdk.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

        @Stability(Stable)
public RustFunction.Builder tracing​(software.amazon.awscdk.services.lambda.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

        @Stability(Stable)
public RustFunction.Builder vpc​(software.amazon.awscdk.services.ec2.IVpc 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.

        Default: - Function is not placed within a VPC.

        Parameters:
        vpc - VPC network to place Lambda network interfaces. This parameter is required.
        Returns:
        this

      • vpcSubnets

        @Stability(Stable)
public RustFunction.Builder vpcSubnets​(software.amazon.awscdk.services.ec2.SubnetSelection 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).

        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

      • binaryName

        @Stability(Experimental)
public RustFunction.Builder binaryName​(String binaryName)
        (experimental) The name of the binary to build, in case that it's different that the package's name.

        Default: Build all binaries

        Parameters:
        binaryName - The name of the binary to build, in case that it's different that the package's name. This parameter is required.
        Returns:
        this

      • bundling

        @Stability(Experimental)
public RustFunction.Builder bundling​(BundlingOptions bundling)
        (experimental) Bundling options.

        Default: - use default bundling options: all binaries and packages are bundled.

        Parameters:
        bundling - Bundling options. This parameter is required.
        Returns:
        this

      • entry

        @Stability(Experimental)
public RustFunction.Builder entry​(String entry)
        (experimental) Path to the entry Cargo.toml file.

        Default: - Derived from the name of the defining file and the construct's id. If the `RustsFunction` is defined in `stack.ts` with `my-binary` as id (`new RustFunction(this, 'my-binary')`), the construct will look at `stack.my-binary/Cargo.toml`

        Parameters:
        entry - Path to the entry Cargo.toml file. This parameter is required.
        Returns:
        this

      • projectRoot

        @Stability(Experimental)
public RustFunction.Builder projectRoot​(String projectRoot)
        (experimental) The path to the directory containing project Manifest file.

        Default: - the directory containing the `depsLockFilePath`

        Parameters:
        projectRoot - The path to the directory containing project Manifest file. This parameter is required.
        Returns:
        this

      • runtime

        @Stability(Experimental)
public RustFunction.Builder runtime​(software.amazon.awscdk.services.lambda.Runtime runtime)
        (experimental) The runtime environment.

        Only OS-only runtimes are supported.

        Default: `Runtime.PROVIDED_AL2023`

        Parameters:
        runtime - The runtime environment. This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public RustFunction build()
        Specified by:
        build in interface software.amazon.jsii.Builder<RustFunction>
        Returns:
        a newly built instance of RustFunction.