Package com.pulumi.aws.kendra
Class Index
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.kendra.Index
-
public class Index extends com.pulumi.resources.CustomResourceProvides an Amazon Kendra Index resource. ## Example Usage ### Basic
### With capacity unitspackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.kendra.Index; import com.pulumi.aws.kendra.IndexArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Index("example", IndexArgs.builder() .name("example") .description("example") .edition("DEVELOPER_EDITION") .roleArn(this_.arn()) .tags(Map.of("Key1", "Value1")) .build()); } }
### With server side encryption configurationpackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.kendra.Index; import com.pulumi.aws.kendra.IndexArgs; import com.pulumi.aws.kendra.inputs.IndexCapacityUnitsArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Index("example", IndexArgs.builder() .capacityUnits(IndexCapacityUnitsArgs.builder() .queryCapacityUnits(2) .storageCapacityUnits(2) .build()) .name("example") .edition("DEVELOPER_EDITION") .roleArn(this_.arn()) .build()); } }
### With user group resolution configurationpackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.kendra.Index; import com.pulumi.aws.kendra.IndexArgs; import com.pulumi.aws.kendra.inputs.IndexServerSideEncryptionConfigurationArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Index("example", IndexArgs.builder() .serverSideEncryptionConfiguration(IndexServerSideEncryptionConfigurationArgs.builder() .kmsKeyId(this_.arn()) .build()) .name("example") .roleArn(thisAwsIamRole.arn()) .build()); } }
### With Document Metadata Configuration Updates ### Specifying the predefined elements Refer to [Amazon Kendra documentation on built-in document fields](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html#index-reserved-fields) for more information.package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.kendra.Index; import com.pulumi.aws.kendra.IndexArgs; import com.pulumi.aws.kendra.inputs.IndexUserGroupResolutionConfigurationArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Index("example", IndexArgs.builder() .userGroupResolutionConfiguration(IndexUserGroupResolutionConfigurationArgs.builder() .userGroupResolutionMode("AWS_SSO") .build()) .name("example") .roleArn(this_.arn()) .build()); } }
### Appending additional elements The example below shows additional elements with names, `example-string-value`, `example-long-value`, `example-string-list-value`, `example-date-value` representing the 4 types of `STRING_VALUE`, `LONG_VALUE`, `STRING_LIST_VALUE`, `DATE_VALUE` respectively.package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.kendra.Index; import com.pulumi.aws.kendra.IndexArgs; import com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateArgs; import com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs; import com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Index("example", IndexArgs.builder() .documentMetadataConfigurationUpdates( IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(false) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .build()) .name("_authors") .type("STRING_LIST_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_category") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .freshness(false) .importance(1) .duration("25920000s") .rankOrder("ASCENDING") .build()) .name("_created_at") .type("DATE_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_data_source_id") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(true) .facetable(false) .searchable(true) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(2) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_document_title") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(false) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(2) .rankOrder("ASCENDING") .build()) .name("_excerpt_page_number") .type("LONG_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_faq_id") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_file_type") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_language_code") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .freshness(false) .importance(1) .duration("25920000s") .rankOrder("ASCENDING") .build()) .name("_last_updated_at") .type("DATE_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(true) .facetable(false) .searchable(false) .sortable(false) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_source_uri") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_tenant_id") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_version") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .rankOrder("ASCENDING") .build()) .name("_view_count") .type("LONG_VALUE") .build()) .name("example") .roleArn(this_.arn()) .build()); } }
### With JSON token type configurationpackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.kendra.Index; import com.pulumi.aws.kendra.IndexArgs; import com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateArgs; import com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs; import com.pulumi.aws.kendra.inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Index("example", IndexArgs.builder() .documentMetadataConfigurationUpdates( IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(false) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .build()) .name("_authors") .type("STRING_LIST_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_category") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .freshness(false) .importance(1) .duration("25920000s") .rankOrder("ASCENDING") .build()) .name("_created_at") .type("DATE_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_data_source_id") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(true) .facetable(false) .searchable(true) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(2) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_document_title") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(false) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(2) .rankOrder("ASCENDING") .build()) .name("_excerpt_page_number") .type("LONG_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_faq_id") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_file_type") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_language_code") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .freshness(false) .importance(1) .duration("25920000s") .rankOrder("ASCENDING") .build()) .name("_last_updated_at") .type("DATE_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(true) .facetable(false) .searchable(false) .sortable(false) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_source_uri") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_tenant_id") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("_version") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .rankOrder("ASCENDING") .build()) .name("_view_count") .type("LONG_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(true) .facetable(true) .searchable(true) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .valuesImportanceMap(Map.ofEntries( )) .build()) .name("example-string-value") .type("STRING_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(true) .facetable(true) .searchable(false) .sortable(true) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .rankOrder("ASCENDING") .build()) .name("example-long-value") .type("LONG_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(true) .facetable(true) .searchable(true) .sortable(false) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .importance(1) .build()) .name("example-string-list-value") .type("STRING_LIST_VALUE") .build(), IndexDocumentMetadataConfigurationUpdateArgs.builder() .search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder() .displayable(true) .facetable(true) .searchable(false) .sortable(false) .build()) .relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder() .freshness(false) .importance(1) .duration("25920000s") .rankOrder("ASCENDING") .build()) .name("example-date-value") .type("DATE_VALUE") .build()) .name("example") .roleArn(this_.arn()) .build()); } }
## Import Using `pulumi import`, import Amazon Kendra Indexes using its `id`. For example: ```sh $ pulumi import aws:kendra/index:Index example 12345678-1234-5678-9123-123456789123 ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.kendra.Index; import com.pulumi.aws.kendra.IndexArgs; import com.pulumi.aws.kendra.inputs.IndexUserTokenConfigurationsArgs; import com.pulumi.aws.kendra.inputs.IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Index("example", IndexArgs.builder() .userTokenConfigurations(IndexUserTokenConfigurationsArgs.builder() .jsonTokenTypeConfiguration(IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs.builder() .groupAttributeField("groups") .userNameAttributeField("username") .build()) .build()) .name("example") .roleArn(this_.arn()) .build()); } }
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<IndexCapacityUnits>capacityUnits()com.pulumi.core.Output<java.lang.String>createdAt()com.pulumi.core.Output<java.util.Optional<java.lang.String>>description()com.pulumi.core.Output<java.util.List<IndexDocumentMetadataConfigurationUpdate>>documentMetadataConfigurationUpdates()com.pulumi.core.Output<java.util.Optional<java.lang.String>>edition()com.pulumi.core.Output<java.lang.String>errorMessage()static Indexget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IndexState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.util.List<IndexIndexStatistic>>indexStatistics()com.pulumi.core.Output<java.lang.String>name()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.lang.String>roleArn()com.pulumi.core.Output<java.util.Optional<IndexServerSideEncryptionConfiguration>>serverSideEncryptionConfiguration()com.pulumi.core.Output<java.lang.String>status()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()com.pulumi.core.Output<java.lang.String>updatedAt()com.pulumi.core.Output<java.util.Optional<java.lang.String>>userContextPolicy()com.pulumi.core.Output<java.util.Optional<IndexUserGroupResolutionConfiguration>>userGroupResolutionConfiguration()com.pulumi.core.Output<java.util.Optional<IndexUserTokenConfigurations>>userTokenConfigurations()
-
-
-
Constructor Detail
-
Index
public Index(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
Index
public Index(java.lang.String name, IndexArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
Index
public Index(java.lang.String name, IndexArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- ARN of the Index.
-
capacityUnits
public com.pulumi.core.Output<IndexCapacityUnits> capacityUnits()
- Returns:
- Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
-
createdAt
public com.pulumi.core.Output<java.lang.String> createdAt()
- Returns:
- Unix datetime that the index was created.
-
description
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
- Returns:
- Description of the Index.
-
documentMetadataConfigurationUpdates
public com.pulumi.core.Output<java.util.List<IndexDocumentMetadataConfigurationUpdate>> documentMetadataConfigurationUpdates()
- Returns:
- One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Minimum number of 0 items. Maximum number of 500 items. If specified, you must define all elements, including those that are provided by default. These index fields are documented at [Amazon Kendra Index documentation](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html). For an example resource that defines these default index fields, refer to the default example above. For an example resource that appends additional index fields, refer to the append example above. All arguments for each block must be specified. Note that blocks cannot be removed since index fields cannot be deleted. This argument is detailed below.
-
edition
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> edition()
- Returns:
- 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. Use `GEN_AI_ENTERPRISE_EDITION` for creating generative AI applications. Once you set the edition for an index, it can't be changed. Defaults to `ENTERPRISE_EDITION`.
-
errorMessage
public com.pulumi.core.Output<java.lang.String> errorMessage()
- Returns:
- When the Status field value is `FAILED`, this contains a message that explains why.
-
indexStatistics
public com.pulumi.core.Output<java.util.List<IndexIndexStatistic>> indexStatistics()
- Returns:
- Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
-
name
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- Name of the Index.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
roleArn
public com.pulumi.core.Output<java.lang.String> roleArn()
- Returns:
- 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
public com.pulumi.core.Output<java.util.Optional<IndexServerSideEncryptionConfiguration>> serverSideEncryptionConfiguration()
- Returns:
- 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. Detailed below.
-
status
public com.pulumi.core.Output<java.lang.String> status()
- Returns:
- 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.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Map of tags to assign to the Index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
updatedAt
public com.pulumi.core.Output<java.lang.String> updatedAt()
- Returns:
- Unix datetime that the index was last updated.
-
userContextPolicy
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> userContextPolicy()
- Returns:
- User context policy. Valid values are `ATTRIBUTE_FILTER` or `USER_TOKEN`. For more information, refer to [UserContextPolicy](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateIndex.html#kendra-CreateIndex-request-UserContextPolicy). Defaults to `ATTRIBUTE_FILTER`.
-
userGroupResolutionConfiguration
public com.pulumi.core.Output<java.util.Optional<IndexUserGroupResolutionConfiguration>> userGroupResolutionConfiguration()
- Returns:
- Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see [UserGroupResolutionConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). Detailed below.
-
userTokenConfigurations
public com.pulumi.core.Output<java.util.Optional<IndexUserTokenConfigurations>> userTokenConfigurations()
- Returns:
- Block that specifies the user token configuration. Detailed below.
-
get
public static Index get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable IndexState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-