Class: Aws::OpenSearchServerless::Types::CreateCollectionGroupRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_limits ⇒ Types::CollectionGroupCapacityLimits

The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.

Returns:



904
905
906
907
908
909
910
911
912
913
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 904

class CreateCollectionGroupRequest < Struct.new(
  :name,
  :standby_replicas,
  :description,
  :tags,
  :capacity_limits,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Unique, case-sensitive identifier to ensure idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


904
905
906
907
908
909
910
911
912
913
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 904

class CreateCollectionGroupRequest < Struct.new(
  :name,
  :standby_replicas,
  :description,
  :tags,
  :capacity_limits,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the collection group.

Returns:

  • (String) 


904
905
906
907
908
909
910
911
912
913
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 904

class CreateCollectionGroupRequest < Struct.new(
  :name,
  :standby_replicas,
  :description,
  :tags,
  :capacity_limits,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the collection group.

Returns:

  • (String) 


904
905
906
907
908
909
910
911
912
913
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 904

class CreateCollectionGroupRequest < Struct.new(
  :name,
  :standby_replicas,
  :description,
  :tags,
  :capacity_limits,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#standby_replicas ⇒ String

Indicates whether standby replicas should be used for a collection group.

Returns:

  • (String) 


904
905
906
907
908
909
910
911
912
913
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 904

class CreateCollectionGroupRequest < Struct.new(
  :name,
  :standby_replicas,
  :description,
  :tags,
  :capacity_limits,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.

Returns:



904
905
906
907
908
909
910
911
912
913
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 904

class CreateCollectionGroupRequest < Struct.new(
  :name,
  :standby_replicas,
  :description,
  :tags,
  :capacity_limits,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end