interface IamIdentityCenterOptionsProperty

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

Settings for IAM Identity Center for an OpenSearch Application.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.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 iamIdentityCenterOptionsProperty: opensearchservice.CfnApplication.IamIdentityCenterOptionsProperty = {
  enabled: false,
  iamIdentityCenterInstanceArn: 'iamIdentityCenterInstanceArn',
  iamRoleForIdentityCenterApplicationArn: 'iamRoleForIdentityCenterApplicationArn',
};

Properties

Name	Type	Description
enabled?	boolean | IResolvable	IAM Identity Center is enabled for the OpenSearch Application.
iamIdentityCenterInstanceArn?	string	Amazon Resource Name (ARN) format.
iamRoleForIdentityCenterApplicationArn?	string	Amazon Resource Name of the IAM Identity Center's Application created for the OpenSearch Application after enabling IAM Identity Center.

---

enabled?

Type: boolean | IResolvable (optional)

IAM Identity Center is enabled for the OpenSearch Application.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-enabled

---

iamIdentityCenterInstanceArn?

Type: string (optional)

Amazon Resource Name (ARN) format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-iamidentitycenterinstancearn

---

iamRoleForIdentityCenterApplicationArn?

Type: string (optional)

Amazon Resource Name of the IAM Identity Center's Application created for the OpenSearch Application after enabling IAM Identity Center.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-application-iamidentitycenteroptions.html#cfn-opensearchservice-application-iamidentitycenteroptions-iamroleforidentitycenterapplicationarn