Stratosphere.ResourceProperties.APIGatewayDeploymentStageDescription

StageDescription is a property of the AWS::ApiGateway::Deployment resource that configures an Amazon API Gateway (API Gateway) deployment stage.

Documentation

data APIGatewayDeploymentStageDescription

Full data type definition for APIGatewayDeploymentStageDescription. See apiGatewayDeploymentStageDescription for a more convenient constructor.

Constructors

APIGatewayDeploymentStageDescription

Fields

• _aPIGatewayDeploymentStageDescriptionCacheClusterEnabled :: Maybe (Val Bool')
• _aPIGatewayDeploymentStageDescriptionCacheClusterSize :: Maybe (Val Text)
• _aPIGatewayDeploymentStageDescriptionCacheDataEncrypted :: Maybe (Val Bool')
• _aPIGatewayDeploymentStageDescriptionCacheTtlInSeconds :: Maybe (Val Integer')
• _aPIGatewayDeploymentStageDescriptionCachingEnabled :: Maybe (Val Bool')
• _aPIGatewayDeploymentStageDescriptionClientCertificateId :: Maybe (Val Text)
• _aPIGatewayDeploymentStageDescriptionDataTraceEnabled :: Maybe (Val Bool')
• _aPIGatewayDeploymentStageDescriptionDescription :: Maybe (Val Text)
• _aPIGatewayDeploymentStageDescriptionLoggingLevel :: Maybe (Val Text)
• _aPIGatewayDeploymentStageDescriptionMethodSettings :: Maybe APIGatewayDeploymentStageDescriptionMethodSetting
• _aPIGatewayDeploymentStageDescriptionMetricsEnabled :: Maybe (Val Bool')
• _aPIGatewayDeploymentStageDescriptionStageName :: Maybe (Val Text)
• _aPIGatewayDeploymentStageDescriptionThrottlingBurstLimit :: Maybe (Val Integer')
• _aPIGatewayDeploymentStageDescriptionThrottlingRateLimit :: Maybe Double'
• _aPIGatewayDeploymentStageDescriptionVariables :: Maybe Object

Instances

Show APIGatewayDeploymentStageDescription

Methods

showsPrec :: Int -> APIGatewayDeploymentStageDescription -> ShowS

show :: APIGatewayDeploymentStageDescription -> String

showList :: [APIGatewayDeploymentStageDescription] -> ShowS

Generic APIGatewayDeploymentStageDescription

Associated Types

type Rep APIGatewayDeploymentStageDescription :: * -> *

Methods

from :: APIGatewayDeploymentStageDescription -> Rep APIGatewayDeploymentStageDescription x

to :: Rep APIGatewayDeploymentStageDescription x -> APIGatewayDeploymentStageDescription

ToJSON APIGatewayDeploymentStageDescription

Methods

toJSON :: APIGatewayDeploymentStageDescription -> Value

toEncoding :: APIGatewayDeploymentStageDescription -> Encoding

toJSONList :: [APIGatewayDeploymentStageDescription] -> Value

toEncodingList :: [APIGatewayDeploymentStageDescription] -> Encoding

FromJSON APIGatewayDeploymentStageDescription

Methods

parseJSON :: Value -> Parser APIGatewayDeploymentStageDescription

parseJSONList :: Value -> Parser [APIGatewayDeploymentStageDescription]

type Rep APIGatewayDeploymentStageDescription

type Rep APIGatewayDeploymentStageDescription = D1 (MetaData "APIGatewayDeploymentStageDescription" "Stratosphere.ResourceProperties.APIGatewayDeploymentStageDescription" "stratosphere-0.2.0-B1WeL9cnxuQ3qer3csMa6f" False) (C1 (MetaCons "APIGatewayDeploymentStageDescription" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionCacheClusterEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))) ((:*:) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionCacheClusterSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionCacheDataEncrypted") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionCacheTtlInSeconds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer')))) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionCachingEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool'))))) ((:*:) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionClientCertificateId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionDataTraceEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool'))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionLoggingLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionMethodSettings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe APIGatewayDeploymentStageDescriptionMethodSetting))) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionMetricsEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionStageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionThrottlingBurstLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer'))))) ((:*:) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionThrottlingRateLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Double'))) (S1 (MetaSel (Just Symbol "_aPIGatewayDeploymentStageDescriptionVariables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object))))))))

apiGatewayDeploymentStageDescription :: APIGatewayDeploymentStageDescription

Constructor for APIGatewayDeploymentStageDescription containing required fields as arguments.

apigdsdCacheClusterEnabled :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Bool'))

Indicates whether cache clustering is enabled for the stage.

apigdsdCacheClusterSize :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Text))

The size of the stage's cache cluster.

apigdsdCacheDataEncrypted :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Bool'))

Indicates whether the cached responses are encrypted.

apigdsdCacheTtlInSeconds :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Integer'))

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

apigdsdCachingEnabled :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Bool'))

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.

apigdsdClientCertificateId :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Text))

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

apigdsdDataTraceEnabled :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Bool'))

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

apigdsdDescription :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Text))

A description of the purpose of the stage.

apigdsdLoggingLevel :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Text))

The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

apigdsdMethodSettings :: Lens' APIGatewayDeploymentStageDescription (Maybe APIGatewayDeploymentStageDescriptionMethodSetting)

Configures settings for all of the stage's methods.

apigdsdMetricsEnabled :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Bool'))

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

apigdsdStageName :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Text))

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

apigdsdThrottlingBurstLimit :: Lens' APIGatewayDeploymentStageDescription (Maybe (Val Integer'))

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.

apigdsdThrottlingRateLimit :: Lens' APIGatewayDeploymentStageDescription (Maybe Double')

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.

apigdsdVariables :: Lens' APIGatewayDeploymentStageDescription (Maybe Object)

A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.