FunctionArgs class

The set of arguments for Function. The set of arguments for Function.

Constructors

FunctionArgs({Input<List<String>?>? architectures, Input<FunctionCapacityProviderConfig?>? capacityProviderConfig, Input? code, Input<String?>? codeSha256, Input<String?>? codeSigningConfigArn, Input<FunctionDeadLetterConfig?>? deadLetterConfig, Input<String?>? description, Input<FunctionDurableConfig?>? durableConfig, Input<FunctionEnvironment?>? environment, Input<FunctionEphemeralStorage?>? ephemeralStorage, Input<FunctionFileSystemConfig?>? fileSystemConfig, Input<String?>? handler, Input<FunctionImageConfig?>? imageConfig, Input<String?>? imageUri, Input<String?>? kmsKeyArn, Input<List<String>?>? layers, Input<FunctionLoggingConfig?>? loggingConfig, Input<int?>? memorySize, Input<String?>? name, Input<String?>? packageType, Input<bool?>? publish, Input<String?>? publishTo, Input<String?>? region, Input<bool?>? replaceSecurityGroupsOnDestroy, Input<List<String>?>? replacementSecurityGroupIds, Input<int?>? reservedConcurrentExecutions, required Input<String> role, Input? runtime, Input<String?>? s3Bucket, Input<String?>? s3Key, Input<String?>? s3ObjectVersion, Input<bool?>? skipDestroy, Input<FunctionSnapStart?>? snapStart, Input<String?>? sourceCodeHash, Input<String?>? sourceKmsKeyArn, Input<Map<String, String>?>? tags, Input<FunctionTenancyConfig?>? tenancyConfig, Input<int?>? timeout, Input<FunctionTracingConfig?>? tracingConfig, Input<bool?>? useResourceTimeoutForPropagation, Input<FunctionVpcConfig?>? vpcConfig})
Creates a new FunctionArgs. architectures Instruction set architecture for your Lambda function. Valid values are ["x8664"] and ["arm64"]. Default is ["x8664"]. Removing this attribute, function's architecture stays the same. capacityProviderConfig Configuration block for Lambda Capacity Provider. See below. code Path to the function's deployment package within the local filesystem. Conflicts with imageUri and s3Bucket. One of filename, imageUri, or s3Bucket must be specified. codeSha256 Base64-encoded representation the source code package file. Use this argument to trigger updates when the function source code changes. For OCI, this value is relayed directly from the image digest. For zip files, this value is the Base64 encoded SHA-256 hash of the .zip file. Layers are not included in the calculation. To trigger updates using a non-standard hashing algorithm, use the sourceCodeHash argument instead. codeSigningConfigArn ARN of a code-signing configuration to enable code signing for this function. deadLetterConfig Configuration block for dead letter queue. See below. description Description of what your Lambda Function does. durableConfig Configuration block for durable function settings. See below. durableConfig may only be available in limited regions, including us-east-2. environment Configuration block for environment variables. See below. ephemeralStorage Amount of ephemeral storage (/tmp) to allocate for the Lambda Function. See below. fileSystemConfig Configuration block for EFS or S3 Files file system. See below. handler Function entry point in your code. Required if packageType is Zip. imageConfig Container image configuration values. See below. imageUri ECR image URI containing the function's deployment package. Conflicts with filename and s3Bucket. One of filename, imageUri, or s3Bucket must be specified. kmsKeyArn ARN of the KMS key used to encrypt environment variables. If not provided when environment variables are in use, AWS Lambda uses a default service key. If provided when environment variables are not in use, the AWS Lambda API does not save this configuration. layers List of Lambda Layer Version ARNs (maximum of 5) to attach to your Lambda Function. loggingConfig Configuration block for advanced logging settings. See below. memorySize Amount of memory in MB your Lambda Function can use at runtime. Valid value between 128 MB to 32,768 MB (32 GB), in 1 MB increments. Defaults to 128. name Unique name for your Lambda Function. packageType Lambda deployment package type. Valid values are Zip and Image. Defaults to Zip. publish Whether to publish creation/change as new Lambda Function Version. Defaults to false. publishTo Whether to publish to a alias or version number. Omit for regular version publishing. Option is LATEST_PUBLISHED. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replaceSecurityGroupsOnDestroy Whether to replace the security groups on the function's VPC configuration prior to destruction. Default is false. replacementSecurityGroupIds List of security group IDs to assign to the function's VPC configuration prior to destruction. Required if replaceSecurityGroupsOnDestroy is true. reservedConcurrentExecutions Amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations. Defaults to Unreserved Concurrency Limits -1. role ARN of the function's execution role. The role provides the function's identity and access to AWS services and resources. runtime Identifier of the function's runtime. Required if packageType is Zip. See Runtimes for valid values. s3Bucket S3 bucket location containing the function's deployment package. Conflicts with filename and imageUri. One of filename, imageUri, or s3Bucket must be specified. s3Key S3 key of an object containing the function's deployment package. Required if s3Bucket is set. s3ObjectVersion Object version containing the function's deployment package. Conflicts with filename and imageUri. skipDestroy Whether to retain the old version of a previously deployed Lambda Layer. Default is false. snapStart Configuration block for snap start settings. See below. sourceCodeHash User-defined hash of the source code package file. Use this argument to trigger updates when the local function source code changes. This is a synthetic argument tracked only by the AWS provider and does not need to match the hashing algorithm used by Lambda to compute the CodeSha256 response value. Out-of-band changes to the source code will not be captured by this argument. To include out-of-band source code changes as an update trigger, use the codeSha256 argument instead. sourceKmsKeyArn ARN of the KMS key used to encrypt the function's .zip deployment package. Conflicts with imageUri. tags Key-value map of tags for the Lambda function. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tenancyConfig Configuration block for Tenancy. See below. timeout Amount of time your Lambda Function has to run in seconds. Defaults to 3. Valid between 1 and 900. tracingConfig Configuration block for X-Ray tracing. See below. useResourceTimeoutForPropagation Whether to apply resource level timeout values while retrying eventually consistent API operations. By default the provider uses a 5 minute timeout to allow for propagation in the Lambda service. When set to true, this default value is replaced with the configurable resource timeouts. Increased timeout values may be useful in highly active accounts, or regions where propagation delays are inconsistent. vpcConfig Configuration block for VPC. See below.
const
FunctionArgs.fromMap(Map<String, dynamic> map)
factory

