Stratosphere.Resources.ApiGatewayRestApi

The AWS::ApiGateway::RestApi resource contains a collection of Amazon API Gateway (API Gateway) resources and methods that can be invoked through HTTPS endpoints.

Documentation

data ApiGatewayRestApi

Full data type definition for ApiGatewayRestApi. See apiGatewayRestApi for a more convenient constructor.

Constructors

ApiGatewayRestApi

Fields

• _apiGatewayRestApiBody :: Maybe Object
• _apiGatewayRestApiBodyS3Location :: Maybe ApiGatewayRestApiS3Location
• _apiGatewayRestApiCloneFrom :: Maybe (Val Text)
• _apiGatewayRestApiDescription :: Maybe (Val Text)
• _apiGatewayRestApiFailOnWarnings :: Maybe (Val Bool')
• _apiGatewayRestApiName :: Val Text
• _apiGatewayRestApiParameters :: Maybe [Val Text]

Instances

Show ApiGatewayRestApi

Methods

showsPrec :: Int -> ApiGatewayRestApi -> ShowS

show :: ApiGatewayRestApi -> String

showList :: [ApiGatewayRestApi] -> ShowS

Generic ApiGatewayRestApi

Associated Types

type Rep ApiGatewayRestApi :: * -> *

Methods

from :: ApiGatewayRestApi -> Rep ApiGatewayRestApi x

to :: Rep ApiGatewayRestApi x -> ApiGatewayRestApi

ToJSON ApiGatewayRestApi

Methods

toJSON :: ApiGatewayRestApi -> Value

toEncoding :: ApiGatewayRestApi -> Encoding

toJSONList :: [ApiGatewayRestApi] -> Value

toEncodingList :: [ApiGatewayRestApi] -> Encoding

FromJSON ApiGatewayRestApi

Methods

parseJSON :: Value -> Parser ApiGatewayRestApi

parseJSONList :: Value -> Parser [ApiGatewayRestApi]

type Rep ApiGatewayRestApi

type Rep ApiGatewayRestApi = D1 (MetaData "ApiGatewayRestApi" "Stratosphere.Resources.ApiGatewayRestApi" "stratosphere-0.2.2-Fnop5S0NvsvBmp7LUeJWuv" False) (C1 (MetaCons "ApiGatewayRestApi" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayRestApiBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayRestApiBodyS3Location") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ApiGatewayRestApiS3Location))) (S1 (MetaSel (Just Symbol "_apiGatewayRestApiCloneFrom") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayRestApiDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_apiGatewayRestApiFailOnWarnings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool'))))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayRestApiName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) (S1 (MetaSel (Just Symbol "_apiGatewayRestApiParameters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Val Text])))))))

apiGatewayRestApi

Arguments

:: Val Text

agraName

-> ApiGatewayRestApi

Constructor for ApiGatewayRestApi containing required fields as arguments.

agraBody :: Lens' ApiGatewayRestApi (Maybe Object)

A Swagger specification that defines a set of RESTful APIs in the JSON format.

agraBodyS3Location :: Lens' ApiGatewayRestApi (Maybe ApiGatewayRestApiS3Location)

The Amazon Simple Storage Service (Amazon S3) location that points to a Swagger file, which defines a set of RESTful APIs in JSON or YAML format.

agraCloneFrom :: Lens' ApiGatewayRestApi (Maybe (Val Text))

The ID of the API Gateway RestApi resource that you want to clone.

agraDescription :: Lens' ApiGatewayRestApi (Maybe (Val Text))

A description of the purpose of this API Gateway RestApi resource.

agraFailOnWarnings :: Lens' ApiGatewayRestApi (Maybe (Val Bool'))

If a warning occurs while API Gateway is creating the RestApi resource, indicates whether to roll back the resource.

agraName :: Lens' ApiGatewayRestApi (Val Text)

A name for the API Gateway RestApi resource.

agraParameters :: Lens' ApiGatewayRestApi (Maybe [Val Text])

Custom header parameters for the request.