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

Class: Aws::Kendra::Types::CreateIndexRequest

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

Overview

Note:

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

{
  name: "IndexName", # required
  edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
  role_arn: "RoleArn", # required
  server_side_encryption_configuration: {
    kms_key_id: "KmsKeyId",
  },
  description: "Description",
  client_token: "ClientTokenName",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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

#client_token ⇒ String

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.

Returns:

  • (String) —

    A token that you provide to identify the request to create an index.

#description ⇒ String

A description for the index.

Returns:

  • (String) —

    A description for the index.

#edition ⇒ String

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. Once you set the edition for an index, it can\'t be changed.

The Edition parameter is optional. If you don\'t supply a value, the default is ENTERPRISE_EDITION.

Possible values:

  • DEVELOPER_EDITION
  • ENTERPRISE_EDITION

Returns:

  • (String) —

    The Amazon Kendra edition to use for the index.

#name ⇒ String

The name for the new index.

Returns:

  • (String) —

    The name for the new 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 used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Returns:

  • (String) —

    An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.

#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn\'t support asymmetric CMKs.

Returns:

#tags ⇒ Array<Types::Tag>

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

Returns:

  • (Array<Types::Tag>) —

    A list of key-value pairs that identify the index.

#user_context_policy ⇒ String

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Possible values:

  • ATTRIBUTE_FILTER
  • USER_TOKEN

Returns:

  • (String) —

    The user context policy.

#user_token_configurations ⇒ Array<Types::UserTokenConfiguration>

The user token configuration.

Returns: