libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ApiGatewayV2.Types.Stage

Description

 
Synopsis

Documentation

data Stage Source #

Represents an API stage.

See: newStage smart constructor.

Constructors

Stage' 

Fields

Instances

Instances details
Eq Stage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.Types.Stage

Methods

(==) :: Stage -> Stage -> Bool #

(/=) :: Stage -> Stage -> Bool #

Read Stage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.Types.Stage

Show Stage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.Types.Stage

Methods

showsPrec :: Int -> Stage -> ShowS #

show :: Stage -> String #

showList :: [Stage] -> ShowS #

Generic Stage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.Types.Stage

Associated Types

type Rep Stage :: Type -> Type #

Methods

from :: Stage -> Rep Stage x #

to :: Rep Stage x -> Stage #

NFData Stage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.Types.Stage

Methods

rnf :: Stage -> () #

Hashable Stage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.Types.Stage

Methods

hashWithSalt :: Int -> Stage -> Int #

hash :: Stage -> Int #

FromJSON Stage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.Types.Stage

type Rep Stage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.Types.Stage

type Rep Stage = D1 ('MetaData "Stage" "Amazonka.ApiGatewayV2.Types.Stage" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "Stage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastDeploymentStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "routeSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RouteSettings))))) :*: ((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :*: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "autoDeploy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "defaultRouteSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteSettings)) :*: S1 ('MetaSel ('Just "apiGatewayManaged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newStage Source #

Create a value of Stage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lastDeploymentStatusMessage:Stage', stage_lastDeploymentStatusMessage - Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

$sel:deploymentId:Stage', stage_deploymentId - The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

$sel:routeSettings:Stage', stage_routeSettings - Route settings for the stage, by routeKey.

$sel:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.

$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

$sel:stageVariables:Stage', stage_stageVariables - A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

$sel:autoDeploy:Stage', stage_autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.

$sel:defaultRouteSettings:Stage', stage_defaultRouteSettings - Default route settings for the stage.

$sel:apiGatewayManaged:Stage', stage_apiGatewayManaged - Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage was last updated.

$sel:description:Stage', stage_description - The description of the stage.

$sel:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:stageName:Stage', stage_stageName - The name of the stage.

stage_lastDeploymentStatusMessage :: Lens' Stage (Maybe Text) Source #

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

stage_deploymentId :: Lens' Stage (Maybe Text) Source #

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

stage_routeSettings :: Lens' Stage (Maybe (HashMap Text RouteSettings)) Source #

Route settings for the stage, by routeKey.

stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

stage_stageVariables :: Lens' Stage (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

stage_autoDeploy :: Lens' Stage (Maybe Bool) Source #

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

stage_createdDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage was created.

stage_defaultRouteSettings :: Lens' Stage (Maybe RouteSettings) Source #

Default route settings for the stage.

stage_apiGatewayManaged :: Lens' Stage (Maybe Bool) Source #

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage was last updated.

stage_description :: Lens' Stage (Maybe Text) Source #

The description of the stage.

stage_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

stage_stageName :: Lens' Stage Text Source #

The name of the stage.