AWS r53recovery documentation change
Summary
Restructured documentation by removing detailed CLI examples and moving them to separate pages, while consolidating conceptual information about zonal autoshift capabilities.
Security assessment
The changes primarily reorganize content and remove implementation details without addressing security vulnerabilities or introducing new security features. The documentation focuses on operational aspects of zonal autoshift configuration rather than security controls or vulnerabilities.
Diff
diff --git a/r53recovery/latest/dg/getting-started-cli-zonal-autoshift.md b/r53recovery/latest/dg/getting-started-cli-zonal-autoshift.md index 7b955463a..f19a08b4e 100644 --- a//r53recovery/latest/dg/getting-started-cli-zonal-autoshift.md +++ b//r53recovery/latest/dg/getting-started-cli-zonal-autoshift.md @@ -5,2 +4,0 @@ -Create practice run configurationEnable or disable autoshiftsCancel an in-progress autoshiftCancel an in-progress practice runEdit a practice run configurationDelete a practice run configuration - @@ -11,184 +9 @@ This section walks through simple application examples of working with zonal aut -Zonal autoshift is a capability in ARC. With zonal autoshift, you authorize AWS to shift away supported application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Zonal autoshift includes practice runs, which also shift traffic away from Availability Zones, to help verify, on an ongoing basis, that autoshifts are safe for your application. - -For more information, see [Supported resources](./arc-zonal-shift.resource-types.html). - -This section provides the following examples to illustrate how to get started with and work with zonal autoshift: - - * Create a practice run configuration for a resource. - - * Enable and disable autoshifts for a resource. - - * End an in-progress practice run by canceling the zonal shift started by the practice run. - - * End an in-progress autoshift by disabling the zonal autoshift feature for a resource. - - * Edit a practice run configuration for a resource to change the specified alarms or blocked dates or windows. - - * Delete a practice run configuration for a resource. - - - - -For more information about using the AWS CLI, see the [AWS CLI Command Reference](https://docs.aws.amazon.com/cli/latest/reference/arc-zonal-shift/index.html). For a list of zonal autoshift API actions and links to more information, see [Zonal autoshift API operations](./actions.zonalautoshift.html). - -## Create practice run configuration - -Before you can enable zonal autoshift for a resource, you must create a practice run configuration for the resource, to choose options for the required practice runs. You create a practice run configuration for a resource with the CLI by using the `create-practice-run-configuration` command. - -Note the following when you create a practice run configuration for a resource: - - * The only supported alarm type at this time is `CLOUDWATCH`. - - * You must use alarms that are in the same AWS Region that your resource is deployed in. - - * Specifying an outcome alarm is required. Specifying a blocking alarm is optional. - - * Specifying blocked dates or blocked windows is optional. - - - - -You create a practice run configuration with the CLI by using the `create-practice-run-configuration` command. - -For example, to create a practice run configuration for a resource, use a command like the following: - - - aws arc-zonal-shift create-practice-run-configuration \ - --resource-identifier="arn:aws:elasticloadbalancing:Region:111122223333:ExampleALB123456890" \ - --outcome-alarms type=CLOUDWATCH,alarmIdentifier=arn:aws:cloudwatch:Region:111122223333:alarm:Region-MyAppHealthAlarm \ - --blocking-alarms type=CLOUDWATCH,alarmIdentifier=arn:aws:cloudwatch:Region:111122223333:alarm:Region-BlockWhenALARM \ - --blocked-dates 2023-12-01 --blocked-windows Mon:10:00-Mon:10:30 - - - { - "arn": "arn:aws:elasticloadbalancing:us-west-2:111122223333:ExampleALB123456890", - "name": "zonal-shift-elb" - "zonalAutoshiftStatus": "DISABLED", - "practiceRunConfiguration": { - "blockingAlarms": [ - { - "type": "CLOUDWATCH", - "alarmIdentifier": "arn:aws:cloudwatch:us-west-2:111122223333:alarm:us-west-2-BlockWhenALARM" - } - ] - "outcomeAlarms": [ - { - "type": "CLOUDWATCH", - "alarmIdentifier": "arn:aws:cloudwatch:us-west-2:111122223333:alarm:us-west-2-MyAppHealthAlarm" - } - ], - "blockedWindows": [ - "Mon:10:00-Mon:10:30" - ], - "blockedDates": [ - "2023-12-01" - ] - } - -## Enable or disable autoshifts - -You enable or disable autoshifts for a resource by updating the zonal autoshift status with the CLI. To change the zonal autoshift status, use the `update-zonal-autoshift-configuration` command. - -For example, to enable autoshifts for a resource, use a command like the following: - - - aws arc-zonal-shift update-zonal-autoshift-configuration \ - --resource-identifier="arn:aws:elasticloadbalancing:Region:111122223333:ExampleALB123456890" \ - --zonal-autoshift-status="ENABLED" - - - { - "resourceIdentifier": "arn:aws:elasticloadbalancing:us-west-2:111122223333:ExampleALB123456890", - "zonalAutoshiftStatus": "ENABLED" - } - -## Cancel an in-progress autoshift - -You can cancel an in-progress autoshift with the CLI by canceling the zonal autoshift for the resource. To cancel a zonal autoshift, use the `cancel-zonal-shift command`. - - - aws arc-zonal-shift cancel-zonal-shift --zonal-shift-id 9ac9ec1e-1df1-0755-3dc5-8cf573cd9c38 - - - { - "awayFrom": "usw2-az1", - "comment": "Zonal autoshift started. Shifting traffic away from Availability Zone usw2-az1.", - "expiryTime": "2024-12-17T22:29:38-08:00", - "resourceIdentifier": "arn:aws:elasticloadbalancing:us-east-1:111122223333:loadbalancer/app/Testing/5a19403ecd42dc05", - "startTime": "2024-12-17T21:27:26-08:00", - "status": "CANCELED", - "zonalShiftId": "9ac9ec1e-1df1-0755-3dc5-8cf573cd9c38" - } - -## Cancel an in-progress practice run - -You can cancel an in-progress practice run with the CLI by canceling the zonal shift that the practice run started for the resource. To cancel a practice run, use the `cancel-zonal-shift` command. - -For example, to cancel a practice run for a resource, use a command like the following: - - - aws arc-zonal-shift cancel-zonal-shift \ - --zonal-shift-id="="arn:aws:testservice::111122223333:ExampleALB123456890" - - - { - "zonalShiftId": "2222222-3333-444-1111", - "resourceIdentifier": "arn:aws:testservice::111122223333:ExampleALB123456890", - "awayFrom": "usw2-az1", - "expiryTime": 2024-11-15T10:35:42+00:00, - "startTime": 2024-11-15T09:35:42+00:00, - "status": "CANCELED", - "comment": "Practice Run Started" - } - -## Edit a practice run configuration - -You can edit a practice run configuration for a resource with the CLI to update different configuration options, such as changing the alarms for practice runs or updating the blocked dates or blocked windows, when ARC won't start practice runs. To edit a practice run configuration, use the `update-practice-run-configuration` command. - -Note the following when you edit a practice run configuration for a resource: - - * The only supported alarm type at this time is `CLOUDWATCH`. - - * You must use alarms that are in the same AWS Region that your resource is deployed in. - - * Specifying an outcome alarm is required. Specifying a blocking alarm is optional. - - * Specifying blocked dates or blocked windows is optional. - - * The blocked dates or blocked windows that you specify replace any existing values. - - - - -For example, to edit a practice run configuration for a resource to specify a new blocked date, use a command like the following: - - - aws arc-zonal-shift update-practice-run-configuration \ - --resource-identifier="arn:aws:elasticloadbalancing:Region:111122223333:ExampleALB123456890" \ - --blocked-dates 2024-03-01 - - - { - "arn": "arn:aws:elasticloadbalancing:us-west-2:111122223333:ExampleALB123456890", - "name": "zonal-shift-elb" - "zonalAutoshiftStatus": "DISABLED", - "practiceRunConfiguration": { - "blockingAlarms": [ - { - "type": "CLOUDWATCH", - "alarmIdentifier": "arn:aws:cloudwatch:us-west-2:111122223333:alarm:us-west-2-BlockWhenALARM" - } - ] - "outcomeAlarms": [ - { - "type": "CLOUDWATCH", - "alarmIdentifier": "arn:aws:cloudwatch:us-west-2:111122223333:alarm:us-west-2-MyAppHealthAlarm" - } - ], - "blockedWindows": [ - "Mon:10:00-Mon:10:30" - ], - "blockedDates": [ - "2024-03-01" - ] - } +Zonal autoshift is a capability in ARC. With zonal autoshift, you authorize AWS to shift away supported application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. For more information about resources that you can use with zonal autoshift, see [Supported resources](./arc-zonal-shift.resource-types.html). @@ -196 +11 @@ For example, to edit a practice run configuration for a resource to specify a ne -## Delete a practice run configuration +Zonal autoshift includes practice runs, which also shift traffic away from Availability Zones, to help verify that autoshifts are safe for your application. @@ -198 +13 @@ For example, to edit a practice run configuration for a resource to specify a ne -You can delete a practice run configuration for a resource, but you must first disable zonal autoshift for the resource. A resource is required to have a practice run configuration to have zonal autoshift enabled. Regular practice runs help you to make sure that your application can run normally without one Availability Zone. +For a list of zonal autoshift API actions and links to more information, see [Zonal autoshift API operations](./actions.zonalautoshift.html). For more information about using the AWS CLI, see the [AWS CLI Command Reference](https://docs.aws.amazon.com/cli/latest/reference/arc-zonal-shift/index.html). @@ -200 +15 @@ You can delete a practice run configuration for a resource, but you must first d