We recommend new projects start with resources from the AWS provider.
aws-native.kendra.Index
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
A Kendra index
Create Index Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);@overload
def Index(resource_name: str,
          args: IndexArgs,
          opts: Optional[ResourceOptions] = None)
@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          edition: Optional[IndexEdition] = None,
          role_arn: Optional[str] = None,
          capacity_units: Optional[IndexCapacityUnitsConfigurationArgs] = None,
          description: Optional[str] = None,
          document_metadata_configurations: Optional[Sequence[IndexDocumentMetadataConfigurationArgs]] = None,
          name: Optional[str] = None,
          server_side_encryption_configuration: Optional[IndexServerSideEncryptionConfigurationArgs] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
          user_context_policy: Optional[IndexUserContextPolicy] = None,
          user_token_configurations: Optional[Sequence[IndexUserTokenConfigurationArgs]] = None)func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)type: aws-native:kendra:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IndexArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IndexArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IndexArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Index Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Index resource accepts the following input properties:
- Edition
Pulumi.Aws Native. Kendra. Index Edition 
- Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
- RoleArn string
- An 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.
- CapacityUnits Pulumi.Aws Native. Kendra. Inputs. Index Capacity Units Configuration 
- Capacity units
- Description string
- A description for the index
- DocumentMetadata List<Pulumi.Configurations Aws Native. Kendra. Inputs. Index Document Metadata Configuration> 
- Document metadata configurations
- Name string
- The name of the index.
- ServerSide Pulumi.Encryption Configuration Aws Native. Kendra. Inputs. Index Server Side Encryption Configuration 
- Server side encryption configuration
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- Tags for labeling the index
- UserContext Pulumi.Policy Aws Native. Kendra. Index User Context Policy 
- 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_idand_group_idsor you can provide user and group information inUserContext.
 - 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.
 
- 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 
- UserToken List<Pulumi.Configurations Aws Native. Kendra. Inputs. Index User Token Configuration> 
- Defines the type of user token used for the index.
- Edition
IndexEdition 
- Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
- RoleArn string
- An 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.
- CapacityUnits IndexCapacity Units Configuration Args 
- Capacity units
- Description string
- A description for the index
- DocumentMetadata []IndexConfigurations Document Metadata Configuration Args 
- Document metadata configurations
- Name string
- The name of the index.
- ServerSide IndexEncryption Configuration Server Side Encryption Configuration Args 
- Server side encryption configuration
- 
TagArgs 
- Tags for labeling the index
- UserContext IndexPolicy User Context Policy 
- 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_idand_group_idsor you can provide user and group information inUserContext.
 - 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.
 
- 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 
- UserToken []IndexConfigurations User Token Configuration Args 
- Defines the type of user token used for the index.
- edition
IndexEdition 
- Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
- roleArn String
- An 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.
- capacityUnits IndexCapacity Units Configuration 
- Capacity units
- description String
- A description for the index
- documentMetadata List<IndexConfigurations Document Metadata Configuration> 
- Document metadata configurations
- name String
- The name of the index.
- serverSide IndexEncryption Configuration Server Side Encryption Configuration 
- Server side encryption configuration
- List<Tag>
- Tags for labeling the index
- userContext IndexPolicy User Context Policy 
- 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_idand_group_idsor you can provide user and group information inUserContext.
 - 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.
 
- 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 
- userToken List<IndexConfigurations User Token Configuration> 
- Defines the type of user token used for the index.
- edition
IndexEdition 
- Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
- roleArn string
- An 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.
- capacityUnits IndexCapacity Units Configuration 
- Capacity units
- description string
- A description for the index
- documentMetadata IndexConfigurations Document Metadata Configuration[] 
- Document metadata configurations
- name string
- The name of the index.
- serverSide IndexEncryption Configuration Server Side Encryption Configuration 
- Server side encryption configuration
- Tag[]
- Tags for labeling the index
- userContext IndexPolicy User Context Policy 
- 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_idand_group_idsor you can provide user and group information inUserContext.
 - 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.
 
