com.amazonaws.services.kendra.model

Class UserGroupResolutionConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.UserGroupResolutionConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserGroupResolutionConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides the configuration information to get users and groups from an IAM Identity Center identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the PutPrincipalMapping API to map users to their groups so that you only need to provide the user ID when you issue the query.

To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see Getting started with an IAM Identity Center identity source. You must also grant the required permissions to use IAM Identity Center with Amazon Kendra. For more information, see IAM roles for IAM Identity Center.

Amazon Kendra currently does not support using UserGroupResolutionConfiguration with an Amazon Web Services organization member account for your IAM Identity Center identify source. You must create your index in the management account for the organization in order to use UserGroupResolutionConfiguration.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserGroupResolutionConfiguration()

Method Summary

Modifier and Type	Method and Description
UserGroupResolutionConfiguration	clone()
boolean	equals(Object obj)
String	getUserGroupResolutionMode() The identity store provider (mode) you want to use to get users and groups.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setUserGroupResolutionMode(String userGroupResolutionMode) The identity store provider (mode) you want to use to get users and groups.
String	toString() Returns a string representation of this object.
UserGroupResolutionConfiguration	withUserGroupResolutionMode(String userGroupResolutionMode) The identity store provider (mode) you want to use to get users and groups.
UserGroupResolutionConfiguration	withUserGroupResolutionMode(UserGroupResolutionMode userGroupResolutionMode) The identity store provider (mode) you want to use to get users and groups.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserGroupResolutionConfiguration

public UserGroupResolutionConfiguration()

Method Detail

setUserGroupResolutionMode

public void setUserGroupResolutionMode(String userGroupResolutionMode)

The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Parameters:

userGroupResolutionMode - The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

See Also:

UserGroupResolutionMode

getUserGroupResolutionMode

public String getUserGroupResolutionMode()

The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Returns:

The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

See Also:

UserGroupResolutionMode

withUserGroupResolutionMode

public UserGroupResolutionConfiguration withUserGroupResolutionMode(String userGroupResolutionMode)

The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Parameters:

userGroupResolutionMode - The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserGroupResolutionMode

withUserGroupResolutionMode

public UserGroupResolutionConfiguration withUserGroupResolutionMode(UserGroupResolutionMode userGroupResolutionMode)

The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Parameters:

userGroupResolutionMode - The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserGroupResolutionMode

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UserGroupResolutionConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.