Struct aws_sdk_lambda::client::fluent_builders::CreateFunction

pub struct CreateFunction { /* private fields */ }

Fluent builder constructing a request to CreateFunction.

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.

You set the package type to Image if the deployment package is a container image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

You set the package type to Zip if the deployment package is a .zip file archive. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, the default value is x86-64.

When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States.

A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.

The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set set of signing profiles, which define the trusted publishers for this function.

If another account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.

To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.

Implementations

impl CreateFunction

pub async fn send(
    self
) -> Result<CreateFunctionOutput, SdkError<CreateFunctionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn function_name(self, input: impl Into<String>) -> Self

The name of the Lambda function.

Name formats

• Function name - my-function.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

• Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

pub fn set_function_name(self, input: Option<String>) -> Self

The name of the Lambda function.

Name formats

• Function name - my-function.

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

• Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

pub fn runtime(self, input: Runtime) -> Self

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

pub fn set_runtime(self, input: Option<Runtime>) -> Self

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

pub fn role(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the function's execution role.

pub fn set_role(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the function's execution role.

pub fn handler(self, input: impl Into<String>) -> Self

The name of the method within your code that Lambda calls to execute 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 Programming Model.

pub fn set_handler(self, input: Option<String>) -> Self

The name of the method within your code that Lambda calls to execute 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 Programming Model.

pub fn code(self, input: FunctionCode) -> Self

The code for the function.

pub fn set_code(self, input: Option<FunctionCode>) -> Self

The code for the function.

pub fn description(self, input: impl Into<String>) -> Self

A description of the function.

pub fn set_description(self, input: Option<String>) -> Self

A description of the function.

pub fn timeout(self, input: i32) -> Self

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 additional information, see Lambda execution environment.

pub fn set_timeout(self, input: Option<i32>) -> Self

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 additional information, see Lambda execution environment.

pub fn memory_size(self, input: i32) -> Self

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.

pub fn set_memory_size(self, input: Option<i32>) -> Self

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.

pub fn publish(self, input: bool) -> Self

Set to true to publish the first version of the function during creation.

pub fn set_publish(self, input: Option<bool>) -> Self

Set to true to publish the first version of the function during creation.

pub fn vpc_config(self, input: VpcConfig) -> Self

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.

pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.

pub fn package_type(self, input: PackageType) -> Self

The type of deployment package. Set to Image for container image and set Zip for ZIP archive.

pub fn set_package_type(self, input: Option<PackageType>) -> Self

The type of deployment package. Set to Image for container image and set Zip for ZIP archive.

pub fn dead_letter_config(self, input: DeadLetterConfig) -> Self

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

pub fn set_dead_letter_config(self, input: Option<DeadLetterConfig>) -> Self

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

pub fn environment(self, input: Environment) -> Self

Environment variables that are accessible from function code during execution.

pub fn set_environment(self, input: Option<Environment>) -> Self

Environment variables that are accessible from function code during execution.

pub fn kms_key_arn(self, input: impl Into<String>) -> Self

The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.

pub fn set_kms_key_arn(self, input: Option<String>) -> Self

The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.

pub fn tracing_config(self, input: TracingConfig) -> Self

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

pub fn set_tracing_config(self, input: Option<TracingConfig>) -> Self

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_tags.

A list of tags to apply to the function.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

A list of tags to apply to the function.

pub fn layers(self, input: impl Into<String>) -> Self

Appends an item to Layers.

To override the contents of this collection use set_layers.

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

pub fn set_layers(self, input: Option<Vec<String>>) -> Self

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

pub fn file_system_configs(self, input: FileSystemConfig) -> Self

Appends an item to FileSystemConfigs.

To override the contents of this collection use set_file_system_configs.

Connection settings for an Amazon EFS file system.

pub fn set_file_system_configs(
    self,
    input: Option<Vec<FileSystemConfig>>
) -> Self

Connection settings for an Amazon EFS file system.

pub fn image_config(self, input: ImageConfig) -> Self

Container image configuration values that override the values in the container image Dockerfile.

pub fn set_image_config(self, input: Option<ImageConfig>) -> Self

Container image configuration values that override the values in the container image Dockerfile.

pub fn code_signing_config_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_code_signing_config_arn(self, input: Option<String>) -> Self

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.

pub fn architectures(self, input: Architecture) -> Self

Appends an item to Architectures.

To override the contents of this collection use set_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.

pub fn set_architectures(self, input: Option<Vec<Architecture>>) -> Self

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.

pub fn ephemeral_storage(self, input: EphemeralStorage) -> Self

The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.

pub fn set_ephemeral_storage(self, input: Option<EphemeralStorage>) -> Self

The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.

Trait Implementations

impl Clone for CreateFunction

fn clone(&self) -> CreateFunction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateFunction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.