Stratosphere.Resources.ApiGatewayMethod

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.

Documentation

data ApiGatewayMethod

Full data type definition for ApiGatewayMethod. See apiGatewayMethod for a more convenient constructor.

Constructors

ApiGatewayMethod

Fields

• _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

Instances

Show ApiGatewayMethod

Methods

showsPrec :: Int -> ApiGatewayMethod -> ShowS

show :: ApiGatewayMethod -> String

showList :: [ApiGatewayMethod] -> ShowS

Generic ApiGatewayMethod

Associated Types

type Rep ApiGatewayMethod :: * -> *

Methods

from :: ApiGatewayMethod -> Rep ApiGatewayMethod x

to :: Rep ApiGatewayMethod x -> ApiGatewayMethod

ToJSON ApiGatewayMethod

Methods

toJSON :: ApiGatewayMethod -> Value

toEncoding :: ApiGatewayMethod -> Encoding

toJSONList :: [ApiGatewayMethod] -> Value

toEncodingList :: [ApiGatewayMethod] -> Encoding

FromJSON ApiGatewayMethod

Methods

parseJSON :: Value -> Parser ApiGatewayMethod

parseJSONList :: Value -> Parser [ApiGatewayMethod]

type Rep ApiGatewayMethod

type Rep ApiGatewayMethod = D1 (MetaData "ApiGatewayMethod" "Stratosphere.Resources.ApiGatewayMethod" "stratosphere-0.2.2-Fnop5S0NvsvBmp7LUeJWuv" False) (C1 (MetaCons "ApiGatewayMethod" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayMethodApiKeyRequired") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))) (S1 (MetaSel (Just Symbol "_apiGatewayMethodAuthorizationType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AuthorizationType))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayMethodAuthorizerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayMethodHttpMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HttpMethod)) (S1 (MetaSel (Just Symbol "_apiGatewayMethodIntegration") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ApiGatewayIntegration)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayMethodMethodResponses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [ApiGatewayMethodResponse]))) (S1 (MetaSel (Just Symbol "_apiGatewayMethodRequestModels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object)))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayMethodRequestParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayMethodResourceId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) (S1 (MetaSel (Just Symbol "_apiGatewayMethodRestApiId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))))))))

apiGatewayMethod

Arguments

:: AuthorizationType

agmeAuthorizationType

-> HttpMethod

agmeHttpMethod

-> Val Text

agmeResourceId

-> Val Text

agmeRestApiId

-> ApiGatewayMethod

Constructor for ApiGatewayMethod containing required fields as arguments.

agmeApiKeyRequired :: Lens' ApiGatewayMethod (Maybe (Val Bool'))

Indicates whether the method requires clients to submit a valid API key.

agmeAuthorizationType :: Lens' ApiGatewayMethod AuthorizationType

The method's authorization type.

agmeAuthorizerId :: Lens' ApiGatewayMethod (Maybe (Val Text))

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

The HTTP method that clients will use to call this method.

agmeIntegration :: Lens' ApiGatewayMethod (Maybe ApiGatewayIntegration)

The back-end system that the method calls when it receives a request.

agmeMethodResponses :: Lens' ApiGatewayMethod (Maybe [ApiGatewayMethodResponse])

The responses that can be sent to the client who calls the method.

agmeRequestModels :: Lens' ApiGatewayMethod (Maybe Object)

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)

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)

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)

The ID of the RestApi resource in which API Gateway creates the method.