Class: Aws::S3Vectors::Types::CreateIndexInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_type ⇒ String

The data type of the vectors to be inserted into the vector index.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dimension ⇒ Integer

The dimensions of the vectors to be inserted into the vector index.

Returns:

  • (Integer) 


99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#distance_metric ⇒ String

The distance metric to be used for similarity search.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

The encryption configuration for a vector index. By default, if you don’t specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the vector index to create.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_configuration ⇒ Types::MetadataConfiguration

The metadata configuration for the vector index.

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see [Tagging for cost allocation or attribute-based access control (ABAC)].

<note markdown=“1”> You must have the ‘s3vectors:TagResource` permission in addition to `s3vectors:CreateIndex` permission to create a vector index with tags.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html

Returns:

  • (Hash<String,String>) 


99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vector_bucket_arn ⇒ String

The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vector_bucket_name ⇒ String

The name of the vector bucket to create the vector index in.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aws-sdk-s3vectors/types.rb', line 99

class CreateIndexInput < Struct.new(
  :vector_bucket_name,
  :vector_bucket_arn,
  :index_name,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end