CreateIndexRequest

import type { CreateIndexRequest } from "https://aws-api.deno.dev/v0.4/services/kendra.ts?docs=full";

interface CreateIndexRequest {

ClientToken?: string | null;

Description?: string | null;

Edition?: IndexEdition | null;

Name: string;

RoleArn: string;

ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | null;

Tags?: Tag[] | null;

UserContextPolicy?: UserContextPolicy | null;

UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | null;

UserTokenConfigurations?: UserTokenConfiguration[] | null;

}

§Properties

ClientToken?: string | null

[src]

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.

Description?: string | null

[src]

A description for the index.

Edition?: IndexEdition | null

[src]

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.

Name: string

[src]

A name for the index.

RoleArn: string

[src]

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 you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.

ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | null

[src]

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.

Tags?: Tag[] | null

[src]

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.

UserContextPolicy?: UserContextPolicy | null

[src]

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.

UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | null

[src]

Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

UserTokenConfigurations?: UserTokenConfiguration[] | null

[src]

The user token configuration.