Stratosphere.Resources.ApiGatewayDeployment

The AWS::ApiGateway::Deployment resource deploys an Amazon API Gateway (API Gateway) RestApi resource to a stage so that clients can call the API over the Internet. The stage acts as an environment.

Documentation

data ApiGatewayDeployment

Full data type definition for ApiGatewayDeployment. See apiGatewayDeployment for a more convenient constructor.

Constructors

ApiGatewayDeployment

Fields

• _apiGatewayDeploymentDescription :: Maybe (Val Text)
• _apiGatewayDeploymentRestApiId :: Val Text
• _apiGatewayDeploymentStageDescription :: Maybe APIGatewayDeploymentStageDescription
• _apiGatewayDeploymentStageName :: Maybe (Val Text)

Instances

Show ApiGatewayDeployment

Methods

showsPrec :: Int -> ApiGatewayDeployment -> ShowS

show :: ApiGatewayDeployment -> String

showList :: [ApiGatewayDeployment] -> ShowS

Generic ApiGatewayDeployment

Associated Types

type Rep ApiGatewayDeployment :: * -> *

Methods

from :: ApiGatewayDeployment -> Rep ApiGatewayDeployment x

to :: Rep ApiGatewayDeployment x -> ApiGatewayDeployment

ToJSON ApiGatewayDeployment

Methods

toJSON :: ApiGatewayDeployment -> Value

toEncoding :: ApiGatewayDeployment -> Encoding

toJSONList :: [ApiGatewayDeployment] -> Value

toEncodingList :: [ApiGatewayDeployment] -> Encoding

FromJSON ApiGatewayDeployment

Methods

parseJSON :: Value -> Parser ApiGatewayDeployment

parseJSONList :: Value -> Parser [ApiGatewayDeployment]

type Rep ApiGatewayDeployment

type Rep ApiGatewayDeployment = D1 (MetaData "ApiGatewayDeployment" "Stratosphere.Resources.ApiGatewayDeployment" "stratosphere-0.2.0-B1WeL9cnxuQ3qer3csMa6f" False) (C1 (MetaCons "ApiGatewayDeployment" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayDeploymentDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_apiGatewayDeploymentRestApiId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayDeploymentStageDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe APIGatewayDeploymentStageDescription))) (S1 (MetaSel (Just Symbol "_apiGatewayDeploymentStageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))))))

apiGatewayDeployment

Arguments

:: Val Text

agdRestApiId

-> ApiGatewayDeployment

Constructor for ApiGatewayDeployment containing required fields as arguments.

agdDescription :: Lens' ApiGatewayDeployment (Maybe (Val Text))

A description of the purpose of the API Gateway deployment.

agdRestApiId :: Lens' ApiGatewayDeployment (Val Text)

The ID of the RestApi resource to deploy.

agdStageDescription :: Lens' ApiGatewayDeployment (Maybe APIGatewayDeploymentStageDescription)

Configures the stage that API Gateway creates with this deployment.

agdStageName :: Lens' ApiGatewayDeployment (Maybe (Val Text))

A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.