Stratosphere.Resources.ApiGatewayModel

The AWS::ApiGateway::Model resource defines the structure of a request or response payload for an Amazon API Gateway (API Gateway) method.

Documentation

data ApiGatewayModel

Full data type definition for ApiGatewayModel. See apiGatewayModel for a more convenient constructor.

Constructors

ApiGatewayModel

Fields

• _apiGatewayModelContentType :: Maybe (Val Text)
• _apiGatewayModelDescription :: Maybe (Val Text)
• _apiGatewayModelName :: Maybe (Val Text)
• _apiGatewayModelRestApiId :: Val Text
• _apiGatewayModelSchema :: Maybe Object

Instances

Show ApiGatewayModel

Methods

showsPrec :: Int -> ApiGatewayModel -> ShowS

show :: ApiGatewayModel -> String

showList :: [ApiGatewayModel] -> ShowS

Generic ApiGatewayModel

Associated Types

type Rep ApiGatewayModel :: * -> *

Methods

from :: ApiGatewayModel -> Rep ApiGatewayModel x

to :: Rep ApiGatewayModel x -> ApiGatewayModel

ToJSON ApiGatewayModel

Methods

toJSON :: ApiGatewayModel -> Value

toEncoding :: ApiGatewayModel -> Encoding

toJSONList :: [ApiGatewayModel] -> Value

toEncodingList :: [ApiGatewayModel] -> Encoding

FromJSON ApiGatewayModel

Methods

parseJSON :: Value -> Parser ApiGatewayModel

parseJSONList :: Value -> Parser [ApiGatewayModel]

type Rep ApiGatewayModel

type Rep ApiGatewayModel = D1 (MetaData "ApiGatewayModel" "Stratosphere.Resources.ApiGatewayModel" "stratosphere-0.2.0-B1WeL9cnxuQ3qer3csMa6f" False) (C1 (MetaCons "ApiGatewayModel" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayModelContentType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_apiGatewayModelDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayModelName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayModelRestApiId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) (S1 (MetaSel (Just Symbol "_apiGatewayModelSchema") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object)))))))

apiGatewayModel

Arguments

:: Val Text

agmRestApiId

-> ApiGatewayModel

Constructor for ApiGatewayModel containing required fields as arguments.

agmContentType :: Lens' ApiGatewayModel (Maybe (Val Text))

The content type for the model.

agmDescription :: Lens' ApiGatewayModel (Maybe (Val Text))

A description that identifies this model.

agmName :: Lens' ApiGatewayModel (Maybe (Val Text))

A name for the mode. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type. Important If you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.

agmRestApiId :: Lens' ApiGatewayModel (Val Text)

The ID of a REST API with which to associate this model.

agmSchema :: Lens' ApiGatewayModel (Maybe Object)

The schema to use to transform data to one or more output formats.