APIMethodResponse
apigateway.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigateway-controller/apis/v1alpha1#APIMethodResponse |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | APIMethodResponse |
| ListKind | APIMethodResponseList |
| Plural | apimethodresponses |
| Singular | apimethodresponse |
Spec
httpMethod: string
resourceID: string
resourceRef:
from:
name: string
namespace: string
responseModels: {}
responseParameters: {}
restAPIID: string
restAPIRef:
from:
name: string
namespace: string
statusCode: string
| Field | Description |
|---|---|
| httpMethod Required | string The HTTP verb of the Method resource. |
| resourceID Optional | string The Resource identifier for the Method resource. |
| resourceRef 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 |
| resourceRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| resourceRef.from.name Optional | string |
| resourceRef.from.namespace Optional | string |
| responseModels Optional | object Specifies the Model resources used for the response’s content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value. |
| responseParameters Optional | object A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., ‘application/json’), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.) |
| restAPIID Optional | string The string identifier of the associated RestApi. |
| restAPIRef 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 |
| restAPIRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| restAPIRef.from.name Optional | string |
| restAPIRef.from.namespace Optional | string |
| statusCode Required | string The method response’s status code. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: 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. |
| 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 |