- 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 
- userToken IndexConfigurations User Token Configuration[] 
- Defines the type of user token used for the index.
- edition
IndexEdition 
- Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
- role_arn str
- An 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.
- capacity_units IndexCapacity Units Configuration Args 
- Capacity units
- description str
- A description for the index
- document_metadata_ Sequence[Indexconfigurations Document Metadata Configuration Args] 
- Document metadata configurations
- name str
- The name of the index.
- server_side_ Indexencryption_ configuration Server Side Encryption Configuration Args 
- Server side encryption configuration
- 
Sequence[TagArgs] 
- Tags for labeling the index
- user_context_ Indexpolicy User Context Policy 
- 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_idand_group_idsor you can provide user and group information inUserContext.
 - 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.
 
- 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_token_ Sequence[Indexconfigurations User Token Configuration Args] 
- Defines the type of user token used for the index.
- edition "DEVELOPER_EDITION" | "ENTERPRISE_EDITION" | "GEN_AI_ENTERPRISE_EDITION"
- Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
- roleArn String
- An 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.
- capacityUnits Property Map
- Capacity units
- description String
- A description for the index
- documentMetadata List<Property Map>Configurations 
- Document metadata configurations
- name String
- The name of the index.
- serverSide Property MapEncryption Configuration 
- Server side encryption configuration
- List<Property Map>
- Tags for labeling the index
- userContext "ATTRIBUTE_FILTER" | "USER_TOKEN"Policy 
- 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_idand_group_idsor you can provide user and group information inUserContext.
 - 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.
 
