APIIntegrationResponse
apigateway.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigateway-controller/apis/v1alpha1#APIIntegrationResponse |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | APIIntegrationResponse |
| ListKind | APIIntegrationResponseList |
| Plural | apiintegrationresponses |
| Singular | apiintegrationresponse |
Spec
contentHandling: string
httpMethod: string
resourceID: string
resourceRef:
from:
name: string
namespace: string
responseParameters: {}
responseTemplates: {}
restAPIID: string
restAPIRef:
from:
name: string
namespace: string
selectionPattern: string
statusCode: string
| Field | Description |
|---|---|
| contentHandling Optional | string Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. |
| httpMethod Required | string Specifies a put integration response request’s HTTP method. |
| resourceID Optional | string Specifies a put integration response request’s resource identifier. |
| 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 |
| responseParameters Optional | object A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix. |
| responseTemplates Optional | object Specifies a put integration response’s templates. |
| 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 |
| selectionPattern Optional | string Specifies the selection pattern of a put integration response. |
| statusCode Required | string Specifies the status code that is used to map the integration response to an existing MethodResponse. |
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 |