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

Class: Aws::CloudSearch::Types::DescribeAvailabilityOptionsRequest

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

Overview

Note:

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

{
  domain_name: "DomainName", # required
  deployed: false,
}

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Instance Attribute Summary collapse

Instance Attribute Details

#deployedBoolean

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns:

  • (Boolean)


920
921
922
923
924
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 920

class DescribeAvailabilityOptionsRequest < Struct.new(
  :domain_name,
  :deployed)
  include Aws::Structure
end

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)


920
921
922
923
924
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 920

class DescribeAvailabilityOptionsRequest < Struct.new(
  :domain_name,
  :deployed)
  include Aws::Structure
end