Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.IdentityCenterOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.IdentityCenterOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.IdentityCenterOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Container for IAM Identity Center Options settings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchservice.*;
 IdentityCenterOptionsProperty identityCenterOptionsProperty = IdentityCenterOptionsProperty.builder()
         .enabledApiAccess(false)
         .identityCenterApplicationArn("identityCenterApplicationArn")
         .identityCenterInstanceArn("identityCenterInstanceArn")
         .identityStoreId("identityStoreId")
         .rolesKey("rolesKey")
         .subjectKey("subjectKey")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.IdentityCenterOptionsProperty.Builder	A builder for CfnDomain.IdentityCenterOptionsProperty
static final class	CfnDomain.IdentityCenterOptionsProperty.Jsii$Proxy	An implementation for CfnDomain.IdentityCenterOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.IdentityCenterOptionsProperty.Builder	builder()
default Object	getEnabledApiAccess()	True to enable IAM Identity Center for API access in Amazon OpenSearch Service.
default String	getIdentityCenterApplicationArn()	The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.
default String	getIdentityCenterInstanceArn()	The ARN for IAM Identity Center Instance.
default String	getIdentityStoreId()	The ID of IAM Identity Store.
default String	getRolesKey()	Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center.
default String	getSubjectKey()	Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabledApiAccess

@Stability(Stable)
@Nullable
default Object getEnabledApiAccess()

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

getIdentityCenterApplicationArn

@Stability(Stable)
@Nullable
default String getIdentityCenterApplicationArn()

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

getIdentityCenterInstanceArn

@Stability(Stable)
@Nullable
default String getIdentityCenterInstanceArn()

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

getIdentityStoreId

@Stability(Stable)
@Nullable
default String getIdentityStoreId()

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

getRolesKey

@Stability(Stable)
@Nullable
default String getRolesKey()

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

getSubjectKey

@Stability(Stable)
@Nullable
default String getSubjectKey()

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

builder

@Stability(Stable)
static CfnDomain.IdentityCenterOptionsProperty.Builder builder()

Returns:

a CfnDomain.IdentityCenterOptionsProperty.Builder of CfnDomain.IdentityCenterOptionsProperty