Function

lambda.services.k8s.aws/v1alpha1

Type	Link
GoDoc	lambda-controller/apis/v1alpha1#Function

Metadata

Property	Value
Scope	Namespaced
Kind	`Function`
ListKind	`FunctionList`
Plural	`functions`
Singular	`function`

Spec

architectures:
- string
code: 
  imageURI: string
  s3Bucket: string
  s3BucketRef: 
    from: 
      name: string
  s3Key: string
  s3ObjectVersion: string
  zipFile: string
codeSigningConfigARN: string
deadLetterConfig: 
  targetARN: string
description: string
environment: 
  variables: {}
ephemeralStorage: 
  size: integer
fileSystemConfigs:
- arn: string
  localMountPath: string
handler: string
imageConfig: 
  command:
  - string
  entryPoint:
  - string
  workingDirectory: string
kmsKeyARN: string
kmsKeyRef: 
  from: 
    name: string
layers:
- string
memorySize: integer
name: string
packageType: string
publish: boolean
reservedConcurrentExecutions: integer
role: string
runtime: string
snapStart: 
  applyOn: string
tags: {}
timeout: integer
tracingConfig: 
  mode: string
vpcConfig: 
  securityGroupIDs:
  - string
  securityGroupRefs:
    from: 
      name: string
  subnetIDs:
  - string
  subnetRefs:
    from: 
      name: string

Field	Description
architectures Optional	array 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.
architectures.[] Required	string
code.imageURI Optional	string
code.s3Bucket Optional	string
code.s3BucketRef Optional	object Reference field for S3Bucket
code.s3BucketRef.from Optional	object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
code.s3BucketRef.from.name Optional	string
code.s3Key Optional	string
code.s3ObjectVersion Optional	string
code.zipFile Optional	string
codeSigningConfigARN Optional	string 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.
deadLetterConfig Optional	object 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).
deadLetterConfig.targetARN Optional	string
description Optional	string A description of the function.
environment Optional	object Environment variables that are accessible from function code during execution.
environment.variables Optional	object
ephemeralStorage Optional	object The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB.
ephemeralStorage.size Optional	integer
fileSystemConfigs Optional	array Connection settings for an Amazon EFS file system.
fileSystemConfigs.[] Required	object Details about the connection between a Lambda function and an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).
fileSystemConfigs.[].localMountPath Optional	string
handler Optional	string 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).
imageConfig Optional	object Container image configuration values (https://docs.aws.amazon.com/lambda/latest/dg/configuration-images.html#configuration-images-settings) that override the values in the container image Dockerfile.
imageConfig.command Optional	array
imageConfig.command.[] Required	string
imageConfig.entryPoint.[] Required	string
kmsKeyARN Optional	string The ARN of the Key Management Service (KMS) key that’s used to encrypt your function’s environment variables. If it’s not provided, Lambda uses a default service key.
kmsKeyRef Optional	object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api
kmsKeyRef.from Optional	object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
kmsKeyRef.from.name Optional	string
layers Optional	array 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.
layers.[] Required	string
name Required	string The name of the Lambda function. Name formats * Function name – my-function. * Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. * Partial ARN – 123456789012:function:my-function. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
packageType Optional	string The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.
publish Optional	boolean Set to true to publish the first version of the function during creation.
reservedConcurrentExecutions Optional	integer The number of simultaneous executions to reserve for the function.
role Required	string The Amazon Resource Name (ARN) of the function’s execution role.
runtime Optional	string 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.
snapStart Optional	object The function’s SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
snapStart.applyOn Optional	string
tags Optional	object A list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.
timeout Optional	integer 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).
tracingConfig Optional	object 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).
tracingConfig.mode Optional	string
vpcConfig Optional	object For network connectivity to Amazon Web Services 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).
vpcConfig.securityGroupIDs Optional	array
vpcConfig.securityGroupIDs.[] Required	string
vpcConfig.securityGroupRefs.[] Required	object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:
from: name: my-api
vpcConfig.securityGroupRefs.[].from.name Optional	string
vpcConfig.subnetIDs Optional	array
vpcConfig.subnetIDs.[] Required	string
vpcConfig.subnetRefs.[] Required	object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:
from: name: my-api
vpcConfig.subnetRefs.[].from.name Optional	string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
codeSHA256: string
codeSize: integer
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
imageConfigResponse: 
  error: 
    errorCode: string
    message: string
  imageConfig: 
    command:
    - string
    entryPoint:
    - string
    workingDirectory: string
lastModified: string
lastUpdateStatus: string
lastUpdateStatusReason: string
lastUpdateStatusReasonCode: string
layerStatuses:
- arn: string
  codeSize: integer
  signingJobARN: string
  signingProfileVersionARN: string
masterARN: string
revisionID: string
signingJobARN: string
signingProfileVersionARN: string
state: string
stateReason: string
stateReasonCode: string
version: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
codeSHA256 Optional	string The SHA256 hash of the function’s deployment package.
codeSize Optional	integer The size of the function’s deployment package, in bytes.
conditions Optional	array All CRS managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
imageConfigResponse Optional	object The function’s image configuration values.
imageConfigResponse.error Optional	object Error response to GetFunctionConfiguration.
imageConfigResponse.error.errorCode Optional	string
imageConfigResponse.error.message Optional	string
imageConfigResponse.imageConfig Optional	object 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).
imageConfigResponse.imageConfig.command Optional	array
imageConfigResponse.imageConfig.command.[] Required	string
imageConfigResponse.imageConfig.entryPoint.[] Required	string
lastModified Optional	string The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).
lastUpdateStatus Optional	string The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
lastUpdateStatusReason Optional	string The reason for the last update that was performed on the function.
lastUpdateStatusReasonCode Optional	string The reason code for the last update that was performed on the function.
layerStatuses Optional	array The function’s layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).
layerStatuses.[] Required	object An Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).
layerStatuses.[].codeSize Optional	integer
layerStatuses.[].signingJobARN Optional	string
layerStatuses.[].signingProfileVersionARN Optional	string
masterARN Optional	string For Lambda@Edge functions, the ARN of the main function.
revisionID Optional	string The latest updated revision of the function or alias.
signingJobARN Optional	string The ARN of the signing job.
signingProfileVersionARN Optional	string The ARN of the signing profile version.
state Optional	string The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
stateReason Optional	string The reason for the function’s current state.
stateReasonCode Optional	string The reason code for the function’s current state. When the code is Creating, you can’t invoke or modify the function.
version Optional	string The version of the Lambda function.

Function

Metadata#

Spec#

Status#

Metadata

Spec

Status