Skip to content

/AWS1/CL_OSSIAMFEDR8NCFGOPTS

Describes IAM federation options for an OpenSearch Serverless security configuration in the form of a key-value map. These options define how OpenSearch Serverless integrates with external identity providers using federation.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_groupattribute TYPE /AWS1/OSSIAMFEDR8NGROUPATTR /AWS1/OSSIAMFEDR8NGROUPATTR

The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions.

iv_userattribute TYPE /AWS1/OSSIAMFEDR8NUSERATTR /AWS1/OSSIAMFEDR8NUSERATTR

The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process.


Queryable Attributes

groupAttribute

The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions.

Accessible with the following methods

Method Description
GET_GROUPATTRIBUTE() Getter for GROUPATTRIBUTE, with configurable default
ASK_GROUPATTRIBUTE() Getter for GROUPATTRIBUTE w/ exceptions if field has no valu
HAS_GROUPATTRIBUTE() Determine if GROUPATTRIBUTE has a value

userAttribute

The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process.

Accessible with the following methods

Method Description
GET_USERATTRIBUTE() Getter for USERATTRIBUTE, with configurable default
ASK_USERATTRIBUTE() Getter for USERATTRIBUTE w/ exceptions if field has no value
HAS_USERATTRIBUTE() Determine if USERATTRIBUTE has a value