Package io.github.cdklabs.awslambdarust

Class RustFunctionProps.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • runtime

        @Stability(Experimental)
public RustFunctionProps.Builder runtime​(software.amazon.awscdk.services.lambda.Runtime runtime)
        Sets the value of RustFunctionProps.getRuntime()
        Parameters:
        runtime - The runtime environment. Only OS-only runtimes are supported.
        Returns:
        this

      • adotInstrumentation

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

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

        Returns:
        this

      • allowPublicSubnet

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

      • applicationLogLevel

        @Stability(Stable)
public RustFunctionProps.Builder applicationLogLevel​(String applicationLogLevel)
        Sets the value of FunctionOptions.getApplicationLogLevel()
        Parameters:
        applicationLogLevel - Sets the application log level for the function.
        Returns:
        this

      • architecture

        @Stability(Stable)
public RustFunctionProps.Builder architecture​(software.amazon.awscdk.services.lambda.Architecture architecture)
        Sets the value of FunctionOptions.getArchitecture()
        Parameters:
        architecture - The system architectures compatible with this lambda function.
        Returns:
        this

      • codeSigningConfig

        @Stability(Stable)
public RustFunctionProps.Builder codeSigningConfig​(software.amazon.awscdk.services.lambda.ICodeSigningConfig codeSigningConfig)
        Sets the value of FunctionOptions.getCodeSigningConfig()
        Parameters:
        codeSigningConfig - Code signing config associated with this function.
        Returns:
        this

      • currentVersionOptions

        @Stability(Stable)
public RustFunctionProps.Builder currentVersionOptions​(software.amazon.awscdk.services.lambda.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 RustFunctionProps.Builder deadLetterQueue​(software.amazon.awscdk.services.sqs.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 RustFunctionProps.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 RustFunctionProps.Builder deadLetterTopic​(software.amazon.awscdk.services.sns.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 RustFunctionProps.Builder description​(String description)
        Sets the value of FunctionOptions.getDescription()
        Parameters:
        description - A description of the function.
        Returns:
        this

      • environment

        @Stability(Stable)
public RustFunctionProps.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 RustFunctionProps.Builder environmentEncryption​(software.amazon.awscdk.services.kms.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 RustFunctionProps.Builder ephemeralStorageSize​(software.amazon.awscdk.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 RustFunctionProps.Builder events​(List<? extends software.amazon.awscdk.services.lambda.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 RustFunctionProps.Builder filesystem​(software.amazon.awscdk.services.lambda.FileSystem filesystem)
        Sets the value of FunctionOptions.getFilesystem()
        Parameters:
        filesystem - The filesystem configuration for the lambda function.
        Returns:
        this

      • functionName

        @Stability(Stable)
public RustFunctionProps.Builder functionName​(String functionName)
        Sets the value of FunctionOptions.getFunctionName()
        Parameters:
        functionName - A name for the function.
        Returns:
        this

      • initialPolicy

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

      • logFormat

        @Stability(Stable)
public RustFunctionProps.Builder logFormat​(String logFormat)
        Sets the value of FunctionOptions.getLogFormat()
        Parameters:
        logFormat - Sets the logFormat for the function.
        Returns:
        this

      • logGroup

        @Stability(Stable)
public RustFunctionProps.Builder logGroup​(software.amazon.awscdk.services.logs.ILogGroup logGroup)
        Sets the value of FunctionOptions.getLogGroup()
        Parameters:
        logGroup - Sets the log group name for the function.
        Returns:
        this

      • logRetention

        @Stability(Stable)
public RustFunctionProps.Builder logRetention​(software.amazon.awscdk.services.logs.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 RustFunctionProps.Builder logRetentionRetryOptions​(software.amazon.awscdk.services.lambda.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 RustFunctionProps.Builder logRetentionRole​(software.amazon.awscdk.services.iam.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 RustFunctionProps.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 RustFunctionProps.Builder paramsAndSecrets​(software.amazon.awscdk.services.lambda.ParamsAndSecretsLayerVersion paramsAndSecrets)
        Sets the value of FunctionOptions.getParamsAndSecrets()
        Parameters:
        paramsAndSecrets - Specify the configuration of Parameters and Secrets Extension.
        Returns:
        this

      • profiling

        @Stability(Stable)
public RustFunctionProps.Builder profiling​(Boolean profiling)
        Sets the value of FunctionOptions.getProfiling()
        Parameters:
        profiling - Enable profiling.
        Returns:
        this

      • profilingGroup

        @Stability(Stable)
public RustFunctionProps.Builder profilingGroup​(software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup profilingGroup)
        Sets the value of FunctionOptions.getProfilingGroup()
        Parameters:
        profilingGroup - Profiling Group.
        Returns:
        this

      • reservedConcurrentExecutions

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

      • snapStart

        @Stability(Stable)
public RustFunctionProps.Builder snapStart​(software.amazon.awscdk.services.lambda.SnapStartConf snapStart)
        Sets the value of FunctionOptions.getSnapStart()
        Parameters:
        snapStart - Enable SnapStart for Lambda Function. SnapStart is currently supported only for Java 11, 17 runtime
        Returns:
        this

      • systemLogLevel

        @Stability(Stable)
public RustFunctionProps.Builder systemLogLevel​(String systemLogLevel)
        Sets the value of FunctionOptions.getSystemLogLevel()
        Parameters:
        systemLogLevel - Sets the system log level for the function.
        Returns:
        this

      • timeout

        @Stability(Stable)
public RustFunctionProps.Builder timeout​(software.amazon.awscdk.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 RustFunctionProps.Builder tracing​(software.amazon.awscdk.services.lambda.Tracing tracing)
        Sets the value of FunctionOptions.getTracing()
        Parameters:
        tracing - Enable AWS X-Ray Tracing for Lambda Function.
        Returns:
        this

      • vpc

        @Stability(Stable)
public RustFunctionProps.Builder vpc​(software.amazon.awscdk.services.ec2.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 RustFunctionProps.Builder vpcSubnets​(software.amazon.awscdk.services.ec2.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 RustFunctionProps.Builder maxEventAge​(software.amazon.awscdk.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 RustFunctionProps.Builder onFailure​(software.amazon.awscdk.services.lambda.IDestination onFailure)
        Sets the value of EventInvokeConfigOptions.getOnFailure()
        Parameters:
        onFailure - The destination for failed invocations.
        Returns:
        this

      • onSuccess

        @Stability(Stable)
public RustFunctionProps.Builder onSuccess​(software.amazon.awscdk.services.lambda.IDestination onSuccess)
        Sets the value of EventInvokeConfigOptions.getOnSuccess()
        Parameters:
        onSuccess - The destination for successful invocations.
        Returns:
        this

      • retryAttempts

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