2023/11/30 - AWS ARC - Zonal Shift - 5 new 3 updated api methods
Changes This release adds a new capability, zonal autoshift. You can configure zonal autoshift so that AWS shifts traffic for a resource away from an Availability Zone, on your behalf, when AWS determines that there is an issue that could potentially affect customers in the Availability Zone.
Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
See also: AWS API Documentation
Request Syntax
client.delete_practice_run_configuration(
resourceIdentifier='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'zonalAutoshiftStatus': 'ENABLED'|'DISABLED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the resource that you deleted the practice run for.
name (string) --
The name of the resource that you deleted the practice run for.
zonalAutoshiftStatus (string) --
The status of zonal autoshift for the resource.
Returns the active autoshifts for a specified resource.
See also: AWS API Documentation
Request Syntax
client.list_autoshifts(
maxResults=123,
nextToken='string',
status='ACTIVE'|'COMPLETED'
)
integer
The number of objects that you want to return with this call.
string
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
The status of the autoshift.
dict
Response Syntax
{
'items': [
{
'awayFrom': 'string',
'endTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'COMPLETED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The items in the response list.
(dict) --
Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource away from an Availability Zone in an Amazon Web Services Region when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. You can configure zonal autoshift in Route 53 ARC for managed resources in your Amazon Web Services account in a Region. Supported Amazon Web Services resources are automatically registered with Route 53 ARC.
Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and traffic for the resource is no longer directed to the other Availability Zones in the Region.
You can stop an autoshift for a resource by disabling zonal autoshift.
awayFrom (string) --
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.
endTime (datetime) --
The time (in UTC) when the autoshift ended.
startTime (datetime) --
The time (in UTC) when the autoshift started.
status (string) --
The status for an autoshift.
nextToken (string) --
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.
A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_practice_run_configuration(
blockedDates=[
'string',
],
blockedWindows=[
'string',
],
blockingAlarms=[
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
],
outcomeAlarms=[
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
],
resourceIdentifier='string'
)
list
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 .
(string) --
list
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 .
(string) --
list
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.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) -- [REQUIRED]
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
list
[REQUIRED]
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.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) -- [REQUIRED]
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
string
[REQUIRED]
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.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'practiceRunConfiguration': {
'blockedDates': [
'string',
],
'blockedWindows': [
'string',
],
'blockingAlarms': [
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
],
'outcomeAlarms': [
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
]
},
'zonalAutoshiftStatus': 'ENABLED'|'DISABLED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the resource that you configured the practice run for.
name (string) --
The name of the resource that you configured the practice run for.
practiceRunConfiguration (dict) --
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.
blockedDates (list) --
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.
(string) --
blockedWindows (list) --
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 .
(string) --
blockingAlarms (list) --
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.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) --
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) --
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
outcomeAlarms (list) --
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.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) --
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) --
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
zonalAutoshiftStatus (string) --
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.
Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
See also: AWS API Documentation
Request Syntax
client.update_practice_run_configuration(
blockedDates=[
'string',
],
blockedWindows=[
'string',
],
blockingAlarms=[
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
],
outcomeAlarms=[
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
],
resourceIdentifier='string'
)
list
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 .
(string) --
list
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 .
(string) --
list
Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) -- [REQUIRED]
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
list
Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) -- [REQUIRED]
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
string
[REQUIRED]
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.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'practiceRunConfiguration': {
'blockedDates': [
'string',
],
'blockedWindows': [
'string',
],
'blockingAlarms': [
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
],
'outcomeAlarms': [
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
]
},
'zonalAutoshiftStatus': 'ENABLED'|'DISABLED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the resource that you updated the practice run for.
name (string) --
The name of the resource that you updated the practice run for.
practiceRunConfiguration (dict) --
The practice run configuration that was updated.
blockedDates (list) --
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.
(string) --
blockedWindows (list) --
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 .
(string) --
blockingAlarms (list) --
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.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) --
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) --
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
outcomeAlarms (list) --
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.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) --
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) --
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
zonalAutoshiftStatus (string) --
The zonal autoshift status for the resource that you updated the practice run for.
You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift. When zonal autoshift is ENABLED , Amazon Web Services shifts away 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.
See also: AWS API Documentation
Request Syntax
client.update_zonal_autoshift_configuration(
resourceIdentifier='string',
zonalAutoshiftStatus='ENABLED'|'DISABLED'
)
string
[REQUIRED]
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
[REQUIRED]
The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for.
dict
Response Syntax
{
'resourceIdentifier': 'string',
'zonalAutoshiftStatus': 'ENABLED'|'DISABLED'
}
Response Structure
(dict) --
resourceIdentifier (string) --
The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.
zonalAutoshiftStatus (string) --
The zonal autoshift status for the resource that you updated the zonal autoshift configuration for.
{'autoshifts': [{'appliedStatus': 'APPLIED | NOT_APPLIED',
'awayFrom': 'string',
'startTime': 'timestamp'}],
'practiceRunConfiguration': {'blockedDates': ['string'],
'blockedWindows': ['string'],
'blockingAlarms': [{'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'}],
'outcomeAlarms': [{'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'}]},
'zonalAutoshiftStatus': 'ENABLED | DISABLED',
'zonalShifts': {'practiceRunOutcome': 'FAILED | INTERRUPTED | PENDING | '
'SUCCEEDED'}}
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
See also: AWS API Documentation
Request Syntax
client.get_managed_resource(
resourceIdentifier='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'appliedWeights': {
'string': ...
},
'arn': 'string',
'autoshifts': [
{
'appliedStatus': 'APPLIED'|'NOT_APPLIED',
'awayFrom': 'string',
'startTime': datetime(2015, 1, 1)
},
],
'name': 'string',
'practiceRunConfiguration': {
'blockedDates': [
'string',
],
'blockedWindows': [
'string',
],
'blockingAlarms': [
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
],
'outcomeAlarms': [
{
'alarmIdentifier': 'string',
'type': 'CLOUDWATCH'
},
]
},
'zonalAutoshiftStatus': 'ENABLED'|'DISABLED',
'zonalShifts': [
{
'appliedStatus': 'APPLIED'|'NOT_APPLIED',
'awayFrom': 'string',
'comment': 'string',
'expiryTime': datetime(2015, 1, 1),
'practiceRunOutcome': 'FAILED'|'INTERRUPTED'|'PENDING'|'SUCCEEDED',
'resourceIdentifier': 'string',
'startTime': datetime(2015, 1, 1),
'zonalShiftId': 'string'
},
]
}
Response Structure
(dict) --
appliedWeights (dict) --
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) --
(float) --
arn (string) --
The Amazon Resource Name (ARN) for the resource.
autoshifts (list) --
An array of the autoshifts that are active for the resource.
(dict) --
A complex structure that lists an autoshift that is currently active for a managed resource and information about the autoshift.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
appliedStatus (string) --
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.
awayFrom (string) --
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.
startTime (datetime) --
The time (UTC) when the autoshift started.
name (string) --
The name of the resource.
practiceRunConfiguration (dict) --
The practice run configuration for zonal autoshift that's associated with the resource.
blockedDates (list) --
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.
(string) --
blockedWindows (list) --
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 .
(string) --
blockingAlarms (list) --
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.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) --
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) --
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
outcomeAlarms (list) --
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.
(dict) --
A control condition is an alarm that you specify for a practice run. When you configure practice runs with zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch to use with the practice run. The alarms that you specify are an outcome alarm , to monitor application health during practice runs and, optionally, a blocking alarm , to block practice runs from starting.
Control condition alarms do not apply for autoshifts.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
alarmIdentifier (string) --
The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.
type (string) --
The type of alarm specified for a practice run. The only valid value is CLOUDWATCH .
zonalAutoshiftStatus (string) --
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.
zonalShifts (list) --
The zonal shifts that are currently active for a resource.
(dict) --
A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
appliedStatus (string) --
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.
awayFrom (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 Amazon Web Services Region.
comment (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 (datetime) --
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.
practiceRunOutcome (string) --
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.
resourceIdentifier (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 (datetime) --
The time (UTC) when the zonal shift starts.
zonalShiftId (string) --
The identifier of a zonal shift.
{'items': {'appliedWeights': {'string': 'float'},
'autoshifts': [{'appliedStatus': 'APPLIED | NOT_APPLIED',
'awayFrom': 'string',
'startTime': 'timestamp'}],
'practiceRunStatus': 'ENABLED | DISABLED',
'zonalAutoshiftStatus': 'ENABLED | DISABLED',
'zonalShifts': [{'appliedStatus': 'APPLIED | NOT_APPLIED',
'awayFrom': 'string',
'comment': 'string',
'expiryTime': 'timestamp',
'practiceRunOutcome': 'FAILED | INTERRUPTED | '
'PENDING | SUCCEEDED',
'resourceIdentifier': 'string',
'startTime': 'timestamp',
'zonalShiftId': 'string'}]}}
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
See also: AWS API Documentation
Request Syntax
client.list_managed_resources(
maxResults=123,
nextToken='string'
)
integer
The number of objects that you want to return with this call.
string
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.
dict
Response Syntax
{
'items': [
{
'appliedWeights': {
'string': ...
},
'arn': 'string',
'autoshifts': [
{
'appliedStatus': 'APPLIED'|'NOT_APPLIED',
'awayFrom': 'string',
'startTime': datetime(2015, 1, 1)
},
],
'availabilityZones': [
'string',
],
'name': 'string',
'practiceRunStatus': 'ENABLED'|'DISABLED',
'zonalAutoshiftStatus': 'ENABLED'|'DISABLED',
'zonalShifts': [
{
'appliedStatus': 'APPLIED'|'NOT_APPLIED',
'awayFrom': 'string',
'comment': 'string',
'expiryTime': datetime(2015, 1, 1),
'practiceRunOutcome': 'FAILED'|'INTERRUPTED'|'PENDING'|'SUCCEEDED',
'resourceIdentifier': 'string',
'startTime': datetime(2015, 1, 1),
'zonalShiftId': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The items in the response list.
(dict) --
A complex structure for a managed resource in an Amazon Web Services account with information about zonal shifts and autoshifts.
A managed resource is a 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 Amazon Web Services Region. You can also configure zonal autoshift for a managed resource.
Note
At this time, managed resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
appliedWeights (dict) --
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) --
(float) --
arn (string) --
The Amazon Resource Name (ARN) for the managed resource.
autoshifts (list) --
An array of the autoshifts that have been completed for a resource.
(dict) --
A complex structure that lists an autoshift that is currently active for a managed resource and information about the autoshift.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
appliedStatus (string) --
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.
awayFrom (string) --
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.
startTime (datetime) --
The time (UTC) when the autoshift started.
availabilityZones (list) --
The Availability Zones that a resource is deployed in.
(string) --
name (string) --
The name of the managed resource.
practiceRunStatus (string) --
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 .
zonalAutoshiftStatus (string) --
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 .
zonalShifts (list) --
An array of the zonal shifts for a resource.
(dict) --
A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
appliedStatus (string) --
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.
awayFrom (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 Amazon Web Services Region.
comment (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 (datetime) --
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.
practiceRunOutcome (string) --
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.
resourceIdentifier (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 (datetime) --
The time (UTC) when the zonal shift starts.
zonalShiftId (string) --
The identifier of a zonal shift.
nextToken (string) --
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.
{'resourceIdentifier': 'string'}
Response {'items': {'practiceRunOutcome': 'FAILED | INTERRUPTED | PENDING | SUCCEEDED'}}
Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-started zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.
The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts .
See also: AWS API Documentation
Request Syntax
client.list_zonal_shifts(
maxResults=123,
nextToken='string',
resourceIdentifier='string',
status='ACTIVE'|'EXPIRED'|'CANCELED'
)
integer
The number of objects that you want to return with this call.
string
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
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
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.
dict
Response Syntax
{
'items': [
{
'awayFrom': 'string',
'comment': 'string',
'expiryTime': datetime(2015, 1, 1),
'practiceRunOutcome': 'FAILED'|'INTERRUPTED'|'PENDING'|'SUCCEEDED',
'resourceIdentifier': 'string',
'startTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'EXPIRED'|'CANCELED',
'zonalShiftId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The items in the response list.
(dict) --
Lists information about zonal shifts in Amazon Route 53 Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that Route 53 ARC starts on your behalf for practice runs with zonal autoshift.
Zonal shifts are temporary, including customer-started zonal shifts and the zonal autoshift practice run zonal shifts that Route 53 ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.
awayFrom (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 Amazon Web Services Region.
comment (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 (datetime) --
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.
practiceRunOutcome (string) --
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.
resourceIdentifier (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 (datetime) --
The time (UTC) when the zonal shift starts.
status (string) --
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.
zonalShiftId (string) --
The identifier of a zonal shift.
nextToken (string) --
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.