You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticsearchService::Types::ListElasticsearchInstanceTypesRequest

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

Overview

Note:

When making an API call, you may pass ListElasticsearchInstanceTypesRequest data as a hash:

{
  elasticsearch_version: "ElasticsearchVersionString", # required
  domain_name: "DomainName",
  max_results: 1,
  next_token: "NextToken",
}

Container for the parameters to the ListElasticsearchInstanceTypes operation.

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

Returns:

  • (String)


807
808
809
810
811
812
813
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 807

class ListElasticsearchInstanceTypesRequest < Struct.new(
  :elasticsearch_version,
  :domain_name,
  :max_results,
  :next_token)
  include Aws::Structure
end

#elasticsearch_versionString

Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

Returns:

  • (String)


807
808
809
810
811
812
813
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 807

class ListElasticsearchInstanceTypesRequest < Struct.new(
  :elasticsearch_version,
  :domain_name,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

Returns:

  • (Integer)


807
808
809
810
811
812
813
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 807

class ListElasticsearchInstanceTypesRequest < Struct.new(
  :elasticsearch_version,
  :domain_name,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

Returns:

  • (String)


807
808
809
810
811
812
813
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 807

class ListElasticsearchInstanceTypesRequest < Struct.new(
  :elasticsearch_version,
  :domain_name,
  :max_results,
  :next_token)
  include Aws::Structure
end