Class: Aws::OpenSearchServerless::Types::CollectionGroupDetail

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

Overview

Details about a collection group.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the collection group.

Returns:

  • (String) 


558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_limits ⇒ Types::CollectionGroupCapacityLimits

The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

Returns:



558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Integer

The Epoch time when the collection group was created.

Returns:

  • (Integer) 


558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the collection group.

Returns:

  • (String) 


558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the collection group.

Returns:

  • (String) 


558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the collection group.

Returns:

  • (String) 


558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_collections ⇒ Integer

The number of collections associated with the collection group.

Returns:

  • (Integer) 


558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end

#standby_replicas ⇒ String

Indicates whether standby replicas are used for the collection group.

Returns:

  • (String) 


558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A map of key-value pairs associated with the collection group.

Returns:



558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 558

class CollectionGroupDetail < Struct.new(
  :id,
  :arn,
  :name,
  :standby_replicas,
  :description,
  :tags,
  :created_date,
  :capacity_limits,
  :number_of_collections)
  SENSITIVE = []
  include Aws::Structure
end