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

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchServerless::Types::CreateCollectionRequest

Defined in:

gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

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

• #collection_group_name ⇒ String

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

• #deletion_protection ⇒ String

  Indicates whether to enable deletion protection for the collection.

• #description ⇒ String

  Description of the collection.

• #encryption_config ⇒ Types::EncryptionConfig

  Encryption settings for the collection.

• #name ⇒ String

  Name of the collection.

• #standby_replicas ⇒ String

  Indicates whether standby replicas should be used for a collection.

• #tags ⇒ Array<Types::Tag>

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

• #type ⇒ String

  The type of collection.

• #vector_options ⇒ Types::VectorOptions

  Configuration options for vector search capabilities in the collection.

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)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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

#collection_group_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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

#deletion_protection ⇒ String

Indicates whether to enable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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

#description ⇒ String

Description of the collection.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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

#encryption_config ⇒ Types::EncryptionConfig

Encryption settings for the collection.

Returns:

• (Types::EncryptionConfig)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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

#name ⇒ String

Name of the collection.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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

#standby_replicas ⇒ String

Indicates whether standby replicas should be used for a collection.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

class CreateCollectionRequest < Struct.new(
  :name,
  :type,
  :description,
  :tags,
  :standby_replicas,
  :vector_options,
  :collection_group_name,
  :encryption_config,
  :deletion_protection,
  :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:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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

#type ⇒ String

The type of collection.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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

#vector_options ⇒ Types::VectorOptions

Configuration options for vector search capabilities in the collection.

Returns:

• (Types::VectorOptions)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1094

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