AWS ARC - Zonal Shift 2022-10-30
- Client: Aws\ARCZonalShift\ARCZonalShiftClient
- Service ID: arc-zonal-shift
- Version: 2022-10-30
This page describes the parameters and results for the operations of the AWS ARC - Zonal Shift (2022-10-30), and shows how to use the Aws\ARCZonalShift\ARCZonalShiftClient object to call the described operations. This documentation is specific to the 2022-10-30 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CancelZonalShift ( array $params = [] )
Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.
- GetManagedResource ( array $params = [] )
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region.
- ListManagedResources ( array $params = [] )
Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
- ListZonalShifts ( array $params = [] )
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
- StartZonalShift ( array $params = [] )
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone.
- UpdateZonalShift ( array $params = [] )
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CancelZonalShift
$result = $client->cancelZonalShift([/* ... */]); $promise = $client->cancelZonalShiftAsync([/* ... */]);
Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.
Parameter Syntax
$result = $client->cancelZonalShift([
'zonalShiftId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- zonalShiftId
-
- Required: Yes
- Type: string
The internally-generated identifier of a zonal shift.
Result Syntax
[
'awayFrom' => '<string>',
'comment' => '<string>',
'expiryTime' => <DateTime>,
'resourceIdentifier' => '<string>',
'startTime' => <DateTime>,
'status' => 'ACTIVE|EXPIRED|CANCELED',
'zonalShiftId' => '<string>',
]
Result Details
Members
- awayFrom
-
- Required: Yes
- Type: string
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.
- comment
-
- Required: Yes
- Type: string
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.
- expiryTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- resourceIdentifier
-
- Required: Yes
- Type: string
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.
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time (UTC) when the zonal shift is started.
- status
-
- Required: Yes
- Type: string
A status for a zonal shift.
The
Statusfor 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.
- zonalShiftId
-
- Required: Yes
- Type: string
The identifier of a zonal shift.
Errors
-
There was an internal server error.
-
The request could not be processed because of conflict in the current state of the resource.
-
The input requested a resource that was not found.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
GetManagedResource
$result = $client->getManagedResource([/* ... */]); $promise = $client->getManagedResourceAsync([/* ... */]);
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC.
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.
Parameter Syntax
$result = $client->getManagedResource([
'resourceIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceIdentifier
-
- Required: Yes
- Type: string
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.
Result Syntax
[
'appliedWeights' => [<float>, ...],
'arn' => '<string>',
'name' => '<string>',
'zonalShifts' => [
[
'appliedStatus' => 'APPLIED|NOT_APPLIED',
'awayFrom' => '<string>',
'comment' => '<string>',
'expiryTime' => <DateTime>,
'resourceIdentifier' => '<string>',
'startTime' => <DateTime>,
'zonalShiftId' => '<string>',
],
// ...
],
]
Result Details
Members
- appliedWeights
-
- Required: Yes
- Type: Associative array of custom strings keys (AvailabilityZone) to floats
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.
- arn
-
- Type: string
The Amazon Resource Name (ARN) for the resource.
- name
-
- Type: string
The name of the resource.
- zonalShifts
-
- Required: Yes
- Type: Array of ZonalShiftInResource structures
The zonal shifts that are currently active for a resource.
Errors
-
There was an internal server error.
-
The input requested a resource that was not found.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
ListManagedResources
$result = $client->listManagedResources([/* ... */]); $promise = $client->listManagedResourcesAsync([/* ... */]);
Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and the resource name.
Parameter Syntax
$result = $client->listManagedResources([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The number of objects that you want to return with this call.
- nextToken
-
- Type: string
Specifies that you want to receive the next page of results. Valid only if you received a
NextTokenresponse 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'sNextTokenresponse to request the next page of results.
Result Syntax
[
'items' => [
[
'arn' => '<string>',
'availabilityZones' => ['<string>', ...],
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of ManagedResourceSummary structures
The items in the response list.
- nextToken
-
- Type: string
Specifies that you want to receive the next page of results. Valid only if you received a
NextTokenresponse 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'sNextTokenresponse to request the next page of results.
Errors
-
There was an internal server error.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
ListZonalShifts
$result = $client->listZonalShifts([/* ... */]); $promise = $client->listZonalShiftsAsync([/* ... */]);
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
Parameter Syntax
$result = $client->listZonalShifts([
'maxResults' => <integer>,
'nextToken' => '<string>',
'status' => 'ACTIVE|EXPIRED|CANCELED',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The number of objects that you want to return with this call.
- nextToken
-
- Type: string
Specifies that you want to receive the next page of results. Valid only if you received a
NextTokenresponse 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'sNextTokenresponse to request the next page of results. - status
-
- Type: string
A status for a zonal shift.
The
Statusfor 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.
Result Syntax
[
'items' => [
[
'awayFrom' => '<string>',
'comment' => '<string>',
'expiryTime' => <DateTime>,
'resourceIdentifier' => '<string>',
'startTime' => <DateTime>,
'status' => 'ACTIVE|EXPIRED|CANCELED',
'zonalShiftId' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of ZonalShiftSummary structures
The items in the response list.
- nextToken
-
- Type: string
Specifies that you want to receive the next page of results. Valid only if you received a
NextTokenresponse 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'sNextTokenresponse to request the next page of results.
Errors
-
There was an internal server error.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
StartZonalShift
$result = $client->startZonalShift([/* ... */]); $promise = $client->startZonalShiftAsync([/* ... */]);
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help 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. Resources are automatically registered with Route 53 ARC by AWS services.
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.
When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.
For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.
Parameter Syntax
$result = $client->startZonalShift([
'awayFrom' => '<string>', // REQUIRED
'comment' => '<string>', // REQUIRED
'expiresIn' => '<string>', // REQUIRED
'resourceIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- awayFrom
-
- Required: Yes
- Type: string
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.
- comment
-
- Required: Yes
- Type: string
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.
- expiresIn
-
- Required: Yes
- Type: string
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> - resourceIdentifier
-
- Required: Yes
- Type: string
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.
Result Syntax
[
'awayFrom' => '<string>',
'comment' => '<string>',
'expiryTime' => <DateTime>,
'resourceIdentifier' => '<string>',
'startTime' => <DateTime>,
'status' => 'ACTIVE|EXPIRED|CANCELED',
'zonalShiftId' => '<string>',
]
Result Details
Members
- awayFrom
-
- Required: Yes
- Type: string
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.
- comment
-
- Required: Yes
- Type: string
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.
- expiryTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- resourceIdentifier
-
- Required: Yes
- Type: string
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.
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time (UTC) when the zonal shift is started.
- status
-
- Required: Yes
- Type: string
A status for a zonal shift.
The
Statusfor 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.
- zonalShiftId
-
- Required: Yes
- Type: string
The identifier of a zonal shift.
Errors
-
There was an internal server error.
-
The request could not be processed because of conflict in the current state of the resource.
-
The input requested a resource that was not found.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
UpdateZonalShift
$result = $client->updateZonalShift([/* ... */]); $promise = $client->updateZonalShiftAsync([/* ... */]);
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
Parameter Syntax
$result = $client->updateZonalShift([
'comment' => '<string>',
'expiresIn' => '<string>',
'zonalShiftId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- comment
-
- Type: string
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.
- expiresIn
-
- Type: string
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:
20hmeans the zonal shift expires in 20 hours.120mmeans the zonal shift expires in 120 minutes (2 hours). - zonalShiftId
-
- Required: Yes
- Type: string
The identifier of a zonal shift.
Result Syntax
[
'awayFrom' => '<string>',
'comment' => '<string>',
'expiryTime' => <DateTime>,
'resourceIdentifier' => '<string>',
'startTime' => <DateTime>,
'status' => 'ACTIVE|EXPIRED|CANCELED',
'zonalShiftId' => '<string>',
]
Result Details
Members
- awayFrom
-
- Required: Yes
- Type: string
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.
- comment
-
- Required: Yes
- Type: string
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.
- expiryTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- resourceIdentifier
-
- Required: Yes
- Type: string
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.
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time (UTC) when the zonal shift is started.
- status
-
- Required: Yes
- Type: string
A status for a zonal shift.
The
Statusfor 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.
- zonalShiftId
-
- Required: Yes
- Type: string
The identifier of a zonal shift.
Errors
-
There was an internal server error.
-
The request could not be processed because of conflict in the current state of the resource.
-
The input requested a resource that was not found.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- message
-
- Type: string
ConflictException
Description
The request could not be processed because of conflict in the current state of the resource.
Members
- message
-
- Required: Yes
- Type: string
- reason
-
- Required: Yes
- Type: string
The reason for the conflict exception.
- zonalShiftId
-
- Type: string
The zonal shift ID associated with the conflict exception.
InternalServerException
Description
There was an internal server error.
Members
- message
-
- Type: string
ManagedResourceSummary
Description
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.
Members
- arn
-
- Type: string
The Amazon Resource Name (ARN) for the managed resource.
- availabilityZones
-
- Required: Yes
- Type: Array of strings
The Availability Zones that a resource is deployed in.
- name
-
- Type: string
The name of the managed resource.
ResourceNotFoundException
Description
The input requested a resource that was not found.
Members
- message
-
- Required: Yes
- Type: string
ThrottlingException
Description
The request was denied due to request throttling.
Members
- message
-
- Type: string
ValidationException
Description
The input fails to satisfy the constraints specified by an AWS service.
Members
- message
-
- Required: Yes
- Type: string
- reason
-
- Required: Yes
- Type: string
The reason for the validation exception.
ZonalShiftInResource
Description
A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
Members
- appliedStatus
-
- Required: Yes
- Type: string
An
appliedStatusfor a zonal shift for a resource can have one of two values:APPLIEDorNOT_APPLIED. - awayFrom
-
- Required: Yes
- Type: string
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.
- comment
-
- Required: Yes
- Type: string
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.
- expiryTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- resourceIdentifier
-
- Required: Yes
- Type: string
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.
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time (UTC) when the zonal shift is started.
- zonalShiftId
-
- Required: Yes
- Type: string
The identifier of a zonal shift.
ZonalShiftSummary
Description
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.
Members
- awayFrom
-
- Required: Yes
- Type: string
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.
- comment
-
- Required: Yes
- Type: string
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.
- expiryTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- resourceIdentifier
-
- Required: Yes
- Type: string
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.
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time (UTC) when the zonal shift is started.
- status
-
- Required: Yes
- Type: string
A status for a zonal shift.
The
Statusfor 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.
- zonalShiftId
-
- Required: Yes
- Type: string
The identifier of a zonal shift.