Class: Aws::OpenSearchServerless::Types::CollectionGroupSummary

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

Overview

Summary information 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) 


634
635
636
637
638
639
640
641
642
643
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 634

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

#capacity_limits ⇒ Types::CollectionGroupCapacityLimits

Capacity limits for a collection group. These limits define the minimum and maximum OpenSearch Compute Units (OCUs) for indexing and search operations that can be used by collections in the group.

Returns:



634
635
636
637
638
639
640
641
642
643
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 634

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

#created_date ⇒ Integer

The Epoch time when the collection group was created.

Returns:

  • (Integer) 


634
635
636
637
638
639
640
641
642
643
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 634

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

#id ⇒ String

The unique identifier of the collection group.

Returns:

  • (String) 


634
635
636
637
638
639
640
641
642
643
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 634

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

#name ⇒ String

The name of the collection group.

Returns:

  • (String) 


634
635
636
637
638
639
640
641
642
643
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 634

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

#number_of_collections ⇒ Integer

The number of collections within the collection group.

Returns:

  • (Integer) 


634
635
636
637
638
639
640
641
642
643
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 634

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