Class: Aws::OpenSearchServerless::Types::CollectionSummary

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

Overview

Details about each OpenSearch Serverless collection.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the collection.

Returns:

  • (String)


674
675
676
677
678
679
680
681
682
683
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 674

class CollectionSummary < Struct.new(
  :id,
  :name,
  :status,
  :arn,
  :kms_key_arn,
  :collection_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#collection_group_nameString

The name of the collection group that contains this collection.

Returns:

  • (String)


674
675
676
677
678
679
680
681
682
683
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 674

class CollectionSummary < Struct.new(
  :id,
  :name,
  :status,
  :arn,
  :kms_key_arn,
  :collection_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique identifier of the collection.

Returns:

  • (String)


674
675
676
677
678
679
680
681
682
683
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 674

class CollectionSummary < Struct.new(
  :id,
  :name,
  :status,
  :arn,
  :kms_key_arn,
  :collection_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arnString

The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.

Returns:

  • (String)


674
675
676
677
678
679
680
681
682
683
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 674

class CollectionSummary < Struct.new(
  :id,
  :name,
  :status,
  :arn,
  :kms_key_arn,
  :collection_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the collection.

Returns:

  • (String)


674
675
676
677
678
679
680
681
682
683
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 674

class CollectionSummary < Struct.new(
  :id,
  :name,
  :status,
  :arn,
  :kms_key_arn,
  :collection_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the collection.

Returns:

  • (String)


674
675
676
677
678
679
680
681
682
683
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 674

class CollectionSummary < Struct.new(
  :id,
  :name,
  :status,
  :arn,
  :kms_key_arn,
  :collection_group_name)
  SENSITIVE = []
  include Aws::Structure
end