AWS mediaconnect documentation change
Summary
Updated documentation for setting flow maintenance windows with clarified procedures, added operational constraints, and restructured CLI examples
Security assessment
The changes focus on operational procedures for scheduling maintenance windows without addressing vulnerabilities, security controls, or security features. The added constraint about not changing windows 4 hours before maintenance is operational, not security-related.
Diff
diff --git a/mediaconnect/latest/ug/setting-flow-maintenance.md b/mediaconnect/latest/ug/setting-flow-maintenance.md index aa39e8f07..6f135b9b4 100644 --- a//mediaconnect/latest/ug/setting-flow-maintenance.md +++ b//mediaconnect/latest/ug/setting-flow-maintenance.md @@ -7 +7 @@ -# Setting maintenance windows +# Setting flow maintenance windows @@ -9 +9 @@ -You can select the day and time that maintenance events occur. This is called a _maintenance window_. These windows help minimize maintenance impact on your production. +You can set or change the maintenance window for a flow, regardless of whether the flow is active or stopped. You specify a preferred day and start hour, and MediaConnect performs maintenance within the two-hour window starting at that time. @@ -11 +11 @@ You can select the day and time that maintenance events occur. This is called a -A maintenance window is used every time a maintenance event is required. You can set a maintenance window while creating a flow, or add the window to an existing flow. To change the day and time of a maintenance window, you can use the MediaConnect console or the AWS CLI. Also, if maintenance is required, you can set a specific date for the maintenance to occur. The date you select must be before the required maintenance date. +###### Important @@ -13 +13 @@ A maintenance window is used every time a maintenance event is required. You can -If you don't set a maintenance window, MediaConnect restarts the flows for you. We recommend that you set a maintenance window for each flow that requires maintenance. +You cannot change the maintenance window for a flow within 4 hours of the scheduled maintenance start time, or while maintenance is in progress. @@ -19 +19 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - 2. In the navigation pane, choose **Flows**. When a flow requires maintenance, it will display a **Required by** date under the **Maintenance window** column. + 2. In the navigation pane, choose **Flows**. @@ -21 +21 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - 3. Select the flow or flows. You can set a unique maintenance window for each flow. Alternatively, you can set maintenance windows in bulk by selecting multiple flows. + 3. Select the check box next to one or more flows that you want to update. @@ -23 +23 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - 4. Under the **Flow actions** drop-down menu, select **Edit flow maintenance window**. + 4. Choose **Flow actions** , and then choose **Update maintenance window**. @@ -25 +25 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - 5. * Select the day of the week maintenance will occur in the **Start day** field. + 5. For **Start day** , choose the preferred day of the week. @@ -27 +27 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - * Select the time maintenance will occur in the **Start hour** field. Time is presented in UTC. + 6. For **Start hour** , choose the preferred start time (UTC). @@ -29 +29 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - * If maintenance is required, you have the option to select a specific date in the **Maintenance window date** field. The selected date must occur before the required maintenance date and time. + 7. (Optional) If maintenance is required for the flow, the **Maintenance window date** field is available. Select a specific date for the next maintenance event. The selected date must be before the required-by deadline. @@ -31 +31 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - * Select **Update**. + 8. Choose **Update**. @@ -33 +32,0 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - 6. You can verify the window by viewing the **Maintenance window** column on the **Flows** dashboard. @@ -36,0 +36 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. +###### To set a flow maintenance window (AWS CLI) @@ -38 +38 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. -###### To set a maintenance window (AWS CLI) +Use the `update-flow` command with the `--maintenance` parameter to set the preferred maintenance day and start hour. @@ -40 +40 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. - 1. In the AWS CLI, use the `update-flow` command with the `--maintenance` option. You will also need to use the `--flow-arn` option to specify which flow you are working with. +The following example sets the maintenance window for a flow to Tuesday at 10:00 UTC: @@ -42 +41,0 @@ If you don't set a maintenance window, MediaConnect restarts the flows for you. -The `--maintenance` option accepts the following arguments: @@ -44 +43,3 @@ The `--maintenance` option accepts the following arguments: - * `MaintenanceDay` + aws mediaconnect update-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame \ + --maintenance MaintenanceDay='Tuesday',MaintenanceStartHour='10:00' @@ -46 +47 @@ The `--maintenance` option accepts the following arguments: - * `MaintenanceStartHour` +The following example shows the return value: @@ -48,7 +48,0 @@ The `--maintenance` option accepts the following arguments: - * `MaintenanceScheduleDate` \- This argument is only accepted when there is a required maintenance date assigned by AWS. - - 2. Use the following command to update the reoccurring maintenance day and time. The maintenance day and time can be configured at any time, regardless of required maintenance status. - - aws mediaconnect update-flow --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame --maintenance MaintenanceDay='Tuesday',MaintenanceStartHour='10:00' - -The following example shows the return value when only setting the **MaintenanceDay** and **MaintenanceStartHour** : @@ -57,4 +51 @@ The following example shows the return value when only setting the **Maintenance - "Flows": [ - { - "AvailabilityZone": "us-west-2d", - "Description": "Example flow description", + "Flow": { @@ -63 +54 @@ The following example shows the return value when only setting the **Maintenance - "SourceType": "OWNED", + ... @@ -67 +58,2 @@ The following example shows the return value when only setting the **Maintenance - "MaintenanceStartHour": "10:00"} + "MaintenanceStartHour": "10:00" + } @@ -69 +60,0 @@ The following example shows the return value when only setting the **Maintenance - ] @@ -72 +63 @@ The following example shows the return value when only setting the **Maintenance - 3. Use the following command to set a specific maintenance date, in addition to setting the reoccurring maintenance day and time. The maintenance scheduled date can only be set when AWS requires maintenance on the flow. +###### Setting a specific maintenance date @@ -74 +65,14 @@ The following example shows the return value when only setting the **Maintenance - aws mediaconnect update-flow --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:2-3aBC45dEF67hiJ8k-2AbC34DE5fGa6:AwardsShow --maintenance MaintenanceDay='Saturday',MaintenanceStartHour='23:00',MaintenanceScheduledDate='2021-10-23' +If maintenance is required for a flow, you can specify a particular date for maintenance to occur by including the `MaintenanceScheduledDate` parameter. The selected date must be before the required-by deadline. + +###### Note + +If you change the preferred day or start hour and a maintenance date is already scheduled, you must also update the scheduled date to match your new preferences. + +The following example sets the maintenance window to Friday at 01:00 UTC and schedules maintenance for June 5, 2026: + + + aws mediaconnect update-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame \ + --maintenance MaintenanceDay='Friday',MaintenanceStartHour='01:00',MaintenanceScheduledDate='2026-06-05' + +The following example shows the return value: @@ -76 +79,0 @@ The following example shows the return value when only setting the **Maintenance -The following example shows the return value when setting the **MaintenanceDay** , **MaintenanceStartHour** , and **MaintenanceScheduledDate** : @@ -79,7 +82,4 @@ The following example shows the return value when setting the **MaintenanceDay** - "Flows": [ - { - "AvailabilityZone": "us-west-2b", - "Description": "Example flow description", - "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:2-3aBC45dEF67hiJ8k-2AbC34DE5fGa6:AwardsShow", - "Name": "AwardsShow", - "SourceType": "OWNED", + "Flow": { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame", + "Name": "BasketballGame", + ... @@ -88,4 +88,5 @@ The following example shows the return value when setting the **MaintenanceDay** - "MaintenanceDay": "Saturday", - "MaintenanceDeadline": "2021-10-25T22:15:56Z", - "MaintenanceScheduledDate": "2021-10-23", - "MaintenanceStartHour": "23:00"} + "MaintenanceDay": "Friday", + "MaintenanceDeadline": "2026-06-07T00:00:00Z", + "MaintenanceScheduledDate": "2026-06-05", + "MaintenanceStartHour": "01:00" + } @@ -93 +93,0 @@ The following example shows the return value when setting the **MaintenanceDay** - ] @@ -95,5 +94,0 @@ The following example shows the return value when setting the **MaintenanceDay** - - - - -The selected day and time are used for all future recurring maintenance events on that flow. Repeat these steps to add or edit additional maintenance windows. After maintenance is complete, the **Maintenance status** column on the **Flows** dashboard will display **No maintenance required**. @@ -107 +102 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Viewing flows that require maintenance +Viewing flow maintenance status @@ -109 +104 @@ Viewing flows that require maintenance -Quotas +Manually restarting resources for maintenance