Class: Aws::OpenSearchServerless::Types::UpdateCollectionDetail

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchServerless::Types::UpdateCollectionDetail

Defined in:

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

Overview

Details about an updated OpenSearch Serverless collection.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the collection.

• #created_date ⇒ Integer

  The date and time when the collection was created.

• #deletion_protection ⇒ String

  Indicates whether deletion protection is ENABLED or DISABLED for the collection.

• #description ⇒ String

  The description of the collection.

• #id ⇒ String

  The unique identifier of the collection.

• #kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key used to encrypt the collection.

• #last_modified_date ⇒ Integer

  The date and time when the collection was last modified.

• #name ⇒ String

  The name of the collection.

• #status ⇒ String

  The current status of the collection.

• #type ⇒ String

  The collection type.

• #vector_options ⇒ Types::VectorOptions

  Configuration options for vector search capabilities in the collection.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the collection.

Returns:

• (String)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Integer

The date and time when the collection was created.

Returns:

• (Integer)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ String

Indicates whether deletion protection is ENABLED or DISABLED for the collection.

Returns:

• (String)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the collection.

Returns:

• (String)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the collection.

Returns:

• (String)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key used to encrypt the collection.

Returns:

• (String)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Integer

The date and time when the collection was last modified.

Returns:

• (Integer)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the collection.

Returns:

• (String)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the collection.

Returns:

• (String)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The collection type.

Returns:

• (String)

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

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  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 3971

class UpdateCollectionDetail < Struct.new(
  :id,
  :name,
  :status,
  :type,
  :description,
  :vector_options,
  :kms_key_arn,
  :arn,
  :created_date,
  :last_modified_date,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end