AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getFunction

Resource Type definition for AWS::Lambda::Function

Using getFunction

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFunction(args: GetFunctionArgs, opts?: InvokeOptions): Promise<GetFunctionResult>
function getFunctionOutput(args: GetFunctionOutputArgs, opts?: InvokeOptions): Output<GetFunctionResult>
def get_function(function_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFunctionResult
def get_function_output(function_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFunctionResult]
func LookupFunction(ctx *Context, args *LookupFunctionArgs, opts ...InvokeOption) (*LookupFunctionResult, error)
func LookupFunctionOutput(ctx *Context, args *LookupFunctionOutputArgs, opts ...InvokeOption) LookupFunctionResultOutput

> Note: This function is named LookupFunction in the Go SDK.

public static class GetFunction 
{
    public static Task<GetFunctionResult> InvokeAsync(GetFunctionArgs args, InvokeOptions? opts = null)
    public static Output<GetFunctionResult> Invoke(GetFunctionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFunctionResult> getFunction(GetFunctionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:lambda:getFunction
  Arguments:
    # Arguments dictionary

The following arguments are supported:

FunctionName string

The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

FunctionName string

The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

functionName String

The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

functionName string

The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

function_name str

The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

functionName String

The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

getFunction Result

The following output properties are available:

Architectures List<Pulumi.AwsNative.Lambda.FunctionArchitecturesItem>
Arn string

Unique identifier for function resources

CodeSigningConfigArn string

A unique Arn for CodeSigningConfig resource

DeadLetterConfig Pulumi.AwsNative.Lambda.Outputs.FunctionDeadLetterConfig

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

Description string

A description of the function.

Environment Pulumi.AwsNative.Lambda.Outputs.FunctionEnvironment

Environment variables that are accessible from function code during execution.

EphemeralStorage Pulumi.AwsNative.Lambda.Outputs.FunctionEphemeralStorage

A function's ephemeral storage settings.

FileSystemConfigs List<Pulumi.AwsNative.Lambda.Outputs.FunctionFileSystemConfig>

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.

Handler string

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime

ImageConfig Pulumi.AwsNative.Lambda.Outputs.FunctionImageConfig

ImageConfig

KmsKeyArn string

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

Layers List<string>

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

MemorySize int

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

PackageType Pulumi.AwsNative.Lambda.FunctionPackageType

PackageType.

ReservedConcurrentExecutions int

The number of simultaneous executions to reserve for the function.

Role string

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

Runtime string

The identifier of the function's runtime.

Tags List<Pulumi.AwsNative.Lambda.Outputs.FunctionTag>

A list of tags to apply to the function.

Timeout int

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

TracingConfig Pulumi.AwsNative.Lambda.Outputs.FunctionTracingConfig

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

VpcConfig Pulumi.AwsNative.Lambda.Outputs.FunctionVpcConfig

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

Architectures []FunctionArchitecturesItem
Arn string

Unique identifier for function resources

CodeSigningConfigArn string

A unique Arn for CodeSigningConfig resource

DeadLetterConfig FunctionDeadLetterConfig

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

Description string

A description of the function.

Environment FunctionEnvironment

Environment variables that are accessible from function code during execution.

EphemeralStorage FunctionEphemeralStorage

A function's ephemeral storage settings.

FileSystemConfigs []FunctionFileSystemConfig

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.

Handler string

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime

ImageConfig FunctionImageConfig

ImageConfig

KmsKeyArn string

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

Layers []string

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

MemorySize int

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

PackageType FunctionPackageType

PackageType.

ReservedConcurrentExecutions int

The number of simultaneous executions to reserve for the function.

Role string

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

Runtime string

The identifier of the function's runtime.

Tags []FunctionTag

A list of tags to apply to the function.

Timeout int

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

TracingConfig FunctionTracingConfig

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

VpcConfig FunctionVpcConfig

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

architectures List<FunctionArchitecturesItem>
arn String

Unique identifier for function resources

codeSigningConfigArn String

A unique Arn for CodeSigningConfig resource

deadLetterConfig FunctionDeadLetterConfig

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

description String

A description of the function.

environment FunctionEnvironment

Environment variables that are accessible from function code during execution.

ephemeralStorage FunctionEphemeralStorage

A function's ephemeral storage settings.

fileSystemConfigs List<FunctionFileSystemConfig>

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.

handler String

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime

imageConfig FunctionImageConfig

ImageConfig

kmsKeyArn String

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

layers List<String>

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

memorySize Integer

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

packageType FunctionPackageType

PackageType.

reservedConcurrentExecutions Integer

The number of simultaneous executions to reserve for the function.

role String

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

runtime String

The identifier of the function's runtime.

tags List<FunctionTag>

A list of tags to apply to the function.

timeout Integer

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

tracingConfig FunctionTracingConfig

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

vpcConfig FunctionVpcConfig

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

architectures FunctionArchitecturesItem[]
arn string

Unique identifier for function resources

codeSigningConfigArn string

A unique Arn for CodeSigningConfig resource

deadLetterConfig FunctionDeadLetterConfig

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

description string

A description of the function.

environment FunctionEnvironment

Environment variables that are accessible from function code during execution.

ephemeralStorage FunctionEphemeralStorage

A function's ephemeral storage settings.

fileSystemConfigs FunctionFileSystemConfig[]

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.

handler string

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime

imageConfig FunctionImageConfig

ImageConfig

kmsKeyArn string

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

layers string[]

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

memorySize number

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

packageType FunctionPackageType

PackageType.

reservedConcurrentExecutions number

The number of simultaneous executions to reserve for the function.

role string

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

runtime string

The identifier of the function's runtime.

tags FunctionTag[]

A list of tags to apply to the function.

timeout number

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

tracingConfig FunctionTracingConfig

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

vpcConfig FunctionVpcConfig

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

architectures FunctionArchitecturesItem]
arn str

Unique identifier for function resources

code_signing_config_arn str

A unique Arn for CodeSigningConfig resource

dead_letter_config FunctionDeadLetterConfig

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

description str

A description of the function.

environment FunctionEnvironment

Environment variables that are accessible from function code during execution.

ephemeral_storage FunctionEphemeralStorage

A function's ephemeral storage settings.

file_system_configs FunctionFileSystemConfig]

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.

handler str

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime

image_config FunctionImageConfig

ImageConfig

kms_key_arn str

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

layers Sequence[str]

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

memory_size int

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

package_type FunctionPackageType

PackageType.

reserved_concurrent_executions int

The number of simultaneous executions to reserve for the function.

role str

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

runtime str

The identifier of the function's runtime.

tags FunctionTag]

A list of tags to apply to the function.

timeout int

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

tracing_config FunctionTracingConfig

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

vpc_config FunctionVpcConfig

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

architectures List<"x86_64" | "arm64">
arn String

Unique identifier for function resources

codeSigningConfigArn String

A unique Arn for CodeSigningConfig resource

deadLetterConfig Property Map

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

description String

A description of the function.

environment Property Map

Environment variables that are accessible from function code during execution.

ephemeralStorage Property Map

A function's ephemeral storage settings.

fileSystemConfigs List<Property Map>

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.

handler String

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime

imageConfig Property Map

ImageConfig

kmsKeyArn String

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

layers List<String>

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

memorySize Number

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

packageType "Image" | "Zip"

PackageType.

reservedConcurrentExecutions Number

The number of simultaneous executions to reserve for the function.

role String

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

runtime String

The identifier of the function's runtime.

tags List<Property Map>

A list of tags to apply to the function.

timeout Number

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

tracingConfig Property Map

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

vpcConfig Property Map

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

Supporting Types

FunctionArchitecturesItem

FunctionDeadLetterConfig

TargetArn string

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

TargetArn string

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

targetArn String

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

targetArn string

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

target_arn str

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

targetArn String

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

FunctionEnvironment

Variables object

Environment variable key-value pairs.

Variables interface{}

Environment variable key-value pairs.

variables Object

Environment variable key-value pairs.

variables any

Environment variable key-value pairs.

variables Any

Environment variable key-value pairs.

variables Any

Environment variable key-value pairs.

FunctionEphemeralStorage

Size int

The amount of ephemeral storage that your function has access to.

Size int

The amount of ephemeral storage that your function has access to.

size Integer

The amount of ephemeral storage that your function has access to.

size number

The amount of ephemeral storage that your function has access to.

size int

The amount of ephemeral storage that your function has access to.

size Number

The amount of ephemeral storage that your function has access to.

FunctionFileSystemConfig

Arn string

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

LocalMountPath string

The path where the function can access the file system, starting with /mnt/.

Arn string

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

LocalMountPath string

The path where the function can access the file system, starting with /mnt/.

arn String

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

localMountPath String

The path where the function can access the file system, starting with /mnt/.

arn string

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

localMountPath string

The path where the function can access the file system, starting with /mnt/.

arn str

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

local_mount_path str

The path where the function can access the file system, starting with /mnt/.

arn String

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

localMountPath String

The path where the function can access the file system, starting with /mnt/.

FunctionImageConfig

Command List<string>

Command.

EntryPoint List<string>

EntryPoint.

WorkingDirectory string

WorkingDirectory.

Command []string

Command.

EntryPoint []string

EntryPoint.

WorkingDirectory string

WorkingDirectory.

command List<String>

Command.

entryPoint List<String>

EntryPoint.

workingDirectory String

WorkingDirectory.

command string[]

Command.

entryPoint string[]

EntryPoint.

workingDirectory string

WorkingDirectory.

command Sequence[str]

Command.

entry_point Sequence[str]

EntryPoint.

working_directory str

WorkingDirectory.

command List<String>

Command.

entryPoint List<String>

EntryPoint.

workingDirectory String

WorkingDirectory.

FunctionPackageType

FunctionTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

FunctionTracingConfig

FunctionTracingConfigMode

FunctionVpcConfig

SecurityGroupIds List<string>

A list of VPC security groups IDs.

SubnetIds List<string>

A list of VPC subnet IDs.

SecurityGroupIds []string

A list of VPC security groups IDs.

SubnetIds []string

A list of VPC subnet IDs.

securityGroupIds List<String>

A list of VPC security groups IDs.

subnetIds List<String>

A list of VPC subnet IDs.

securityGroupIds string[]

A list of VPC security groups IDs.

subnetIds string[]

A list of VPC subnet IDs.

security_group_ids Sequence[str]

A list of VPC security groups IDs.

subnet_ids Sequence[str]

A list of VPC subnet IDs.

securityGroupIds List<String>

A list of VPC security groups IDs.

subnetIds List<String>

A list of VPC subnet IDs.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0