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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass CreateIndexRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String)

1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for the index.

Returns:

  • (String)

1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end

#editionString

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`.

Returns:

  • (String)

1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name for the new index.

Returns:

  • (String)

1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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)

1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_encryption_configurationTypes::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.


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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:


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end

#user_context_policyString

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.

Returns:

  • (String)

1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end

#user_token_configurationsArray<Types::UserTokenConfiguration>

The user token configuration.

Returns:


1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/aws-sdk-kendra/types.rb', line 1959

class CreateIndexRequest < Struct.new(
  :name,
  :edition,
  :role_arn,
  :server_side_encryption_configuration,
  :description,
  :client_token,
  :tags,
  :user_token_configurations,
  :user_context_policy)
  SENSITIVE = []
  include Aws::Structure
end