API

apigatewayv2.services.k8s.aws/v1alpha1

TypeLink
GoDocapigatewayv2-controller/apis/v1alpha1#API

Metadata

PropertyValue
ScopeNamespaced
KindAPI
ListKindAPIList
Pluralapis
Singularapi

Represents an API.

Spec

apiKeySelectionExpression: string
basepath: string
body: string
corsConfiguration: 
  allowCredentials: boolean
  allowHeaders:
  - string
  allowMethods:
  - string
  allowOrigins:
  - string
  exposeHeaders:
  - string
  maxAge: integer
credentialsARN: string
description: string
disableExecuteAPIEndpoint: boolean
disableSchemaValidation: boolean
failOnWarnings: boolean
name: string
protocolType: string
routeKey: string
routeSelectionExpression: string
tags: {}
target: string
version: string
FieldDescription
apiKeySelectionExpression
Optional
string
basepath
Optional
string
body
Optional
string
corsConfiguration
Optional
object
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring
CORS (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html)
for more information.
corsConfiguration.allowCredentials
Optional
boolean
corsConfiguration.allowHeaders
Optional
array
Represents a collection of allowed headers. Supported only for HTTP APIs.
corsConfiguration.allowHeaders.[]
Required
string
corsConfiguration.allowMethods.[]
Required
string
corsConfiguration.allowOrigins.[]
Required
string
corsConfiguration.exposeHeaders.[]
Required
string
credentialsARN
Optional
string
description
Optional
string
disableExecuteAPIEndpoint
Optional
boolean
disableSchemaValidation
Optional
boolean
failOnWarnings
Optional
boolean
name
Optional
string
protocolType
Optional
string
routeKey
Optional
string
routeSelectionExpression
Optional
string
tags
Optional
object
target
Optional
string
version
Optional
string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
apiEndpoint: string
apiGatewayManaged: boolean
apiID: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdDate: string
importInfo:
- string
warnings:
- 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.
apiEndpoint
Optional
string
apiGatewayManaged
Optional
boolean
apiID
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
createdDate
Optional
string
importInfo
Optional
array
importInfo.[]
Required
string
warnings.[]
Required
string