Class: Aws::Kendra::Types::CreateIndexRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::CreateIndexRequest
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_token ⇒ String
A token that you provide to identify the request to create an index.
-
#description ⇒ String
A description for the index.
-
#edition ⇒ String
The Amazon Kendra edition to use for the index.
-
#name ⇒ String
A name for the index.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics.
-
#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration
The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra.
-
#tags ⇒ Array<Types::Tag>
A list of key-value pairs that identify or categorize the index.
-
#user_context_policy ⇒ String
The user context policy.
-
#user_group_resolution_configuration ⇒ Types::UserGroupResolutionConfiguration
Gets users and groups from IAM Identity Center identity source.
-
#user_token_configurations ⇒ Array<Types::UserTokenConfiguration>
The user token configuration.
Instance Attribute Details
#client_token ⇒ String
A token that you provide to identify the request to create an index.
Multiple calls to the CreateIndex
API 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.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description for the index.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#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 production. Use
GEN_AI_ENTERPRISE_EDITION
for creating generative AI applications.
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
.
For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see Quotas.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A name for the index.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration
The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#user_context_policy ⇒ String
The user context policy.
If you're using an Amazon Kendra Gen AI Enterprise Edition index,
you can only use ATTRIBUTE_FILTER
to filter search results by user
context. If you're using an Amazon Kendra Gen AI Enterprise Edition
index and you try to use USER_TOKEN
to configure user context
policy, Amazon Kendra returns a ValidationException
error.
- ATTRIBUTE_FILTER
All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of
_user_id
and_group_ids
or you can provide user and group information inUserContext
.- USER_TOKEN
Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#user_group_resolution_configuration ⇒ Types::UserGroupResolutionConfiguration
Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
If you're using an Amazon Kendra Gen AI Enterprise Edition index,
UserGroupResolutionConfiguration
isn't supported.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |
#user_token_configurations ⇒ Array<Types::UserTokenConfiguration>
The user token configuration.
If you're using an Amazon Kendra Gen AI Enterprise Edition index
and you try to use UserTokenConfigurations
to configure user
context policy, Amazon Kendra returns a ValidationException
error.
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2460 class CreateIndexRequest < Struct.new( :name, :edition, :role_arn, :server_side_encryption_configuration, :description, :client_token, :tags, :user_token_configurations, :user_context_policy, :user_group_resolution_configuration) SENSITIVE = [] include Aws::Structure end |