Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- data Stage = Stage' {
- lastDeploymentStatusMessage :: Maybe Text
- deploymentId :: Maybe Text
- routeSettings :: Maybe (HashMap Text RouteSettings)
- accessLogSettings :: Maybe AccessLogSettings
- clientCertificateId :: Maybe Text
- stageVariables :: Maybe (HashMap Text Text)
- autoDeploy :: Maybe Bool
- createdDate :: Maybe POSIX
- defaultRouteSettings :: Maybe RouteSettings
- apiGatewayManaged :: Maybe Bool
- lastUpdatedDate :: Maybe POSIX
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- stageName :: Text
- newStage :: Text -> Stage
- stage_lastDeploymentStatusMessage :: Lens' Stage (Maybe Text)
- stage_deploymentId :: Lens' Stage (Maybe Text)
- stage_routeSettings :: Lens' Stage (Maybe (HashMap Text RouteSettings))
- stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings)
- stage_clientCertificateId :: Lens' Stage (Maybe Text)
- stage_stageVariables :: Lens' Stage (Maybe (HashMap Text Text))
- stage_autoDeploy :: Lens' Stage (Maybe Bool)
- stage_createdDate :: Lens' Stage (Maybe UTCTime)
- stage_defaultRouteSettings :: Lens' Stage (Maybe RouteSettings)
- stage_apiGatewayManaged :: Lens' Stage (Maybe Bool)
- stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime)
- stage_description :: Lens' Stage (Maybe Text)
- stage_tags :: Lens' Stage (Maybe (HashMap Text Text))
- stage_stageName :: Lens' Stage Text
Documentation
Represents an API stage.
See: newStage
smart constructor.
Stage' | |
|
Instances
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_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.