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 AwsApiGatewayV2StageDetails = AwsApiGatewayV2StageDetails' {
- lastDeploymentStatusMessage :: Maybe Text
- deploymentId :: Maybe Text
- routeSettings :: Maybe AwsApiGatewayV2RouteSettings
- accessLogSettings :: Maybe AwsApiGatewayAccessLogSettings
- clientCertificateId :: Maybe Text
- stageVariables :: Maybe (HashMap Text Text)
- autoDeploy :: Maybe Bool
- createdDate :: Maybe Text
- defaultRouteSettings :: Maybe AwsApiGatewayV2RouteSettings
- apiGatewayManaged :: Maybe Bool
- stageName :: Maybe Text
- lastUpdatedDate :: Maybe Text
- description :: Maybe Text
- newAwsApiGatewayV2StageDetails :: AwsApiGatewayV2StageDetails
- awsApiGatewayV2StageDetails_lastDeploymentStatusMessage :: Lens' AwsApiGatewayV2StageDetails (Maybe Text)
- awsApiGatewayV2StageDetails_deploymentId :: Lens' AwsApiGatewayV2StageDetails (Maybe Text)
- awsApiGatewayV2StageDetails_routeSettings :: Lens' AwsApiGatewayV2StageDetails (Maybe AwsApiGatewayV2RouteSettings)
- awsApiGatewayV2StageDetails_accessLogSettings :: Lens' AwsApiGatewayV2StageDetails (Maybe AwsApiGatewayAccessLogSettings)
- awsApiGatewayV2StageDetails_clientCertificateId :: Lens' AwsApiGatewayV2StageDetails (Maybe Text)
- awsApiGatewayV2StageDetails_stageVariables :: Lens' AwsApiGatewayV2StageDetails (Maybe (HashMap Text Text))
- awsApiGatewayV2StageDetails_autoDeploy :: Lens' AwsApiGatewayV2StageDetails (Maybe Bool)
- awsApiGatewayV2StageDetails_createdDate :: Lens' AwsApiGatewayV2StageDetails (Maybe Text)
- awsApiGatewayV2StageDetails_defaultRouteSettings :: Lens' AwsApiGatewayV2StageDetails (Maybe AwsApiGatewayV2RouteSettings)
- awsApiGatewayV2StageDetails_apiGatewayManaged :: Lens' AwsApiGatewayV2StageDetails (Maybe Bool)
- awsApiGatewayV2StageDetails_stageName :: Lens' AwsApiGatewayV2StageDetails (Maybe Text)
- awsApiGatewayV2StageDetails_lastUpdatedDate :: Lens' AwsApiGatewayV2StageDetails (Maybe Text)
- awsApiGatewayV2StageDetails_description :: Lens' AwsApiGatewayV2StageDetails (Maybe Text)
Documentation
data AwsApiGatewayV2StageDetails Source #
Contains information about a version 2 stage for Amazon API Gateway.
See: newAwsApiGatewayV2StageDetails
smart constructor.
AwsApiGatewayV2StageDetails' | |
|
Instances
newAwsApiGatewayV2StageDetails :: AwsApiGatewayV2StageDetails Source #
Create a value of AwsApiGatewayV2StageDetails
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:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_lastDeploymentStatusMessage
- The status of the last deployment of a stage. Supported only if the
stage has automatic deployment enabled.
$sel:deploymentId:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_deploymentId
- The identifier of the deployment that the stage is associated with.
$sel:routeSettings:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_routeSettings
- The route settings for the stage.
$sel:accessLogSettings:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_accessLogSettings
- Information about settings for logging access for the stage.
$sel:clientCertificateId:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_clientCertificateId
- The identifier of a client certificate for a stage. Supported only for
WebSocket API calls.
$sel:stageVariables:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_stageVariables
- A map that defines the stage variables for the stage.
Variable names can have alphanumeric and underscore characters.
Variable values can contain the following characters:
- Uppercase and lowercase letters
- Numbers
- Special characters -._~:/?#&=,
$sel:autoDeploy:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_autoDeploy
- Indicates whether updates to an API automatically trigger a new
deployment.
$sel:createdDate:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_createdDate
- Indicates when the stage was created.
Uses the date-time
format specified in
RFC 3339 section 5.6, Internet Date/Time Format.
The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z
.
$sel:defaultRouteSettings:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_defaultRouteSettings
- Default route settings for the stage.
$sel:apiGatewayManaged:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_apiGatewayManaged
- Indicates whether the stage is managed by API Gateway.
$sel:stageName:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_stageName
- The name of the stage.
$sel:lastUpdatedDate:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_lastUpdatedDate
- Indicates when the stage was most recently updated.
Uses the date-time
format specified in
RFC 3339 section 5.6, Internet Date/Time Format.
The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z
.
$sel:description:AwsApiGatewayV2StageDetails'
, awsApiGatewayV2StageDetails_description
- The description of the stage.
awsApiGatewayV2StageDetails_lastDeploymentStatusMessage :: Lens' AwsApiGatewayV2StageDetails (Maybe Text) Source #
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
awsApiGatewayV2StageDetails_deploymentId :: Lens' AwsApiGatewayV2StageDetails (Maybe Text) Source #
The identifier of the deployment that the stage is associated with.
awsApiGatewayV2StageDetails_routeSettings :: Lens' AwsApiGatewayV2StageDetails (Maybe AwsApiGatewayV2RouteSettings) Source #
The route settings for the stage.
awsApiGatewayV2StageDetails_accessLogSettings :: Lens' AwsApiGatewayV2StageDetails (Maybe AwsApiGatewayAccessLogSettings) Source #
Information about settings for logging access for the stage.
awsApiGatewayV2StageDetails_clientCertificateId :: Lens' AwsApiGatewayV2StageDetails (Maybe Text) Source #
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
awsApiGatewayV2StageDetails_stageVariables :: Lens' AwsApiGatewayV2StageDetails (Maybe (HashMap Text Text)) Source #
A map that defines the stage variables for the stage.
Variable names can have alphanumeric and underscore characters.
Variable values can contain the following characters:
- Uppercase and lowercase letters
- Numbers
- Special characters -._~:/?#&=,
awsApiGatewayV2StageDetails_autoDeploy :: Lens' AwsApiGatewayV2StageDetails (Maybe Bool) Source #
Indicates whether updates to an API automatically trigger a new deployment.
awsApiGatewayV2StageDetails_createdDate :: Lens' AwsApiGatewayV2StageDetails (Maybe Text) Source #
Indicates when the stage was created.
Uses the date-time
format specified in
RFC 3339 section 5.6, Internet Date/Time Format.
The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z
.
awsApiGatewayV2StageDetails_defaultRouteSettings :: Lens' AwsApiGatewayV2StageDetails (Maybe AwsApiGatewayV2RouteSettings) Source #
Default route settings for the stage.
awsApiGatewayV2StageDetails_apiGatewayManaged :: Lens' AwsApiGatewayV2StageDetails (Maybe Bool) Source #
Indicates whether the stage is managed by API Gateway.
awsApiGatewayV2StageDetails_stageName :: Lens' AwsApiGatewayV2StageDetails (Maybe Text) Source #
The name of the stage.
awsApiGatewayV2StageDetails_lastUpdatedDate :: Lens' AwsApiGatewayV2StageDetails (Maybe Text) Source #
Indicates when the stage was most recently updated.
Uses the date-time
format specified in
RFC 3339 section 5.6, Internet Date/Time Format.
The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z
.
awsApiGatewayV2StageDetails_description :: Lens' AwsApiGatewayV2StageDetails (Maybe Text) Source #
The description of the stage.