AWS cli documentation change

Service: cli · 2025-08-01 · Documentation low

File: cli/latest/reference/opensearch/update-domain-config.md

Summary

Added documentation for IAMFederationOptions configuration parameters in OpenSearch domain updates, including Enabled, SubjectKey, and RolesKey settings

Security assessment

The change introduces documentation for IAM federation authentication configuration, which is a security feature. However, there is no evidence of addressing a specific security vulnerability or incident.

Diff

diff --git a/cli/latest/reference/opensearch/update-domain-config.md b/cli/latest/reference/opensearch/update-domain-config.md
index ef284e272..c30a16656 100644
--- a//cli/latest/reference/opensearch/update-domain-config.md
+++ b//cli/latest/reference/opensearch/update-domain-config.md
@@ -15 +15 @@
-  * [AWS CLI 2.27.63 Command Reference](../../index.html) »
+  * [AWS CLI 2.28.0 Command Reference](../../index.html) »
@@ -651,0 +652,16 @@ JSON Syntax:
+> IAMFederationOptions -> (structure)
+>
+>> Container for information about the IAM federation configuration for an OpenSearch UI application.
+>> 
+>> Enabled -> (boolean)
+>>
+>>> True to enable IAM federation authentication for a domain.
+>> 
+>> SubjectKey -> (string)
+>>
+>>> Element of the IAM federation assertion to use for the user name. Default is `sub` .
+>> 
+>> RolesKey -> (string)
+>>
+>>> Element of the IAM federation assertion to use for backend roles. Default is `roles` .
+> 
@@ -659 +675 @@ Shorthand Syntax:
-    Enabled=boolean,InternalUserDatabaseEnabled=boolean,MasterUserOptions={MasterUserARN=string,MasterUserName=string,MasterUserPassword=string},SAMLOptions={Enabled=boolean,Idp={MetadataContent=string,EntityId=string},MasterUserName=string,MasterBackendRole=string,SubjectKey=string,RolesKey=string,SessionTimeoutMinutes=integer},JWTOptions={Enabled=boolean,SubjectKey=string,RolesKey=string,PublicKey=string},AnonymousAuthEnabled=boolean
+    Enabled=boolean,InternalUserDatabaseEnabled=boolean,MasterUserOptions={MasterUserARN=string,MasterUserName=string,MasterUserPassword=string},SAMLOptions={Enabled=boolean,Idp={MetadataContent=string,EntityId=string},MasterUserName=string,MasterBackendRole=string,SubjectKey=string,RolesKey=string,SessionTimeoutMinutes=integer},JWTOptions={Enabled=boolean,SubjectKey=string,RolesKey=string,PublicKey=string},IAMFederationOptions={Enabled=boolean,SubjectKey=string,RolesKey=string},AnonymousAuthEnabled=boolean
@@ -690,0 +707,5 @@ JSON Syntax:
+      "IAMFederationOptions": {
+        "Enabled": true|false,
+        "SubjectKey": "string",
+        "RolesKey": "string"
+      },
@@ -1731,0 +1753,16 @@ DomainConfig -> (structure)
+>>> IAMFederationOptions -> (structure)
+>>>
+>>>> Container for information about the IAM federation configuration for an OpenSearch UI application.
+>>>> 
+>>>> Enabled -> (boolean)
+>>>>
+>>>>> True if IAM federation is enabled.
+>>>> 
+>>>> SubjectKey -> (string)
+>>>>
+>>>>> The key used for matching the IAM federation subject attribute.
+>>>> 
+>>>> RolesKey -> (string)
+>>>>
+>>>>> The key used for matching the IAM federation roles attribute.
+>>> 
@@ -2166 +2203 @@ DryRunProgressStatus -> (structure)
-  * [AWS CLI 2.27.63 Command Reference](../../index.html) »
+  * [AWS CLI 2.28.0 Command Reference](../../index.html) »