aws-native.kendra.Index

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

Create Index Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);

@overload
def Index(resource_name: str,
          args: IndexArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          edition: Optional[IndexEdition] = None,
          role_arn: Optional[str] = None,
          capacity_units: Optional[IndexCapacityUnitsConfigurationArgs] = None,
          description: Optional[str] = None,
          document_metadata_configurations: Optional[Sequence[IndexDocumentMetadataConfigurationArgs]] = None,
          name: Optional[str] = None,
          server_side_encryption_configuration: Optional[IndexServerSideEncryptionConfigurationArgs] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
          user_context_policy: Optional[IndexUserContextPolicy] = None,
          user_token_configurations: Optional[Sequence[IndexUserTokenConfigurationArgs]] = None)

func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)

public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)

public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)

type: aws-native:kendra:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args IndexArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args IndexArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args IndexArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IndexArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IndexArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const indexResource = new aws_native.kendra.Index("indexResource", {
    edition: aws_native.kendra.IndexEdition.DeveloperEdition,
    roleArn: "string",
    capacityUnits: {
        queryCapacityUnits: 0,
        storageCapacityUnits: 0,
    },
    description: "string",
    documentMetadataConfigurations: [{
        name: "string",
        type: aws_native.kendra.IndexDocumentAttributeValueType.StringValue,
        relevance: {
            duration: "string",
            freshness: false,
            importance: 0,
            rankOrder: aws_native.kendra.IndexOrder.Ascending,
            valueImportanceItems: [{
                key: "string",
                value: 0,
            }],
        },
        search: {
            displayable: false,
            facetable: false,
            searchable: false,
            sortable: false,
        },
    }],
    name: "string",
    serverSideEncryptionConfiguration: {
        kmsKeyId: "string",
    },
    tags: [{
        key: "string",
        value: "string",
    }],
    userContextPolicy: aws_native.kendra.IndexUserContextPolicy.AttributeFilter,
    userTokenConfigurations: [{
        jsonTokenTypeConfiguration: {
            groupAttributeField: "string",
            userNameAttributeField: "string",
        },
        jwtTokenTypeConfiguration: {
            keyLocation: aws_native.kendra.IndexKeyLocation.Url,
            claimRegex: "string",
            groupAttributeField: "string",
            issuer: "string",
            secretManagerArn: "string",
            url: "string",
            userNameAttributeField: "string",
        },
    }],
});