Struct CreateFunctionInput

#[non_exhaustive]
pub struct CreateFunctionInput {

    pub function_name: Option<String>,
    pub runtime: Option<Runtime>,
    pub role: Option<String>,
    pub handler: Option<String>,
    pub code: Option<FunctionCode>,
    pub description: Option<String>,
    pub timeout: Option<i32>,
    pub memory_size: Option<i32>,
    pub publish: Option<bool>,
    pub vpc_config: Option<VpcConfig>,
    pub package_type: Option<PackageType>,
    pub dead_letter_config: Option<DeadLetterConfig>,
    pub environment: Option<Environment>,
    pub kms_key_arn: Option<String>,
    pub tracing_config: Option<TracingConfig>,
    pub tags: Option<HashMap<String, String>>,
    pub layers: Option<Vec<String>>,
    pub file_system_configs: Option<Vec<FileSystemConfig>>,
    pub image_config: Option<ImageConfig>,
    pub code_signing_config_arn: Option<String>,
    pub architectures: Option<Vec<Architecture>>,
    pub ephemeral_storage: Option<EphemeralStorage>,
    pub snap_start: Option<SnapStart>,
    pub logging_config: Option<LoggingConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

function_name: 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.

runtime: Option<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.

role: Option<String>

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

handler: 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.

code: Option<FunctionCode>

The code for the function.

description: Option<String>

A description of the function.

timeout: 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.

memory_size: 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.

publish: Option<bool>

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

vpc_config: 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.

package_type: Option<PackageType>

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

dead_letter_config: 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.

environment: Option<Environment>

Environment variables that are accessible from function code during execution.

kms_key_arn: Option<String>

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

• The function's environment variables.

• The function's Lambda SnapStart snapshots.

• When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

• The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

tracing_config: Option<TracingConfig>

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

tags: Option<HashMap<String, String>>

A list of tags to apply to the function.

layers: 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.

file_system_configs: Option<Vec<FileSystemConfig>>

Connection settings for an Amazon EFS file system.

image_config: Option<ImageConfig>

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

code_signing_config_arn: 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.

architectures: 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.

ephemeral_storage: 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).

snap_start: Option<SnapStart>

The function's SnapStart setting.

logging_config: Option<LoggingConfig>

The function's Amazon CloudWatch Logs configuration settings.

Implementations

impl CreateFunctionInput

pub fn function_name(&self) -> Option<&str>

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.

pub fn runtime(&self) -> Option<&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.

pub fn role(&self) -> Option<&str>

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

pub fn handler(&self) -> Option<&str>

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.

pub fn code(&self) -> Option<&FunctionCode>

The code for the function.

pub fn description(&self) -> Option<&str>

A description of the function.

pub fn 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.

pub fn 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.

pub fn publish(&self) -> Option<bool>

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

pub fn 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.

pub fn package_type(&self) -> Option<&PackageType>

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

pub fn 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.

pub fn environment(&self) -> Option<&Environment>

Environment variables that are accessible from function code during execution.

pub fn kms_key_arn(&self) -> Option<&str>

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

• The function's environment variables.

• The function's Lambda SnapStart snapshots.

• When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

• The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

pub fn tracing_config(&self) -> Option<&TracingConfig>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

A list of tags to apply to the function.

pub fn layers(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .layers.is_none().

pub fn file_system_configs(&self) -> &[FileSystemConfig]

Connection settings for an Amazon EFS file system.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .file_system_configs.is_none().

pub fn image_config(&self) -> Option<&ImageConfig>

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

pub fn code_signing_config_arn(&self) -> Option<&str>

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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .architectures.is_none().

pub fn 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).

pub fn snap_start(&self) -> Option<&SnapStart>

The function's SnapStart setting.

pub fn logging_config(&self) -> Option<&LoggingConfig>

The function's Amazon CloudWatch Logs configuration settings.

impl CreateFunctionInput

pub fn builder() -> CreateFunctionInputBuilder

Creates a new builder-style object to manufacture CreateFunctionInput.

Trait Implementations

impl Clone for CreateFunctionInput

fn clone(&self) -> CreateFunctionInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateFunctionInput

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

Formats the value using the given formatter.

impl PartialEq for CreateFunctionInput

fn eq(&self, other: &CreateFunctionInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateFunctionInput