GetFunctionResult

data class GetFunctionResult(val architectures: List<FunctionArchitecturesItem>? = null, val arn: String? = null, val codeSigningConfigArn: String? = null, val deadLetterConfig: FunctionDeadLetterConfig? = null, val description: String? = null, val environment: FunctionEnvironment? = null, val ephemeralStorage: FunctionEphemeralStorage? = null, val fileSystemConfigs: List<FunctionFileSystemConfig>? = null, val handler: String? = null, val imageConfig: FunctionImageConfig? = null, val kmsKeyArn: String? = null, val layers: List<String>? = null, val loggingConfig: FunctionLoggingConfig? = null, val memorySize: Int? = null, val packageType: FunctionPackageType? = null, val recursiveLoop: FunctionRecursiveLoop? = null, val reservedConcurrentExecutions: Int? = null, val role: String? = null, val runtime: String? = null, val runtimeManagementConfig: FunctionRuntimeManagementConfig? = null, val snapStartResponse: FunctionSnapStartResponse? = null, val tags: List<Tag>? = null, val timeout: Int? = null, val tracingConfig: FunctionTracingConfig? = null, val vpcConfig: FunctionVpcConfig? = null)

Constructors

Link copied to clipboard
constructor(architectures: List<FunctionArchitecturesItem>? = null, arn: String? = null, codeSigningConfigArn: String? = null, deadLetterConfig: FunctionDeadLetterConfig? = null, description: String? = null, environment: FunctionEnvironment? = null, ephemeralStorage: FunctionEphemeralStorage? = null, fileSystemConfigs: List<FunctionFileSystemConfig>? = null, handler: String? = null, imageConfig: FunctionImageConfig? = null, kmsKeyArn: String? = null, layers: List<String>? = null, loggingConfig: FunctionLoggingConfig? = null, memorySize: Int? = null, packageType: FunctionPackageType? = null, recursiveLoop: FunctionRecursiveLoop? = null, reservedConcurrentExecutions: Int? = null, role: String? = null, runtime: String? = null, runtimeManagementConfig: FunctionRuntimeManagementConfig? = null, snapStartResponse: FunctionSnapStartResponse? = null, tags: List<Tag>? = null, timeout: Int? = null, tracingConfig: FunctionTracingConfig? = null, vpcConfig: FunctionVpcConfig? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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`.

Link copied to clipboard
val arn: String? = null

The Amazon Resource Name (ARN) of the function.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val description: String? = null

A description of the function.

Link copied to clipboard

Environment variables that are accessible from function code during execution.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
val handler: String? = 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.

Link copied to clipboard

Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.

Link copied to clipboard
val kmsKeyArn: String? = null

The ARN of the KMSlong (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.

Link copied to clipboard
val layers: List<String>? = null

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

Link copied to clipboard

The function's Amazon CloudWatch Logs configuration settings.

Link copied to clipboard
val memorySize: Int? = null

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The number of simultaneous executions to reserve for the function.

Link copied to clipboard
val role: String? = null

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

Link copied to clipboard
val runtime: String? = null

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.

Link copied to clipboard

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.

Link copied to clipboard
Link copied to clipboard
val tags: List<Tag>? = null

A list of tags to apply to the function.

Link copied to clipboard
val timeout: Int? = 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.

Link copied to clipboard

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

Link copied to clipboard

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.