Class: Aws::OpenSearchServerless::Types::CreateCollectionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier to ensure idempotency of the request.

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

Returns:

  • (String) 


971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#collection_group_name ⇒ String

The name of the collection group to associate with the collection.

Returns:

  • (String) 


971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Description of the collection.

Returns:

  • (String) 


971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_config ⇒ Types::EncryptionConfig

Encryption settings for the collection.

Returns:



971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Name of the collection.

Returns:

  • (String) 


971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#standby_replicas ⇒ String

Indicates whether standby replicas should be used for a collection.

Returns:

  • (String) 


971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

Returns:



971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of collection.

Returns:

  • (String) 


971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#vector_options ⇒ Types::VectorOptions

Configuration options for vector search capabilities in the collection.

Returns:



971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 971

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end