Class: Aws::OpenSearchService::Types::ListInstanceTypeDetailsRequest

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::ListInstanceTypeDetailsRequest

Defined in:

gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain_name ⇒ String

  The name of the domain.

• #engine_version ⇒ String

  The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

• #instance_type ⇒ String

  An optional parameter that lists information for a given instance type.

• #max_results ⇒ Integer

  An optional parameter that specifies the maximum number of results to return.

• #next_token ⇒ String

  If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

• #retrieve_a_zs ⇒ Boolean

  An optional parameter that specifies the Availability Zones for the domain.

Instance Attribute Details

#domain_name ⇒ String

The name of the domain.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4165

class ListInstanceTypeDetailsRequest < Struct.new(
  :engine_version,
  :domain_name,
  :max_results,
  :next_token,
  :retrieve_a_zs,
  :instance_type)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4165

class ListInstanceTypeDetailsRequest < Struct.new(
  :engine_version,
  :domain_name,
  :max_results,
  :next_token,
  :retrieve_a_zs,
  :instance_type)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

An optional parameter that lists information for a given instance type.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4165

class ListInstanceTypeDetailsRequest < Struct.new(
  :engine_version,
  :domain_name,
  :max_results,
  :next_token,
  :retrieve_a_zs,
  :instance_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Returns:

• (Integer)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4165

class ListInstanceTypeDetailsRequest < Struct.new(
  :engine_version,
  :domain_name,
  :max_results,
  :next_token,
  :retrieve_a_zs,
  :instance_type)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4165

class ListInstanceTypeDetailsRequest < Struct.new(
  :engine_version,
  :domain_name,
  :max_results,
  :next_token,
  :retrieve_a_zs,
  :instance_type)
  SENSITIVE = []
  include Aws::Structure
end

#retrieve_a_zs ⇒ Boolean

An optional parameter that specifies the Availability Zones for the domain.

Returns:

• (Boolean)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4165

class ListInstanceTypeDetailsRequest < Struct.new(
  :engine_version,
  :domain_name,
  :max_results,
  :next_token,
  :retrieve_a_zs,
  :instance_type)
  SENSITIVE = []
  include Aws::Structure
end