Stratosphere.Resources.ApiGatewayStage

The AWS::ApiGateway::Stage resource creates a stage for an Amazon API Gateway (API Gateway) deployment.

Documentation

data ApiGatewayStage

Full data type definition for ApiGatewayStage. See apiGatewayStage for a more convenient constructor.

Constructors

ApiGatewayStage

Fields

• _apiGatewayStageCacheClusterEnabled :: Maybe (Val Bool')
• _apiGatewayStageCacheClusterSize :: Maybe (Val Text)
• _apiGatewayStageClientCertificateId :: Maybe (Val Text)
• _apiGatewayStageDeploymentId :: Val Text
• _apiGatewayStageDescription :: Maybe (Val Text)
• _apiGatewayStageMethodSettings :: Maybe [ApiGatewayStageMethodSetting]
• _apiGatewayStageRestApiId :: Val Text
• _apiGatewayStageStageName :: Val Text
• _apiGatewayStageVariables :: Maybe Object

Instances

Show ApiGatewayStage

Methods

showsPrec :: Int -> ApiGatewayStage -> ShowS

show :: ApiGatewayStage -> String

showList :: [ApiGatewayStage] -> ShowS

Generic ApiGatewayStage

Associated Types

type Rep ApiGatewayStage :: * -> *

Methods

from :: ApiGatewayStage -> Rep ApiGatewayStage x

to :: Rep ApiGatewayStage x -> ApiGatewayStage

ToJSON ApiGatewayStage

Methods

toJSON :: ApiGatewayStage -> Value

toEncoding :: ApiGatewayStage -> Encoding

toJSONList :: [ApiGatewayStage] -> Value

toEncodingList :: [ApiGatewayStage] -> Encoding

FromJSON ApiGatewayStage

Methods

parseJSON :: Value -> Parser ApiGatewayStage

parseJSONList :: Value -> Parser [ApiGatewayStage]

type Rep ApiGatewayStage

type Rep ApiGatewayStage = D1 (MetaData "ApiGatewayStage" "Stratosphere.Resources.ApiGatewayStage" "stratosphere-0.2.0-B1WeL9cnxuQ3qer3csMa6f" False) (C1 (MetaCons "ApiGatewayStage" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageCacheClusterEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))) (S1 (MetaSel (Just Symbol "_apiGatewayStageCacheClusterSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageClientCertificateId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_apiGatewayStageDeploymentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_apiGatewayStageMethodSettings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [ApiGatewayStageMethodSetting])))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageRestApiId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) ((:*:) (S1 (MetaSel (Just Symbol "_apiGatewayStageStageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) (S1 (MetaSel (Just Symbol "_apiGatewayStageVariables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object))))))))

apiGatewayStage

Arguments

:: Val Text

agsDeploymentId

-> Val Text

agsRestApiId

-> Val Text

agsStageName

-> ApiGatewayStage

Constructor for ApiGatewayStage containing required fields as arguments.

agsCacheClusterEnabled :: Lens' ApiGatewayStage (Maybe (Val Bool'))

Indicates whether cache clustering is enabled for the stage.

agsCacheClusterSize :: Lens' ApiGatewayStage (Maybe (Val Text))

The stage's cache cluster size.

agsClientCertificateId :: Lens' ApiGatewayStage (Maybe (Val Text))

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

agsDeploymentId :: Lens' ApiGatewayStage (Val Text)

The ID of the deployment that the stage points to.

agsDescription :: Lens' ApiGatewayStage (Maybe (Val Text))

A description of the stage's purpose.

agsMethodSettings :: Lens' ApiGatewayStage (Maybe [ApiGatewayStageMethodSetting])

Settings for all methods in the stage.

agsRestApiId :: Lens' ApiGatewayStage (Val Text)

The ID of the RestApi resource that you're deploying with this stage.

agsStageName :: Lens' ApiGatewayStage (Val Text)

The name of the stage, which API Gateway uses as the first path segment in the invoke Uniform Resource Identifier (URI).

agsVariables :: Lens' ApiGatewayStage (Maybe Object)

A map (string to string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.