Class: Aws::OpenSearchServerless::Types::CreateCollectionDetail

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

Overview

Details about the created OpenSearch Serverless collection.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#collection_group_name ⇒ String

The name of the collection group that contains this collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#created_date ⇒ Integer

The Epoch time when the collection was created.

Returns:

  • (Integer) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#deletion_protection ⇒ String

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

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#description ⇒ String

A description of the collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#id ⇒ String

The unique identifier of the collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#last_modified_date ⇒ Integer

The date and time when the collection was last modified.

Returns:

  • (Integer) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#name ⇒ String

The name of the collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#standby_replicas ⇒ String

Creates details about an OpenSearch Serverless collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#status ⇒ String

The current status of the collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#type ⇒ String

The type of collection.

Returns:

  • (String) 


907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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

#vector_options ⇒ Types::VectorOptions

Configuration options for vector search capabilities in the collection.

Returns:



907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 907

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