AWS cli medium security documentation change
Summary
Updated command parameters, reordered options, modified validation patterns, and added 'SECURE_STRING' parameter type support
Security assessment
The change introduces 'SECURE_STRING' as a valid parameter type for Systems Manager parameters, which is explicitly designed for handling sensitive data. This addition directly documents security-related functionality for secure parameter storage.
Diff
diff --git a/cli/latest/reference/mgn/put-source-server-action.md b/cli/latest/reference/mgn/put-source-server-action.md index b7484904c..b5b367ce4 100644 --- a//cli/latest/reference/mgn/put-source-server-action.md +++ b//cli/latest/reference/mgn/put-source-server-action.md @@ -15 +15 @@ - * [AWS CLI 2.32.11 Command Reference](../../index.html) » + * [AWS CLI 2.32.13 Command Reference](../../index.html) » @@ -67,2 +67 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 - [--account-id <value>] - --action-id <value> + --source-server-id <value> @@ -70,3 +68,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 - [--active | --no-active] - [--category <value>] - [--description <value>] @@ -73,0 +70,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 + --order <value> + --action-id <value> @@ -75 +73,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 - [--external-parameters <value>] + [--active | --no-active] + [--timeout-seconds <value>] @@ -77 +75,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 - --order <value> @@ -79,2 +77,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 - --source-server-id <value> - [--timeout-seconds <value>] + [--external-parameters <value>] + [--description <value>] + [--category <value>] + [--account-id <value>] @@ -105 +105 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -`--account-id` (string) +`--source-server-id` (string) [required] @@ -107 +107 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Source server post migration custom account ID. +> Source server ID. @@ -111,3 +111,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> * min: `12` -> * max: `12` -> * pattern: `[0-9]{12,}` +> * min: `19` +> * max: `19` +> * pattern: `s-[0-9a-zA-Z]{17}` @@ -117 +117 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -`--action-id` (string) [required] +`--action-name` (string) [required] @@ -119 +119 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Source server post migration custom action ID. +> Source server post migration custom action name. @@ -124,2 +124,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> * max: `64` -> * pattern: `[0-9a-zA-Z]$` +> * max: `256` +> * pattern: `[^\s\x00]( *[^\s\x00])*` @@ -129 +129 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -`--action-name` (string) [required] +`--document-identifier` (string) [required] @@ -131 +131 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Source server post migration custom action name. +> Source server post migration custom action document identifier. @@ -135 +135 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> * min: `1` +> * min: `0` @@ -137 +136,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> * pattern: `^[^\s\x00]( *[^\s\x00])*$` @@ -141,5 +140 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -`--active` | `--no-active` (boolean) - -> Source server post migration custom action active status. - -`--category` (string) +`--order` (integer) [required] @@ -147 +142 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Source server post migration custom action category. +> Source server post migration custom action order. @@ -149 +144 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Possible values: +> Constraints: @@ -151,11 +146,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> * `DISASTER_RECOVERY` -> * `OPERATING_SYSTEM` -> * `LICENSE_AND_SUBSCRIPTION` -> * `VALIDATION` -> * `OBSERVABILITY` -> * `REFACTORING` -> * `SECURITY` -> * `NETWORKING` -> * `CONFIGURATION` -> * `BACKUP` -> * `OTHER` +> * min: `1001` +> * max: `10000` @@ -165 +151 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -`--description` (string) +`--action-id` (string) [required] @@ -167 +153 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Source server post migration custom action description. +> Source server post migration custom action ID. @@ -171,3 +157,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> * min: `0` -> * max: `256` -> * pattern: `^[0-9a-zA-Z ():/.,'-_#*; ]*$` +> * min: `1` +> * max: `64` +> * pattern: `.*[0-9a-zA-Z]` @@ -177 +163 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -`--document-identifier` (string) [required] +`--document-version` (string) @@ -179 +165 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Source server post migration custom action document identifier. +> Source server post migration custom action document version. @@ -183,2 +169 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> * min: `0` -> * max: `256` +> * pattern: `(\$DEFAULT|\$LATEST|[0-9]+)` @@ -188 +173 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -`--document-version` (string) +`--active` | `--no-active` (boolean) @@ -190 +175,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Source server post migration custom action document version. +> Source server post migration custom action active status. + +`--timeout-seconds` (integer) + +> Source server post migration custom action timeout in seconds. @@ -194 +183 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> * pattern: `^(\$DEFAULT|\$LATEST|[0-9]+)$` +> * min: `1` @@ -198 +187 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -`--external-parameters` (map) +`--must-succeed-for-cutover` | `--no-must-succeed-for-cutover` (boolean) @@ -200 +189,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> Source server post migration custom action external parameters. +> Source server post migration custom action must succeed for cutover. + +`--parameters` (map) + +> Source server post migration custom action parameters. @@ -215 +208 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 ->> * pattern: `^([A-Za-z0-9])+$` +>> * pattern: `([A-Za-z0-9])+` @@ -219 +212 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 -> value -> (tagged union structure) +> value -> (list) @@ -221 +214 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 ->> AWS Systems Manager Document external parameter. +>> Constraints: @@ -223 +216,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 ->> ### Note +>> * min: `0` +>> * max: `10` @@ -225 +219 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 ->> This is a Tagged Union structure. Only one of the following top level keys can be set: `dynamicPath`. + @@ -227 +221 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 ->> dynamicPath -> (string) +>> (structure) @@ -229 +223 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 ->>> AWS Systems Manager Document external parameters dynamic path. +>>> AWS Systems Manager Parameter Store parameter. @@ -231 +225 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 ->>> Constraints: +>>> parameterType -> (string) [required] @@ -233,3 +227,10 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 ->>> * min: `1` ->>> * max: `1011` ->>> * pattern: `^[a-zA-Z0-9_]+(\.[a-zA-Z0-9_\[\]]+)*$` +>>>> AWS Systems Manager Parameter Store parameter type. +>>>> +>>>> Possible values: +>>>> +>>>> * `STRING` +>>>> * `SECURE_STRING` +>>>> + +>>> +>>> parameterName -> (string) [required] @@ -236,0 +238,8 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mgn-20 +>>>> AWS Systems Manager Parameter Store parameter name. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `1011` +>>>> * pattern: `([A-Za-z0-9_\.-])+` +>>>> @@ -242 +251 @@ Shorthand Syntax: - KeyName1=dynamicPath=string,KeyName2=dynamicPath=string + KeyName1=[{parameterType=string,parameterName=string},{parameterType=string,parameterName=string}],KeyName2=[{parameterType=string,parameterName=string},{parameterType=string,parameterName=string}] @@ -248,2 +257,4 @@ JSON Syntax: - {"string": { - "dynamicPath": "string" + {"string": [ + { + "parameterType": "STRING"|"SECURE_STRING", + "parameterName": "string" @@ -250,0 +262,2 @@ JSON Syntax: + ... + ]