Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype AppliedStatus where
- AppliedStatus' { }
- pattern AppliedStatus_APPLIED :: AppliedStatus
- pattern AppliedStatus_NOT_APPLIED :: AppliedStatus
- newtype ZonalShiftStatus where
- ZonalShiftStatus' { }
- pattern ZonalShiftStatus_ACTIVE :: ZonalShiftStatus
- pattern ZonalShiftStatus_CANCELED :: ZonalShiftStatus
- pattern ZonalShiftStatus_EXPIRED :: ZonalShiftStatus
- data ManagedResourceSummary = ManagedResourceSummary' {}
- newManagedResourceSummary :: ManagedResourceSummary
- managedResourceSummary_arn :: Lens' ManagedResourceSummary (Maybe Text)
- managedResourceSummary_name :: Lens' ManagedResourceSummary (Maybe Text)
- managedResourceSummary_availabilityZones :: Lens' ManagedResourceSummary [Text]
- data ZonalShift = ZonalShift' {
- awayFrom :: Text
- comment :: Text
- expiryTime :: POSIX
- resourceIdentifier :: Text
- startTime :: POSIX
- status :: ZonalShiftStatus
- zonalShiftId :: Text
- newZonalShift :: Text -> Text -> UTCTime -> Text -> UTCTime -> ZonalShiftStatus -> Text -> ZonalShift
- zonalShift_awayFrom :: Lens' ZonalShift Text
- zonalShift_comment :: Lens' ZonalShift Text
- zonalShift_expiryTime :: Lens' ZonalShift UTCTime
- zonalShift_resourceIdentifier :: Lens' ZonalShift Text
- zonalShift_startTime :: Lens' ZonalShift UTCTime
- zonalShift_status :: Lens' ZonalShift ZonalShiftStatus
- zonalShift_zonalShiftId :: Lens' ZonalShift Text
- data ZonalShiftInResource = ZonalShiftInResource' {}
- newZonalShiftInResource :: AppliedStatus -> Text -> Text -> UTCTime -> Text -> UTCTime -> Text -> ZonalShiftInResource
- zonalShiftInResource_appliedStatus :: Lens' ZonalShiftInResource AppliedStatus
- zonalShiftInResource_awayFrom :: Lens' ZonalShiftInResource Text
- zonalShiftInResource_comment :: Lens' ZonalShiftInResource Text
- zonalShiftInResource_expiryTime :: Lens' ZonalShiftInResource UTCTime
- zonalShiftInResource_resourceIdentifier :: Lens' ZonalShiftInResource Text
- zonalShiftInResource_startTime :: Lens' ZonalShiftInResource UTCTime
- zonalShiftInResource_zonalShiftId :: Lens' ZonalShiftInResource Text
- data ZonalShiftSummary = ZonalShiftSummary' {
- awayFrom :: Text
- comment :: Text
- expiryTime :: POSIX
- resourceIdentifier :: Text
- startTime :: POSIX
- status :: ZonalShiftStatus
- zonalShiftId :: Text
- newZonalShiftSummary :: Text -> Text -> UTCTime -> Text -> UTCTime -> ZonalShiftStatus -> Text -> ZonalShiftSummary
- zonalShiftSummary_awayFrom :: Lens' ZonalShiftSummary Text
- zonalShiftSummary_comment :: Lens' ZonalShiftSummary Text
- zonalShiftSummary_expiryTime :: Lens' ZonalShiftSummary UTCTime
- zonalShiftSummary_resourceIdentifier :: Lens' ZonalShiftSummary Text
- zonalShiftSummary_startTime :: Lens' ZonalShiftSummary UTCTime
- zonalShiftSummary_status :: Lens' ZonalShiftSummary ZonalShiftStatus
- zonalShiftSummary_zonalShiftId :: Lens' ZonalShiftSummary Text
Service Configuration
defaultService :: Service Source #
API version 2022-10-30
of the Amazon ARC - Zonal Shift SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
The request could not be processed because of conflict in the current state of the resource.
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an internal server error.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The input requested a resource that was not found.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
AppliedStatus
newtype AppliedStatus Source #
pattern AppliedStatus_APPLIED :: AppliedStatus | |
pattern AppliedStatus_NOT_APPLIED :: AppliedStatus |
Instances
ZonalShiftStatus
newtype ZonalShiftStatus Source #
pattern ZonalShiftStatus_ACTIVE :: ZonalShiftStatus | |
pattern ZonalShiftStatus_CANCELED :: ZonalShiftStatus | |
pattern ZonalShiftStatus_EXPIRED :: ZonalShiftStatus |
Instances
ManagedResourceSummary
data ManagedResourceSummary Source #
A complex structure for a managed resource in an account.
A managed resource is a Network Load Balancer or Application Load Balancer that has been registered with Route 53 ARC by Elastic Load Balancing. You can start a zonal shift in Route 53 ARC for a managed resource to temporarily move traffic for the resource away from an Availability Zone in an AWS Region.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
See: newManagedResourceSummary
smart constructor.
Instances
newManagedResourceSummary :: ManagedResourceSummary Source #
Create a value of ManagedResourceSummary
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:arn:ManagedResourceSummary'
, managedResourceSummary_arn
- The Amazon Resource Name (ARN) for the managed resource.
$sel:name:ManagedResourceSummary'
, managedResourceSummary_name
- The name of the managed resource.
$sel:availabilityZones:ManagedResourceSummary'
, managedResourceSummary_availabilityZones
- The Availability Zones that a resource is deployed in.
managedResourceSummary_arn :: Lens' ManagedResourceSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) for the managed resource.
managedResourceSummary_name :: Lens' ManagedResourceSummary (Maybe Text) Source #
The name of the managed resource.
managedResourceSummary_availabilityZones :: Lens' ManagedResourceSummary [Text] Source #
The Availability Zones that a resource is deployed in.
ZonalShift
data ZonalShift Source #
See: newZonalShift
smart constructor.
ZonalShift' | |
|
Instances
:: Text | |
-> Text | |
-> UTCTime | |
-> Text | |
-> UTCTime | |
-> ZonalShiftStatus | |
-> Text | |
-> ZonalShift |
Create a value of ZonalShift
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:awayFrom:ZonalShift'
, zonalShift_awayFrom
- The Availability Zone that traffic is moved away from for a resource
when you start a zonal shift. Until the zonal shift expires or you
cancel it, traffic for the resource is instead moved to other
Availability Zones in the AWS Region.
$sel:comment:ZonalShift'
, zonalShift_comment
- A comment that you enter about the zonal shift. Only the latest comment
is retained; no comment history is maintained. A new comment overwrites
any existing comment string.
$sel:expiryTime:ZonalShift'
, zonalShift_expiryTime
- The expiry time (expiration time) for the zonal shift. A zonal shift is
temporary and must be set to expire when you start the zonal shift. You
can initially set a zonal shift to expire in a maximum of three days (72
hours). However, you can update a zonal shift to set a new expiration at
any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
$sel:resourceIdentifier:ZonalShift'
, zonalShift_resourceIdentifier
- The identifier for the resource to include in a zonal shift. The
identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
$sel:startTime:ZonalShift'
, zonalShift_startTime
- The time (UTC) when the zonal shift is started.
$sel:status:ZonalShift'
, zonalShift_status
- A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
- ACTIVE: The zonal shift is started and active.
- EXPIRED: The zonal shift has expired (the expiry time was exceeded).
- CANCELED: The zonal shift was canceled.
$sel:zonalShiftId:ZonalShift'
, zonalShift_zonalShiftId
- The identifier of a zonal shift.
zonalShift_awayFrom :: Lens' ZonalShift Text Source #
The Availability Zone that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.
zonalShift_comment :: Lens' ZonalShift Text Source #
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
zonalShift_expiryTime :: Lens' ZonalShift UTCTime Source #
The expiry time (expiration time) for the zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
zonalShift_resourceIdentifier :: Lens' ZonalShift Text Source #
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
zonalShift_startTime :: Lens' ZonalShift UTCTime Source #
The time (UTC) when the zonal shift is started.
zonalShift_status :: Lens' ZonalShift ZonalShiftStatus Source #
A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
- ACTIVE: The zonal shift is started and active.
- EXPIRED: The zonal shift has expired (the expiry time was exceeded).
- CANCELED: The zonal shift was canceled.
zonalShift_zonalShiftId :: Lens' ZonalShift Text Source #
The identifier of a zonal shift.
ZonalShiftInResource
data ZonalShiftInResource Source #
A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
See: newZonalShiftInResource
smart constructor.
ZonalShiftInResource' | |
|
Instances
newZonalShiftInResource Source #
:: AppliedStatus | |
-> Text | |
-> Text | |
-> UTCTime | |
-> Text | |
-> UTCTime | |
-> Text | |
-> ZonalShiftInResource |
Create a value of ZonalShiftInResource
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:appliedStatus:ZonalShiftInResource'
, zonalShiftInResource_appliedStatus
- An appliedStatus
for a zonal shift for a resource can have one of two
values: APPLIED
or NOT_APPLIED
.
$sel:awayFrom:ZonalShiftInResource'
, zonalShiftInResource_awayFrom
- The Availability Zone that traffic is moved away from for a resource
when you start a zonal shift. Until the zonal shift expires or you
cancel it, traffic for the resource is instead moved to other
Availability Zones in the AWS Region.
$sel:comment:ZonalShiftInResource'
, zonalShiftInResource_comment
- A comment that you enter about the zonal shift. Only the latest comment
is retained; no comment history is maintained. That is, a new comment
overwrites any existing comment string.
$sel:expiryTime:ZonalShiftInResource'
, zonalShiftInResource_expiryTime
- The expiry time (expiration time) for the zonal shift. A zonal shift is
temporary and must be set to expire when you start the zonal shift. You
can initially set a zonal shift to expire in a maximum of three days (72
hours). However, you can update a zonal shift to set a new expiration at
any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
$sel:resourceIdentifier:ZonalShiftInResource'
, zonalShiftInResource_resourceIdentifier
- The identifier for the resource to include in a zonal shift. The
identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
$sel:startTime:ZonalShiftInResource'
, zonalShiftInResource_startTime
- The time (UTC) when the zonal shift is started.
$sel:zonalShiftId:ZonalShiftInResource'
, zonalShiftInResource_zonalShiftId
- The identifier of a zonal shift.
zonalShiftInResource_appliedStatus :: Lens' ZonalShiftInResource AppliedStatus Source #
An appliedStatus
for a zonal shift for a resource can have one of two
values: APPLIED
or NOT_APPLIED
.
zonalShiftInResource_awayFrom :: Lens' ZonalShiftInResource Text Source #
The Availability Zone that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.
zonalShiftInResource_comment :: Lens' ZonalShiftInResource Text Source #
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
zonalShiftInResource_expiryTime :: Lens' ZonalShiftInResource UTCTime Source #
The expiry time (expiration time) for the zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
zonalShiftInResource_resourceIdentifier :: Lens' ZonalShiftInResource Text Source #
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
zonalShiftInResource_startTime :: Lens' ZonalShiftInResource UTCTime Source #
The time (UTC) when the zonal shift is started.
zonalShiftInResource_zonalShiftId :: Lens' ZonalShiftInResource Text Source #
The identifier of a zonal shift.
ZonalShiftSummary
data ZonalShiftSummary Source #
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region. A zonal shift helps your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Supported AWS resources are automatically registered with Route 53 ARC.
Zonal shifts are temporary. A zonal shift can be active for up to three days (72 hours).
When you start a zonal shift, you specify how long you want it to be active, which Amazon Route 53 Application Recovery Controller converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can extend the zonal shift by updating the expiration so the zonal shift is active longer.
See: newZonalShiftSummary
smart constructor.
ZonalShiftSummary' | |
|
Instances
:: Text | |
-> Text | |
-> UTCTime | |
-> Text | |
-> UTCTime | |
-> ZonalShiftStatus | |
-> Text | |
-> ZonalShiftSummary |
Create a value of ZonalShiftSummary
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:awayFrom:ZonalShiftSummary'
, zonalShiftSummary_awayFrom
- The Availability Zone that traffic is moved away from for a resource
when you start a zonal shift. Until the zonal shift expires or you
cancel it, traffic for the resource is instead moved to other
Availability Zones in the AWS Region.
$sel:comment:ZonalShiftSummary'
, zonalShiftSummary_comment
- A comment that you enter about the zonal shift. Only the latest comment
is retained; no comment history is maintained. That is, a new comment
overwrites any existing comment string.
$sel:expiryTime:ZonalShiftSummary'
, zonalShiftSummary_expiryTime
- The expiry time (expiration time) for the zonal shift. A zonal shift is
temporary and must be set to expire when you start the zonal shift. You
can initially set a zonal shift to expire in a maximum of three days (72
hours). However, you can update a zonal shift to set a new expiration at
any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
$sel:resourceIdentifier:ZonalShiftSummary'
, zonalShiftSummary_resourceIdentifier
- The identifier for the resource to include in a zonal shift. The
identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
$sel:startTime:ZonalShiftSummary'
, zonalShiftSummary_startTime
- The time (UTC) when the zonal shift is started.
$sel:status:ZonalShiftSummary'
, zonalShiftSummary_status
- A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
- ACTIVE: The zonal shift is started and active.
- EXPIRED: The zonal shift has expired (the expiry time was exceeded).
- CANCELED: The zonal shift was canceled.
$sel:zonalShiftId:ZonalShiftSummary'
, zonalShiftSummary_zonalShiftId
- The identifier of a zonal shift.
zonalShiftSummary_awayFrom :: Lens' ZonalShiftSummary Text Source #
The Availability Zone that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.
zonalShiftSummary_comment :: Lens' ZonalShiftSummary Text Source #
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
zonalShiftSummary_expiryTime :: Lens' ZonalShiftSummary UTCTime Source #
The expiry time (expiration time) for the zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
zonalShiftSummary_resourceIdentifier :: Lens' ZonalShiftSummary Text Source #
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
zonalShiftSummary_startTime :: Lens' ZonalShiftSummary UTCTime Source #
The time (UTC) when the zonal shift is started.
zonalShiftSummary_status :: Lens' ZonalShiftSummary ZonalShiftStatus Source #
A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
- ACTIVE: The zonal shift is started and active.
- EXPIRED: The zonal shift has expired (the expiry time was exceeded).
- CANCELED: The zonal shift was canceled.
zonalShiftSummary_zonalShiftId :: Lens' ZonalShiftSummary Text Source #
The identifier of a zonal shift.