com.pulumi.awsnative.lambda.kotlin.Function.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.lambda.kotlin
import com.pulumi.awsnative.kotlin.outputs.Tag
import com.pulumi.awsnative.lambda.kotlin.enums.FunctionArchitecturesItem
import com.pulumi.awsnative.lambda.kotlin.enums.FunctionPackageType
import com.pulumi.awsnative.lambda.kotlin.enums.FunctionRecursiveLoop
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionCode
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionDeadLetterConfig
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionEnvironment
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionEphemeralStorage
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionFileSystemConfig
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionImageConfig
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionLoggingConfig
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionRuntimeManagementConfig
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionSnapStart
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionSnapStartResponse
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionTracingConfig
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionVpcConfig
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin as tagToKotlin
import com.pulumi.awsnative.lambda.kotlin.enums.FunctionArchitecturesItem.Companion.toKotlin as functionArchitecturesItemToKotlin
import com.pulumi.awsnative.lambda.kotlin.enums.FunctionPackageType.Companion.toKotlin as functionPackageTypeToKotlin
import com.pulumi.awsnative.lambda.kotlin.enums.FunctionRecursiveLoop.Companion.toKotlin as functionRecursiveLoopToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionCode.Companion.toKotlin as functionCodeToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionDeadLetterConfig.Companion.toKotlin as functionDeadLetterConfigToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionEnvironment.Companion.toKotlin as functionEnvironmentToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionEphemeralStorage.Companion.toKotlin as functionEphemeralStorageToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionFileSystemConfig.Companion.toKotlin as functionFileSystemConfigToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionImageConfig.Companion.toKotlin as functionImageConfigToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionLoggingConfig.Companion.toKotlin as functionLoggingConfigToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionRuntimeManagementConfig.Companion.toKotlin as functionRuntimeManagementConfigToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionSnapStart.Companion.toKotlin as functionSnapStartToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionSnapStartResponse.Companion.toKotlin as functionSnapStartResponseToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionTracingConfig.Companion.toKotlin as functionTracingConfigToKotlin
import com.pulumi.awsnative.lambda.kotlin.outputs.FunctionVpcConfig.Companion.toKotlin as functionVpcConfigToKotlin
/**
* Builder for [Function].
*/
@PulumiTagMarker
public class FunctionResourceBuilder internal constructor() {
public var name: String? = null
public var args: FunctionArgs = FunctionArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend FunctionArgsBuilder.() -> Unit) {
val builder = FunctionArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Function {
val builtJavaResource = com.pulumi.awsnative.lambda.Function(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Function(builtJavaResource)
}
}
/**
* The ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). 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 AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
* You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). 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](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-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. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).
* You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) 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 a set of signing profiles, which define the trusted publishers for this function.
* Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a ``AWS::Lambda::Version`` or a ``AWS::Lambda::Alias``.
* For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*
* ## Example Usage
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
* ### Example
* No Java example available.
*/
public class Function internal constructor(
override val javaResource: com.pulumi.awsnative.lambda.Function,
) : KotlinCustomResource(javaResource, FunctionMapper) {
/**
* 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``.
*/
public val architectures: Output>?
get() = javaResource.architectures().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
functionArchitecturesItemToKotlin(args0)
})
})
}).orElse(null)
})
/**
* The Amazon Resource Name (ARN) of the function.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The code for the function.
*/
public val code: Output
get() = javaResource.code().applyValue({ args0 ->
args0.let({ args0 ->
functionCodeToKotlin(args0)
})
})
/**
* 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.
*/
public val codeSigningConfigArn: Output?
get() = javaResource.codeSigningConfigArn().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).
*/
public val deadLetterConfig: Output?
get() = javaResource.deadLetterConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> functionDeadLetterConfigToKotlin(args0) })
}).orElse(null)
})
/**
* A description of the function.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Environment variables that are accessible from function code during execution.
*/
public val environment: Output?
get() = javaResource.environment().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
functionEnvironmentToKotlin(args0)
})
}).orElse(null)
})
/**
* The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
*/
public val ephemeralStorage: Output?
get() = javaResource.ephemeralStorage().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> functionEphemeralStorageToKotlin(args0) })
}).orElse(null)
})
/**
* Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function.
* For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).
*/
public val fileSystemConfigs: Output>?
get() = javaResource.fileSystemConfigs().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
functionFileSystemConfigToKotlin(args0)
})
})
}).orElse(null)
})
/**
* The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.
* If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
*/
public val functionName: Output?
get() = javaResource.functionName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).
*/
public val handler: Output?
get() = javaResource.handler().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).
*/
public val imageConfig: Output?
get() = javaResource.imageConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
functionImageConfigToKotlin(args0)
})
}).orElse(null)
})
/**
* The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) 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.
*/
public val kmsKeyArn: Output?
get() = javaResource.kmsKeyArn().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.
*/
public val layers: Output>?
get() = javaResource.layers().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The function's Amazon CloudWatch Logs configuration settings.
*/
public val loggingConfig: Output?
get() = javaResource.loggingConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> functionLoggingConfigToKotlin(args0) })
}).orElse(null)
})
/**
* The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) 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. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
*/
public val memorySize: Output?
get() = javaResource.memorySize().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.
*/
public val packageType: Output?
get() = javaResource.packageType().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
functionPackageTypeToKotlin(args0)
})
}).orElse(null)
})
/**
* The status of your function's recursive loop detection configuration.
* When this value is set to `Allow` and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.
* When this value is set to `Terminate` and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
*/
public val recursiveLoop: Output?
get() = javaResource.recursiveLoop().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> functionRecursiveLoopToKotlin(args0) })
}).orElse(null)
})
/**
* The number of simultaneous executions to reserve for the function.
*/
public val reservedConcurrentExecutions: Output?
get() = javaResource.reservedConcurrentExecutions().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The Amazon Resource Name (ARN) of the function's execution role.
*/
public val role: Output
get() = javaResource.role().applyValue({ args0 -> args0 })
/**
* The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). 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](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels).
* For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported).
*/
public val runtime: Output?
get() = javaResource.runtime().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).
*/
public val runtimeManagementConfig: Output?
get() = javaResource.runtimeManagementConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> functionRuntimeManagementConfigToKotlin(args0) })
}).orElse(null)
})
/**
* The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
*/
public val snapStart: Output?
get() = javaResource.snapStart().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
functionSnapStartToKotlin(args0)
})
}).orElse(null)
})
public val snapStartResponse: Output
get() = javaResource.snapStartResponse().applyValue({ args0 ->
args0.let({ args0 ->
functionSnapStartResponseToKotlin(args0)
})
})
/**
* A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> tagToKotlin(args0) })
})
}).orElse(null)
})
/**
* 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](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).
*/
public val timeout: Output?
get() = javaResource.timeout().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).
*/
public val tracingConfig: Output?
get() = javaResource.tracingConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> functionTracingConfigToKotlin(args0) })
}).orElse(null)
})
/**
* For network connectivity to AWS 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](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).
*/
public val vpcConfig: Output?
get() = javaResource.vpcConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
functionVpcConfigToKotlin(args0)
})
}).orElse(null)
})
}
public object FunctionMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.lambda.Function::class == javaResource::class
override fun map(javaResource: Resource): Function = Function(
javaResource as
com.pulumi.awsnative.lambda.Function,
)
}
/**
* @see [Function].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Function].
*/
public suspend fun function(name: String, block: suspend FunctionResourceBuilder.() -> Unit): Function {
val builder = FunctionResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Function].
* @param name The _unique_ name of the resulting resource.
*/
public fun function(name: String): Function {
val builder = FunctionResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy