Method
apigateway.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | apigateway-controller/apis/v1alpha1#Method |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | Method |
ListKind | MethodList |
Plural | methods |
Singular | method |
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Spec
apiKeyRequired: boolean
authorizationScopes:
- string
authorizationType: string
authorizerID: string
httpMethod: string
operationName: string
requestModels: {}
requestParameters: {}
requestValidatorID: string
resourceID: string
resourceRef:
from:
name: string
namespace: string
restAPIID: string
restAPIRef:
from:
name: string
namespace: string
Field | Description |
---|---|
apiKeyRequired Optional | boolean Specifies whether the method required a valid ApiKey. |
authorizationScopes Optional | array A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes. |
authorizationScopes.[] Required | string |
authorizerID Optional | string Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer. |
httpMethod Required | string Specifies the method request’s HTTP method type. |
operationName Optional | string A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example. |
requestModels Optional | object Specifies the Model resources used for the request’s content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value. |
requestParameters Optional | object A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates. |
requestValidatorID Optional | string The identifier of a RequestValidator for validating the method request. |
resourceID Optional | string The Resource identifier for the new 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 |
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 |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
methodIntegration:
cacheKeyParameters:
- string
cacheNamespace: string
connectionID: string
connectionType: string
contentHandling: string
credentials: string
httpMethod: string
integrationResponses: {}
passthroughBehavior: string
requestParameters: {}
requestTemplates: {}
timeoutInMillis: integer
tlsConfig:
insecureSkipVerification: boolean
type: string
uri: string
methodResponses: {}
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 |
methodIntegration Optional | object Gets the method’s integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end. |
methodIntegration.cacheKeyParameters Optional | array |
methodIntegration.cacheKeyParameters.[] Required | string |
methodIntegration.connectionID Optional | string |
methodIntegration.connectionType Optional | string |
methodIntegration.contentHandling Optional | string |
methodIntegration.credentials Optional | string |
methodIntegration.httpMethod Optional | string |
methodIntegration.integrationResponses Optional | object |
methodIntegration.passthroughBehavior Optional | string |
methodIntegration.requestParameters Optional | object |
methodIntegration.requestTemplates Optional | object |
methodIntegration.timeoutInMillis Optional | integer |
methodIntegration.tlsConfig Optional | object Specifies the TLS configuration for an integration. |
methodIntegration.tlsConfig.insecureSkipVerification Optional | boolean |
methodIntegration.type Optional | string The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any Amazon Web Services service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration. |
methodIntegration.uri Optional | string |
methodResponses Optional | object Gets a method response associated with a given HTTP status code. |