AWS cli medium security documentation change
Summary
Added documentation for automated snapshot pause options including configuration parameters, warnings about reduced data protection, and maximum suspension duration of 3 days.
Security assessment
The change explicitly addresses data protection risks by warning that suspending snapshots reduces data protection and prevents point-in-time restores. It documents security implications of the feature and includes safeguards like maximum suspension duration.
Diff
diff --git a/cli/latest/reference/opensearch/update-domain-config.md b/cli/latest/reference/opensearch/update-domain-config.md index 2a77d016d..d833b0e96 100644 --- a//cli/latest/reference/opensearch/update-domain-config.md +++ b//cli/latest/reference/opensearch/update-domain-config.md @@ -15 +15 @@ - * [AWS CLI 2.34.45 Command Reference](../../index.html) » + * [AWS CLI 2.34.48 Command Reference](../../index.html) » @@ -88,0 +89 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/opense + [--automated-snapshot-pause-options <value>] @@ -1626,0 +1628,38 @@ JSON Syntax: +`--automated-snapshot-pause-options` (structure) + +> Specifies the automated snapshot pause options for the domain. +> +> ### Warning +> +> Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows. +> +> Maximum suspension duration: 3 days. +> +> Enabled -> (boolean) [required] +> +>> Whether to enable or disable automated snapshot pause for the domain. +> +> StartTime -> (timestamp) +> +>> The timestamp at which the automated snapshot pause should begin. +> +> EndTime -> (timestamp) +> +>> The timestamp at which the automated snapshot pause should end. The maximum allowed duration between `StartTime` and `EndTime` is 3 days. + +Shorthand Syntax: + + + Enabled=boolean,StartTime=timestamp,EndTime=timestamp + + +JSON Syntax: + + + { + "Enabled": true|false, + "StartTime": timestamp, + "EndTime": timestamp + } + + @@ -3813,0 +3853,71 @@ DomainConfig -> (structure) +>>> +>>> PendingDeletion -> (boolean) +>>> +>>>> Indicates whether the entity is being deleted. +> +> AutomatedSnapshotPauseOptions -> (structure) +> +>> Specifies `AutomatedSnapshotPauseOptions` for the domain. +>> +>> Options -> (structure) [required] +>> +>>> Automated snapshot pause options for the domain. +>>> +>>> Enabled -> (boolean) [required] +>>> +>>>> Whether automated snapshot pause is enabled for the domain. +>>> +>>> StartTime -> (timestamp) +>>> +>>>> The timestamp at which the automated snapshot pause begins. +>>> +>>> EndTime -> (timestamp) +>>> +>>>> The timestamp at which the automated snapshot pause ends. +>>> +>>> State -> (string) +>>> +>>>> The current state of the automated snapshot pause. Valid values are `Active` , `Completed` , `Scheduled` , and `Disabled` . +>>>> +>>>> Possible values: +>>>> +>>>> * `Active` +>>>> * `Completed` +>>>> * `Scheduled` +>>>> * `Disabled` +>>>> + +>> +>> Status -> (structure) [required] +>> +>>> The current status of the automated snapshot pause options for the domain. +>>> +>>> CreationDate -> (timestamp) [required] +>>> +>>>> The timestamp when the entity was created. +>>> +>>> UpdateDate -> (timestamp) [required] +>>> +>>>> The timestamp of the last time the entity was updated. +>>> +>>> UpdateVersion -> (integer) +>>> +>>>> The latest version of the entity. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `0` +>>>> + +>>> +>>> State -> (string) [required] +>>> +>>>> The state of the entity. +>>>> +>>>> Possible values: +>>>> +>>>> * `RequiresIndexDocuments` +>>>> * `Processing` +>>>> * `Active` +>>>> + @@ -3906 +4016 @@ DryRunProgressStatus -> (structure) - * [AWS CLI 2.34.45 Command Reference](../../index.html) » + * [AWS CLI 2.34.48 Command Reference](../../index.html) »