- 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 
- userToken List<Property Map>Configurations 
- Defines the type of user token used for the index.
Outputs
All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:
Supporting Types
IndexCapacityUnitsConfiguration, IndexCapacityUnitsConfigurationArgs        
- QueryCapacity intUnits 
- The amount of extra query capacity for an index and GetQuerySuggestions capacity. - A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units. - GetQuerySuggestionscapacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and- GetQuerySuggestionscapacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the- GetQuerySuggestionscapacity is 2.5 calls per second (higher than five times 0.2 queries per second).
- StorageCapacity intUnits 
- 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. You can add up to 100 extra capacity units.
- QueryCapacity intUnits 
- The amount of extra query capacity for an index and GetQuerySuggestions capacity. - A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units. - GetQuerySuggestionscapacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and- GetQuerySuggestionscapacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the- GetQuerySuggestionscapacity is 2.5 calls per second (higher than five times 0.2 queries per second).
- StorageCapacity intUnits 
- 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. You can add up to 100 extra capacity units.
- queryCapacity IntegerUnits 
- The amount of extra query capacity for an index and GetQuerySuggestions capacity. - A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units. - GetQuerySuggestionscapacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and- GetQuerySuggestionscapacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the- GetQuerySuggestionscapacity is 2.5 calls per second (higher than five times 0.2 queries per second).
- storageCapacity IntegerUnits 
- 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. You can add up to 100 extra capacity units.
- queryCapacity numberUnits 
- The amount of extra query capacity for an index and GetQuerySuggestions capacity. - A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units. - GetQuerySuggestionscapacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and- GetQuerySuggestionscapacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the- GetQuerySuggestionscapacity is 2.5 calls per second (higher than five times 0.2 queries per second).
- storageCapacity numberUnits 
- 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. You can add up to 100 extra capacity units.
- query_capacity_ intunits 
- The amount of extra query capacity for an index and GetQuerySuggestions capacity. - A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units. - GetQuerySuggestionscapacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and- GetQuerySuggestionscapacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the- GetQuerySuggestionscapacity is 2.5 calls per second (higher than five times 0.2 queries per second).
- storage_capacity_ intunits 
- 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. You can add up to 100 extra capacity units.
- queryCapacity NumberUnits 
- The amount of extra query capacity for an index and GetQuerySuggestions capacity. - A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units. - GetQuerySuggestionscapacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and- GetQuerySuggestionscapacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the- GetQuerySuggestionscapacity is 2.5 calls per second (higher than five times 0.2 queries per second).
- storageCapacity NumberUnits 
- 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. You can add up to 100 extra capacity units.
IndexDocumentAttributeValueType, IndexDocumentAttributeValueTypeArgs          
- StringValue 
- STRING_VALUE
- StringList Value 
- STRING_LIST_VALUE
- LongValue 
- LONG_VALUE
- DateValue 
- DATE_VALUE
- IndexDocument Attribute Value Type String Value 
- STRING_VALUE
- IndexDocument Attribute Value Type String List Value 
- STRING_LIST_VALUE
- IndexDocument Attribute Value Type Long Value 
- LONG_VALUE
- IndexDocument Attribute Value Type Date Value 
- DATE_VALUE
- StringValue 
- STRING_VALUE
- StringList Value 
- STRING_LIST_VALUE
- LongValue 
- LONG_VALUE
- DateValue 
- DATE_VALUE
- StringValue 
- STRING_VALUE
- StringList Value 
- STRING_LIST_VALUE
- LongValue 
- LONG_VALUE
- DateValue 
- DATE_VALUE
- STRING_VALUE
- STRING_VALUE
- STRING_LIST_VALUE
- STRING_LIST_VALUE
- LONG_VALUE
- LONG_VALUE
- DATE_VALUE
- DATE_VALUE
- "STRING_VALUE"
- STRING_VALUE
- "STRING_LIST_VALUE"
- STRING_LIST_VALUE
- "LONG_VALUE"
- LONG_VALUE
- "DATE_VALUE"
- DATE_VALUE
IndexDocumentMetadataConfiguration, IndexDocumentMetadataConfigurationArgs        
IndexEdition, IndexEditionArgs    
- DeveloperEdition 
- DEVELOPER_EDITION
- EnterpriseEdition 
- ENTERPRISE_EDITION
- GenAi Enterprise Edition 
- GEN_AI_ENTERPRISE_EDITION
- IndexEdition Developer Edition 
- DEVELOPER_EDITION
- IndexEdition Enterprise Edition 
- ENTERPRISE_EDITION
- IndexEdition Gen Ai Enterprise Edition 
- GEN_AI_ENTERPRISE_EDITION
- DeveloperEdition 
- DEVELOPER_EDITION
- EnterpriseEdition 
- ENTERPRISE_EDITION
- GenAi Enterprise Edition 
- GEN_AI_ENTERPRISE_EDITION
- DeveloperEdition 
- DEVELOPER_EDITION
- EnterpriseEdition 
- ENTERPRISE_EDITION
- GenAi Enterprise Edition 
- GEN_AI_ENTERPRISE_EDITION
- DEVELOPER_EDITION
- DEVELOPER_EDITION
- ENTERPRISE_EDITION
- ENTERPRISE_EDITION
- GEN_AI_ENTERPRISE_EDITION
- GEN_AI_ENTERPRISE_EDITION
- "DEVELOPER_EDITION"
- DEVELOPER_EDITION
- "ENTERPRISE_EDITION"
- ENTERPRISE_EDITION
- "GEN_AI_ENTERPRISE_EDITION"
- GEN_AI_ENTERPRISE_EDITION
IndexJsonTokenTypeConfiguration, IndexJsonTokenTypeConfigurationArgs          
- GroupAttribute stringField 
- UserName stringAttribute Field 
- GroupAttribute stringField 
- UserName stringAttribute Field 
- groupAttribute StringField 
- userName StringAttribute Field 
- groupAttribute stringField 
- userName stringAttribute Field 
- groupAttribute StringField 
- userName StringAttribute Field 
IndexJwtTokenTypeConfiguration, IndexJwtTokenTypeConfigurationArgs          
- KeyLocation Pulumi.Aws Native. Kendra. Index Key Location 
- ClaimRegex string
- GroupAttribute stringField 
- Issuer string
- SecretManager stringArn 
- Url string
- UserName stringAttribute Field 
- KeyLocation IndexKey Location 
- ClaimRegex string
- GroupAttribute stringField 
- Issuer string
- SecretManager stringArn 
- Url string
- UserName stringAttribute Field 
- keyLocation IndexKey Location 
- claimRegex String
- groupAttribute StringField 
- issuer String
- secretManager StringArn 
- url String
- userName StringAttribute Field 
- keyLocation IndexKey Location 
- claimRegex string
- groupAttribute stringField 
- issuer string
- secretManager stringArn 
- url string
- userName stringAttribute Field 
- keyLocation "URL" | "SECRET_MANAGER"
- claimRegex String
- groupAttribute StringField 
- issuer String
- secretManager StringArn 
- url String
- userName StringAttribute Field 
IndexKeyLocation, IndexKeyLocationArgs      
- Url
- URL
- SecretManager 
- SECRET_MANAGER
- IndexKey Location Url 
- URL
- IndexKey Location Secret Manager 
- SECRET_MANAGER
- Url
- URL
- SecretManager 
- SECRET_MANAGER
- Url
- URL
- SecretManager 
- SECRET_MANAGER
- URL
- URL
- SECRET_MANAGER
- SECRET_MANAGER
- "URL"
- URL
- "SECRET_MANAGER"
- SECRET_MANAGER
IndexOrder, IndexOrderArgs    
- Ascending
- ASCENDING
- Descending
- DESCENDING
- IndexOrder Ascending 
- ASCENDING
- IndexOrder Descending 
- DESCENDING
- Ascending
- ASCENDING
- Descending
- DESCENDING
- Ascending
- ASCENDING
- Descending
- DESCENDING
- ASCENDING
- ASCENDING
- DESCENDING
- DESCENDING
- "ASCENDING"
- ASCENDING
- "DESCENDING"
- DESCENDING
IndexRelevance, IndexRelevanceArgs    
- duration String
- freshness Boolean
- importance Integer
- rankOrder IndexOrder 
- valueImportance List<IndexItems Value Importance Item> 
- duration string
- freshness boolean
- importance number
- rankOrder IndexOrder 
- valueImportance IndexItems Value Importance Item[] 
IndexSearch, IndexSearchArgs    
- Displayable bool
- Facetable bool
- Searchable bool
- Sortable bool
- Displayable bool
- Facetable bool
- Searchable bool
- Sortable bool
- displayable Boolean
- facetable Boolean
- searchable Boolean
- sortable Boolean
- displayable boolean
- facetable boolean
- searchable boolean
- sortable boolean
- displayable bool
- facetable bool
- searchable bool
- sortable bool
- displayable Boolean
- facetable Boolean
- searchable Boolean
- sortable Boolean
IndexServerSideEncryptionConfiguration, IndexServerSideEncryptionConfigurationArgs          
- KmsKey stringId 
- The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
- KmsKey stringId 
- The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
- kmsKey StringId 
- The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
- kmsKey stringId 
- The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
- kms_key_ strid 
- The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
- kmsKey StringId 
- The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
IndexUserContextPolicy, IndexUserContextPolicyArgs        
- AttributeFilter 
- ATTRIBUTE_FILTER
- UserToken 
- USER_TOKEN
- IndexUser Context Policy Attribute Filter 
- ATTRIBUTE_FILTER
- IndexUser Context Policy User Token 
- USER_TOKEN
- AttributeFilter 
- ATTRIBUTE_FILTER
- UserToken 
- USER_TOKEN
- AttributeFilter 
- ATTRIBUTE_FILTER
- UserToken 
- USER_TOKEN
- ATTRIBUTE_FILTER
- ATTRIBUTE_FILTER
- USER_TOKEN
- USER_TOKEN
- "ATTRIBUTE_FILTER"
- ATTRIBUTE_FILTER
- "USER_TOKEN"
- USER_TOKEN
IndexUserTokenConfiguration, IndexUserTokenConfigurationArgs        
IndexValueImportanceItem, IndexValueImportanceItemArgs        
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.