Route
apigatewayv2.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigatewayv2-controller/apis/v1alpha1#Route |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Route |
| ListKind | RouteList |
| Plural | routes |
| Singular | route |
Represents a route.
Spec
apiID: string
apiKeyRequired: boolean
apiRef:
from:
name: string
namespace: string
authorizationScopes:
- string
authorizationType: string
authorizerID: string
authorizerRef:
from:
name: string
namespace: string
modelSelectionExpression: string
operationName: string
requestModels: {}
requestParameters: {}
routeKey: string
routeResponseSelectionExpression: string
target: string
targetRef:
from:
name: string
namespace: string
| Field | Description |
|---|---|
| apiID Optional | string The API identifier. |
| apiKeyRequired Optional | boolean Specifies whether an API key is required for the route. Supported only for WebSocket APIs. |
| 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 |
| authorizationScopes Optional | array The authorization scopes supported by this route. |
| authorizationScopes.[] Required | string |
| authorizerID Optional | string The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer. |
| 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 |
| authorizerRef.from.namespace Optional | string |
| modelSelectionExpression Optional | string The model selection expression for the route. Supported only for WebSocket APIs. |
| operationName Optional | string The operation name for the route. |
| requestModels Optional | object The request models for the route. Supported only for WebSocket APIs. |
| requestParameters Optional | object The request parameters for the route. Supported only for WebSocket APIs. |
| routeKey Required | string The route key for the route. |
| routeResponseSelectionExpression Optional | string The route response selection expression for the route. Supported only for WebSocket APIs. |
| target Optional | string The target for the route. |
| 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 |
| targetRef.from.namespace 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
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat 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. |
| apiGatewayManaged Optional | boolean Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can’t modify the $default route key. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe 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 The route ID. |