com.amazonaws.services.kendra.model

Class CreateIndexRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.CreateIndexRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateIndexRequest()

Method Summary

Modifier and Type	Method and Description
CreateIndexRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A token that you provide to identify the request to create an index.
String	getDescription() A description for the index.
String	getEdition() The Amazon Kendra edition to use for the index.
String	getName() A name for the index.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics.
ServerSideEncryptionConfiguration	getServerSideEncryptionConfiguration() The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra.
List<Tag>	getTags() A list of key-value pairs that identify or categorize the index.
String	getUserContextPolicy() The user context policy.
UserGroupResolutionConfiguration	getUserGroupResolutionConfiguration() Gets users and groups from IAM Identity Center identity source.
List<UserTokenConfiguration>	getUserTokenConfigurations() The user token configuration.
int	hashCode()
void	setClientToken(String clientToken) A token that you provide to identify the request to create an index.
void	setDescription(String description) A description for the index.
void	setEdition(String edition) The Amazon Kendra edition to use for the index.
void	setName(String name) A name for the index.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics.
void	setServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra.
void	setTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the index.
void	setUserContextPolicy(String userContextPolicy) The user context policy.
void	setUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration) Gets users and groups from IAM Identity Center identity source.
void	setUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations) The user token configuration.
String	toString() Returns a string representation of this object.
CreateIndexRequest	withClientToken(String clientToken) A token that you provide to identify the request to create an index.
CreateIndexRequest	withDescription(String description) A description for the index.
CreateIndexRequest	withEdition(IndexEdition edition) The Amazon Kendra edition to use for the index.
CreateIndexRequest	withEdition(String edition) The Amazon Kendra edition to use for the index.
CreateIndexRequest	withName(String name) A name for the index.
CreateIndexRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics.
CreateIndexRequest	withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra.
CreateIndexRequest	withTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the index.
CreateIndexRequest	withTags(Tag... tags) A list of key-value pairs that identify or categorize the index.
CreateIndexRequest	withUserContextPolicy(String userContextPolicy) The user context policy.
CreateIndexRequest	withUserContextPolicy(UserContextPolicy userContextPolicy) The user context policy.
CreateIndexRequest	withUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration) Gets users and groups from IAM Identity Center identity source.
CreateIndexRequest	withUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations) The user token configuration.
CreateIndexRequest	withUserTokenConfigurations(UserTokenConfiguration... userTokenConfigurations) The user token configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateIndexRequest

public CreateIndexRequest()

Method Detail

setName

public void setName(String name)

A name for the index.

Parameters:

name - A name for the index.

getName

public String getName()

A name for the index.

Returns:

A name for the index.

withName

public CreateIndexRequest withName(String name)

A name for the index.

Parameters:

name - A name for the index.

Returns:

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

setEdition

public void setEdition(String edition)

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Parameters:

edition - The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

See Also:

IndexEdition

getEdition

public String getEdition()

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Returns:

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

See Also:

IndexEdition

withEdition

public CreateIndexRequest withEdition(String edition)

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Parameters:

edition - The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Returns:

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

See Also:

IndexEdition

withEdition

public CreateIndexRequest withEdition(IndexEdition edition)

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Parameters:

edition - The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Returns:

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

See Also:

IndexEdition

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

Returns:

The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

withRoleArn

public CreateIndexRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

Returns:

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

setServerSideEncryptionConfiguration

public void setServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Parameters:

serverSideEncryptionConfiguration - The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

getServerSideEncryptionConfiguration

public ServerSideEncryptionConfiguration getServerSideEncryptionConfiguration()

The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Returns:

The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

withServerSideEncryptionConfiguration

public CreateIndexRequest withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Parameters:

serverSideEncryptionConfiguration - The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Returns:

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

setDescription

public void setDescription(String description)

A description for the index.

Parameters:

description - A description for the index.

getDescription

public String getDescription()

A description for the index.

Returns:

A description for the index.

withDescription

public CreateIndexRequest withDescription(String description)

A description for the index.

Parameters:

description - A description for the index.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Parameters:

clientToken - A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

getClientToken

public String getClientToken()

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Returns:

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

withClientToken

public CreateIndexRequest withClientToken(String clientToken)

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Parameters:

clientToken - A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Returns:

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

getTags

public List<Tag> getTags()

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

setTags

public void setTags(Collection<Tag> tags)

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Parameters:

tags - A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

withTags

public CreateIndexRequest withTags(Tag... tags)

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

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

withTags

public CreateIndexRequest withTags(Collection<Tag> tags)

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Parameters:

tags - A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

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

getUserTokenConfigurations

public List<UserTokenConfiguration> getUserTokenConfigurations()

The user token configuration.

Returns:

The user token configuration.

setUserTokenConfigurations

public void setUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)

The user token configuration.

Parameters:

userTokenConfigurations - The user token configuration.

withUserTokenConfigurations

public CreateIndexRequest withUserTokenConfigurations(UserTokenConfiguration... userTokenConfigurations)

The user token configuration.

NOTE: This method appends the values to the existing list (if any). Use setUserTokenConfigurations(java.util.Collection) or withUserTokenConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

userTokenConfigurations - The user token configuration.

Returns:

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

withUserTokenConfigurations

public CreateIndexRequest withUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)

The user token configuration.

Parameters:

userTokenConfigurations - The user token configuration.

Returns:

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

setUserContextPolicy

public void setUserContextPolicy(String userContextPolicy)

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Parameters:

userContextPolicy - The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

See Also:

UserContextPolicy

getUserContextPolicy

public String getUserContextPolicy()

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Returns:

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

See Also:

UserContextPolicy

withUserContextPolicy

public CreateIndexRequest withUserContextPolicy(String userContextPolicy)

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Parameters:

userContextPolicy - The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Returns:

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

See Also:

UserContextPolicy

withUserContextPolicy

public CreateIndexRequest withUserContextPolicy(UserContextPolicy userContextPolicy)

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Parameters:

userContextPolicy - The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Returns:

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

See Also:

UserContextPolicy

setUserGroupResolutionConfiguration

public void setUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameters:

userGroupResolutionConfiguration - Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

getUserGroupResolutionConfiguration

public UserGroupResolutionConfiguration getUserGroupResolutionConfiguration()

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

withUserGroupResolutionConfiguration

public CreateIndexRequest withUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameters:

userGroupResolutionConfiguration - Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

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

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 CreateIndexRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()