Safe Haskell | None |
---|---|
Language | Haskell2010 |
The AWS::ApiGateway::Method resource creates Amazon API Gateway (API Gateway) methods that define the parameters and body that clients must send in their requests.
- data ApiGatewayMethod = ApiGatewayMethod {
- _apiGatewayMethodApiKeyRequired :: Maybe (Val Bool')
- _apiGatewayMethodAuthorizationType :: AuthorizationType
- _apiGatewayMethodAuthorizerId :: Maybe (Val Text)
- _apiGatewayMethodHttpMethod :: HttpMethod
- _apiGatewayMethodIntegration :: Maybe ApiGatewayIntegration
- _apiGatewayMethodMethodResponses :: Maybe [ApiGatewayMethodResponse]
- _apiGatewayMethodRequestModels :: Maybe Object
- _apiGatewayMethodRequestParameters :: Maybe Object
- _apiGatewayMethodResourceId :: Val Text
- _apiGatewayMethodRestApiId :: Val Text
- apiGatewayMethod :: AuthorizationType -> HttpMethod -> Val Text -> Val Text -> ApiGatewayMethod
- agmeApiKeyRequired :: Lens' ApiGatewayMethod (Maybe (Val Bool'))
- agmeAuthorizationType :: Lens' ApiGatewayMethod AuthorizationType
- agmeAuthorizerId :: Lens' ApiGatewayMethod (Maybe (Val Text))
- agmeHttpMethod :: Lens' ApiGatewayMethod HttpMethod
- agmeIntegration :: Lens' ApiGatewayMethod (Maybe ApiGatewayIntegration)
- agmeMethodResponses :: Lens' ApiGatewayMethod (Maybe [ApiGatewayMethodResponse])
- agmeRequestModels :: Lens' ApiGatewayMethod (Maybe Object)
- agmeRequestParameters :: Lens' ApiGatewayMethod (Maybe Object)
- agmeResourceId :: Lens' ApiGatewayMethod (Val Text)
- agmeRestApiId :: Lens' ApiGatewayMethod (Val Text)
Documentation
data ApiGatewayMethod Source #
Full data type definition for ApiGatewayMethod. See apiGatewayMethod
for a more convenient constructor.
:: AuthorizationType | |
-> HttpMethod | |
-> Val Text | |
-> Val Text | |
-> ApiGatewayMethod |
Constructor for ApiGatewayMethod
containing required fields as
arguments.
agmeApiKeyRequired :: Lens' ApiGatewayMethod (Maybe (Val Bool')) Source #
Indicates whether the method requires clients to submit a valid API key.
agmeAuthorizationType :: Lens' ApiGatewayMethod AuthorizationType Source #
The method's authorization type.
agmeAuthorizerId :: Lens' ApiGatewayMethod (Maybe (Val Text)) Source #
The identifier of the authorizer to use on this method. If you specify this property, specify CUSTOM for the AuthorizationType property.
agmeHttpMethod :: Lens' ApiGatewayMethod HttpMethod Source #
The HTTP method that clients will use to call this method.
agmeIntegration :: Lens' ApiGatewayMethod (Maybe ApiGatewayIntegration) Source #
The back-end system that the method calls when it receives a request.
agmeMethodResponses :: Lens' ApiGatewayMethod (Maybe [ApiGatewayMethodResponse]) Source #
The responses that can be sent to the client who calls the method.
agmeRequestModels :: Lens' ApiGatewayMethod (Maybe Object) Source #
The resources used for the response's content type. Specify response models as key-value pairs (string-to-string map), with a content type as the key and a Model resource name as the value.
agmeRequestParameters :: Lens' ApiGatewayMethod (Maybe Object) Source #
Request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean map), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the following format method.request.location.name, where the location is querystring, path, or header, and name is a valid, unique parameter name.
agmeResourceId :: Lens' ApiGatewayMethod (Val Text) Source #
The ID of an API Gateway resource. For root resource methods, specify the RestApi root resource ID, such as { Fn::GetAtt: [MyRestApi, RootResourceId] }.
agmeRestApiId :: Lens' ApiGatewayMethod (Val Text) Source #
The ID of the RestApi resource in which API Gateway creates the method.