AWS SDK for C++  1.9.105
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::CreateIndexRequest Class Reference

#include <CreateIndexRequest.h>

+ Inheritance diagram for Aws::kendra::Model::CreateIndexRequest:

Public Member Functions

 CreateIndexRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateIndexRequestWithName (const Aws::String &value)
 
CreateIndexRequestWithName (Aws::String &&value)
 
CreateIndexRequestWithName (const char *value)
 
const IndexEditionGetEdition () const
 
bool EditionHasBeenSet () const
 
void SetEdition (const IndexEdition &value)
 
void SetEdition (IndexEdition &&value)
 
CreateIndexRequestWithEdition (const IndexEdition &value)
 
CreateIndexRequestWithEdition (IndexEdition &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
CreateIndexRequestWithRoleArn (const Aws::String &value)
 
CreateIndexRequestWithRoleArn (Aws::String &&value)
 
CreateIndexRequestWithRoleArn (const char *value)
 
const ServerSideEncryptionConfigurationGetServerSideEncryptionConfiguration () const
 
bool ServerSideEncryptionConfigurationHasBeenSet () const
 
void SetServerSideEncryptionConfiguration (const ServerSideEncryptionConfiguration &value)
 
void SetServerSideEncryptionConfiguration (ServerSideEncryptionConfiguration &&value)
 
CreateIndexRequestWithServerSideEncryptionConfiguration (const ServerSideEncryptionConfiguration &value)
 
CreateIndexRequestWithServerSideEncryptionConfiguration (ServerSideEncryptionConfiguration &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateIndexRequestWithDescription (const Aws::String &value)
 
CreateIndexRequestWithDescription (Aws::String &&value)
 
CreateIndexRequestWithDescription (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateIndexRequestWithClientToken (const Aws::String &value)
 
CreateIndexRequestWithClientToken (Aws::String &&value)
 
CreateIndexRequestWithClientToken (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateIndexRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateIndexRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateIndexRequestAddTags (const Tag &value)
 
CreateIndexRequestAddTags (Tag &&value)
 
const Aws::Vector< UserTokenConfiguration > & GetUserTokenConfigurations () const
 
bool UserTokenConfigurationsHasBeenSet () const
 
void SetUserTokenConfigurations (const Aws::Vector< UserTokenConfiguration > &value)
 
void SetUserTokenConfigurations (Aws::Vector< UserTokenConfiguration > &&value)
 
CreateIndexRequestWithUserTokenConfigurations (const Aws::Vector< UserTokenConfiguration > &value)
 
CreateIndexRequestWithUserTokenConfigurations (Aws::Vector< UserTokenConfiguration > &&value)
 
CreateIndexRequestAddUserTokenConfigurations (const UserTokenConfiguration &value)
 
CreateIndexRequestAddUserTokenConfigurations (UserTokenConfiguration &&value)
 
const UserContextPolicyGetUserContextPolicy () const
 
bool UserContextPolicyHasBeenSet () const
 
void SetUserContextPolicy (const UserContextPolicy &value)
 
void SetUserContextPolicy (UserContextPolicy &&value)
 
CreateIndexRequestWithUserContextPolicy (const UserContextPolicy &value)
 
CreateIndexRequestWithUserContextPolicy (UserContextPolicy &&value)
 
- Public Member Functions inherited from Aws::kendra::KendraRequest
virtual ~KendraRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 28 of file CreateIndexRequest.h.

Constructor & Destructor Documentation

◆ CreateIndexRequest()

Aws::kendra::Model::CreateIndexRequest::CreateIndexRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::AddTags ( const Tag value)
inline

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 398 of file CreateIndexRequest.h.

◆ AddTags() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::AddTags ( Tag &&  value)
inline

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 404 of file CreateIndexRequest.h.

◆ AddUserTokenConfigurations() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::AddUserTokenConfigurations ( const UserTokenConfiguration value)
inline

The user token configuration.

Definition at line 440 of file CreateIndexRequest.h.

◆ AddUserTokenConfigurations() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::AddUserTokenConfigurations ( UserTokenConfiguration &&  value)
inline

The user token configuration.

Definition at line 445 of file CreateIndexRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::ClientTokenHasBeenSet ( ) const
inline

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

Definition at line 313 of file CreateIndexRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::DescriptionHasBeenSet ( ) const
inline

A description for the index.

Definition at line 268 of file CreateIndexRequest.h.

◆ EditionHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::EditionHasBeenSet ( ) const
inline

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 your production databases. 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.

Definition at line 107 of file CreateIndexRequest.h.

◆ GetClientToken()

const Aws::String& Aws::kendra::Model::CreateIndexRequest::GetClientToken ( ) const
inline

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

Definition at line 306 of file CreateIndexRequest.h.

◆ GetDescription()

const Aws::String& Aws::kendra::Model::CreateIndexRequest::GetDescription ( ) const
inline

A description for the index.

Definition at line 263 of file CreateIndexRequest.h.

◆ GetEdition()

const IndexEdition& Aws::kendra::Model::CreateIndexRequest::GetEdition ( ) const
inline

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 your production databases. 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.

Definition at line 95 of file CreateIndexRequest.h.

◆ GetName()

const Aws::String& Aws::kendra::Model::CreateIndexRequest::GetName ( ) const
inline

The name for the new index.

Definition at line 47 of file CreateIndexRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::kendra::Model::CreateIndexRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

◆ GetRoleArn()

const Aws::String& Aws::kendra::Model::CreateIndexRequest::GetRoleArn ( ) const
inline

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 164 of file CreateIndexRequest.h.

◆ GetServerSideEncryptionConfiguration()

const ServerSideEncryptionConfiguration& Aws::kendra::Model::CreateIndexRequest::GetServerSideEncryptionConfiguration ( ) const
inline

The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 227 of file CreateIndexRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::kendra::Model::CreateIndexRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateIndexRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::kendra::Model::CreateIndexRequest::GetTags ( ) const
inline

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 362 of file CreateIndexRequest.h.

◆ GetUserContextPolicy()

const UserContextPolicy& Aws::kendra::Model::CreateIndexRequest::GetUserContextPolicy ( ) const
inline

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Definition at line 456 of file CreateIndexRequest.h.

◆ GetUserTokenConfigurations()

const Aws::Vector<UserTokenConfiguration>& Aws::kendra::Model::CreateIndexRequest::GetUserTokenConfigurations ( ) const
inline

The user token configuration.

Definition at line 410 of file CreateIndexRequest.h.

◆ NameHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::NameHasBeenSet ( ) const
inline

The name for the new index.

Definition at line 52 of file CreateIndexRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::RoleArnHasBeenSet ( ) const
inline

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 172 of file CreateIndexRequest.h.

◆ SerializePayload()

Aws::String Aws::kendra::Model::CreateIndexRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServerSideEncryptionConfigurationHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::ServerSideEncryptionConfigurationHasBeenSet ( ) const
inline

The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 233 of file CreateIndexRequest.h.

◆ SetClientToken() [1/3]

void Aws::kendra::Model::CreateIndexRequest::SetClientToken ( Aws::String &&  value)
inline

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

Definition at line 327 of file CreateIndexRequest.h.

◆ SetClientToken() [2/3]

void Aws::kendra::Model::CreateIndexRequest::SetClientToken ( const Aws::String value)
inline

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

Definition at line 320 of file CreateIndexRequest.h.

◆ SetClientToken() [3/3]

void Aws::kendra::Model::CreateIndexRequest::SetClientToken ( const char *  value)
inline

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

Definition at line 334 of file CreateIndexRequest.h.

◆ SetDescription() [1/3]

void Aws::kendra::Model::CreateIndexRequest::SetDescription ( Aws::String &&  value)
inline

A description for the index.

Definition at line 278 of file CreateIndexRequest.h.

◆ SetDescription() [2/3]

void Aws::kendra::Model::CreateIndexRequest::SetDescription ( const Aws::String value)
inline

A description for the index.

Definition at line 273 of file CreateIndexRequest.h.

◆ SetDescription() [3/3]

void Aws::kendra::Model::CreateIndexRequest::SetDescription ( const char *  value)
inline

A description for the index.

Definition at line 283 of file CreateIndexRequest.h.

◆ SetEdition() [1/2]

void Aws::kendra::Model::CreateIndexRequest::SetEdition ( const IndexEdition value)
inline

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 your production databases. 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.

Definition at line 119 of file CreateIndexRequest.h.

◆ SetEdition() [2/2]

void Aws::kendra::Model::CreateIndexRequest::SetEdition ( IndexEdition &&  value)
inline

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 your production databases. 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.

Definition at line 131 of file CreateIndexRequest.h.

◆ SetName() [1/3]

void Aws::kendra::Model::CreateIndexRequest::SetName ( Aws::String &&  value)
inline

The name for the new index.

Definition at line 62 of file CreateIndexRequest.h.

◆ SetName() [2/3]

void Aws::kendra::Model::CreateIndexRequest::SetName ( const Aws::String value)
inline

The name for the new index.

Definition at line 57 of file CreateIndexRequest.h.

◆ SetName() [3/3]

void Aws::kendra::Model::CreateIndexRequest::SetName ( const char *  value)
inline

The name for the new index.

Definition at line 67 of file CreateIndexRequest.h.

◆ SetRoleArn() [1/3]

void Aws::kendra::Model::CreateIndexRequest::SetRoleArn ( Aws::String &&  value)
inline

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 188 of file CreateIndexRequest.h.

◆ SetRoleArn() [2/3]

void Aws::kendra::Model::CreateIndexRequest::SetRoleArn ( const Aws::String value)
inline

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 180 of file CreateIndexRequest.h.

◆ SetRoleArn() [3/3]

void Aws::kendra::Model::CreateIndexRequest::SetRoleArn ( const char *  value)
inline

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 196 of file CreateIndexRequest.h.

◆ SetServerSideEncryptionConfiguration() [1/2]

void Aws::kendra::Model::CreateIndexRequest::SetServerSideEncryptionConfiguration ( const ServerSideEncryptionConfiguration value)
inline

The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 239 of file CreateIndexRequest.h.

◆ SetServerSideEncryptionConfiguration() [2/2]

void Aws::kendra::Model::CreateIndexRequest::SetServerSideEncryptionConfiguration ( ServerSideEncryptionConfiguration &&  value)
inline

The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 245 of file CreateIndexRequest.h.

◆ SetTags() [1/2]

void Aws::kendra::Model::CreateIndexRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 380 of file CreateIndexRequest.h.

◆ SetTags() [2/2]

void Aws::kendra::Model::CreateIndexRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 374 of file CreateIndexRequest.h.

◆ SetUserContextPolicy() [1/2]

void Aws::kendra::Model::CreateIndexRequest::SetUserContextPolicy ( const UserContextPolicy value)
inline

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Definition at line 476 of file CreateIndexRequest.h.

◆ SetUserContextPolicy() [2/2]

void Aws::kendra::Model::CreateIndexRequest::SetUserContextPolicy ( UserContextPolicy &&  value)
inline

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Definition at line 486 of file CreateIndexRequest.h.

◆ SetUserTokenConfigurations() [1/2]

void Aws::kendra::Model::CreateIndexRequest::SetUserTokenConfigurations ( Aws::Vector< UserTokenConfiguration > &&  value)
inline

The user token configuration.

Definition at line 425 of file CreateIndexRequest.h.

◆ SetUserTokenConfigurations() [2/2]

void Aws::kendra::Model::CreateIndexRequest::SetUserTokenConfigurations ( const Aws::Vector< UserTokenConfiguration > &  value)
inline

The user token configuration.

Definition at line 420 of file CreateIndexRequest.h.

◆ TagsHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::TagsHasBeenSet ( ) const
inline

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 368 of file CreateIndexRequest.h.

◆ UserContextPolicyHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::UserContextPolicyHasBeenSet ( ) const
inline

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Definition at line 466 of file CreateIndexRequest.h.

◆ UserTokenConfigurationsHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::UserTokenConfigurationsHasBeenSet ( ) const
inline

The user token configuration.

Definition at line 415 of file CreateIndexRequest.h.

◆ WithClientToken() [1/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithClientToken ( Aws::String &&  value)
inline

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

Definition at line 348 of file CreateIndexRequest.h.

◆ WithClientToken() [2/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithClientToken ( const Aws::String value)
inline

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

Definition at line 341 of file CreateIndexRequest.h.

◆ WithClientToken() [3/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithClientToken ( const char *  value)
inline

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

Definition at line 355 of file CreateIndexRequest.h.

◆ WithDescription() [1/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithDescription ( Aws::String &&  value)
inline

A description for the index.

Definition at line 293 of file CreateIndexRequest.h.

◆ WithDescription() [2/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithDescription ( const Aws::String value)
inline

A description for the index.

Definition at line 288 of file CreateIndexRequest.h.

◆ WithDescription() [3/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithDescription ( const char *  value)
inline

A description for the index.

Definition at line 298 of file CreateIndexRequest.h.

◆ WithEdition() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithEdition ( const IndexEdition value)
inline

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 your production databases. 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.

Definition at line 143 of file CreateIndexRequest.h.

◆ WithEdition() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithEdition ( IndexEdition &&  value)
inline

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 your production databases. 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.

Definition at line 155 of file CreateIndexRequest.h.

◆ WithName() [1/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithName ( Aws::String &&  value)
inline

The name for the new index.

Definition at line 77 of file CreateIndexRequest.h.

◆ WithName() [2/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithName ( const Aws::String value)
inline

The name for the new index.

Definition at line 72 of file CreateIndexRequest.h.

◆ WithName() [3/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithName ( const char *  value)
inline

The name for the new index.

Definition at line 82 of file CreateIndexRequest.h.

◆ WithRoleArn() [1/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithRoleArn ( Aws::String &&  value)
inline

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 212 of file CreateIndexRequest.h.

◆ WithRoleArn() [2/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithRoleArn ( const Aws::String value)
inline

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 204 of file CreateIndexRequest.h.

◆ WithRoleArn() [3/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithRoleArn ( const char *  value)
inline

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 220 of file CreateIndexRequest.h.

◆ WithServerSideEncryptionConfiguration() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithServerSideEncryptionConfiguration ( const ServerSideEncryptionConfiguration value)
inline

The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 251 of file CreateIndexRequest.h.

◆ WithServerSideEncryptionConfiguration() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithServerSideEncryptionConfiguration ( ServerSideEncryptionConfiguration &&  value)
inline

The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 257 of file CreateIndexRequest.h.

◆ WithTags() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 392 of file CreateIndexRequest.h.

◆ WithTags() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 386 of file CreateIndexRequest.h.

◆ WithUserContextPolicy() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithUserContextPolicy ( const UserContextPolicy value)
inline

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Definition at line 496 of file CreateIndexRequest.h.

◆ WithUserContextPolicy() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithUserContextPolicy ( UserContextPolicy &&  value)
inline

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Definition at line 506 of file CreateIndexRequest.h.

◆ WithUserTokenConfigurations() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithUserTokenConfigurations ( Aws::Vector< UserTokenConfiguration > &&  value)
inline

The user token configuration.

Definition at line 435 of file CreateIndexRequest.h.

◆ WithUserTokenConfigurations() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithUserTokenConfigurations ( const Aws::Vector< UserTokenConfiguration > &  value)
inline

The user token configuration.

Definition at line 430 of file CreateIndexRequest.h.


The documentation for this class was generated from the following file: