interface IamFederationConfigOptionsProperty

Language	Type name
.NET	Amazon.CDK.AWS.OpenSearchServerless.CfnSecurityConfig.IamFederationConfigOptionsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchserverless#CfnSecurityConfig_IamFederationConfigOptionsProperty
Java	software.amazon.awscdk.services.opensearchserverless.CfnSecurityConfig.IamFederationConfigOptionsProperty
Python	aws_cdk.aws_opensearchserverless.CfnSecurityConfig.IamFederationConfigOptionsProperty
TypeScript	aws-cdk-lib » aws_opensearchserverless » CfnSecurityConfig » IamFederationConfigOptionsProperty

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as opensearchserverless } from 'aws-cdk-lib';
const iamFederationConfigOptionsProperty: opensearchserverless.CfnSecurityConfig.IamFederationConfigOptionsProperty = {
  groupAttribute: 'groupAttribute',
  userAttribute: 'userAttribute',
};

Properties

Name	Type	Description
groupAttribute?	string	The group attribute for this IAM federation integration.
userAttribute?	string	The user attribute for this IAM federation integration.

---

groupAttribute?

Type: string (optional)

The group attribute for this IAM federation integration.

This attribute is used to map identity provider groups to OpenSearch Serverless permissions.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html#cfn-opensearchserverless-securityconfig-iamfederationconfigoptions-groupattribute

---

userAttribute?

Type: string (optional)

The user attribute for this IAM federation integration.

This attribute is used to identify users in the federated authentication process.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html#cfn-opensearchserverless-securityconfig-iamfederationconfigoptions-userattribute