Alias

lambda.services.k8s.aws/v1alpha1

TypeLink
GoDoclambda-controller/apis/v1alpha1#Alias

Metadata

PropertyValue
ScopeNamespaced
KindAlias
ListKindAliasList
Pluralaliases
Singularalias

Spec

description: string
functionEventInvokeConfig: 
  destinationConfig: 
    onFailure: 
      destination: string
    onSuccess: 
      destination: string
  functionName: string
  maximumEventAgeInSeconds: integer
  maximumRetryAttempts: integer
  qualifier: string
functionName: string
functionRef: 
  from: 
    name: string
functionVersion: string
name: string
provisionedConcurrencyConfig: 
  functionName: string
  provisionedConcurrentExecutions: integer
  qualifier: string
routingConfig: 
  additionalVersionWeights: {}
FieldDescription
description
Optional
string
A description of the alias.
functionEventInvokeConfig
Optional
object
Configures options for asynchronous invocation on an alias.


- DestinationConfig
A destination for events after they have been sent to a function for processing.


Types of Destinations:
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of a standard SQS queue.
Topic - The ARN of a standard SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.


- MaximumEventAgeInSeconds
The maximum age of a request that Lambda sends to a function for processing.


- MaximumRetryAttempts
The maximum number of times to retry when the function returns an error.
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
functionVersion
Required
string
The function version that the alias invokes.
name
Required
string
The name of the alias.
provisionedConcurrencyConfig
Optional
object
Configures provisioned concurrency to a function’s alias


- ProvisionedConcurrentExecutions
The amount of provisioned concurrency to allocate for the version or alias.
Minimum value of 1 is required
provisionedConcurrencyConfig.functionName
Optional
string
provisionedConcurrencyConfig.provisionedConcurrentExecutions
Optional
integer
provisionedConcurrencyConfig.qualifier
Optional
string
routingConfig
Optional
object
The routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing)
of the alias.
routingConfig.additionalVersionWeights
Optional
object

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
revisionID: 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.
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.
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
revisionID
Optional
string
A unique identifier that changes when you update the alias.