Properties

architectures → Input<List<String>?>?
Instruction set architecture for your Lambda function. Valid values are ["x8664"] and ["arm64"]. Default is ["x8664"]. Removing this attribute, function's architecture stays the same.
final
capacityProviderConfig → Input<FunctionCapacityProviderConfig?>?
Configuration block for Lambda Capacity Provider. See below.
final
code → Input?
Path to the function's deployment package within the local filesystem. Conflicts with imageUri and s3Bucket. One of filename, imageUri, or s3Bucket must be specified.
final
codeSha256 → Input<String?>?
Base64-encoded representation the source code package file. Use this argument to trigger updates when the function source code changes. For OCI, this value is relayed directly from the image digest. For zip files, this value is the Base64 encoded SHA-256 hash of the .zip file. Layers are not included in the calculation. To trigger updates using a non-standard hashing algorithm, use the sourceCodeHash argument instead.
final
codeSigningConfigArn → Input<String?>?
ARN of a code-signing configuration to enable code signing for this function.
final
deadLetterConfig → Input<FunctionDeadLetterConfig?>?
Configuration block for dead letter queue. See below.
final
description → Input<String?>?
Description of what your Lambda Function does.
final
durableConfig → Input<FunctionDurableConfig?>?
Configuration block for durable function settings. See below. durableConfig may only be available in limited regions, including us-east-2.
final
environment → Input<FunctionEnvironment?>?
Configuration block for environment variables. See below.
final
ephemeralStorage → Input<FunctionEphemeralStorage?>?
Amount of ephemeral storage (/tmp) to allocate for the Lambda Function. See below.
final
fileSystemConfig → Input<FunctionFileSystemConfig?>?
Configuration block for EFS or S3 Files file system. See below.
final
handler → Input<String?>?
Function entry point in your code. Required if packageType is Zip.
final
hashCode → int
The hash code for this object.
no setterinherited
imageConfig → Input<FunctionImageConfig?>?
Container image configuration values. See below.
final
imageUri → Input<String?>?
ECR image URI containing the function's deployment package. Conflicts with filename and s3Bucket. One of filename, imageUri, or s3Bucket must be specified.
final
kmsKeyArn → Input<String?>?
ARN of the KMS key used to encrypt environment variables. If not provided when environment variables are in use, AWS Lambda uses a default service key. If provided when environment variables are not in use, the AWS Lambda API does not save this configuration.
final
layers → Input<List<String>?>?
List of Lambda Layer Version ARNs (maximum of 5) to attach to your Lambda Function.
final
loggingConfig → Input<FunctionLoggingConfig?>?
Configuration block for advanced logging settings. See below.
final
memorySize → Input<int?>?
Amount of memory in MB your Lambda Function can use at runtime. Valid value between 128 MB to 32,768 MB (32 GB), in 1 MB increments. Defaults to 128.
final
name → Input<String?>?
Unique name for your Lambda Function.
final
packageType → Input<String?>?
Lambda deployment package type. Valid values are Zip and Image. Defaults to Zip.
final
publish → Input<bool?>?
Whether to publish creation/change as new Lambda Function Version. Defaults to false.
final
publishTo → Input<String?>?
Whether to publish to a alias or version number. Omit for regular version publishing. Option is LATEST_PUBLISHED.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
replacementSecurityGroupIds → Input<List<String>?>?
List of security group IDs to assign to the function's VPC configuration prior to destruction. Required if replaceSecurityGroupsOnDestroy is true.
final
replaceSecurityGroupsOnDestroy → Input<bool?>?
Whether to replace the security groups on the function's VPC configuration prior to destruction. Default is false.
final
reservedConcurrentExecutions → Input<int?>?
Amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations. Defaults to Unreserved Concurrency Limits -1.
final
role → Input<String>
ARN of the function's execution role. The role provides the function's identity and access to AWS services and resources.
final
runtime → Input?
Identifier of the function's runtime. Required if packageType is Zip. See Runtimes for valid values.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
s3Bucket → Input<String?>?
S3 bucket location containing the function's deployment package. Conflicts with filename and imageUri. One of filename, imageUri, or s3Bucket must be specified.
final
s3Key → Input<String?>?
S3 key of an object containing the function's deployment package. Required if s3Bucket is set.
final
s3ObjectVersion → Input<String?>?
Object version containing the function's deployment package. Conflicts with filename and imageUri.
final
skipDestroy → Input<bool?>?
Whether to retain the old version of a previously deployed Lambda Layer. Default is false.
final
snapStart → Input<FunctionSnapStart?>?
Configuration block for snap start settings. See below.
final
sourceCodeHash → Input<String?>?
User-defined hash of the source code package file. Use this argument to trigger updates when the local function source code changes. This is a synthetic argument tracked only by the AWS provider and does not need to match the hashing algorithm used by Lambda to compute the CodeSha256 response value. Out-of-band changes to the source code will not be captured by this argument. To include out-of-band source code changes as an update trigger, use the codeSha256 argument instead.
final
sourceKmsKeyArn → Input<String?>?
ARN of the KMS key used to encrypt the function's .zip deployment package. Conflicts with imageUri.
final
tags → Input<Map<String, String>?>?
Key-value map of tags for the Lambda function. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tenancyConfig → Input<FunctionTenancyConfig?>?
Configuration block for Tenancy. See below.
final
timeout → Input<int?>?
Amount of time your Lambda Function has to run in seconds. Defaults to 3. Valid between 1 and 900.
final
tracingConfig → Input<FunctionTracingConfig?>?
Configuration block for X-Ray tracing. See below.
final
useResourceTimeoutForPropagation → Input<bool?>?
Whether to apply resource level timeout values while retrying eventually consistent API operations. By default the provider uses a 5 minute timeout to allow for propagation in the Lambda service. When set to true, this default value is replaced with the configurable resource timeouts. Increased timeout values may be useful in highly active accounts, or regions where propagation delays are inconsistent.
final
vpcConfig → Input<FunctionVpcConfig?>?
Configuration block for VPC. See below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited