Package software.amazon.awscdk.services.opensearchservice

Interface CfnApplication.IamIdentityCenterOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplication.IamIdentityCenterOptionsProperty.Jsii$Proxy

Enclosing class:

CfnApplication

@Stability(Stable)
public static interface CfnApplication.IamIdentityCenterOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Configuration settings for IAM Identity Center in an OpenSearch application.

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.*;
 IamIdentityCenterOptionsProperty iamIdentityCenterOptionsProperty = IamIdentityCenterOptionsProperty.builder()
         .enabled(false)
         .iamIdentityCenterInstanceArn("iamIdentityCenterInstanceArn")
         .iamRoleForIdentityCenterApplicationArn("iamRoleForIdentityCenterApplicationArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplication.IamIdentityCenterOptionsProperty.Builder	builder()
default Object	getEnabled()	Indicates whether IAM Identity Center is enabled for the OpenSearch application.
default String	getIamIdentityCenterInstanceArn()	Amazon Resource Name (ARN) format.
default String	getIamRoleForIdentityCenterApplicationArn()	The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

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

Indicates whether IAM Identity Center is enabled for the OpenSearch application.

Returns union: either Boolean or IResolvable

See Also:

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

getIamIdentityCenterInstanceArn

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

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

getIamRoleForIdentityCenterApplicationArn

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

The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application.

See Also:

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

builder

@Stability(Stable)
static CfnApplication.IamIdentityCenterOptionsProperty.Builder builder()

Returns:

a CfnApplication.IamIdentityCenterOptionsProperty.Builder of CfnApplication.IamIdentityCenterOptionsProperty