You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kendra::Types::UpdateIndexRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateIndexRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  id: "IndexId", # required
  name: "IndexName",
  role_arn: "RoleArn",
  description: "Description",
  document_metadata_configuration_updates: [
    {
      name: "DocumentMetadataConfigurationName", # required
      type: "STRING_VALUE", # required, accepts STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE
      relevance: {
        freshness: false,
        importance: 1,
        duration: "Duration",
        rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
        value_importance_map: {
          "ValueImportanceMapKey" => 1,
        },
      },
      search: {
        facetable: false,
        searchable: false,
        displayable: false,
        sortable: false,
      },
    },
  ],
  capacity_units: {
    storage_capacity_units: 1, # required
    query_capacity_units: 1, # required
  },
  user_token_configurations: [
    {
      jwt_token_type_configuration: {
        key_location: "URL", # required, accepts URL, SECRET_MANAGER
        url: "Url",
        secret_manager_arn: "RoleArn",
        user_name_attribute_field: "UserNameAttributeField",
        group_attribute_field: "GroupAttributeField",
        issuer: "Issuer",
        claim_regex: "ClaimRegex",
      },
      json_token_type_configuration: {
        user_name_attribute_field: "String", # required
        group_attribute_field: "String", # required
      },
    },
  ],
  user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_units ⇒ Types::CapacityUnitsConfiguration

Sets the number of addtional storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day.

If you are using extra storage units, you can\'t reduce the storage capacity below that required to meet the storage needs for your index.

Returns:

#description ⇒ String

A new description for the index.

Returns:

  • (String) —

    A new description for the index.

#document_metadata_configuration_updates ⇒ Array<Types::DocumentMetadataConfiguration>

The document metadata to update.

Returns:

#id ⇒ String

The identifier of the index to update.

Returns:

  • (String) —

    The identifier of the index to update.

#name ⇒ String

The name of the index to update.

Returns:

  • (String) —

    The name of the index to update.

#role_arn ⇒ String

A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.

Returns:

  • (String) —

    A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.

#user_context_policy ⇒ String

The user user token context policy.

Possible values:

  • ATTRIBUTE_FILTER
  • USER_TOKEN

Returns:

  • (String) —

    The user user token context policy.

#user_token_configurations ⇒ Array<Types::UserTokenConfiguration>

The user token configuration.

Returns: