IndexArgs

data class IndexArgs(val capacityUnits: Output<IndexCapacityUnitsArgs>? = null, val description: Output<String>? = null, val documentMetadataConfigurationUpdates: Output<List<IndexDocumentMetadataConfigurationUpdateArgs>>? = null, val edition: Output<String>? = null, val name: Output<String>? = null, val roleArn: Output<String>? = null, val serverSideEncryptionConfiguration: Output<IndexServerSideEncryptionConfigurationArgs>? = null, val tags: Output<Map<String, String>>? = null, val userContextPolicy: Output<String>? = null, val userGroupResolutionConfiguration: Output<IndexUserGroupResolutionConfigurationArgs>? = null, val userTokenConfigurations: Output<IndexUserTokenConfigurationsArgs>? = null) : ConvertibleToJava<IndexArgs>

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",
})
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 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
})
}
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,
})
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 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
})
}
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"],
})
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 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
})
}
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",
})
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 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
})
}
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",
},
},
])
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 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
})
}
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",
},
},
])
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 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
})
}
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",
},
})
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 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
})
}
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

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

Constructors

Link copied to clipboard
constructor(capacityUnits: Output<IndexCapacityUnitsArgs>? = null, description: Output<String>? = null, documentMetadataConfigurationUpdates: Output<List<IndexDocumentMetadataConfigurationUpdateArgs>>? = null, edition: Output<String>? = null, name: Output<String>? = null, roleArn: Output<String>? = null, serverSideEncryptionConfiguration: Output<IndexServerSideEncryptionConfigurationArgs>? = null, tags: Output<Map<String, String>>? = null, userContextPolicy: Output<String>? = null, userGroupResolutionConfiguration: Output<IndexUserGroupResolutionConfigurationArgs>? = null, userTokenConfigurations: Output<IndexUserTokenConfigurationsArgs>? = null)

Properties

Link copied to clipboard

A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.

Link copied to clipboard
val description: Output<String>? = null

The description of the Index.

Link copied to clipboard

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.

Link copied to clipboard
val edition: Output<String>? = null

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Use GEN_AI_ENTERPRISE_EDITION for creating generative AI applications. Once you set the edition for an index, it can't be changed. Defaults to ENTERPRISE_EDITION.

Link copied to clipboard
val name: Output<String>? = null

Specifies the name of the Index.

Link copied to clipboard
val roleArn: Output<String>? = null

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.

Link copied to clipboard

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.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Tags to apply to the Index. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val userContextPolicy: Output<String>? = null

The user context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy. Defaults to ATTRIBUTE_FILTER.

Link copied to clipboard

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.

Link copied to clipboard

A block that specifies the user token configuration. Detailed below.

Functions

Link copied to clipboard
open override fun toJava(): IndexArgs