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
The Index resource accepts the following input properties:
- Edition
Pulumi.
Aws Native. Kendra. Index Edition - Indicates whether the index is a Enterprise Edition index or a Developer Edition index. Valid values are
DEVELOPER_EDITION
andENTERPRISE_EDITION
. - Role
Arn 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.
- Capacity
Units Pulumi.Aws Native. Kendra. Inputs. Index Capacity Units Configuration - Capacity units
- Description string
- A description for the index
- Document
Metadata List<Pulumi.Configurations Aws Native. Kendra. Inputs. Index Document Metadata Configuration> - Document metadata configurations
- Name string
- The name of the index.
- Server
Side 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
- User
Context 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_id
and_group_ids
or 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 List<Pulumi.Configurations Aws Native. Kendra. Inputs. Index User Token Configuration> - Defines the type of user token used for the index.
- Edition
Index
Edition - Indicates whether the index is a Enterprise Edition index or a Developer Edition index. Valid values are
DEVELOPER_EDITION
andENTERPRISE_EDITION
. - Role
Arn 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.
- Capacity
Units IndexCapacity Units Configuration Args - Capacity units
- Description string
- A description for the index
- Document
Metadata []IndexConfigurations Document Metadata Configuration Args - Document metadata configurations
- Name string
- The name of the index.
- Server
Side IndexEncryption Configuration Server Side Encryption Configuration Args - Server side encryption configuration
- Tag
Args - 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_id
and_group_ids
or 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 []IndexConfigurations User Token Configuration Args - Defines the type of user token used for the index.
- edition
Index
Edition - Indicates whether the index is a Enterprise Edition index or a Developer Edition index. Valid values are
DEVELOPER_EDITION
andENTERPRISE_EDITION
. - role
Arn 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.
- capacity
Units IndexCapacity Units Configuration - Capacity units
- description String
- A description for the index
- document
Metadata List<IndexConfigurations Document Metadata Configuration> - Document metadata configurations
- name String
- The name of the index.
- server
Side IndexEncryption Configuration Server Side Encryption Configuration - Server side encryption configuration
- List<Tag>
- 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_id
and_group_ids
or 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 List<IndexConfigurations User Token Configuration> - Defines the type of user token used for the index.
- edition
Index
Edition - Indicates whether the index is a Enterprise Edition index or a Developer Edition index. Valid values are
DEVELOPER_EDITION
andENTERPRISE_EDITION
. - role
Arn 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.
- capacity
Units IndexCapacity Units Configuration - Capacity units
- description string
- A description for the index
- document
Metadata IndexConfigurations Document Metadata Configuration[] - Document metadata configurations
- name string
- The name of the index.
- server
Side IndexEncryption Configuration Server Side Encryption Configuration - Server side encryption configuration
- Tag[]
- 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_id
and_group_ids
or 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 IndexConfigurations User Token Configuration[] - Defines the type of user token used for the index.
- edition
Index
Edition - Indicates whether the index is a Enterprise Edition index or a Developer Edition index. Valid values are
DEVELOPER_EDITION
andENTERPRISE_EDITION
. - 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[Tag
Args] - 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_id
and_group_ids
or 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"
- Indicates whether the index is a Enterprise Edition index or a Developer Edition index. Valid values are
DEVELOPER_EDITION
andENTERPRISE_EDITION
. - role
Arn 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.
- capacity
Units Property Map - Capacity units
- description String
- A description for the index
- document
Metadata List<Property Map>Configurations - Document metadata configurations
- name String
- The name of the index.
- server
Side Property MapEncryption Configuration - Server side encryption configuration
- List<Property Map>
- Tags for labeling the index
- user
Context "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_id
and_group_ids
or 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 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
- 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.
GetQuerySuggestions
capacity 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, andGetQuerySuggestions
capacity 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, theGetQuerySuggestions
capacity 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.
- 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.
GetQuerySuggestions
capacity 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, andGetQuerySuggestions
capacity 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, theGetQuerySuggestions
capacity 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.
- query
Capacity 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.
GetQuerySuggestions
capacity 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, andGetQuerySuggestions
capacity 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, theGetQuerySuggestions
capacity is 2.5 calls per second (higher than five times 0.2 queries per second).- storage
Capacity 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.
- query
Capacity 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.
GetQuerySuggestions
capacity 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, andGetQuerySuggestions
capacity 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, theGetQuerySuggestions
capacity is 2.5 calls per second (higher than five times 0.2 queries per second).- storage
Capacity 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.
GetQuerySuggestions
capacity 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, andGetQuerySuggestions
capacity 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, theGetQuerySuggestions
capacity 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.
- query
Capacity 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.
GetQuerySuggestions
capacity 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, andGetQuerySuggestions
capacity 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, theGetQuerySuggestions
capacity is 2.5 calls per second (higher than five times 0.2 queries per second).- storage
Capacity 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
- String
Value - STRING_VALUE
- String
List Value - STRING_LIST_VALUE
- Long
Value - LONG_VALUE
- Date
Value - DATE_VALUE
- Index
Document Attribute Value Type String Value - STRING_VALUE
- Index
Document Attribute Value Type String List Value - STRING_LIST_VALUE
- Index
Document Attribute Value Type Long Value - LONG_VALUE
- Index
Document Attribute Value Type Date Value - 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
- 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
- Developer
Edition - DEVELOPER_EDITION
- Enterprise
Edition - ENTERPRISE_EDITION
- Index
Edition Developer Edition - DEVELOPER_EDITION
- Index
Edition Enterprise Edition - ENTERPRISE_EDITION
- Developer
Edition - DEVELOPER_EDITION
- Enterprise
Edition - ENTERPRISE_EDITION
- Developer
Edition - DEVELOPER_EDITION
- Enterprise
Edition - ENTERPRISE_EDITION
- DEVELOPER_EDITION
- DEVELOPER_EDITION
- ENTERPRISE_EDITION
- ENTERPRISE_EDITION
- "DEVELOPER_EDITION"
- DEVELOPER_EDITION
- "ENTERPRISE_EDITION"
- ENTERPRISE_EDITION
IndexJsonTokenTypeConfiguration, IndexJsonTokenTypeConfigurationArgs
- Group
Attribute stringField - User
Name stringAttribute Field
- Group
Attribute stringField - User
Name stringAttribute Field
- group
Attribute StringField - user
Name StringAttribute Field
- group
Attribute stringField - user
Name stringAttribute Field
- group
Attribute StringField - user
Name StringAttribute Field
IndexJwtTokenTypeConfiguration, IndexJwtTokenTypeConfigurationArgs
- Key
Location Pulumi.Aws Native. Kendra. Index Key Location - Claim
Regex string - Group
Attribute stringField - Issuer string
- Secret
Manager stringArn - Url string
- User
Name stringAttribute Field
- Key
Location IndexKey Location - Claim
Regex string - Group
Attribute stringField - Issuer string
- Secret
Manager stringArn - Url string
- User
Name stringAttribute Field
- key
Location IndexKey Location - claim
Regex String - group
Attribute StringField - issuer String
- secret
Manager StringArn - url String
- user
Name StringAttribute Field
- key
Location IndexKey Location - claim
Regex string - group
Attribute stringField - issuer string
- secret
Manager stringArn - url string
- user
Name stringAttribute Field
- key
Location "URL" | "SECRET_MANAGER" - claim
Regex String - group
Attribute StringField - issuer String
- secret
Manager StringArn - url String
- user
Name StringAttribute Field
IndexKeyLocation, IndexKeyLocationArgs
- Url
- URL
- Secret
Manager - SECRET_MANAGER
- Index
Key Location Url - URL
- Index
Key Location Secret Manager - SECRET_MANAGER
- Url
- URL
- Secret
Manager - SECRET_MANAGER
- Url
- URL
- Secret
Manager - SECRET_MANAGER
- URL
- URL
- SECRET_MANAGER
- SECRET_MANAGER
- "URL"
- URL
- "SECRET_MANAGER"
- SECRET_MANAGER
IndexOrder, IndexOrderArgs
- Ascending
- ASCENDING
- Descending
- DESCENDING
- Index
Order Ascending - ASCENDING
- Index
Order 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
- rank
Order IndexOrder - value
Importance List<IndexItems Value Importance Item>
- duration string
- freshness boolean
- importance number
- rank
Order IndexOrder - value
Importance 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
- Kms
Key stringId - The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
- Kms
Key stringId - The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
- kms
Key StringId - The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
- kms
Key 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.
- kms
Key StringId - The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys.
IndexUserContextPolicy, IndexUserContextPolicyArgs
- Attribute
Filter - ATTRIBUTE_FILTER
- User
Token - USER_TOKEN
- Index
User Context Policy Attribute Filter - ATTRIBUTE_FILTER
- Index
User Context Policy User Token - USER_TOKEN
- Attribute
Filter - ATTRIBUTE_FILTER
- User
Token - USER_TOKEN
- Attribute
Filter - ATTRIBUTE_FILTER
- User
Token - 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.