/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace kendra { namespace Model { /** *

Provides the configuration information to get users and groups from an IAM * Identity Center (successor to Single Sign-On) 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 Reference

*/ class UserGroupResolutionConfiguration { public: AWS_KENDRA_API UserGroupResolutionConfiguration(); AWS_KENDRA_API UserGroupResolutionConfiguration(Aws::Utils::Json::JsonView jsonValue); AWS_KENDRA_API UserGroupResolutionConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_KENDRA_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The identity store provider (mode) you want to use to get users and groups. * IAM Identity Center (successor to Single Sign-On) 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.

*/ inline const UserGroupResolutionMode& GetUserGroupResolutionMode() const{ return m_userGroupResolutionMode; } /** *

The identity store provider (mode) you want to use to get users and groups. * IAM Identity Center (successor to Single Sign-On) 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.

*/ inline bool UserGroupResolutionModeHasBeenSet() const { return m_userGroupResolutionModeHasBeenSet; } /** *

The identity store provider (mode) you want to use to get users and groups. * IAM Identity Center (successor to Single Sign-On) 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.

*/ inline void SetUserGroupResolutionMode(const UserGroupResolutionMode& value) { m_userGroupResolutionModeHasBeenSet = true; m_userGroupResolutionMode = value; } /** *

The identity store provider (mode) you want to use to get users and groups. * IAM Identity Center (successor to Single Sign-On) 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.

*/ inline void SetUserGroupResolutionMode(UserGroupResolutionMode&& value) { m_userGroupResolutionModeHasBeenSet = true; m_userGroupResolutionMode = std::move(value); } /** *

The identity store provider (mode) you want to use to get users and groups. * IAM Identity Center (successor to Single Sign-On) 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.

*/ inline UserGroupResolutionConfiguration& WithUserGroupResolutionMode(const UserGroupResolutionMode& value) { SetUserGroupResolutionMode(value); return *this;} /** *

The identity store provider (mode) you want to use to get users and groups. * IAM Identity Center (successor to Single Sign-On) 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.

*/ inline UserGroupResolutionConfiguration& WithUserGroupResolutionMode(UserGroupResolutionMode&& value) { SetUserGroupResolutionMode(std::move(value)); return *this;} private: UserGroupResolutionMode m_userGroupResolutionMode; bool m_userGroupResolutionModeHasBeenSet = false; }; } // namespace Model } // namespace kendra } // namespace Aws