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

Class: Aws::CloudSearch::Types::UpdateAvailabilityOptionsRequest

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 UpdateAvailabilityOptionsRequest data as a hash:

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

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:

  • (String)


2337
2338
2339
2340
2341
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2337

class UpdateAvailabilityOptionsRequest < Struct.new(
  :domain_name,
  :multi_az)
  include Aws::Structure
end

#multi_azBoolean

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

Returns:

  • (Boolean)


2337
2338
2339
2340
2341
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2337

class UpdateAvailabilityOptionsRequest < Struct.new(
  :domain_name,
  :multi_az)
  include Aws::Structure
end