Integration
apigateway.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigateway-controller/apis/v1alpha1#Integration |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Integration |
| ListKind | IntegrationList |
| Plural | integrations |
| Singular | integration |
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Spec
cacheKeyParameters:
- string
cacheNamespace: string
connectionID: string
connectionRef:
from:
name: string
namespace: string
connectionType: string
contentHandling: string
credentials: string
httpMethod: string
integrationHTTPMethod: string
passthroughBehavior: string
requestParameters: {}
requestTemplates: {}
resourceID: string
resourceRef:
from:
name: string
namespace: string
restAPIID: string
restAPIRef:
from:
name: string
namespace: string
timeoutInMillis: integer
tlsConfig:
insecureSkipVerification: boolean
type: string
uri: string
| Field | Description |
|---|---|
| cacheKeyParameters Optional | array A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters. |
| cacheKeyParameters.[] Required | string |
| connectionID Optional | string The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type. |
| connectionRef 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 |
| connectionRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| connectionRef.from.name Optional | string |
| connectionRef.from.namespace Optional | string |
| connectionType Optional | string The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET. |
| contentHandling Optional | string Specifies how to handle request 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 request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through. |
| credentials Optional | string Specifies whether credentials are required for a put integration. |
| httpMethod Required | string Specifies the HTTP method for the integration. |
| integrationHTTPMethod Optional | string The HTTP method for the integration. |
| passthroughBehavior Optional | string Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. |
| requestParameters Optional | object A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name. |
| requestTemplates Optional | object Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. |
| resourceID Optional | string Specifies a put integration request’s resource ID. |
| 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 |
| 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 |
| timeoutInMillis Optional | integer Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. |
| tlsConfig Optional | object Specifies the TLS configuration for an integration. |
| tlsConfig.insecureSkipVerification Optional | boolean |
| type Required | string Specifies a put integration input’s type. |
| uri Optional | string Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
integrationResponses: {}
| 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 |
| integrationResponses Optional | object Specifies the integration’s responses. |