Class CfnDomainPropsMixin.IdentityCenterOptionsProperty

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

Inheritance

object

CfnDomainPropsMixin.IdentityCenterOptionsProperty

Implements

CfnDomainPropsMixin.IIdentityCenterOptionsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.OpenSearchService

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDomainPropsMixin.IdentityCenterOptionsProperty : CfnDomainPropsMixin.IIdentityCenterOptionsProperty

Syntax (vb)

Public Class CfnDomainPropsMixin.IdentityCenterOptionsProperty Implements CfnDomainPropsMixin.IIdentityCenterOptionsProperty

Remarks

This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.OpenSearchService;

             var identityCenterOptionsProperty = new IdentityCenterOptionsProperty {
                 EnabledApiAccess = false,
                 IdentityCenterApplicationArn = "identityCenterApplicationArn",
                 IdentityCenterInstanceArn = "identityCenterInstanceArn",
                 IdentityStoreId = "identityStoreId",
                 RolesKey = "rolesKey",
                 SubjectKey = "subjectKey"
             };

Synopsis

Constructors

IdentityCenterOptionsProperty()

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

Properties

EnabledApiAccess	Indicates whether IAM Identity Center is enabled for the application.
IdentityCenterApplicationArn	The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.
IdentityCenterInstanceArn	The Amazon Resource Name (ARN) of the IAM Identity Center instance.
IdentityStoreId	The identifier of the IAM Identity Store.
RolesKey	Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.
SubjectKey	Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

Constructors

IdentityCenterOptionsProperty()

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.

public IdentityCenterOptionsProperty()

Remarks

This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.OpenSearchService;

             var identityCenterOptionsProperty = new IdentityCenterOptionsProperty {
                 EnabledApiAccess = false,
                 IdentityCenterApplicationArn = "identityCenterApplicationArn",
                 IdentityCenterInstanceArn = "identityCenterInstanceArn",
                 IdentityStoreId = "identityStoreId",
                 RolesKey = "rolesKey",
                 SubjectKey = "subjectKey"
             };

Properties

EnabledApiAccess

Indicates whether IAM Identity Center is enabled for the application.

public object? EnabledApiAccess { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

IdentityCenterApplicationArn

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

public string? IdentityCenterApplicationArn { get; set; }

Property Value

string

Remarks

IdentityCenterInstanceArn

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

public string? IdentityCenterInstanceArn { get; set; }

Property Value

string

Remarks

IdentityStoreId

The identifier of the IAM Identity Store.

public string? IdentityStoreId { get; set; }

Property Value

string

Remarks

RolesKey

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

public string? RolesKey { get; set; }

Property Value

string

Remarks

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

SubjectKey

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

public string? SubjectKey { get; set; }