Version

lambda.services.k8s.aws/v1alpha1

TypeLink
GoDoclambda-controller/apis/v1alpha1#Version

Metadata

PropertyValue
ScopeNamespaced
KindVersion
ListKindVersionList
Pluralversions
Singularversion

Spec

codeSHA256: string
description: string
functionEventInvokeConfig: 
  destinationConfig: 
    onFailure: 
      destination: string
    onSuccess: 
      destination: string
  functionName: string
  maximumEventAgeInSeconds: integer
  maximumRetryAttempts: integer
  qualifier: string
functionName: string
functionRef: 
  from: 
    name: string
    namespace: string
provisionedConcurrencyConfig: 
  functionName: string
  provisionedConcurrentExecutions: integer
  qualifier: string
revisionID: string
FieldDescription
codeSHA256
Optional
string
Only publish a version if the hash value matches the value that’s specified.
Use this option to avoid publishing a version if the function code has changed
since you last updated it. You can get the hash for the version that you
uploaded from the output of UpdateFunctionCode.
description
Optional
string
A description for the version to override the description in the function
configuration.
functionEventInvokeConfig
Optional
object
functionEventInvokeConfig.destinationConfig
Optional
object
A configuration object that specifies the destination of an event after Lambda
processes it.
functionEventInvokeConfig.destinationConfig.onFailure
Optional
object
A destination for events that failed processing.
functionEventInvokeConfig.destinationConfig.onFailure.destination
Optional
string
functionEventInvokeConfig.destinationConfig.onSuccess
Optional
object
A destination for events that were processed successfully.
functionEventInvokeConfig.destinationConfig.onSuccess.destination
Optional
string
functionEventInvokeConfig.functionName
Optional
string
functionEventInvokeConfig.maximumEventAgeInSeconds
Optional
integer
functionEventInvokeConfig.maximumRetryAttempts
Optional
integer
functionEventInvokeConfig.qualifier
Optional
string
functionName
Optional
string
The name of the Lambda function.

Name formats

* Function name - MyFunction.

* Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

* Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the
function name, it is limited to 64 characters in length.
functionRef
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
functionRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
functionRef.from.name
Optional
string
functionRef.from.namespace
Optional
string
provisionedConcurrencyConfig
Optional
object
provisionedConcurrencyConfig.functionName
Optional
string
provisionedConcurrencyConfig.provisionedConcurrentExecutions
Optional
integer
provisionedConcurrencyConfig.qualifier
Optional
string
revisionID
Optional
string
Only update the function if the revision ID matches the ID that’s specified.
Use this option to avoid publishing a version if the function configuration
has changed since you last updated it.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
architectures:
- string
codeSize: integer
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
deadLetterConfig: 
  targetARN: string
environment: 
  error: 
    errorCode: string
    message: string
  variables: {}
ephemeralStorage: 
  size: integer
fileSystemConfigs:
- arn: string
  localMountPath: string
functionARN: string
handler: string
imageConfigResponse: 
  error: 
    errorCode: string
    message: string
  imageConfig: 
    command:
    - string
    entryPoint:
    - string
    workingDirectory: string
kmsKeyARN: string
lastModified: string
lastUpdateStatus: string
lastUpdateStatusReason: string
lastUpdateStatusReasonCode: string
layers:
- arn: string
  codeSize: integer
  signingJobARN: string
  signingProfileVersionARN: string
masterARN: string
memorySize: integer
packageType: string
qualifier: string
role: string
runtime: string
signingJobARN: string
signingProfileVersionARN: string
snapStart: 
  applyOn: string
  optimizationStatus: string
state: string
stateReason: string
stateReasonCode: string
timeout: integer
tracingConfig: 
  mode: string
version: string
vpcConfig: 
  securityGroupIDs:
  - string
  subnetIDs:
  - string
  vpcID: string
FieldDescription
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.
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.
architectures
Optional
array
The instruction set architecture that the function supports. Architecture
is a string array with one of the valid values. The default architecture
value is x86_64.
architectures.[]
Required
string
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
deadLetterConfig
Optional
object
The function’s dead letter queue.
deadLetterConfig.targetARN
Optional
string
environment
Optional
object
The function’s environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).
Omitted from CloudTrail logs.
environment.error
Optional
object
Error messages for environment variables that couldn’t be applied.
environment.error.errorCode
Optional
string
environment.error.message
Optional
string
environment.variables
Optional
object
ephemeralStorage
Optional
object
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.
ephemeralStorage.size
Optional
integer
fileSystemConfigs
Optional
array
Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).
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
functionARN
Optional
string
The function’s Amazon Resource Name (ARN).
handler
Optional
string
The function that Lambda calls to begin running your function.
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
kmsKeyARN
Optional
string
The KMS key that’s used to encrypt the function’s environment variables.
This key is returned only if you’ve configured a customer managed key.
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.
layers
Optional
array
The function’s layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).
layers.[]
Required
object
An Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).
layers.[].codeSize
Optional
integer
layers.[].signingJobARN
Optional
string
layers.[].signingProfileVersionARN
Optional
string
masterARN
Optional
string
For Lambda@Edge functions, the ARN of the main function.
memorySize
Optional
integer
The amount of memory available to the function at runtime.
packageType
Optional
string
The type of deployment package. Set to Image for container image and set
Zip for .zip file archive.
qualifier
Optional
string
The version of the Lambda function.
role
Optional
string
The function’s execution role.
runtime
Optional
string
The runtime environment for the Lambda function.
signingJobARN
Optional
string
The ARN of the signing job.
signingProfileVersionARN
Optional
string
The ARN of the signing profile version.
snapStart
Optional
object
Set ApplyOn to PublishedVersions to create a snapshot of the initialized
execution environment when you publish a function version. For more information,
see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html).
snapStart.applyOn
Optional
string
snapStart.optimizationStatus
Optional
string
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.
timeout
Optional
integer
The amount of time in seconds that Lambda allows a function to run before
stopping it.
tracingConfig
Optional
object
The function’s X-Ray tracing configuration.
tracingConfig.mode
Optional
string
version
Optional
string
The version of the Lambda function.
vpcConfig
Optional
object
The function’s networking configuration.
vpcConfig.securityGroupIDs
Optional
array
vpcConfig.securityGroupIDs.[]
Required
string
vpcConfig.subnetIDs.[]
Required
string