Authorizer

apigatewayv2.services.k8s.aws/v1alpha1

TypeLink
GoDocapigatewayv2-controller/apis/v1alpha1#Authorizer

Metadata

PropertyValue
ScopeNamespaced
KindAuthorizer
ListKindAuthorizerList
Pluralauthorizers
Singularauthorizer

Represents an authorizer.

Spec

apiID: string
apiRef: 
  from: 
    name: string
    namespace: string
authorizerCredentialsARN: string
authorizerPayloadFormatVersion: string
authorizerResultTTLInSeconds: integer
authorizerType: string
authorizerURI: string
enableSimpleResponses: boolean
identitySource:
- string
identityValidationExpression: string
jwtConfiguration: 
  audience:
  - string
  issuer: string
name: string
FieldDescription
apiID
Optional
string
apiRef
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
apiRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
apiRef.from.name
Optional
string
apiRef.from.namespace
Optional
string
authorizerCredentialsARN
Optional
string
authorizerPayloadFormatVersion
Optional
string
authorizerResultTTLInSeconds
Optional
integer
authorizerType
Required
string
authorizerURI
Optional
string
enableSimpleResponses
Optional
boolean
identitySource
Required
array
identitySource.[]
Required
string
jwtConfiguration
Optional
object
Represents the configuration of a JWT authorizer. Required for the JWT authorizer
type. Supported only for HTTP APIs.
jwtConfiguration.audience
Optional
array
jwtConfiguration.audience.[]
Required
string
name
Required
string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
authorizerID: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: 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.
authorizerID
Optional
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