| 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 |
Amazonka.ArcZonalShift
Description
Derived from API version 2022-10-30 of the AWS service descriptions, licensed under Apache 2.0.
This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about zonal shift API actions, data types, and errors.
Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.
Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting 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, reducing the impact and time lost from an issue in one zone.
Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts in Route 53 ARC are managed resources in Route 53 ARC. You can start a zonal shift for any managed resource in your account in a 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.
Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially. If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
For more information about using zonal shift, see the Amazon Route 53 Application Recovery Controller Developer Guide.
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
- data CancelZonalShift = CancelZonalShift' Text
- newCancelZonalShift :: Text -> CancelZonalShift
- data ZonalShift = ZonalShift' Text Text POSIX Text POSIX ZonalShiftStatus Text
- newZonalShift :: Text -> Text -> UTCTime -> Text -> UTCTime -> ZonalShiftStatus -> Text -> ZonalShift
- data GetManagedResource = GetManagedResource' Text
- newGetManagedResource :: Text -> GetManagedResource
- data GetManagedResourceResponse = GetManagedResourceResponse' (Maybe Text) (Maybe Text) Int (HashMap Text Double) [ZonalShiftInResource]
- newGetManagedResourceResponse :: Int -> GetManagedResourceResponse
- data ListManagedResources = ListManagedResources' (Maybe Natural) (Maybe Text)
- newListManagedResources :: ListManagedResources
- data ListManagedResourcesResponse = ListManagedResourcesResponse' (Maybe Text) Int [ManagedResourceSummary]
- newListManagedResourcesResponse :: Int -> ListManagedResourcesResponse
- data ListZonalShifts = ListZonalShifts' (Maybe Natural) (Maybe Text) (Maybe ZonalShiftStatus)
- newListZonalShifts :: ListZonalShifts
- data ListZonalShiftsResponse = ListZonalShiftsResponse' (Maybe [ZonalShiftSummary]) (Maybe Text) Int
- newListZonalShiftsResponse :: Int -> ListZonalShiftsResponse
- data StartZonalShift = StartZonalShift' Text Text Text Text
- newStartZonalShift :: Text -> Text -> Text -> Text -> StartZonalShift
- data ZonalShift = ZonalShift' Text Text POSIX Text POSIX ZonalShiftStatus Text
- newZonalShift :: Text -> Text -> UTCTime -> Text -> UTCTime -> ZonalShiftStatus -> Text -> ZonalShift
- data UpdateZonalShift = UpdateZonalShift' (Maybe Text) (Maybe Text) Text
- newUpdateZonalShift :: Text -> UpdateZonalShift
- data ZonalShift = ZonalShift' Text Text POSIX Text POSIX ZonalShiftStatus Text
- newZonalShift :: Text -> Text -> UTCTime -> Text -> UTCTime -> ZonalShiftStatus -> Text -> ZonalShift
- 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' (Maybe Text) (Maybe Text) [Text]
- newManagedResourceSummary :: ManagedResourceSummary
- data ZonalShift = ZonalShift' Text Text POSIX Text POSIX ZonalShiftStatus Text
- newZonalShift :: Text -> Text -> UTCTime -> Text -> UTCTime -> ZonalShiftStatus -> Text -> ZonalShift
- data ZonalShiftInResource = ZonalShiftInResource' AppliedStatus Text Text POSIX Text POSIX Text
- newZonalShiftInResource :: AppliedStatus -> Text -> Text -> UTCTime -> Text -> UTCTime -> Text -> ZonalShiftInResource
- data ZonalShiftSummary = ZonalShiftSummary' Text Text POSIX Text POSIX ZonalShiftStatus Text
- newZonalShiftSummary :: Text -> Text -> UTCTime -> Text -> UTCTime -> ZonalShiftStatus -> Text -> ZonalShiftSummary
Service Configuration
defaultService :: Service Source #
API version 2022-10-30 of the Amazon ARC - Zonal Shift SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ArcZonalShift.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request could not be processed because of conflict in the current state of the resource.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an internal server error.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The input requested a resource that was not found.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelZonalShift
data CancelZonalShift Source #
See: newCancelZonalShift smart constructor.
Constructors
| CancelZonalShift' Text |
Instances
Arguments
| :: Text | |
| -> CancelZonalShift |
Create a value of CancelZonalShift 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:
CancelZonalShift, cancelZonalShift_zonalShiftId - The internally-generated identifier of a zonal shift.
data ZonalShift Source #
See: newZonalShift smart constructor.
Constructors
| ZonalShift' Text Text POSIX Text POSIX ZonalShiftStatus Text |
Instances
Arguments
| :: 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.
GetManagedResource
data GetManagedResource Source #
See: newGetManagedResource smart constructor.
Constructors
| GetManagedResource' Text |
Instances
newGetManagedResource Source #
Arguments
| :: Text | |
| -> GetManagedResource |
Create a value of GetManagedResource 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:
GetManagedResource, getManagedResource_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.
data GetManagedResourceResponse Source #
See: newGetManagedResourceResponse smart constructor.
Constructors
| GetManagedResourceResponse' (Maybe Text) (Maybe Text) Int (HashMap Text Double) [ZonalShiftInResource] |
Instances
newGetManagedResourceResponse Source #
Create a value of GetManagedResourceResponse 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:
GetManagedResourceResponse, getManagedResourceResponse_arn - The Amazon Resource Name (ARN) for the resource.
GetManagedResourceResponse, getManagedResourceResponse_name - The name of the resource.
$sel:httpStatus:GetManagedResourceResponse', getManagedResourceResponse_httpStatus - The response's http status code.
$sel:appliedWeights:GetManagedResourceResponse', getManagedResourceResponse_appliedWeights - A collection of key-value pairs that indicate whether resources are
active in Availability Zones or not. The key name is the Availability
Zone where the resource is deployed. The value is 1 or 0.
$sel:zonalShifts:GetManagedResourceResponse', getManagedResourceResponse_zonalShifts - The zonal shifts that are currently active for a resource.
ListManagedResources (Paginated)
data ListManagedResources Source #
See: newListManagedResources smart constructor.
Constructors
| ListManagedResources' (Maybe Natural) (Maybe Text) |
Instances
newListManagedResources :: ListManagedResources Source #
Create a value of ListManagedResources 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:maxResults:ListManagedResources', listManagedResources_maxResults - The number of objects that you want to return with this call.
ListManagedResources, listManagedResources_nextToken - Specifies that you want to receive the next page of results. Valid only
if you received a NextToken response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to
request the next page of results.
data ListManagedResourcesResponse Source #
See: newListManagedResourcesResponse smart constructor.
Constructors
| ListManagedResourcesResponse' (Maybe Text) Int [ManagedResourceSummary] |
Instances
newListManagedResourcesResponse Source #
Create a value of ListManagedResourcesResponse 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:
ListManagedResources, listManagedResourcesResponse_nextToken - Specifies that you want to receive the next page of results. Valid only
if you received a NextToken response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to
request the next page of results.
$sel:httpStatus:ListManagedResourcesResponse', listManagedResourcesResponse_httpStatus - The response's http status code.
$sel:items:ListManagedResourcesResponse', listManagedResourcesResponse_items - The items in the response list.
ListZonalShifts (Paginated)
data ListZonalShifts Source #
See: newListZonalShifts smart constructor.
Constructors
| ListZonalShifts' (Maybe Natural) (Maybe Text) (Maybe ZonalShiftStatus) |
Instances
newListZonalShifts :: ListZonalShifts Source #
Create a value of ListZonalShifts 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:maxResults:ListZonalShifts', listZonalShifts_maxResults - The number of objects that you want to return with this call.
ListZonalShifts, listZonalShifts_nextToken - Specifies that you want to receive the next page of results. Valid only
if you received a NextToken response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to
request the next page of results.
ListZonalShifts, listZonalShifts_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.
data ListZonalShiftsResponse Source #
See: newListZonalShiftsResponse smart constructor.
Constructors
| ListZonalShiftsResponse' (Maybe [ZonalShiftSummary]) (Maybe Text) Int |
Instances
newListZonalShiftsResponse Source #
Create a value of ListZonalShiftsResponse 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:items:ListZonalShiftsResponse', listZonalShiftsResponse_items - The items in the response list.
ListZonalShifts, listZonalShiftsResponse_nextToken - Specifies that you want to receive the next page of results. Valid only
if you received a NextToken response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to
request the next page of results.
$sel:httpStatus:ListZonalShiftsResponse', listZonalShiftsResponse_httpStatus - The response's http status code.
StartZonalShift
data StartZonalShift Source #
See: newStartZonalShift smart constructor.
Constructors
| StartZonalShift' Text Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> StartZonalShift |
Create a value of StartZonalShift 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:
StartZonalShift, startZonalShift_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.
StartZonalShift, startZonalShift_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:expiresIn:StartZonalShift', startZonalShift_expiresIn - The length of time that you want a zonal shift to be active, which Route
53 ARC converts to an expiry time (expiration time). Zonal shifts are
temporary. You can set a zonal shift to be active initially for up to
three days (72 hours).
If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
<ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p>
StartZonalShift, startZonalShift_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.
data ZonalShift Source #
See: newZonalShift smart constructor.
Constructors
| ZonalShift' Text Text POSIX Text POSIX ZonalShiftStatus Text |
Instances
Arguments
| :: 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.
UpdateZonalShift
data UpdateZonalShift Source #
See: newUpdateZonalShift smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateZonalShift |
Create a value of UpdateZonalShift 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:
UpdateZonalShift, updateZonalShift_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:expiresIn:UpdateZonalShift', updateZonalShift_expiresIn - The length of time that you want a zonal shift to be active, which Route
53 ARC converts to an expiry time (expiration time). Zonal shifts are
temporary. You can set a zonal shift to be active initially for up to
three days (72 hours).
If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
- A lowercase letter m: To specify that the value is in minutes.
- A lowercase letter h: To specify that the value is in hours.
For example: 20h means the zonal shift expires in 20 hours. 120m
means the zonal shift expires in 120 minutes (2 hours).
UpdateZonalShift, updateZonalShift_zonalShiftId - The identifier of a zonal shift.
data ZonalShift Source #
See: newZonalShift smart constructor.
Constructors
| ZonalShift' Text Text POSIX Text POSIX ZonalShiftStatus Text |
Instances
Arguments
| :: 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.
Types
AppliedStatus
newtype AppliedStatus Source #
Constructors
| AppliedStatus' | |
Fields | |
Bundled Patterns
| pattern AppliedStatus_APPLIED :: AppliedStatus | |
| pattern AppliedStatus_NOT_APPLIED :: AppliedStatus |
Instances
ZonalShiftStatus
newtype ZonalShiftStatus Source #
Constructors
| ZonalShiftStatus' | |
Fields | |
Bundled Patterns
| 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.
ZonalShift
data ZonalShift Source #
See: newZonalShift smart constructor.
Constructors
| ZonalShift' Text Text POSIX Text POSIX ZonalShiftStatus Text |
Instances
Arguments
| :: 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.
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.
Constructors
| ZonalShiftInResource' AppliedStatus Text Text POSIX Text POSIX Text |
Instances
newZonalShiftInResource Source #
Arguments
| :: 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.
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.
Constructors
| ZonalShiftSummary' Text Text POSIX Text POSIX ZonalShiftStatus Text |
Instances
Arguments
| :: 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.