Skip to content

Data Source: awsKendraIndex

Provides details about a specific Amazon Kendra Index.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsKendraIndex.DataAwsKendraIndex(this, "example", {
  id: "12345678-1234-1234-1234-123456789123",
});

Argument Reference

The following arguments are supported:

  • id - (Required) Returns information on a specific Index by id.

Attributes Reference

In addition to all of the arguments above, the following attributes are exported:

  • arn - ARN of the Index.
  • capacityUnits - Block that sets the number of additional document storage and query capacity units that should be used by the index. Documented below.
  • createdAt - Unix datetime that the index was created.
  • description - Description of the Index.
  • documentMetadataConfigurationUpdates - One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Documented below.
  • edition - Amazon Kendra edition for the index.
  • errorMessage - When the Status field value is failed, this contains a message that explains why.
  • id - Identifier of the Index.
  • indexStatistics - Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Documented below.
  • name - Name of the Index.
  • roleArn - An AWS 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 - A block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Documented below.
  • status - Current status of the index. When the value is active, the index is ready for use. If the Status field value is failed, the errorMessage field contains a message that explains why.
  • updatedAt - Unix datetime that the index was last updated.
  • userContextPolicy - User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to [UserContextPolicy](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex. html#Kendra-CreateIndex-request-UserContextPolicy).
  • userGroupResolutionConfiguration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Documented below.
  • userTokenConfigurations - A block that specifies the user token configuration. Documented below.
  • tags - Metadata that helps organize the Indices you create.

A capacityUnits block supports the following attributes:

  • queryCapacityUnits - The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
  • storageCapacityUnits - The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. Minimum value of 0.

A documentMetadataConfigurationUpdates block supports the following attributes:

  • name - Name of the index field. Minimum length of 1. Maximum length of 30.
  • relevance - Block that provides manual tuning parameters to determine how the field affects the search results. Documented below.
  • search - Block that provides information about how the field is used during a search. Documented below.
  • type - Data type of the index field. Valid values are STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE.

A relevance block supports the following attributes:

  • duration - Time period that the boost applies to. For more information, refer to Duration.
  • freshness - How "fresh" a document is. For more information, refer to Freshness.
  • importance - Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
  • rankOrder - Determines how values should be interpreted. For more information, refer to RankOrder.
  • valuesImportanceMap - A list of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.

A search block supports the following attributes:

  • displayable - Determines whether the field is returned in the query response. The default is true.
  • facetable - Whether the field can be used to create search facets, a count of results for each value in the field. The default is false.
  • searchable - Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
  • sortable - Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

A indexStatistics block supports the following attributes:

  • faqStatistics - Block that specifies the number of question and answer topics in the index. Documented below.
  • textDocumentStatistics - A block that specifies the number of text documents indexed.

A faqStatistics block supports the following attributes:

  • indexedQuestionAnswersCount - The total number of FAQ questions and answers contained in the index.

A textDocumentStatistics block supports the following attributes:

  • indexedTextBytes - Total size, in bytes, of the indexed documents.
  • indexedTextDocumentsCount - The number of text documents indexed.

A serverSideEncryptionConfiguration block supports the following attributes:

  • kmsKeyId - Identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

A userGroupResolutionConfiguration block supports the following attributes:

  • userGroupResolutionMode - The identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are AWS_SSO or none.

A userTokenConfigurations block supports the following attributes:

  • jsonTokenTypeConfiguration - A block that specifies the information about the JSON token type configuration.
  • jwtTokenTypeConfiguration - A block that specifies the information about the JWT token type configuration.

A jsonTokenTypeConfiguration block supports the following attributes:

  • groupAttributeField - The group attribute field.
  • userNameAttributeField - The user name attribute field.

A jwtTokenTypeConfiguration block supports the following attributes:

  • claimRegex - Regular expression that identifies the claim.
  • groupAttributeField - The group attribute field.
  • issuer - Issuer of the token.
  • keyLocation - Location of the key. Valid values are url or SECRET_MANAGER
  • secretsManagerArn - ARN of the secret.
  • url - Signing key URL.
  • userNameAttributeField - The user name attribute field.