autoshift_observer_notification_status
Creates, updates, deletes, gets or lists an autoshift_observer_notification_status resource.
Overview
| Name | autoshift_observer_notification_status |
| Type | Resource |
| Id | aws.arc_zonal_shift.autoshift_observer_notification_status |
Fields
The following fields are returned by SELECT queries:
- get_autoshift_observer_notification_status
| Name | Datatype | Description |
|---|---|---|
status | string | The status of autoshift observer notification. If the status is ENABLED, ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. (ENABLED, DISABLED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_autoshift_observer_notification_status | select | region | Returns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be ENABLED or DISABLED. When ENABLED, a notification is sent when an autoshift is triggered. When DISABLED, notifications are not sent. | |
update_autoshift_observer_notification_status | update | region, status | Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notifications for practice runs and autoshifts in the Amazon Application Recovery Controller Developer Guide. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_autoshift_observer_notification_status
Returns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be ENABLED or DISABLED. When ENABLED, a notification is sent when an autoshift is triggered. When DISABLED, notifications are not sent.
SELECT
status
FROM aws.arc_zonal_shift.autoshift_observer_notification_status
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_autoshift_observer_notification_status
Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notifications for practice runs and autoshifts in the Amazon Application Recovery Controller Developer Guide.
UPDATE aws.arc_zonal_shift.autoshift_observer_notification_status
SET
status = '{{ status }}'
WHERE
region = '{{ region }}' --required
AND status = '{{ status }}' --required
RETURNING
status;