Docs Home
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
aws.kendra.Index
Explore with Pulumi AI
Provides an Amazon Kendra Index resource.
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Index("example", {
name: "example",
description: "example",
edition: "DEVELOPER_EDITION",
roleArn: _this.arn,
tags: {
Key1: "Value1",
},
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Index("example",
name="example",
description="example",
edition="DEVELOPER_EDITION",
role_arn=this["arn"],
tags={
"Key1": "Value1",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewIndex(ctx, "example", &kendra.IndexArgs{
Name: pulumi.String("example"),
Description: pulumi.String("example"),
Edition: pulumi.String("DEVELOPER_EDITION"),
RoleArn: pulumi.Any(this.Arn),
Tags: pulumi.StringMap{
"Key1": pulumi.String("Value1"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Index("example", new()
{
Name = "example",
Description = "example",
Edition = "DEVELOPER_EDITION",
RoleArn = @this.Arn,
Tags =
{
{ "Key1", "Value1" },
},
});
});
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 java.util.List;
import java.util.ArrayList;
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());
}
}
resources:
example:
type: aws:kendra:Index
properties:
name: example
description: example
edition: DEVELOPER_EDITION
roleArn: ${this.arn}
tags:
Key1: Value1
With capacity units
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Index("example", {
name: "example",
edition: "DEVELOPER_EDITION",
roleArn: _this.arn,
capacityUnits: {
queryCapacityUnits: 2,
storageCapacityUnits: 2,
},
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Index("example",
name="example",
edition="DEVELOPER_EDITION",
role_arn=this["arn"],
capacity_units={
"query_capacity_units": 2,
"storage_capacity_units": 2,
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewIndex(ctx, "example", &kendra.IndexArgs{
Name: pulumi.String("example"),
Edition: pulumi.String("DEVELOPER_EDITION"),
RoleArn: pulumi.Any(this.Arn),
CapacityUnits: &kendra.IndexCapacityUnitsArgs{
QueryCapacityUnits: pulumi.Int(2),
StorageCapacityUnits: pulumi.Int(2),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Index("example", new()
{
Name = "example",
Edition = "DEVELOPER_EDITION",
RoleArn = @this.Arn,
CapacityUnits = new Aws.Kendra.Inputs.IndexCapacityUnitsArgs
{
QueryCapacityUnits = 2,
StorageCapacityUnits = 2,
},
});
});
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.IndexCapacityUnitsArgs;
import java.util.List;
import java.util.ArrayList;
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")
.edition("DEVELOPER_EDITION")
.roleArn(this_.arn())
.capacityUnits(IndexCapacityUnitsArgs.builder()
.queryCapacityUnits(2)
.storageCapacityUnits(2)
.build())
.build());
}
}
resources:
example:
type: aws:kendra:Index
properties:
name: example
edition: DEVELOPER_EDITION
roleArn: ${this.arn}
capacityUnits:
queryCapacityUnits: 2
storageCapacityUnits: 2
With server side encryption configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Index("example", {
name: "example",
roleArn: thisAwsIamRole.arn,
serverSideEncryptionConfiguration: {
kmsKeyId: _this.arn,
},
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Index("example",
name="example",
role_arn=this_aws_iam_role["arn"],
server_side_encryption_configuration={
"kms_key_id": this["arn"],
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewIndex(ctx, "example", &kendra.IndexArgs{
Name: pulumi.String("example"),
RoleArn: pulumi.Any(thisAwsIamRole.Arn),
ServerSideEncryptionConfiguration: &kendra.IndexServerSideEncryptionConfigurationArgs{
KmsKeyId: pulumi.Any(this.Arn),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Index("example", new()
{
Name = "example",
RoleArn = thisAwsIamRole.Arn,
ServerSideEncryptionConfiguration = new Aws.Kendra.Inputs.IndexServerSideEncryptionConfigurationArgs
{
KmsKeyId = @this.Arn,
},
});
});
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.IndexServerSideEncryptionConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
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")
.roleArn(thisAwsIamRole.arn())
.serverSideEncryptionConfiguration(IndexServerSideEncryptionConfigurationArgs.builder()
.kmsKeyId(this_.arn())
.build())
.build());
}
}
resources:
example:
type: aws:kendra:Index
properties:
name: example
roleArn: ${thisAwsIamRole.arn}
serverSideEncryptionConfiguration:
kmsKeyId: ${this.arn}
With user group resolution configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Index("example", {
name: "example",
roleArn: _this.arn,
userGroupResolutionConfiguration: {
userGroupResolutionMode: "AWS_SSO",
},
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Index("example",
name="example",
role_arn=this["arn"],
user_group_resolution_configuration={
"user_group_resolution_mode": "AWS_SSO",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewIndex(ctx, "example", &kendra.IndexArgs{
Name: pulumi.String("example"),
RoleArn: pulumi.Any(this.Arn),
UserGroupResolutionConfiguration: &kendra.IndexUserGroupResolutionConfigurationArgs{
UserGroupResolutionMode: pulumi.String("AWS_SSO"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Index("example", new()
{
Name = "example",
RoleArn = @this.Arn,
UserGroupResolutionConfiguration = new Aws.Kendra.Inputs.IndexUserGroupResolutionConfigurationArgs
{
UserGroupResolutionMode = "AWS_SSO",
},
});
});
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.List;
import java.util.ArrayList;
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")
.roleArn(this_.arn())
.userGroupResolutionConfiguration(IndexUserGroupResolutionConfigurationArgs.builder()
.userGroupResolutionMode("AWS_SSO")
.build())
.build());
}
}
resources:
example:
type: aws:kendra:Index
properties:
name: example
roleArn: ${this.arn}
userGroupResolutionConfiguration:
userGroupResolutionMode: AWS_SSO
With Document Metadata Configuration Updates
Specifying the predefined elements
Refer to Amazon Kendra documentation on built-in document fields for more information.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Index("example", {
name: "example",
roleArn: _this.arn,
documentMetadataConfigurationUpdates: [
{
name: "_authors",
type: "STRING_LIST_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: false,
},
relevance: {
importance: 1,
},
},
{
name: "_category",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_created_at",
type: "DATE_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
freshness: false,
importance: 1,
duration: "25920000s",
rankOrder: "ASCENDING",
},
},
{
name: "_data_source_id",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_document_title",
type: "STRING_VALUE",
search: {
displayable: true,
facetable: false,
searchable: true,
sortable: true,
},
relevance: {
importance: 2,
valuesImportanceMap: {},
},
},
{
name: "_excerpt_page_number",
type: "LONG_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: false,
},
relevance: {
importance: 2,
rankOrder: "ASCENDING",
},
},
{
name: "_faq_id",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_file_type",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_language_code",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_last_updated_at",
type: "DATE_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
freshness: false,
importance: 1,
duration: "25920000s",
rankOrder: "ASCENDING",
},
},
{
name: "_source_uri",
type: "STRING_VALUE",
search: {
displayable: true,
facetable: false,
searchable: false,
sortable: false,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_tenant_id",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_version",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_view_count",
type: "LONG_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
rankOrder: "ASCENDING",
},
},
],
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Index("example",
name="example",
role_arn=this["arn"],
document_metadata_configuration_updates=[
{
"name": "_authors",
"type": "STRING_LIST_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": False,
},
"relevance": {
"importance": 1,
},
},
{
"name": "_category",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_created_at",
"type": "DATE_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"freshness": False,
"importance": 1,
"duration": "25920000s",
"rank_order": "ASCENDING",
},
},
{
"name": "_data_source_id",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_document_title",
"type": "STRING_VALUE",
"search": {
"displayable": True,
"facetable": False,
"searchable": True,
"sortable": True,
},
"relevance": {
"importance": 2,
"values_importance_map": {},
},
},
{
"name": "_excerpt_page_number",
"type": "LONG_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": False,
},
"relevance": {
"importance": 2,
"rank_order": "ASCENDING",
},
},
{
"name": "_faq_id",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_file_type",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_language_code",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_last_updated_at",
"type": "DATE_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"freshness": False,
"importance": 1,
"duration": "25920000s",
"rank_order": "ASCENDING",
},
},
{
"name": "_source_uri",
"type": "STRING_VALUE",
"search": {
"displayable": True,
"facetable": False,
"searchable": False,
"sortable": False,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_tenant_id",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_version",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_view_count",
"type": "LONG_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"rank_order": "ASCENDING",
},
},
])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewIndex(ctx, "example", &kendra.IndexArgs{
Name: pulumi.String("example"),
RoleArn: pulumi.Any(this.Arn),
DocumentMetadataConfigurationUpdates: kendra.IndexDocumentMetadataConfigurationUpdateArray{
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_authors"),
Type: pulumi.String("STRING_LIST_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(false),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_category"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_created_at"),
Type: pulumi.String("DATE_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Freshness: pulumi.Bool(false),
Importance: pulumi.Int(1),
Duration: pulumi.String("25920000s"),
RankOrder: pulumi.String("ASCENDING"),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_data_source_id"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_document_title"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(true),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(true),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(2),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_excerpt_page_number"),
Type: pulumi.String("LONG_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(false),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(2),
RankOrder: pulumi.String("ASCENDING"),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_faq_id"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_file_type"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_language_code"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_last_updated_at"),
Type: pulumi.String("DATE_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Freshness: pulumi.Bool(false),
Importance: pulumi.Int(1),
Duration: pulumi.String("25920000s"),
RankOrder: pulumi.String("ASCENDING"),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_source_uri"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(true),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(false),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_tenant_id"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_version"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_view_count"),
Type: pulumi.String("LONG_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
RankOrder: pulumi.String("ASCENDING"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Index("example", new()
{
Name = "example",
RoleArn = @this.Arn,
DocumentMetadataConfigurationUpdates = new[]
{
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_authors",
Type = "STRING_LIST_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = false,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_category",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_created_at",
Type = "DATE_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Freshness = false,
Importance = 1,
Duration = "25920000s",
RankOrder = "ASCENDING",
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_data_source_id",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_document_title",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = true,
Facetable = false,
Searchable = true,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 2,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_excerpt_page_number",
Type = "LONG_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = false,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 2,
RankOrder = "ASCENDING",
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_faq_id",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_file_type",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_language_code",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_last_updated_at",
Type = "DATE_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Freshness = false,
Importance = 1,
Duration = "25920000s",
RankOrder = "ASCENDING",
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_source_uri",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = true,
Facetable = false,
Searchable = false,
Sortable = false,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_tenant_id",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_version",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_view_count",
Type = "LONG_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
RankOrder = "ASCENDING",
},
},
},
});
});
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.List;
import java.util.ArrayList;
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")
.roleArn(this_.arn())
.documentMetadataConfigurationUpdates(
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_authors")
.type("STRING_LIST_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(false)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_category")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_created_at")
.type("DATE_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.freshness(false)
.importance(1)
.duration("25920000s")
.rankOrder("ASCENDING")
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_data_source_id")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_document_title")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(true)
.facetable(false)
.searchable(true)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(2)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_excerpt_page_number")
.type("LONG_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(false)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(2)
.rankOrder("ASCENDING")
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_faq_id")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_file_type")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_language_code")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_last_updated_at")
.type("DATE_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.freshness(false)
.importance(1)
.duration("25920000s")
.rankOrder("ASCENDING")
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_source_uri")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(true)
.facetable(false)
.searchable(false)
.sortable(false)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_tenant_id")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_version")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_view_count")
.type("LONG_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.rankOrder("ASCENDING")
.build())
.build())
.build());
}
}
resources:
example:
type: aws:kendra:Index
properties:
name: example
roleArn: ${this.arn}
documentMetadataConfigurationUpdates:
- name: _authors
type: STRING_LIST_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: false
relevance:
importance: 1
- name: _category
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _created_at
type: DATE_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
freshness: false
importance: 1
duration: 25920000s
rankOrder: ASCENDING
- name: _data_source_id
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _document_title
type: STRING_VALUE
search:
displayable: true
facetable: false
searchable: true
sortable: true
relevance:
importance: 2
valuesImportanceMap: {}
- name: _excerpt_page_number
type: LONG_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: false
relevance:
importance: 2
rankOrder: ASCENDING
- name: _faq_id
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _file_type
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _language_code
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _last_updated_at
type: DATE_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
freshness: false
importance: 1
duration: 25920000s
rankOrder: ASCENDING
- name: _source_uri
type: STRING_VALUE
search:
displayable: true
facetable: false
searchable: false
sortable: false
relevance:
importance: 1
valuesImportanceMap: {}
- name: _tenant_id
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _version
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _view_count
type: LONG_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
rankOrder: ASCENDING
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.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Index("example", {
name: "example",
roleArn: _this.arn,
documentMetadataConfigurationUpdates: [
{
name: "_authors",
type: "STRING_LIST_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: false,
},
relevance: {
importance: 1,
},
},
{
name: "_category",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_created_at",
type: "DATE_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
freshness: false,
importance: 1,
duration: "25920000s",
rankOrder: "ASCENDING",
},
},
{
name: "_data_source_id",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_document_title",
type: "STRING_VALUE",
search: {
displayable: true,
facetable: false,
searchable: true,
sortable: true,
},
relevance: {
importance: 2,
valuesImportanceMap: {},
},
},
{
name: "_excerpt_page_number",
type: "LONG_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: false,
},
relevance: {
importance: 2,
rankOrder: "ASCENDING",
},
},
{
name: "_faq_id",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_file_type",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_language_code",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_last_updated_at",
type: "DATE_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
freshness: false,
importance: 1,
duration: "25920000s",
rankOrder: "ASCENDING",
},
},
{
name: "_source_uri",
type: "STRING_VALUE",
search: {
displayable: true,
facetable: false,
searchable: false,
sortable: false,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_tenant_id",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_version",
type: "STRING_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "_view_count",
type: "LONG_VALUE",
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
rankOrder: "ASCENDING",
},
},
{
name: "example-string-value",
type: "STRING_VALUE",
search: {
displayable: true,
facetable: true,
searchable: true,
sortable: true,
},
relevance: {
importance: 1,
valuesImportanceMap: {},
},
},
{
name: "example-long-value",
type: "LONG_VALUE",
search: {
displayable: true,
facetable: true,
searchable: false,
sortable: true,
},
relevance: {
importance: 1,
rankOrder: "ASCENDING",
},
},
{
name: "example-string-list-value",
type: "STRING_LIST_VALUE",
search: {
displayable: true,
facetable: true,
searchable: true,
sortable: false,
},
relevance: {
importance: 1,
},
},
{
name: "example-date-value",
type: "DATE_VALUE",
search: {
displayable: true,
facetable: true,
searchable: false,
sortable: false,
},
relevance: {
freshness: false,
importance: 1,
duration: "25920000s",
rankOrder: "ASCENDING",
},
},
],
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Index("example",
name="example",
role_arn=this["arn"],
document_metadata_configuration_updates=[
{
"name": "_authors",
"type": "STRING_LIST_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": False,
},
"relevance": {
"importance": 1,
},
},
{
"name": "_category",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_created_at",
"type": "DATE_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"freshness": False,
"importance": 1,
"duration": "25920000s",
"rank_order": "ASCENDING",
},
},
{
"name": "_data_source_id",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_document_title",
"type": "STRING_VALUE",
"search": {
"displayable": True,
"facetable": False,
"searchable": True,
"sortable": True,
},
"relevance": {
"importance": 2,
"values_importance_map": {},
},
},
{
"name": "_excerpt_page_number",
"type": "LONG_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": False,
},
"relevance": {
"importance": 2,
"rank_order": "ASCENDING",
},
},
{
"name": "_faq_id",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_file_type",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_language_code",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_last_updated_at",
"type": "DATE_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"freshness": False,
"importance": 1,
"duration": "25920000s",
"rank_order": "ASCENDING",
},
},
{
"name": "_source_uri",
"type": "STRING_VALUE",
"search": {
"displayable": True,
"facetable": False,
"searchable": False,
"sortable": False,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_tenant_id",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_version",
"type": "STRING_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "_view_count",
"type": "LONG_VALUE",
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"rank_order": "ASCENDING",
},
},
{
"name": "example-string-value",
"type": "STRING_VALUE",
"search": {
"displayable": True,
"facetable": True,
"searchable": True,
"sortable": True,
},
"relevance": {
"importance": 1,
"values_importance_map": {},
},
},
{
"name": "example-long-value",
"type": "LONG_VALUE",
"search": {
"displayable": True,
"facetable": True,
"searchable": False,
"sortable": True,
},
"relevance": {
"importance": 1,
"rank_order": "ASCENDING",
},
},
{
"name": "example-string-list-value",
"type": "STRING_LIST_VALUE",
"search": {
"displayable": True,
"facetable": True,
"searchable": True,
"sortable": False,
},
"relevance": {
"importance": 1,
},
},
{
"name": "example-date-value",
"type": "DATE_VALUE",
"search": {
"displayable": True,
"facetable": True,
"searchable": False,
"sortable": False,
},
"relevance": {
"freshness": False,
"importance": 1,
"duration": "25920000s",
"rank_order": "ASCENDING",
},
},
])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewIndex(ctx, "example", &kendra.IndexArgs{
Name: pulumi.String("example"),
RoleArn: pulumi.Any(this.Arn),
DocumentMetadataConfigurationUpdates: kendra.IndexDocumentMetadataConfigurationUpdateArray{
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_authors"),
Type: pulumi.String("STRING_LIST_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(false),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_category"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_created_at"),
Type: pulumi.String("DATE_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Freshness: pulumi.Bool(false),
Importance: pulumi.Int(1),
Duration: pulumi.String("25920000s"),
RankOrder: pulumi.String("ASCENDING"),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_data_source_id"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_document_title"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(true),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(true),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(2),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_excerpt_page_number"),
Type: pulumi.String("LONG_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(false),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(2),
RankOrder: pulumi.String("ASCENDING"),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_faq_id"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_file_type"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_language_code"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_last_updated_at"),
Type: pulumi.String("DATE_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Freshness: pulumi.Bool(false),
Importance: pulumi.Int(1),
Duration: pulumi.String("25920000s"),
RankOrder: pulumi.String("ASCENDING"),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_source_uri"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(true),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(false),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_tenant_id"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_version"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("_view_count"),
Type: pulumi.String("LONG_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
RankOrder: pulumi.String("ASCENDING"),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("example-string-value"),
Type: pulumi.String("STRING_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(true),
Facetable: pulumi.Bool(true),
Searchable: pulumi.Bool(true),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
ValuesImportanceMap: pulumi.IntMap{},
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("example-long-value"),
Type: pulumi.String("LONG_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(true),
Facetable: pulumi.Bool(true),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(true),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
RankOrder: pulumi.String("ASCENDING"),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("example-string-list-value"),
Type: pulumi.String("STRING_LIST_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(true),
Facetable: pulumi.Bool(true),
Searchable: pulumi.Bool(true),
Sortable: pulumi.Bool(false),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Importance: pulumi.Int(1),
},
},
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("example-date-value"),
Type: pulumi.String("DATE_VALUE"),
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(true),
Facetable: pulumi.Bool(true),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(false),
},
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Freshness: pulumi.Bool(false),
Importance: pulumi.Int(1),
Duration: pulumi.String("25920000s"),
RankOrder: pulumi.String("ASCENDING"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Index("example", new()
{
Name = "example",
RoleArn = @this.Arn,
DocumentMetadataConfigurationUpdates = new[]
{
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_authors",
Type = "STRING_LIST_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = false,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_category",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_created_at",
Type = "DATE_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Freshness = false,
Importance = 1,
Duration = "25920000s",
RankOrder = "ASCENDING",
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_data_source_id",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_document_title",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = true,
Facetable = false,
Searchable = true,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 2,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_excerpt_page_number",
Type = "LONG_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = false,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 2,
RankOrder = "ASCENDING",
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_faq_id",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_file_type",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_language_code",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_last_updated_at",
Type = "DATE_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Freshness = false,
Importance = 1,
Duration = "25920000s",
RankOrder = "ASCENDING",
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_source_uri",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = true,
Facetable = false,
Searchable = false,
Sortable = false,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_tenant_id",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_version",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "_view_count",
Type = "LONG_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
RankOrder = "ASCENDING",
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "example-string-value",
Type = "STRING_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = true,
Facetable = true,
Searchable = true,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
ValuesImportanceMap = null,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "example-long-value",
Type = "LONG_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = true,
Facetable = true,
Searchable = false,
Sortable = true,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
RankOrder = "ASCENDING",
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "example-string-list-value",
Type = "STRING_LIST_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = true,
Facetable = true,
Searchable = true,
Sortable = false,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Importance = 1,
},
},
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "example-date-value",
Type = "DATE_VALUE",
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = true,
Facetable = true,
Searchable = false,
Sortable = false,
},
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Freshness = false,
Importance = 1,
Duration = "25920000s",
RankOrder = "ASCENDING",
},
},
},
});
});
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.List;
import java.util.ArrayList;
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")
.roleArn(this_.arn())
.documentMetadataConfigurationUpdates(
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_authors")
.type("STRING_LIST_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(false)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_category")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_created_at")
.type("DATE_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.freshness(false)
.importance(1)
.duration("25920000s")
.rankOrder("ASCENDING")
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_data_source_id")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_document_title")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(true)
.facetable(false)
.searchable(true)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(2)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_excerpt_page_number")
.type("LONG_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(false)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(2)
.rankOrder("ASCENDING")
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_faq_id")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_file_type")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_language_code")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_last_updated_at")
.type("DATE_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.freshness(false)
.importance(1)
.duration("25920000s")
.rankOrder("ASCENDING")
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_source_uri")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(true)
.facetable(false)
.searchable(false)
.sortable(false)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_tenant_id")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_version")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("_view_count")
.type("LONG_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.rankOrder("ASCENDING")
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("example-string-value")
.type("STRING_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(true)
.facetable(true)
.searchable(true)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.valuesImportanceMap()
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("example-long-value")
.type("LONG_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(true)
.facetable(true)
.searchable(false)
.sortable(true)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.rankOrder("ASCENDING")
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("example-string-list-value")
.type("STRING_LIST_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(true)
.facetable(true)
.searchable(true)
.sortable(false)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.importance(1)
.build())
.build(),
IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("example-date-value")
.type("DATE_VALUE")
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(true)
.facetable(true)
.searchable(false)
.sortable(false)
.build())
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.freshness(false)
.importance(1)
.duration("25920000s")
.rankOrder("ASCENDING")
.build())
.build())
.build());
}
}
resources:
example:
type: aws:kendra:Index
properties:
name: example
roleArn: ${this.arn}
documentMetadataConfigurationUpdates:
- name: _authors
type: STRING_LIST_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: false
relevance:
importance: 1
- name: _category
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _created_at
type: DATE_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
freshness: false
importance: 1
duration: 25920000s
rankOrder: ASCENDING
- name: _data_source_id
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _document_title
type: STRING_VALUE
search:
displayable: true
facetable: false
searchable: true
sortable: true
relevance:
importance: 2
valuesImportanceMap: {}
- name: _excerpt_page_number
type: LONG_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: false
relevance:
importance: 2
rankOrder: ASCENDING
- name: _faq_id
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _file_type
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _language_code
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _last_updated_at
type: DATE_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
freshness: false
importance: 1
duration: 25920000s
rankOrder: ASCENDING
- name: _source_uri
type: STRING_VALUE
search:
displayable: true
facetable: false
searchable: false
sortable: false
relevance:
importance: 1
valuesImportanceMap: {}
- name: _tenant_id
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _version
type: STRING_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: _view_count
type: LONG_VALUE
search:
displayable: false
facetable: false
searchable: false
sortable: true
relevance:
importance: 1
rankOrder: ASCENDING
- name: example-string-value
type: STRING_VALUE
search:
displayable: true
facetable: true
searchable: true
sortable: true
relevance:
importance: 1
valuesImportanceMap: {}
- name: example-long-value
type: LONG_VALUE
search:
displayable: true
facetable: true
searchable: false
sortable: true
relevance:
importance: 1
rankOrder: ASCENDING
- name: example-string-list-value
type: STRING_LIST_VALUE
search:
displayable: true
facetable: true
searchable: true
sortable: false
relevance:
importance: 1
- name: example-date-value
type: DATE_VALUE
search:
displayable: true
facetable: true
searchable: false
sortable: false
relevance:
freshness: false
importance: 1
duration: 25920000s
rankOrder: ASCENDING
With JSON token type configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Index("example", {
name: "example",
roleArn: _this.arn,
userTokenConfigurations: {
jsonTokenTypeConfiguration: {
groupAttributeField: "groups",
userNameAttributeField: "username",
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Index("example",
name="example",
role_arn=this["arn"],
user_token_configurations={
"json_token_type_configuration": {
"group_attribute_field": "groups",
"user_name_attribute_field": "username",
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewIndex(ctx, "example", &kendra.IndexArgs{
Name: pulumi.String("example"),
RoleArn: pulumi.Any(this.Arn),
UserTokenConfigurations: &kendra.IndexUserTokenConfigurationsArgs{
JsonTokenTypeConfiguration: &kendra.IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs{
GroupAttributeField: pulumi.String("groups"),
UserNameAttributeField: pulumi.String("username"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Index("example", new()
{
Name = "example",
RoleArn = @this.Arn,
UserTokenConfigurations = new Aws.Kendra.Inputs.IndexUserTokenConfigurationsArgs
{
JsonTokenTypeConfiguration = new Aws.Kendra.Inputs.IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs
{
GroupAttributeField = "groups",
UserNameAttributeField = "username",
},
},
});
});
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.List;
import java.util.ArrayList;
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")
.roleArn(this_.arn())
.userTokenConfigurations(IndexUserTokenConfigurationsArgs.builder()
.jsonTokenTypeConfiguration(IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs.builder()
.groupAttributeField("groups")
.userNameAttributeField("username")
.build())
.build())
.build());
}
}
resources:
example:
type: aws:kendra:Index
properties:
name: example
roleArn: ${this.arn}
userTokenConfigurations:
jsonTokenTypeConfiguration:
groupAttributeField: groups
userNameAttributeField: username
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,
role_arn: Optional[str] = None,
capacity_units: Optional[IndexCapacityUnitsArgs] = None,
description: Optional[str] = None,
document_metadata_configuration_updates: Optional[Sequence[IndexDocumentMetadataConfigurationUpdateArgs]] = None,
edition: Optional[str] = None,
name: Optional[str] = None,
server_side_encryption_configuration: Optional[IndexServerSideEncryptionConfigurationArgs] = None,
tags: Optional[Mapping[str, str]] = None,
user_context_policy: Optional[str] = None,
user_group_resolution_configuration: Optional[IndexUserGroupResolutionConfigurationArgs] = None,
user_token_configurations: Optional[IndexUserTokenConfigurationsArgs] = None)func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)type: aws: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.
Constructor example
The following reference example uses placeholder values for all input properties.
var indexResource = new Aws.Kendra.Index("indexResource", new()
{
RoleArn = "string",
CapacityUnits = new Aws.Kendra.Inputs.IndexCapacityUnitsArgs
{
QueryCapacityUnits = 0,
StorageCapacityUnits = 0,
},
Description = "string",
DocumentMetadataConfigurationUpdates = new[]
{
new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateArgs
{
Name = "string",
Type = "string",
Relevance = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateRelevanceArgs
{
Duration = "string",
Freshness = false,
Importance = 0,
RankOrder = "string",
ValuesImportanceMap =
{
{ "string", 0 },
},
},
Search = new Aws.Kendra.Inputs.IndexDocumentMetadataConfigurationUpdateSearchArgs
{
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = false,
},
},
},
Edition = "string",
Name = "string",
ServerSideEncryptionConfiguration = new Aws.Kendra.Inputs.IndexServerSideEncryptionConfigurationArgs
{
KmsKeyId = "string",
},
Tags =
{
{ "string", "string" },
},
UserContextPolicy = "string",
UserGroupResolutionConfiguration = new Aws.Kendra.Inputs.IndexUserGroupResolutionConfigurationArgs
{
UserGroupResolutionMode = "string",
},
UserTokenConfigurations = new Aws.Kendra.Inputs.IndexUserTokenConfigurationsArgs
{
JsonTokenTypeConfiguration = new Aws.Kendra.Inputs.IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs
{
GroupAttributeField = "string",
UserNameAttributeField = "string",
},
JwtTokenTypeConfiguration = new Aws.Kendra.Inputs.IndexUserTokenConfigurationsJwtTokenTypeConfigurationArgs
{
KeyLocation = "string",
ClaimRegex = "string",
GroupAttributeField = "string",
Issuer = "string",
SecretsManagerArn = "string",
Url = "string",
UserNameAttributeField = "string",
},
},
});
example, err := kendra.NewIndex(ctx, "indexResource", &kendra.IndexArgs{
RoleArn: pulumi.String("string"),
CapacityUnits: &kendra.IndexCapacityUnitsArgs{
QueryCapacityUnits: pulumi.Int(0),
StorageCapacityUnits: pulumi.Int(0),
},
Description: pulumi.String("string"),
DocumentMetadataConfigurationUpdates: kendra.IndexDocumentMetadataConfigurationUpdateArray{
&kendra.IndexDocumentMetadataConfigurationUpdateArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Relevance: &kendra.IndexDocumentMetadataConfigurationUpdateRelevanceArgs{
Duration: pulumi.String("string"),
Freshness: pulumi.Bool(false),
Importance: pulumi.Int(0),
RankOrder: pulumi.String("string"),
ValuesImportanceMap: pulumi.IntMap{
"string": pulumi.Int(0),
},
},
Search: &kendra.IndexDocumentMetadataConfigurationUpdateSearchArgs{
Displayable: pulumi.Bool(false),
Facetable: pulumi.Bool(false),
Searchable: pulumi.Bool(false),
Sortable: pulumi.Bool(false),
},
},
},
Edition: pulumi.String("string"),
Name: pulumi.String("string"),
ServerSideEncryptionConfiguration: &kendra.IndexServerSideEncryptionConfigurationArgs{
KmsKeyId: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
UserContextPolicy: pulumi.String("string"),
UserGroupResolutionConfiguration: &kendra.IndexUserGroupResolutionConfigurationArgs{
UserGroupResolutionMode: pulumi.String("string"),
},
UserTokenConfigurations: &kendra.IndexUserTokenConfigurationsArgs{
JsonTokenTypeConfiguration: &kendra.IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs{
GroupAttributeField: pulumi.String("string"),
UserNameAttributeField: pulumi.String("string"),
},
JwtTokenTypeConfiguration: &kendra.IndexUserTokenConfigurationsJwtTokenTypeConfigurationArgs{
KeyLocation: pulumi.String("string"),
ClaimRegex: pulumi.String("string"),
GroupAttributeField: pulumi.String("string"),
Issuer: pulumi.String("string"),
SecretsManagerArn: pulumi.String("string"),
Url: pulumi.String("string"),
UserNameAttributeField: pulumi.String("string"),
},
},
})
var indexResource = new Index("indexResource", IndexArgs.builder()
.roleArn("string")
.capacityUnits(IndexCapacityUnitsArgs.builder()
.queryCapacityUnits(0)
.storageCapacityUnits(0)
.build())
.description("string")
.documentMetadataConfigurationUpdates(IndexDocumentMetadataConfigurationUpdateArgs.builder()
.name("string")
.type("string")
.relevance(IndexDocumentMetadataConfigurationUpdateRelevanceArgs.builder()
.duration("string")
.freshness(false)
.importance(0)
.rankOrder("string")
.valuesImportanceMap(Map.of("string", 0))
.build())
.search(IndexDocumentMetadataConfigurationUpdateSearchArgs.builder()
.displayable(false)
.facetable(false)
.searchable(false)
.sortable(false)
.build())
.build())
.edition("string")
.name("string")
.serverSideEncryptionConfiguration(IndexServerSideEncryptionConfigurationArgs.builder()
.kmsKeyId("string")
.build())
.tags(Map.of("string", "string"))
.userContextPolicy("string")
.userGroupResolutionConfiguration(IndexUserGroupResolutionConfigurationArgs.builder()
.userGroupResolutionMode("string")
.build())
.userTokenConfigurations(IndexUserTokenConfigurationsArgs.builder()
.jsonTokenTypeConfiguration(IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs.builder()
.groupAttributeField("string")
.userNameAttributeField("string")
.build())
.jwtTokenTypeConfiguration(IndexUserTokenConfigurationsJwtTokenTypeConfigurationArgs.builder()
.keyLocation("string")
.claimRegex("string")
.groupAttributeField("string")
.issuer("string")
.secretsManagerArn("string")
.url("string")
.userNameAttributeField("string")
.build())
.build())
.build());
index_resource = aws.kendra.Index("indexResource",
role_arn="string",
capacity_units={
"query_capacity_units": 0,
"storage_capacity_units": 0,
},
description="string",
document_metadata_configuration_updates=[{
"name": "string",
"type": "string",
"relevance": {
"duration": "string",
"freshness": False,
"importance": 0,
"rank_order": "string",
"values_importance_map": {
"string": 0,
},
},
"search": {
"displayable": False,
"facetable": False,
"searchable": False,
"sortable": False,
},
}],
edition="string",
name="string",
server_side_encryption_configuration={
"kms_key_id": "string",
},
tags={
"string": "string",
},
user_context_policy="string",
user_group_resolution_configuration={
"user_group_resolution_mode": "string",
},
user_token_configurations={
"json_token_type_configuration": {
"group_attribute_field": "string",
"user_name_attribute_field": "string",
},
"jwt_token_type_configuration": {
"key_location": "string",
"claim_regex": "string",
"group_attribute_field": "string",
"issuer": "string",
"secrets_manager_arn": "string",
"url": "string",
"user_name_attribute_field": "string",
},
})
const indexResource = new aws.kendra.Index("indexResource", {
roleArn: "string",
capacityUnits: {
queryCapacityUnits: 0,
storageCapacityUnits: 0,
},
description: "string",
documentMetadataConfigurationUpdates: [{
name: "string",
type: "string",
relevance: {
duration: "string",
freshness: false,
importance: 0,
rankOrder: "string",
valuesImportanceMap: {
string: 0,
},
},
search: {
displayable: false,
facetable: false,
searchable: false,
sortable: false,
},
}],
edition: "string",
name: "string",
serverSideEncryptionConfiguration: {
kmsKeyId: "string",
},
tags: {
string: "string",
},
userContextPolicy: "string",
userGroupResolutionConfiguration: {
userGroupResolutionMode: "string",
},
userTokenConfigurations: {
jsonTokenTypeConfiguration: {
groupAttributeField: "string",
userNameAttributeField: "string",
},
jwtTokenTypeConfiguration: {
keyLocation: "string",
claimRegex: "string",
groupAttributeField: "string",
issuer: "string",
secretsManagerArn: "string",
url: "string",
userNameAttributeField: "string",
},
},
});
type: aws:kendra:Index
properties:
capacityUnits:
queryCapacityUnits: 0
storageCapacityUnits: 0
description: string
documentMetadataConfigurationUpdates:
- name: string
relevance:
duration: string
freshness: false
importance: 0
rankOrder: string
valuesImportanceMap:
string: 0
search:
displayable: false
facetable: false
searchable: false
sortable: false
type: string
edition: string
name: string
roleArn: string
serverSideEncryptionConfiguration:
kmsKeyId: string
tags:
string: string
userContextPolicy: string
userGroupResolutionConfiguration:
userGroupResolutionMode: string
userTokenConfigurations:
jsonTokenTypeConfiguration:
groupAttributeField: string
userNameAttributeField: string
jwtTokenTypeConfiguration:
claimRegex: string
groupAttributeField: string
issuer: string
keyLocation: string
secretsManagerArn: string
url: string
userNameAttributeField: string
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:
- Role
Arn string - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - Capacity
Units IndexCapacity Units - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- Description string
- The description of the Index.
- Document
Metadata List<IndexConfiguration Updates Document Metadata Configuration Update> - 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. 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 string
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - Name string
- Specifies the name of the Index.
- Server
Side IndexEncryption Configuration Server Side Encryption Configuration - 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. Detailed below.
- Dictionary<string, string>
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - User
Context stringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - User
Group IndexResolution Configuration User Group Resolution Configuration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- User
Token IndexConfigurations User Token Configurations - A block that specifies the user token configuration. Detailed below.
- Role
Arn string - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - Capacity
Units IndexCapacity Units Args - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- Description string
- The description of the Index.
- Document
Metadata []IndexConfiguration Updates Document Metadata Configuration Update Args - 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. 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 string
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - Name string
- Specifies the name of the Index.
- Server
Side IndexEncryption Configuration Server Side Encryption Configuration Args - 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. Detailed below.
- map[string]string
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - User
Context stringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - User
Group IndexResolution Configuration User Group Resolution Configuration Args - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- User
Token IndexConfigurations User Token Configurations Args - A block that specifies the user token configuration. Detailed below.
- role
Arn String - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - capacity
Units IndexCapacity Units - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- description String
- The description of the Index.
- document
Metadata List<IndexConfiguration Updates Document Metadata Configuration Update> - 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. 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 String
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - name String
- Specifies the name of the Index.
- server
Side IndexEncryption Configuration Server Side Encryption Configuration - 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. Detailed below.
- Map<String,String>
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Context StringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - user
Group IndexResolution Configuration User Group Resolution Configuration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- user
Token IndexConfigurations User Token Configurations - A block that specifies the user token configuration. Detailed below.
- role
Arn string - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - capacity
Units IndexCapacity Units - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- description string
- The description of the Index.
- document
Metadata IndexConfiguration Updates Document Metadata Configuration Update[] - 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. 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 string
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - name string
- Specifies the name of the Index.
- server
Side IndexEncryption Configuration Server Side Encryption Configuration - 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. Detailed below.
- {[key: string]: string}
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Context stringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - user
Group IndexResolution Configuration User Group Resolution Configuration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- user
Token IndexConfigurations User Token Configurations - A block that specifies the user token configuration. Detailed below.
- role_
arn str - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - capacity_
units IndexCapacity Units Args - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- description str
- The description of the Index.
- document_
metadata_ Sequence[Indexconfiguration_ updates Document Metadata Configuration Update Args] - 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. 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 str
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - name str
- Specifies the name of the Index.
- server_
side_ Indexencryption_ configuration Server Side Encryption Configuration Args - 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. Detailed below.
- Mapping[str, str]
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user_
context_ strpolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - user_
group_ Indexresolution_ configuration User Group Resolution Configuration Args - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- user_
token_ Indexconfigurations User Token Configurations Args - A block that specifies the user token configuration. Detailed below.
- role
Arn String - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - capacity
Units Property Map - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- description String
- The description of the Index.
- document
Metadata List<Property Map>Configuration Updates - 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. 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 String
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - name String
- Specifies the name of the Index.
- server
Side Property MapEncryption Configuration - 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. Detailed below.
- Map<String>
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Context StringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - user
Group Property MapResolution Configuration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- user
Token Property MapConfigurations - A block that specifies the user token configuration. Detailed below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the Index.
- Created
At string - The Unix datetime that the index was created.
- Error
Message string - When the Status field value is
FAILED, this contains a message that explains why. - Id string
- The provider-assigned unique ID for this managed resource.
- Index
Statistics List<IndexIndex Statistic> - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- Status string
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Updated
At string - The Unix datetime that the index was last updated.
- Arn string
- The Amazon Resource Name (ARN) of the Index.
- Created
At string - The Unix datetime that the index was created.
- Error
Message string - When the Status field value is
FAILED, this contains a message that explains why. - Id string
- The provider-assigned unique ID for this managed resource.
- Index
Statistics []IndexIndex Statistic - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- Status string
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Updated
At string - The Unix datetime that the index was last updated.
- arn String
- The Amazon Resource Name (ARN) of the Index.
- created
At String - The Unix datetime that the index was created.
- error
Message String - When the Status field value is
FAILED, this contains a message that explains why. - id String
- The provider-assigned unique ID for this managed resource.
- index
Statistics List<IndexIndex Statistic> - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- status String
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At String - The Unix datetime that the index was last updated.
- arn string
- The Amazon Resource Name (ARN) of the Index.
- created
At string - The Unix datetime that the index was created.
- error
Message string - When the Status field value is
FAILED, this contains a message that explains why. - id string
- The provider-assigned unique ID for this managed resource.
- index
Statistics IndexIndex Statistic[] - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- status string
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At string - The Unix datetime that the index was last updated.
- arn str
- The Amazon Resource Name (ARN) of the Index.
- created_
at str - The Unix datetime that the index was created.
- error_
message str - When the Status field value is
FAILED, this contains a message that explains why. - id str
- The provider-assigned unique ID for this managed resource.
- index_
statistics Sequence[IndexIndex Statistic] - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- status str
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated_
at str - The Unix datetime that the index was last updated.
- arn String
- The Amazon Resource Name (ARN) of the Index.
- created
At String - The Unix datetime that the index was created.
- error
Message String - When the Status field value is
FAILED, this contains a message that explains why. - id String
- The provider-assigned unique ID for this managed resource.
- index
Statistics List<Property Map> - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- status String
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At String - The Unix datetime that the index was last updated.
Look up Existing Index Resource
Get an existing Index resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: IndexState, opts?: CustomResourceOptions): Index@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
capacity_units: Optional[IndexCapacityUnitsArgs] = None,
created_at: Optional[str] = None,
description: Optional[str] = None,
document_metadata_configuration_updates: Optional[Sequence[IndexDocumentMetadataConfigurationUpdateArgs]] = None,
edition: Optional[str] = None,
error_message: Optional[str] = None,
index_statistics: Optional[Sequence[IndexIndexStatisticArgs]] = None,
name: Optional[str] = None,
role_arn: Optional[str] = None,
server_side_encryption_configuration: Optional[IndexServerSideEncryptionConfigurationArgs] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
updated_at: Optional[str] = None,
user_context_policy: Optional[str] = None,
user_group_resolution_configuration: Optional[IndexUserGroupResolutionConfigurationArgs] = None,
user_token_configurations: Optional[IndexUserTokenConfigurationsArgs] = None) -> Indexfunc GetIndex(ctx *Context, name string, id IDInput, state *IndexState, opts ...ResourceOption) (*Index, error)public static Index Get(string name, Input<string> id, IndexState? state, CustomResourceOptions? opts = null)public static Index get(String name, Output<String> id, IndexState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The Amazon Resource Name (ARN) of the Index.
- Capacity
Units IndexCapacity Units - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- Created
At string - The Unix datetime that the index was created.
- Description string
- The description of the Index.
- Document
Metadata List<IndexConfiguration Updates Document Metadata Configuration Update> - 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. 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 string
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - Error
Message string - When the Status field value is
FAILED, this contains a message that explains why. - Index
Statistics List<IndexIndex Statistic> - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- Name string
- Specifies the name of the Index.
- Role
Arn string - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - Server
Side IndexEncryption Configuration Server Side Encryption Configuration - 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. Detailed below.
- Status string
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - Dictionary<string, string>
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Updated
At string - The Unix datetime that the index was last updated.
- User
Context stringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - User
Group IndexResolution Configuration User Group Resolution Configuration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- User
Token IndexConfigurations User Token Configurations - A block that specifies the user token configuration. Detailed below.
- Arn string
- The Amazon Resource Name (ARN) of the Index.
- Capacity
Units IndexCapacity Units Args - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- Created
At string - The Unix datetime that the index was created.
- Description string
- The description of the Index.
- Document
Metadata []IndexConfiguration Updates Document Metadata Configuration Update Args - 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. 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 string
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - Error
Message string - When the Status field value is
FAILED, this contains a message that explains why. - Index
Statistics []IndexIndex Statistic Args - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- Name string
- Specifies the name of the Index.
- Role
Arn string - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - Server
Side IndexEncryption Configuration Server Side Encryption Configuration Args - 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. Detailed below.
- Status string
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - map[string]string
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Updated
At string - The Unix datetime that the index was last updated.
- User
Context stringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - User
Group IndexResolution Configuration User Group Resolution Configuration Args - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- User
Token IndexConfigurations User Token Configurations Args - A block that specifies the user token configuration. Detailed below.
- arn String
- The Amazon Resource Name (ARN) of the Index.
- capacity
Units IndexCapacity Units - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- created
At String - The Unix datetime that the index was created.
- description String
- The description of the Index.
- document
Metadata List<IndexConfiguration Updates Document Metadata Configuration Update> - 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. 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 String
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - error
Message String - When the Status field value is
FAILED, this contains a message that explains why. - index
Statistics List<IndexIndex Statistic> - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- name String
- Specifies the name of the Index.
- role
Arn String - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - server
Side IndexEncryption Configuration Server Side Encryption Configuration - 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. Detailed below.
- status String
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - Map<String,String>
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At String - The Unix datetime that the index was last updated.
- user
Context StringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - user
Group IndexResolution Configuration User Group Resolution Configuration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- user
Token IndexConfigurations User Token Configurations - A block that specifies the user token configuration. Detailed below.
- arn string
- The Amazon Resource Name (ARN) of the Index.
- capacity
Units IndexCapacity Units - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- created
At string - The Unix datetime that the index was created.
- description string
- The description of the Index.
- document
Metadata IndexConfiguration Updates Document Metadata Configuration Update[] - 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. 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 string
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - error
Message string - When the Status field value is
FAILED, this contains a message that explains why. - index
Statistics IndexIndex Statistic[] - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- name string
- Specifies the name of the Index.
- role
Arn string - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - server
Side IndexEncryption Configuration Server Side Encryption Configuration - 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. Detailed below.
- status string
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - {[key: string]: string}
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At string - The Unix datetime that the index was last updated.
- user
Context stringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - user
Group IndexResolution Configuration User Group Resolution Configuration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- user
Token IndexConfigurations User Token Configurations - A block that specifies the user token configuration. Detailed below.
- arn str
- The Amazon Resource Name (ARN) of the Index.
- capacity_
units IndexCapacity Units Args - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- created_
at str - The Unix datetime that the index was created.
- description str
- The description of the Index.
- document_
metadata_ Sequence[Indexconfiguration_ updates Document Metadata Configuration Update Args] - 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. 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 str
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - error_
message str - When the Status field value is
FAILED, this contains a message that explains why. - index_
statistics Sequence[IndexIndex Statistic Args] - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- name str
- Specifies the name of the Index.
- role_
arn str - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - server_
side_ Indexencryption_ configuration Server Side Encryption Configuration Args - 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. Detailed below.
- status str
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - Mapping[str, str]
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated_
at str - The Unix datetime that the index was last updated.
- user_
context_ strpolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - user_
group_ Indexresolution_ configuration User Group Resolution Configuration Args - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- user_
token_ Indexconfigurations User Token Configurations Args - A block that specifies the user token configuration. Detailed below.
- arn String
- The Amazon Resource Name (ARN) of the Index.
- capacity
Units Property Map - A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
- created
At String - The Unix datetime that the index was created.
- description String
- The description of the Index.
- document
Metadata List<Property Map>Configuration Updates - 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. 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 String
- The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION - error
Message String - When the Status field value is
FAILED, this contains a message that explains why. - index
Statistics List<Property Map> - A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
- name String
- Specifies the name of the Index.
- role
Arn String - 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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket. - server
Side Property MapEncryption Configuration - 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. Detailed below.
- status String
- The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerror_messagefield contains a message that explains why. - Map<String>
- Tags to apply to the Index. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - updated
At String - The Unix datetime that the index was last updated.
- user
Context StringPolicy - The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER. - user
Group Property MapResolution Configuration - A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
- user
Token Property MapConfigurations - A block that specifies the user token configuration. Detailed below.
Supporting Types
IndexCapacityUnits, IndexCapacityUnitsArgs
- Query
Capacity intUnits - The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
- 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. Minimum value of 0.
- Query
Capacity intUnits - The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
- 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. Minimum value of 0.
- query
Capacity IntegerUnits - The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
- 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. Minimum value of 0.
- query
Capacity numberUnits - The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
- 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. Minimum value of 0.
- query_
capacity_ intunits - The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
- 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. Minimum value of 0.
- query
Capacity NumberUnits - The amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
- 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. Minimum value of 0.
IndexDocumentMetadataConfigurationUpdate, IndexDocumentMetadataConfigurationUpdateArgs
- Name string
- The name of the index field. Minimum length of 1. Maximum length of 30.
- Type string
- The data type of the index field. Valid values are
STRING_VALUE,STRING_LIST_VALUE,LONG_VALUE,DATE_VALUE. - Relevance
Index
Document Metadata Configuration Update Relevance - A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below
- Search
Index
Document Metadata Configuration Update Search - A block that provides information about how the field is used during a search. Documented below. Detailed below
- Name string
- The name of the index field. Minimum length of 1. Maximum length of 30.
- Type string
- The data type of the index field. Valid values are
STRING_VALUE,STRING_LIST_VALUE,LONG_VALUE,DATE_VALUE. - Relevance
Index
Document Metadata Configuration Update Relevance - A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below
- Search
Index
Document Metadata Configuration Update Search - A block that provides information about how the field is used during a search. Documented below. Detailed below
- name String
- The name of the index field. Minimum length of 1. Maximum length of 30.
- type String
- The data type of the index field. Valid values are
STRING_VALUE,STRING_LIST_VALUE,LONG_VALUE,DATE_VALUE. - relevance
Index
Document Metadata Configuration Update Relevance - A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below
- search
Index
Document Metadata Configuration Update Search - A block that provides information about how the field is used during a search. Documented below. Detailed below
- name string
- The name of the index field. Minimum length of 1. Maximum length of 30.
- type string
- The data type of the index field. Valid values are
STRING_VALUE,STRING_LIST_VALUE,LONG_VALUE,DATE_VALUE. - relevance
Index
Document Metadata Configuration Update Relevance - A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below
- search
Index
Document Metadata Configuration Update Search - A block that provides information about how the field is used during a search. Documented below. Detailed below
- name str
- The name of the index field. Minimum length of 1. Maximum length of 30.
- type str
- The data type of the index field. Valid values are
STRING_VALUE,STRING_LIST_VALUE,LONG_VALUE,DATE_VALUE. - relevance
Index
Document Metadata Configuration Update Relevance - A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below
- search
Index
Document Metadata Configuration Update Search - A block that provides information about how the field is used during a search. Documented below. Detailed below
- name String
- The name of the index field. Minimum length of 1. Maximum length of 30.
- type String
- The data type of the index field. Valid values are
STRING_VALUE,STRING_LIST_VALUE,LONG_VALUE,DATE_VALUE. - relevance Property Map
- A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below
- search Property Map
- A block that provides information about how the field is used during a search. Documented below. Detailed below
IndexDocumentMetadataConfigurationUpdateRelevance, IndexDocumentMetadataConfigurationUpdateRelevanceArgs
- Duration string
- Specifies the time period that the boost applies to. For more information, refer to Duration.
- Freshness bool
- Indicates that this field determines how "fresh" a document is. For more information, refer to Freshness.
- Importance int
- The 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.
- Rank
Order string - Determines how values should be interpreted. For more information, refer to RankOrder.
- Values
Importance Dictionary<string, int>Map - A list of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.
- Duration string
- Specifies the time period that the boost applies to. For more information, refer to Duration.
- Freshness bool
- Indicates that this field determines how "fresh" a document is. For more information, refer to Freshness.
- Importance int
- The 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.
- Rank
Order string - Determines how values should be interpreted. For more information, refer to RankOrder.
- Values
Importance map[string]intMap - A list of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.
- duration String
- Specifies the time period that the boost applies to. For more information, refer to Duration.
- freshness Boolean
- Indicates that this field determines how "fresh" a document is. For more information, refer to Freshness.
- importance Integer
- The 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.
- rank
Order String - Determines how values should be interpreted. For more information, refer to RankOrder.
- values
Importance Map<String,Integer>Map - A list of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.
- duration string
- Specifies the time period that the boost applies to. For more information, refer to Duration.
- freshness boolean
- Indicates that this field determines how "fresh" a document is. For more information, refer to Freshness.
- importance number
- The 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.
- rank
Order string - Determines how values should be interpreted. For more information, refer to RankOrder.
- values
Importance {[key: string]: number}Map - A list of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.
- duration str
- Specifies the time period that the boost applies to. For more information, refer to Duration.
- freshness bool
- Indicates that this field determines how "fresh" a document is. For more information, refer to Freshness.
- importance int
- The 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.
- rank_
order str - Determines how values should be interpreted. For more information, refer to RankOrder.
- values_
importance_ Mapping[str, int]map - A list of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.
- duration String
- Specifies the time period that the boost applies to. For more information, refer to Duration.
- freshness Boolean
- Indicates that this field determines how "fresh" a document is. For more information, refer to Freshness.
- importance Number
- The 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.
- rank
Order String - Determines how values should be interpreted. For more information, refer to RankOrder.
- values
Importance Map<Number>Map - A list of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.
IndexDocumentMetadataConfigurationUpdateSearch, IndexDocumentMetadataConfigurationUpdateSearchArgs
- Displayable bool
- Determines whether the field is returned in the query response. The default is
true. - Facetable bool
- Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is
false. - Searchable bool
- 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
trueforstringfields andfalsefornumberanddatefields. - Sortable bool
- 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.
- Displayable bool
- Determines whether the field is returned in the query response. The default is
true. - Facetable bool
- Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is
false. - Searchable bool
- 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
trueforstringfields andfalsefornumberanddatefields. - Sortable bool
- 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.
- displayable Boolean
- Determines whether the field is returned in the query response. The default is
true. - facetable Boolean
- Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is
false. - searchable Boolean
- 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
trueforstringfields andfalsefornumberanddatefields. - sortable Boolean
- 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.
- displayable boolean
- Determines whether the field is returned in the query response. The default is
true. - facetable boolean
- Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is
false. - searchable boolean
- 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
trueforstringfields andfalsefornumberanddatefields. - sortable boolean
- 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.
- displayable bool
- Determines whether the field is returned in the query response. The default is
true. - facetable bool
- Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is
false. - searchable bool
- 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
trueforstringfields andfalsefornumberanddatefields. - sortable bool
- 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.
- displayable Boolean
- Determines whether the field is returned in the query response. The default is
true. - facetable Boolean
- Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is
false. - searchable Boolean
- 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
trueforstringfields andfalsefornumberanddatefields. - sortable Boolean
- 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.
IndexIndexStatistic, IndexIndexStatisticArgs
- Faq
Statistics List<IndexIndex Statistic Faq Statistic> - A block that specifies the number of question and answer topics in the index. Detailed below.
- Text
Document List<IndexStatistics Index Statistic Text Document Statistic> - A block that specifies the number of text documents indexed. Detailed below.
- Faq
Statistics []IndexIndex Statistic Faq Statistic - A block that specifies the number of question and answer topics in the index. Detailed below.
- Text
Document []IndexStatistics Index Statistic Text Document Statistic - A block that specifies the number of text documents indexed. Detailed below.
- faq
Statistics List<IndexIndex Statistic Faq Statistic> - A block that specifies the number of question and answer topics in the index. Detailed below.
- text
Document List<IndexStatistics Index Statistic Text Document Statistic> - A block that specifies the number of text documents indexed. Detailed below.
- faq
Statistics IndexIndex Statistic Faq Statistic[] - A block that specifies the number of question and answer topics in the index. Detailed below.
- text
Document IndexStatistics Index Statistic Text Document Statistic[] - A block that specifies the number of text documents indexed. Detailed below.
- faq_
statistics Sequence[IndexIndex Statistic Faq Statistic] - A block that specifies the number of question and answer topics in the index. Detailed below.
- text_
document_ Sequence[Indexstatistics Index Statistic Text Document Statistic] - A block that specifies the number of text documents indexed. Detailed below.
- faq
Statistics List<Property Map> - A block that specifies the number of question and answer topics in the index. Detailed below.
- text
Document List<Property Map>Statistics - A block that specifies the number of text documents indexed. Detailed below.
IndexIndexStatisticFaqStatistic, IndexIndexStatisticFaqStatisticArgs
- Indexed
Question intAnswers Count - The total number of FAQ questions and answers contained in the index.
- Indexed
Question intAnswers Count - The total number of FAQ questions and answers contained in the index.
- indexed
Question IntegerAnswers Count - The total number of FAQ questions and answers contained in the index.
- indexed
Question numberAnswers Count - The total number of FAQ questions and answers contained in the index.
- indexed_
question_ intanswers_ count - The total number of FAQ questions and answers contained in the index.
- indexed
Question NumberAnswers Count - The total number of FAQ questions and answers contained in the index.
IndexIndexStatisticTextDocumentStatistic, IndexIndexStatisticTextDocumentStatisticArgs
- Indexed
Text intBytes - The total size, in bytes, of the indexed documents.
- Indexed
Text intDocuments Count - The number of text documents indexed.
- Indexed
Text intBytes - The total size, in bytes, of the indexed documents.
- Indexed
Text intDocuments Count - The number of text documents indexed.
- indexed
Text IntegerBytes - The total size, in bytes, of the indexed documents.
- indexed
Text IntegerDocuments Count - The number of text documents indexed.
- indexed
Text numberBytes - The total size, in bytes, of the indexed documents.
- indexed
Text numberDocuments Count - The number of text documents indexed.
- indexed_
text_ intbytes - The total size, in bytes, of the indexed documents.
- indexed_
text_ intdocuments_ count - The number of text documents indexed.
- indexed
Text NumberBytes - The total size, in bytes, of the indexed documents.
- indexed
Text NumberDocuments Count - The number of text documents indexed.
IndexServerSideEncryptionConfiguration, IndexServerSideEncryptionConfigurationArgs
- Kms
Key stringId - The identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
- Kms
Key stringId - The identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
- kms
Key StringId - The identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
- kms
Key stringId - The identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
- kms_
key_ strid - The identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
- kms
Key StringId - The identifier of the AWS KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
IndexUserGroupResolutionConfiguration, IndexUserGroupResolutionConfigurationArgs
- User
Group stringResolution Mode - 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_SSOorNONE.
- User
Group stringResolution Mode - 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_SSOorNONE.
- user
Group StringResolution Mode - 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_SSOorNONE.
- user
Group stringResolution Mode - 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_SSOorNONE.
- user_
group_ strresolution_ mode - 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_SSOorNONE.
- user
Group StringResolution Mode - 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_SSOorNONE.
IndexUserTokenConfigurations, IndexUserTokenConfigurationsArgs
- Json
Token IndexType Configuration User Token Configurations Json Token Type Configuration - A block that specifies the information about the JSON token type configuration. Detailed below.
- Jwt
Token IndexType Configuration User Token Configurations Jwt Token Type Configuration - A block that specifies the information about the JWT token type configuration. Detailed below.
- Json
Token IndexType Configuration User Token Configurations Json Token Type Configuration - A block that specifies the information about the JSON token type configuration. Detailed below.
- Jwt
Token IndexType Configuration User Token Configurations Jwt Token Type Configuration - A block that specifies the information about the JWT token type configuration. Detailed below.
- json
Token IndexType Configuration User Token Configurations Json Token Type Configuration - A block that specifies the information about the JSON token type configuration. Detailed below.
- jwt
Token IndexType Configuration User Token Configurations Jwt Token Type Configuration - A block that specifies the information about the JWT token type configuration. Detailed below.
- json
Token IndexType Configuration User Token Configurations Json Token Type Configuration - A block that specifies the information about the JSON token type configuration. Detailed below.
- jwt
Token IndexType Configuration User Token Configurations Jwt Token Type Configuration - A block that specifies the information about the JWT token type configuration. Detailed below.
- json_
token_ Indextype_ configuration User Token Configurations Json Token Type Configuration - A block that specifies the information about the JSON token type configuration. Detailed below.
- jwt_
token_ Indextype_ configuration User Token Configurations Jwt Token Type Configuration - A block that specifies the information about the JWT token type configuration. Detailed below.
- json
Token Property MapType Configuration - A block that specifies the information about the JSON token type configuration. Detailed below.
- jwt
Token Property MapType Configuration - A block that specifies the information about the JWT token type configuration. Detailed below.
IndexUserTokenConfigurationsJsonTokenTypeConfiguration, IndexUserTokenConfigurationsJsonTokenTypeConfigurationArgs
- Group
Attribute stringField - The group attribute field. Minimum length of 1. Maximum length of 2048.
- User
Name stringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 2048.
- Group
Attribute stringField - The group attribute field. Minimum length of 1. Maximum length of 2048.
- User
Name stringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 2048.
- group
Attribute StringField - The group attribute field. Minimum length of 1. Maximum length of 2048.
- user
Name StringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 2048.
- group
Attribute stringField - The group attribute field. Minimum length of 1. Maximum length of 2048.
- user
Name stringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 2048.
- group_
attribute_ strfield - The group attribute field. Minimum length of 1. Maximum length of 2048.
- user_
name_ strattribute_ field - The user name attribute field. Minimum length of 1. Maximum length of 2048.
- group
Attribute StringField - The group attribute field. Minimum length of 1. Maximum length of 2048.
- user
Name StringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 2048.
IndexUserTokenConfigurationsJwtTokenTypeConfiguration, IndexUserTokenConfigurationsJwtTokenTypeConfigurationArgs
- Key
Location string - The location of the key. Valid values are
URLorSECRET_MANAGER - Claim
Regex string - The regular expression that identifies the claim. Minimum length of 1. Maximum length of 100.
- Group
Attribute stringField - The group attribute field. Minimum length of 1. Maximum length of 100.
- Issuer string
- The issuer of the token. Minimum length of 1. Maximum length of 65.
- Secrets
Manager stringArn - The Amazon Resource Name (ARN) of the secret.
- Url string
- The signing key URL. Valid pattern is
^(https?|ftp|file):\/\/([^\s]*) - User
Name stringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 100.
- Key
Location string - The location of the key. Valid values are
URLorSECRET_MANAGER - Claim
Regex string - The regular expression that identifies the claim. Minimum length of 1. Maximum length of 100.
- Group
Attribute stringField - The group attribute field. Minimum length of 1. Maximum length of 100.
- Issuer string
- The issuer of the token. Minimum length of 1. Maximum length of 65.
- Secrets
Manager stringArn - The Amazon Resource Name (ARN) of the secret.
- Url string
- The signing key URL. Valid pattern is
^(https?|ftp|file):\/\/([^\s]*) - User
Name stringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 100.
- key
Location String - The location of the key. Valid values are
URLorSECRET_MANAGER - claim
Regex String - The regular expression that identifies the claim. Minimum length of 1. Maximum length of 100.
- group
Attribute StringField - The group attribute field. Minimum length of 1. Maximum length of 100.
- issuer String
- The issuer of the token. Minimum length of 1. Maximum length of 65.
- secrets
Manager StringArn - The Amazon Resource Name (ARN) of the secret.
- url String
- The signing key URL. Valid pattern is
^(https?|ftp|file):\/\/([^\s]*) - user
Name StringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 100.
- key
Location string - The location of the key. Valid values are
URLorSECRET_MANAGER - claim
Regex string - The regular expression that identifies the claim. Minimum length of 1. Maximum length of 100.
- group
Attribute stringField - The group attribute field. Minimum length of 1. Maximum length of 100.
- issuer string
- The issuer of the token. Minimum length of 1. Maximum length of 65.
- secrets
Manager stringArn - The Amazon Resource Name (ARN) of the secret.
- url string
- The signing key URL. Valid pattern is
^(https?|ftp|file):\/\/([^\s]*) - user
Name stringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 100.
- key_
location str - The location of the key. Valid values are
URLorSECRET_MANAGER - claim_
regex str - The regular expression that identifies the claim. Minimum length of 1. Maximum length of 100.
- group_
attribute_ strfield - The group attribute field. Minimum length of 1. Maximum length of 100.
- issuer str
- The issuer of the token. Minimum length of 1. Maximum length of 65.
- secrets_
manager_ strarn - The Amazon Resource Name (ARN) of the secret.
- url str
- The signing key URL. Valid pattern is
^(https?|ftp|file):\/\/([^\s]*) - user_
name_ strattribute_ field - The user name attribute field. Minimum length of 1. Maximum length of 100.
- key
Location String - The location of the key. Valid values are
URLorSECRET_MANAGER - claim
Regex String - The regular expression that identifies the claim. Minimum length of 1. Maximum length of 100.
- group
Attribute StringField - The group attribute field. Minimum length of 1. Maximum length of 100.
- issuer String
- The issuer of the token. Minimum length of 1. Maximum length of 65.
- secrets
Manager StringArn - The Amazon Resource Name (ARN) of the secret.
- url String
- The signing key URL. Valid pattern is
^(https?|ftp|file):\/\/([^\s]*) - user
Name StringAttribute Field - The user name attribute field. Minimum length of 1. Maximum length of 100.
Import
Using pulumi import, import Amazon Kendra Indexes using its id. For example:
$ pulumi import aws:kendra/index:Index example 12345678-1234-5678-9123-123456789123
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.