Route

apigatewayv2.services.k8s.aws/v1alpha1

TypeLink
GoDocapigatewayv2-controller/apis/v1alpha1#Route

Metadata

PropertyValue
ScopeNamespaced
KindRoute
ListKindRouteList
Pluralroutes
Singularroute

Represents a route.

Spec

apiID: string
apiKeyRequired: boolean
apiRef: 
  from: 
    name: string
authorizationScopes:
- string
authorizationType: string
authorizerID: string
authorizerRef: 
  from: 
    name: string
modelSelectionExpression: string
operationName: string
requestModels: {}
requestParameters: {}
routeKey: string
routeResponseSelectionExpression: string
target: string
targetRef: 
  from: 
    name: string
FieldDescription
apiID
Optional
string
apiKeyRequired
Optional
boolean
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
authorizationScopes
Optional
array
authorizationScopes.[]
Required
string
authorizerID
Optional
string
authorizerRef
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
authorizerRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
authorizerRef.from.name
Optional
string
modelSelectionExpression
Optional
string
operationName
Optional
string
requestModels
Optional
object
requestParameters
Optional
object
routeKey
Required
string
routeResponseSelectionExpression
Optional
string
target
Optional
string
targetRef
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
targetRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
targetRef.from.name
Optional
string

Status

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