pub struct CreateFunctionFluentBuilder { /* private fields */ }
Expand description
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, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
If the deployment package is a container image, then you set the package type to 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.
If the deployment package is a .zip file archive, then you set the package type to Zip
. 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, then 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 Lambda 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 of signing profiles, which define the trusted publishers for this function.
If another Amazon Web Services account or an Amazon Web Service invokes your function, use AddPermission
to grant permission by creating a resource-based Identity and Access Management (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, create an event source mapping (CreateEventSourceMapping
), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.
Implementations§
source§impl CreateFunctionFluentBuilder
impl CreateFunctionFluentBuilder
sourcepub fn as_input(&self) -> &CreateFunctionInputBuilder
pub fn as_input(&self) -> &CreateFunctionInputBuilder
Access the CreateFunction as a reference.
sourcepub async fn send(
self
) -> Result<CreateFunctionOutput, SdkError<CreateFunctionError, HttpResponse>>
pub async fn send( self ) -> Result<CreateFunctionOutput, SdkError<CreateFunctionError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateFunctionOutput, CreateFunctionError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateFunctionOutput, CreateFunctionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn function_name(self, input: impl Into<String>) -> Self
pub fn function_name(self, input: impl Into<String>) -> Self
The name or ARN 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.
sourcepub fn set_function_name(self, input: Option<String>) -> Self
pub fn set_function_name(self, input: Option<String>) -> Self
The name or ARN 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.
sourcepub fn get_function_name(&self) -> &Option<String>
pub fn get_function_name(&self) -> &Option<String>
The name or ARN 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.
sourcepub fn runtime(self, input: Runtime) -> Self
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.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
sourcepub fn set_runtime(self, input: Option<Runtime>) -> Self
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.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
sourcepub fn get_runtime(&self) -> &Option<Runtime>
pub fn get_runtime(&self) -> &Option<Runtime>
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.
The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.
sourcepub fn role(self, input: impl Into<String>) -> Self
pub fn role(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the function's execution role.
sourcepub fn set_role(self, input: Option<String>) -> Self
pub fn set_role(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the function's execution role.
sourcepub fn get_role(&self) -> &Option<String>
pub fn get_role(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the function's execution role.
sourcepub fn handler(self, input: impl Into<String>) -> Self
pub fn handler(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_handler(self, input: Option<String>) -> Self
pub fn set_handler(self, input: Option<String>) -> Self
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.
sourcepub fn get_handler(&self) -> &Option<String>
pub fn get_handler(&self) -> &Option<String>
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.
sourcepub fn code(self, input: FunctionCode) -> Self
pub fn code(self, input: FunctionCode) -> Self
The code for the function.
sourcepub fn set_code(self, input: Option<FunctionCode>) -> Self
pub fn set_code(self, input: Option<FunctionCode>) -> Self
The code for the function.
sourcepub fn get_code(&self) -> &Option<FunctionCode>
pub fn get_code(&self) -> &Option<FunctionCode>
The code for the function.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the function.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the function.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the function.
sourcepub fn timeout(self, input: i32) -> Self
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 more information, see Lambda execution environment.
sourcepub fn set_timeout(self, input: Option<i32>) -> Self
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 more information, see Lambda execution environment.
sourcepub fn get_timeout(&self) -> &Option<i32>
pub fn get_timeout(&self) -> &Option<i32>
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.
sourcepub fn memory_size(self, input: i32) -> Self
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.
sourcepub fn set_memory_size(self, input: Option<i32>) -> Self
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.
sourcepub fn get_memory_size(&self) -> &Option<i32>
pub fn get_memory_size(&self) -> &Option<i32>
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.
sourcepub fn publish(self, input: bool) -> Self
pub fn publish(self, input: bool) -> Self
Set to true to publish the first version of the function during creation.
sourcepub fn set_publish(self, input: Option<bool>) -> Self
pub fn set_publish(self, input: Option<bool>) -> Self
Set to true to publish the first version of the function during creation.
sourcepub fn get_publish(&self) -> &Option<bool>
pub fn get_publish(&self) -> &Option<bool>
Set to true to publish the first version of the function during creation.
sourcepub fn vpc_config(self, input: VpcConfig) -> Self
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 access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.
sourcepub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self
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 access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.
sourcepub fn get_vpc_config(&self) -> &Option<VpcConfig>
pub fn get_vpc_config(&self) -> &Option<VpcConfig>
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 access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.
sourcepub fn package_type(self, input: PackageType) -> Self
pub fn package_type(self, input: PackageType) -> Self
The type of deployment package. Set to Image
for container image and set to Zip
for .zip file archive.
sourcepub fn set_package_type(self, input: Option<PackageType>) -> Self
pub fn set_package_type(self, input: Option<PackageType>) -> Self
The type of deployment package. Set to Image
for container image and set to Zip
for .zip file archive.
sourcepub fn get_package_type(&self) -> &Option<PackageType>
pub fn get_package_type(&self) -> &Option<PackageType>
The type of deployment package. Set to Image
for container image and set to Zip
for .zip file archive.
sourcepub fn dead_letter_config(self, input: DeadLetterConfig) -> Self
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.
sourcepub fn set_dead_letter_config(self, input: Option<DeadLetterConfig>) -> Self
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.
sourcepub fn get_dead_letter_config(&self) -> &Option<DeadLetterConfig>
pub fn get_dead_letter_config(&self) -> &Option<DeadLetterConfig>
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.
sourcepub fn environment(self, input: Environment) -> Self
pub fn environment(self, input: Environment) -> Self
Environment variables that are accessible from function code during execution.
sourcepub fn set_environment(self, input: Option<Environment>) -> Self
pub fn set_environment(self, input: Option<Environment>) -> Self
Environment variables that are accessible from function code during execution.
sourcepub fn get_environment(&self) -> &Option<Environment>
pub fn get_environment(&self) -> &Option<Environment>
Environment variables that are accessible from function code during execution.
sourcepub fn kms_key_arn(self, input: impl Into<String>) -> Self
pub fn kms_key_arn(self, input: impl Into<String>) -> Self
The ARN of the Key Management Service (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.
sourcepub fn set_kms_key_arn(self, input: Option<String>) -> Self
pub fn set_kms_key_arn(self, input: Option<String>) -> Self
The ARN of the Key Management Service (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.
sourcepub fn get_kms_key_arn(&self) -> &Option<String>
pub fn get_kms_key_arn(&self) -> &Option<String>
The ARN of the Key Management Service (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.
sourcepub fn tracing_config(self, input: TracingConfig) -> Self
pub fn tracing_config(self, input: TracingConfig) -> Self
Set Mode
to Active
to sample and trace a subset of incoming requests with X-Ray.
sourcepub fn set_tracing_config(self, input: Option<TracingConfig>) -> Self
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.
sourcepub fn get_tracing_config(&self) -> &Option<TracingConfig>
pub fn get_tracing_config(&self) -> &Option<TracingConfig>
Set Mode
to Active
to sample and trace a subset of incoming requests with X-Ray.
A list of tags to apply to the function.
A list of tags to apply to the function.
sourcepub fn layers(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_layers(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn get_layers(&self) -> &Option<Vec<String>>
pub fn get_layers(&self) -> &Option<Vec<String>>
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
sourcepub fn file_system_configs(self, input: FileSystemConfig) -> Self
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.
sourcepub fn set_file_system_configs(
self,
input: Option<Vec<FileSystemConfig>>
) -> Self
pub fn set_file_system_configs( self, input: Option<Vec<FileSystemConfig>> ) -> Self
Connection settings for an Amazon EFS file system.
sourcepub fn get_file_system_configs(&self) -> &Option<Vec<FileSystemConfig>>
pub fn get_file_system_configs(&self) -> &Option<Vec<FileSystemConfig>>
Connection settings for an Amazon EFS file system.
sourcepub fn image_config(self, input: ImageConfig) -> Self
pub fn image_config(self, input: ImageConfig) -> Self
Container image configuration values that override the values in the container image Dockerfile.
sourcepub fn set_image_config(self, input: Option<ImageConfig>) -> Self
pub fn set_image_config(self, input: Option<ImageConfig>) -> Self
Container image configuration values that override the values in the container image Dockerfile.
sourcepub fn get_image_config(&self) -> &Option<ImageConfig>
pub fn get_image_config(&self) -> &Option<ImageConfig>
Container image configuration values that override the values in the container image Dockerfile.
sourcepub fn code_signing_config_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_code_signing_config_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_code_signing_config_arn(&self) -> &Option<String>
pub fn get_code_signing_config_arn(&self) -> &Option<String>
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.
sourcepub fn architectures(self, input: Architecture) -> Self
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
.
sourcepub fn set_architectures(self, input: Option<Vec<Architecture>>) -> Self
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
.
sourcepub fn get_architectures(&self) -> &Option<Vec<Architecture>>
pub fn get_architectures(&self) -> &Option<Vec<Architecture>>
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
.
sourcepub fn ephemeral_storage(self, input: EphemeralStorage) -> Self
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 10,240 MB. For more information, see Configuring ephemeral storage (console).
sourcepub fn set_ephemeral_storage(self, input: Option<EphemeralStorage>) -> Self
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 10,240 MB. For more information, see Configuring ephemeral storage (console).
sourcepub fn get_ephemeral_storage(&self) -> &Option<EphemeralStorage>
pub fn get_ephemeral_storage(&self) -> &Option<EphemeralStorage>
The size of the function's /tmp
directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
sourcepub fn snap_start(self, input: SnapStart) -> Self
pub fn snap_start(self, input: SnapStart) -> Self
The function's SnapStart setting.
sourcepub fn set_snap_start(self, input: Option<SnapStart>) -> Self
pub fn set_snap_start(self, input: Option<SnapStart>) -> Self
The function's SnapStart setting.
sourcepub fn get_snap_start(&self) -> &Option<SnapStart>
pub fn get_snap_start(&self) -> &Option<SnapStart>
The function's SnapStart setting.
sourcepub fn logging_config(self, input: LoggingConfig) -> Self
pub fn logging_config(self, input: LoggingConfig) -> Self
The function's Amazon CloudWatch Logs configuration settings.
sourcepub fn set_logging_config(self, input: Option<LoggingConfig>) -> Self
pub fn set_logging_config(self, input: Option<LoggingConfig>) -> Self
The function's Amazon CloudWatch Logs configuration settings.
sourcepub fn get_logging_config(&self) -> &Option<LoggingConfig>
pub fn get_logging_config(&self) -> &Option<LoggingConfig>
The function's Amazon CloudWatch Logs configuration settings.
Trait Implementations§
source§impl Clone for CreateFunctionFluentBuilder
impl Clone for CreateFunctionFluentBuilder
source§fn clone(&self) -> CreateFunctionFluentBuilder
fn clone(&self) -> CreateFunctionFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more