com.amazonaws.services.kendra.model.UserGroupResolutionConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UserGroupResolutionConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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.
*
*/
private 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.
*
*
* @param 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 UserGroupResolutionMode
*/
public void setUserGroupResolutionMode(String userGroupResolutionMode) {
this.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.
*
*
* @return 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 UserGroupResolutionMode
*/
public String getUserGroupResolutionMode() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserGroupResolutionMode
*/
public UserGroupResolutionConfiguration withUserGroupResolutionMode(String userGroupResolutionMode) {
setUserGroupResolutionMode(userGroupResolutionMode);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserGroupResolutionMode
*/
public UserGroupResolutionConfiguration withUserGroupResolutionMode(UserGroupResolutionMode userGroupResolutionMode) {
this.userGroupResolutionMode = userGroupResolutionMode.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUserGroupResolutionMode() != null)
sb.append("UserGroupResolutionMode: ").append(getUserGroupResolutionMode());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UserGroupResolutionConfiguration == false)
return false;
UserGroupResolutionConfiguration other = (UserGroupResolutionConfiguration) obj;
if (other.getUserGroupResolutionMode() == null ^ this.getUserGroupResolutionMode() == null)
return false;
if (other.getUserGroupResolutionMode() != null && other.getUserGroupResolutionMode().equals(this.getUserGroupResolutionMode()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserGroupResolutionMode() == null) ? 0 : getUserGroupResolutionMode().hashCode());
return hashCode;
}
@Override
public UserGroupResolutionConfiguration clone() {
try {
return (UserGroupResolutionConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kendra.model.transform.UserGroupResolutionConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}