interface IdentityCenterOptionsProperty

Language	Type name
.NET	Amazon.CDK.AWS.OpenSearchService.CfnDomain.IdentityCenterOptionsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CfnDomain_IdentityCenterOptionsProperty
Java	software.amazon.awscdk.services.opensearchservice.CfnDomain.IdentityCenterOptionsProperty
Python	aws_cdk.aws_opensearchservice.CfnDomain.IdentityCenterOptionsProperty
TypeScript	aws-cdk-lib » aws_opensearchservice » CfnDomain » IdentityCenterOptionsProperty

Container for IAM Identity Center Options settings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchservice as opensearchservice } from 'aws-cdk-lib';
const identityCenterOptionsProperty: opensearchservice.CfnDomain.IdentityCenterOptionsProperty = {
  enabledApiAccess: false,
  identityCenterApplicationArn: 'identityCenterApplicationArn',
  identityCenterInstanceArn: 'identityCenterInstanceArn',
  identityStoreId: 'identityStoreId',
  rolesKey: 'rolesKey',
  subjectKey: 'subjectKey',
};

Properties

Name	Type	Description
enabledApiAccess?	boolean | IResolvable	True to enable IAM Identity Center for API access in Amazon OpenSearch Service.
identityCenterApplicationArn?	string	The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.
identityCenterInstanceArn?	string	The ARN for IAM Identity Center Instance.
identityStoreId?	string	The ID of IAM Identity Store.
rolesKey?	string	Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center.
subjectKey?	string	Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.

---

enabledApiAccess?

Type: boolean | IResolvable (optional)

True to enable IAM Identity Center for API access in Amazon OpenSearch Service.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-enabledapiaccess

---

identityCenterApplicationArn?

Type: string (optional)

The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitycenterapplicationarn

---

identityCenterInstanceArn?

Type: string (optional)

The ARN for IAM Identity Center Instance.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitycenterinstancearn

---

identityStoreId?

Type: string (optional)

The ID of IAM Identity Store.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-identitystoreid

---

rolesKey?

Type: string (optional)

Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-roleskey

---

subjectKey?

Type: string (optional)

Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-identitycenteroptions.html#cfn-opensearchservice-domain-identitycenteroptions-subjectkey