Package com.pulumi.aws.lambda
Class FunctionArgs
- java.lang.Object
-
- com.pulumi.resources.InputArgs
-
- com.pulumi.resources.ResourceArgs
-
- com.pulumi.aws.lambda.FunctionArgs
-
public final class FunctionArgs extends com.pulumi.resources.ResourceArgs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFunctionArgs.Builder
-
Field Summary
Fields Modifier and Type Field Description static FunctionArgsEmpty
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>architectures()static FunctionArgs.Builderbuilder()static FunctionArgs.Builderbuilder(FunctionArgs defaults)java.util.Optional<com.pulumi.core.Output<FunctionCapacityProviderConfigArgs>>capacityProviderConfig()java.util.Optional<com.pulumi.core.Output<com.pulumi.asset.Archive>>code()java.util.Optional<com.pulumi.core.Output<java.lang.String>>codeSha256()java.util.Optional<com.pulumi.core.Output<java.lang.String>>codeSigningConfigArn()java.util.Optional<com.pulumi.core.Output<FunctionDeadLetterConfigArgs>>deadLetterConfig()java.util.Optional<com.pulumi.core.Output<java.lang.String>>description()java.util.Optional<com.pulumi.core.Output<FunctionDurableConfigArgs>>durableConfig()java.util.Optional<com.pulumi.core.Output<FunctionEnvironmentArgs>>environment()java.util.Optional<com.pulumi.core.Output<FunctionEphemeralStorageArgs>>ephemeralStorage()java.util.Optional<com.pulumi.core.Output<FunctionFileSystemConfigArgs>>fileSystemConfig()java.util.Optional<com.pulumi.core.Output<java.lang.String>>handler()java.util.Optional<com.pulumi.core.Output<FunctionImageConfigArgs>>imageConfig()java.util.Optional<com.pulumi.core.Output<java.lang.String>>imageUri()java.util.Optional<com.pulumi.core.Output<java.lang.String>>kmsKeyArn()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>layers()java.util.Optional<com.pulumi.core.Output<FunctionLoggingConfigArgs>>loggingConfig()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>memorySize()java.util.Optional<com.pulumi.core.Output<java.lang.String>>name()java.util.Optional<com.pulumi.core.Output<java.lang.String>>packageType()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>publish()java.util.Optional<com.pulumi.core.Output<java.lang.String>>publishTo()java.util.Optional<com.pulumi.core.Output<java.lang.String>>region()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>replacementSecurityGroupIds()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>replaceSecurityGroupsOnDestroy()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>reservedConcurrentExecutions()com.pulumi.core.Output<java.lang.String>role()java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,Runtime>>>runtime()java.util.Optional<com.pulumi.core.Output<java.lang.String>>s3Bucket()java.util.Optional<com.pulumi.core.Output<java.lang.String>>s3Key()java.util.Optional<com.pulumi.core.Output<java.lang.String>>s3ObjectVersion()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>skipDestroy()java.util.Optional<com.pulumi.core.Output<FunctionSnapStartArgs>>snapStart()java.util.Optional<com.pulumi.core.Output<java.lang.String>>sourceCodeHash()java.util.Optional<com.pulumi.core.Output<java.lang.String>>sourceKmsKeyArn()java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>tags()java.util.Optional<com.pulumi.core.Output<FunctionTenancyConfigArgs>>tenancyConfig()java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>timeout()java.util.Optional<com.pulumi.core.Output<FunctionTracingConfigArgs>>tracingConfig()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>useResourceTimeoutForPropagation()java.util.Optional<com.pulumi.core.Output<FunctionVpcConfigArgs>>vpcConfig()
-
-
-
Field Detail
-
Empty
public static final FunctionArgs Empty
-
-
Method Detail
-
architectures
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> architectures()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<FunctionCapacityProviderConfigArgs>> capacityProviderConfig()
- Returns:
- Configuration block for Lambda Capacity Provider. See below.
-
code
public java.util.Optional<com.pulumi.core.Output<com.pulumi.asset.Archive>> code()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> codeSha256()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> codeSigningConfigArn()
- Returns:
- ARN of a code-signing configuration to enable code signing for this function.
-
deadLetterConfig
public java.util.Optional<com.pulumi.core.Output<FunctionDeadLetterConfigArgs>> deadLetterConfig()
- Returns:
- Configuration block for dead letter queue. See below.
-
description
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
- Returns:
- Description of what your Lambda Function does.
-
durableConfig
public java.util.Optional<com.pulumi.core.Output<FunctionDurableConfigArgs>> durableConfig()
- Returns:
- Configuration block for durable function settings. See below. `durableConfig` may only be available in [limited regions](https://builder.aws.com/build/capabilities), including `us-east-2`.
-
environment
public java.util.Optional<com.pulumi.core.Output<FunctionEnvironmentArgs>> environment()
- Returns:
- Configuration block for environment variables. See below.
-
ephemeralStorage
public java.util.Optional<com.pulumi.core.Output<FunctionEphemeralStorageArgs>> ephemeralStorage()
- Returns:
- Amount of ephemeral storage (`/tmp`) to allocate for the Lambda Function. See below.
-
fileSystemConfig
public java.util.Optional<com.pulumi.core.Output<FunctionFileSystemConfigArgs>> fileSystemConfig()
- Returns:
- Configuration block for EFS or S3 Files file system. See below.
-
handler
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> handler()
- Returns:
- Function entry point in your code. Required if `packageType` is `Zip`.
-
imageConfig
public java.util.Optional<com.pulumi.core.Output<FunctionImageConfigArgs>> imageConfig()
- Returns:
- Container image configuration values. See below.
-
imageUri
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> imageUri()
- Returns:
- ECR image URI containing the function's deployment package. Conflicts with `filename` and `s3Bucket`. One of `filename`, `imageUri`, or `s3Bucket` must be specified.
-
kmsKeyArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> layers()
- Returns:
- List of Lambda Layer Version ARNs (maximum of 5) to attach to your Lambda Function.
-
loggingConfig
public java.util.Optional<com.pulumi.core.Output<FunctionLoggingConfigArgs>> loggingConfig()
- Returns:
- Configuration block for advanced logging settings. See below.
-
memorySize
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> memorySize()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
- Returns:
- Unique name for your Lambda Function.
-
packageType
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> packageType()
- Returns:
- Lambda deployment package type. Valid values are `Zip` and `Image`. Defaults to `Zip`.
-
publish
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publish()
- Returns:
- Whether to publish creation/change as new Lambda Function Version. Defaults to `false`.
-
publishTo
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> publishTo()
- Returns:
- Whether to publish to a alias or version number. Omit for regular version publishing. Option is `LATEST_PUBLISHED`.
-
region
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
replaceSecurityGroupsOnDestroy
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> replaceSecurityGroupsOnDestroy()
- Returns:
- Whether to replace the security groups on the function's VPC configuration prior to destruction. Default is `false`.
-
replacementSecurityGroupIds
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> replacementSecurityGroupIds()
- Returns:
- List of security group IDs to assign to the function's VPC configuration prior to destruction. Required if `replaceSecurityGroupsOnDestroy` is `true`.
-
reservedConcurrentExecutions
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> reservedConcurrentExecutions()
- Returns:
- 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
public com.pulumi.core.Output<java.lang.String> role()
- Returns:
- ARN of the function's execution role. The role provides the function's identity and access to AWS services and resources. The following arguments are optional:
-
runtime
public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,Runtime>>> runtime()
- Returns:
- Identifier of the function's runtime. Required if `packageType` is `Zip`. See [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime) for valid values.
-
s3Bucket
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3Bucket()
- Returns:
- S3 bucket location containing the function's deployment package. Conflicts with `filename` and `imageUri`. One of `filename`, `imageUri`, or `s3Bucket` must be specified.
-
s3Key
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3Key()
- Returns:
- S3 key of an object containing the function's deployment package. Required if `s3Bucket` is set.
-
s3ObjectVersion
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> s3ObjectVersion()
- Returns:
- Object version containing the function's deployment package. Conflicts with `filename` and `imageUri`.
-
skipDestroy
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipDestroy()
- Returns:
- Whether to retain the old version of a previously deployed Lambda Layer. Default is `false`.
-
snapStart
public java.util.Optional<com.pulumi.core.Output<FunctionSnapStartArgs>> snapStart()
- Returns:
- Configuration block for snap start settings. See below.
-
sourceCodeHash
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceCodeHash()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceKmsKeyArn()
- Returns:
- ARN of the KMS key used to encrypt the function's `.zip` deployment package. Conflicts with `imageUri`.
-
tags
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<FunctionTenancyConfigArgs>> tenancyConfig()
- Returns:
- Configuration block for Tenancy. See below.
-
timeout
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> timeout()
- Returns:
- Amount of time your Lambda Function has to run in seconds. Defaults to 3. Valid between 1 and 900.
-
tracingConfig
public java.util.Optional<com.pulumi.core.Output<FunctionTracingConfigArgs>> tracingConfig()
- Returns:
- Configuration block for X-Ray tracing. See below.
-
useResourceTimeoutForPropagation
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> useResourceTimeoutForPropagation()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<FunctionVpcConfigArgs>> vpcConfig()
- Returns:
- Configuration block for VPC. See below.
-
builder
public static FunctionArgs.Builder builder()
-
builder
public static FunctionArgs.Builder builder(FunctionArgs defaults)
-
-