AWS cli documentation change
Summary
Added detailed documentation for --notification-settings including event types (CA_CERTIFICATE_EXPIRY, END_ENTITY_CERTIFICATE_EXPIRY) and notification channels.
Security assessment
This adds documentation for security-related monitoring features (certificate expiry alerts), but does not indicate a fix for a specific vulnerability.
Diff
diff --git a/cli/latest/reference/rolesanywhere/create-trust-anchor.md b/cli/latest/reference/rolesanywhere/create-trust-anchor.md index babdd9570..e3db4fa0c 100644 --- a//cli/latest/reference/rolesanywhere/create-trust-anchor.md +++ b//cli/latest/reference/rolesanywhere/create-trust-anchor.md @@ -15 +15 @@ - * [AWS CLI 2.32.11 Command Reference](../../index.html) » + * [AWS CLI 2.32.13 Command Reference](../../index.html) » @@ -69 +68,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa - [--enabled | --no-enabled] @@ -71 +69,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa - [--notification-settings <value>] @@ -72,0 +71 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa + [--enabled | --no-enabled] @@ -73,0 +73 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa + [--notification-settings <value>] @@ -98,4 +97,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa -`--enabled` | `--no-enabled` (boolean) - -> Specifies whether the trust anchor is enabled. - @@ -110 +106 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa -> * pattern: `^[ a-zA-Z0-9-_]*$` +> * pattern: `[ a-zA-Z0-9-_]*` @@ -114,9 +110 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa -`--notification-settings` (list) - -> A list of notification settings to be associated to the trust anchor. -> -> Constraints: -> -> * min: `0` -> * max: `50` -> +`--source` (structure) [required] @@ -123,0 +112 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa +> The trust anchor type and its related certificate data. @@ -125 +114 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa -> (structure) +> sourceType -> (string) @@ -127,3 +116 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->> Customizable notification settings that will be applied to notification events. IAM Roles Anywhere consumes these settings while notifying across multiple channels - CloudWatch metrics, EventBridge, and Health Dashboard. ->> ->> channel -> (string) +>> The type of the trust anchor. @@ -131,11 +118 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->>> The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event. ->>> ->>> ### Note ->>> ->>> In the absence of a specific channel, IAM Roles Anywhere applies this setting to ‘ALL’ channels. ->>> ->>> Possible values: ->>> ->>> * `ALL` ->>> - +>> Possible values: @@ -143 +120,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->> enabled -> (boolean) [required] +>> * `AWS_ACM_PCA` +>> * `CERTIFICATE_BUNDLE` +>> * `SELF_SIGNED_REPOSITORY` @@ -145 +124,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->>> Indicates whether the notification setting is enabled. + +> +> sourceData -> (tagged union structure) +> +>> The data field of the trust anchor depending on its type. @@ -147 +130 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->> event -> (string) [required] +>> ### Note @@ -149,8 +132 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->>> The event to which this notification setting is applied. ->>> ->>> Possible values: ->>> ->>> * `CA_CERTIFICATE_EXPIRY` ->>> * `END_ENTITY_CERTIFICATE_EXPIRY` ->>> - +>> This is a Tagged Union structure. Only one of the following top level keys can be set: `x509CertificateData`, `acmPcaArn`. @@ -158 +134 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->> threshold -> (integer) +>> x509CertificateData -> (string) @@ -160 +136 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->>> The number of days before a notification event. This value is required for a notification setting that is enabled. +>>> The PEM-encoded data for the certificate anchor. Included for trust anchors of type `CERTIFICATE_BUNDLE` . @@ -165 +141 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa ->>> * max: `360` +>>> * max: `16000` @@ -167,0 +144,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rolesa +>> +>> acmPcaArn -> (string) +>> +>>> The root certificate of the Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type `AWS_ACM_PCA` . @@ -172 +152 @@ Shorthand Syntax: - channel=string,enabled=boolean,event=string,threshold=integer ... + sourceType=string,sourceData={x509CertificateData=string,acmPcaArn=string} @@ -178 +157,0 @@ JSON Syntax: - [ @@ -180,4 +159,5 @@ JSON Syntax: - "channel": "ALL", - "enabled": true|false, - "event": "CA_CERTIFICATE_EXPIRY"|"END_ENTITY_CERTIFICATE_EXPIRY", - "threshold": integer + "sourceType": "AWS_ACM_PCA"|"CERTIFICATE_BUNDLE"|"SELF_SIGNED_REPOSITORY", + "sourceData": { + "x509CertificateData": "string", + "acmPcaArn": "string" + } @@ -185,2 +164,0 @@ JSON Syntax: - ... - ] @@ -189 +167 @@ JSON Syntax: -`--source` (structure) [required] +`--enabled` | `--no-enabled` (boolean) @@ -191 +169,5 @@ JSON Syntax: -> The trust anchor type and its related certificate data. +> Specifies whether the trust anchor is enabled. + +`--tags` (list) + +> The tags to attach to the trust anchor. @@ -193 +175 @@ JSON Syntax: -> sourceData -> (tagged union structure) +> Constraints: @@ -195,9 +177,8 @@ JSON Syntax: ->> The data field of the trust anchor depending on its type. ->> ->> ### Note ->> ->> This is a Tagged Union structure. Only one of the following top level keys can be set: `acmPcaArn`, `x509CertificateData`. ->> ->> acmPcaArn -> (string) ->> ->>> The root certificate of the Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type `AWS_ACM_PCA` . +> * min: `0` +> * max: `200` +> + +> +> (structure) +> +>> A label that consists of a key and value you define. @@ -205 +186 @@ JSON Syntax: ->> x509CertificateData -> (string) +>> key -> (string) [required] @@ -207 +188 @@ JSON Syntax: ->>> The PEM-encoded data for the certificate anchor. Included for trust anchors of type `CERTIFICATE_BUNDLE` . +>>> The tag key. @@ -212 +193,2 @@ JSON Syntax: ->>> * max: `8000` +>>> * max: `128` +>>> * pattern: `[ a-zA-Z0-9_.:/=+@-]*` @@ -215,4 +196,0 @@ JSON Syntax: -> -> sourceType -> (string) -> ->> The type of the trust anchor. @@ -220,5 +198 @@ JSON Syntax: ->> Possible values: ->> ->> * `AWS_ACM_PCA` ->> * `CERTIFICATE_BUNDLE` ->> * `SELF_SIGNED_REPOSITORY` +>> value -> (string) [required] @@ -225,0 +200,8 @@ JSON Syntax: +>>> The tag value. +>>> +>>> Constraints: +>>> +>>> * min: `0` +>>> * max: `256` +>>> * pattern: `[ a-zA-Z0-9_.:/=+@-]*` +>>> @@ -231 +213 @@ Shorthand Syntax: - sourceData={acmPcaArn=string,x509CertificateData=string},sourceType=string + key=string,value=string ... @@ -236,0 +219 @@ JSON Syntax: + [ @@ -238,5 +221,2 @@ JSON Syntax: - "sourceData": { - "acmPcaArn": "string", - "x509CertificateData": "string" - }, - "sourceType": "AWS_ACM_PCA"|"CERTIFICATE_BUNDLE"|"SELF_SIGNED_REPOSITORY" + "key": "string", + "value": "string" @@ -243,0 +224,2 @@ JSON Syntax: + ... + ] @@ -246 +228 @@ JSON Syntax: -`--tags` (list) +`--notification-settings` (list) @@ -248 +230 @@ JSON Syntax: -> The tags to attach to the trust anchor. +> A list of notification settings to be associated to the trust anchor. @@ -253 +235 @@ JSON Syntax: -> * max: `200`