interface IamFederationConfigOptionsProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.OpenSearchServerless.Mixins.CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsopensearchserverless/mixins#CfnSecurityConfigPropsMixin_IamFederationConfigOptionsProperty
Java	software.amazon.awscdk.mixins.preview.services.opensearchserverless.mixins.CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty
Python	aws_cdk.mixins_preview.aws_opensearchserverless.mixins.CfnSecurityConfigPropsMixin.IamFederationConfigOptionsProperty
TypeScript	@aws-cdk/mixins-preview » aws_opensearchserverless » mixins » CfnSecurityConfigPropsMixin » 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 { mixins as opensearchserverless_mixins } from '@aws-cdk/mixins-preview/aws-opensearchserverless';
const iamFederationConfigOptionsProperty: opensearchserverless_mixins.CfnSecurityConfigPropsMixin.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