String appliedStatus
The appliedStatus field specifies which application traffic shift is in effect for a resource when
there is more than one traffic shift active. There can be more than one application traffic shift in progress at
the same time - that is, practice run zonal shifts, customer-started zonal shifts, or an autoshift. The
appliedStatus field for an autoshift for a resource can have one of two values: APPLIED
or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an
applied status set to APPLIED.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-started zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
String awayFrom
The Availability Zone that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.
Date startTime
The time (UTC) when the autoshift started.
String awayFrom
The Availability Zone that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. Until the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region. An autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when you disable zonal autoshift for the resource.
Date endTime
The time (in UTC) when the autoshift ended.
Date startTime
The time (in UTC) when the autoshift started.
String status
The status for an autoshift.
String zonalShiftId
The internally-generated identifier of a zonal shift.
String 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 Amazon Web Services Region.
String 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.
Date expiryTime
The expiry time (expiration time) for a customer-started 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 when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
String resourceIdentifier
The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
Date startTime
The time (UTC) when the zonal shift starts.
String status
A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
String zonalShiftId
The identifier of a zonal shift.
List<E> blockedDates
Optionally, you can block Route 53 ARC from starting practice runs for a resource on specific calendar dates.
The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.
For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice
runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
List<E> blockedWindows
Optionally, you can block Route 53 ARC from starting practice runs for specific windows of days and times.
The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.
For example, say you run business report summaries three days a week. For this scenario, you might set the
following recurring days and times as blocked windows, for example:
MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
List<E> blockingAlarms
An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks Route 53 ARC
from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an
ALARM state.
List<E> outcomeAlarms
The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a
practice run when the alarm is in an ALARM state.
Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability
Zone during each weekly practice run. You should configure the alarm to go into an ALARM state if
your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the
resource return to the Availability Zone.
String resourceIdentifier
The identifier of the resource to shift away traffic for when a practice run starts a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
String arn
The Amazon Resource Name (ARN) of the resource that you configured the practice run for.
String name
The name of the resource that you configured the practice run for.
PracticeRunConfiguration practiceRunConfiguration
A practice run configuration for a resource. Configurations include the outcome alarm that you specify for practice runs, and, optionally, a blocking alarm and blocking dates and windows.
String zonalAutoshiftStatus
The status for zonal autoshift for a resource. When you specify the autoshift status as ENABLED,
Amazon Web Services shifts traffic away from shifts away application resource traffic from an Availability Zone,
on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could
potentially affect customers.
When you enable zonal autoshift, you must also configure practice runs for the resource.
String resourceIdentifier
The identifier for the resource that you want to delete the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
String resourceIdentifier
The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
Map<K,V> 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.
String arn
The Amazon Resource Name (ARN) for the resource.
List<E> autoshifts
An array of the autoshifts that are active for the resource.
String name
The name of the resource.
PracticeRunConfiguration practiceRunConfiguration
The practice run configuration for zonal autoshift that's associated with the resource.
String zonalAutoshiftStatus
The status for zonal autoshift for a resource. When the autoshift status is ENABLED, Amazon Web
Services shifts traffic for a resource away from an Availability Zone, on your behalf, when Amazon Web Services
determines that there's an issue in the Availability Zone that could potentially affect customers.
List<E> zonalShifts
The zonal shifts that are currently active for a resource.
Integer maxResults
The number of objects that you want to return with this call.
String 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.
String status
The status of the autoshift.
List<E> items
The items in the response list.
String 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.
Integer maxResults
The number of objects that you want to return with this call.
String 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.
List<E> items
The items in the response list.
String 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.
Integer maxResults
The number of objects that you want to return with this call.
String 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.
String resourceIdentifier
The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource.
String status
A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
List<E> items
The items in the response list.
String 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.
Map<K,V> 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.
String arn
The Amazon Resource Name (ARN) for the managed resource.
List<E> autoshifts
An array of the autoshifts that have been completed for a resource.
List<E> availabilityZones
The Availability Zones that a resource is deployed in.
String name
The name of the managed resource.
String practiceRunStatus
This status tracks whether a practice run configuration exists for a resource. When you configure a practice run
for a resource so that a practice run configuration exists, Route 53 ARC sets this value to ENABLED.
If a you have not configured a practice run for the resource, or delete a practice run configuration, Route 53
ARC sets the value to DISABLED.
Route 53 ARC updates this status; you can't set a practice run status to ENABLED or
DISABLED.
String zonalAutoshiftStatus
The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value
of the status to ENABLED or DISABLED.
List<E> zonalShifts
An array of the zonal shifts for a resource.
List<E> blockedDates
An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.
Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.
List<E> blockedWindows
An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource.
Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For
example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.
List<E> blockingAlarms
The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs
when the alarm is in an ALARM state.
List<E> outcomeAlarms
The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm
is in an ALARM state.
String 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 Amazon Web Services Region.
String 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.
String 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).
String resourceIdentifier
The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
String 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 Amazon Web Services Region.
String 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.
Date expiryTime
The expiry time (expiration time) for a customer-started 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 when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
String resourceIdentifier
The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
Date startTime
The time (UTC) when the zonal shift starts.
String status
A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
String zonalShiftId
The identifier of a zonal shift.
List<E> blockedDates
Add, change, or remove blocked dates for a practice run in zonal autoshift.
Optionally, you can block practice runs for specific calendar dates. The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.
For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice
runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.
List<E> blockedWindows
Add, change, or remove windows of days and times for when you can, optionally, block Route 53 ARC from starting a practice run for a resource.
The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.
For example, say you run business report summaries three days a week. For this scenario, you might set the
following recurring days and times as blocked windows, for example:
MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.
List<E> blockingAlarms
Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.
List<E> outcomeAlarms
Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.
String resourceIdentifier
The identifier for the resource that you want to update the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
String arn
The Amazon Resource Name (ARN) of the resource that you updated the practice run for.
String name
The name of the resource that you updated the practice run for.
PracticeRunConfiguration practiceRunConfiguration
The practice run configuration that was updated.
String zonalAutoshiftStatus
The zonal autoshift status for the resource that you updated the practice run for.
String resourceIdentifier
The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
String zonalAutoshiftStatus
The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for.
String resourceIdentifier
The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
String zonalAutoshiftStatus
The zonal autoshift status for the resource that you updated the zonal autoshift configuration for.
String 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.
String 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).
String zonalShiftId
The identifier of a zonal shift.
String 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 Amazon Web Services Region.
String 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.
Date expiryTime
The expiry time (expiration time) for a customer-started 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 when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
String resourceIdentifier
The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
Date startTime
The time (UTC) when the zonal shift starts.
String status
A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
String zonalShiftId
The identifier of a zonal shift.
String reason
The reason for the validation exception.
String appliedStatus
The appliedStatus field specifies which application traffic shift is in effect for a resource when
there is more than one traffic shift active. There can be more than one application traffic shift in progress at
the same time - that is, practice run zonal shifts, customer-started zonal shifts, or an autoshift. The
appliedStatus field for an autoshift for a resource can have one of two values: APPLIED
or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an
applied status set to APPLIED.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-started zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
String 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 Amazon Web Services Region.
String 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.
Date expiryTime
The expiry time (expiration time) for a customer-started 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 when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
String practiceRunOutcome
The outcome, or end state, returned for a practice run. The following values can be returned:
PENDING: Outcome value when a practice run is in progress.
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go
into an ALARM state during the practice run, and the practice run was not interrupted before it
completed the expected 30 minute zonal shift.
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
String 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.
Date startTime
The time (UTC) when the zonal shift starts.
String zonalShiftId
The identifier of a zonal shift.
String 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 Amazon Web Services Region.
String 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.
Date expiryTime
The expiry time (expiration time) for a customer-started 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 when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
String practiceRunOutcome
The outcome, or end state, of a practice run. The following values can be returned:
PENDING: Outcome value when the practice run is in progress.
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go
into an ALARM state during the practice run, and the practice run was not interrupted before it
completed.
INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
String 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.
Date startTime
The time (UTC) when the zonal shift starts.
String status
A status for a zonal shift.
The Status for a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
String zonalShiftId
The identifier of a zonal shift.
Copyright © 2023. All rights reserved.