availability_options

Creates, updates, deletes, gets or lists an availability_options resource.

Overview

Name	availability_options
Type	Resource
Id	aws.cloudsearch.availability_options

Fields

The following fields are returned by SELECT queries:

describe_availability_options

Name	Datatype	Description
options	boolean	The availability options configured for the domain.
status	string	The status of domain configuration option.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_availability_options	select	DomainName, region	Deployed	Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
update_availability_options	update	DomainName, MultiAZ, region		Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DomainName	string
MultiAZ	boolean	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.
region	string	AWS region (default: us-east-1)
Deployed	boolean	Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

SELECT examples

describe_availability_options

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

SELECT
options,
status
FROM aws.cloudsearch.availability_options
WHERE DomainName = '{{ DomainName }}' -- required
AND region = '{{ region }}' -- required
AND Deployed = '{{ Deployed }}'
;

UPDATE examples

update_availability_options

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

UPDATE aws.cloudsearch.availability_options
SET 
-- No updatable properties
WHERE 
DomainName = '{{ DomainName }}' --required
AND MultiAZ = '{{ MultiAZ }}' --required
AND region = '{{ region }}' --required
RETURNING
options,
status;