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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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`.

Constant Summary collapse

SENSITIVE =
[]

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)

970
971
972
973
974
975
# File 'lib/aws-sdk-cloudsearch/types.rb', line 970

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

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)

970
971
972
973
974
975
# File 'lib/aws-sdk-cloudsearch/types.rb', line 970

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