API

apigatewayv2.services.k8s.aws/v1alpha1

Type	Link
GoDoc	apigatewayv2-controller/apis/v1alpha1#API

Metadata

Property	Value
Scope	Namespaced
Kind	`API`
ListKind	`APIList`
Plural	`apis`
Singular	`api`

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

Field	Description
apiKeySelectionExpression Optional	string An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
basepath Optional	string Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
body Optional	string The OpenAPI definition. Supported only for HTTP APIs.
corsConfiguration Optional	object 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 This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To require that the caller’s identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
description Optional	string The description of the API.
disableExecuteAPIEndpoint Optional	boolean Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
disableSchemaValidation Optional	boolean Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
failOnWarnings Optional	boolean Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
name Optional	string The name of the API.
protocolType Optional	string The API protocol.
routeKey Optional	string This property is part of quick create. If you don’t specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can’t be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
routeSelectionExpression Optional	string The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
tags Optional	object The collection of tags. Each tag element is associated with a given resource.
target Optional	string This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
version Optional	string A version identifier for the API.

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

Field	Description
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.
apiEndpoint Optional	string The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
apiGatewayManaged Optional	boolean Specifies whether an API is managed by API Gateway. You can’t update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
apiID Optional	string The API ID.
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 The timestamp when the API was created.
importInfo Optional	array The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
importInfo.[] Required	string
warnings.[] Required	string

API

Metadata#

Spec#

Status#

Metadata

Spec

Status