scaling_parameters

Creates, updates, deletes, gets or lists a scaling_parameters resource.

Overview

Name	scaling_parameters
Type	Resource
Id	aws.cloudsearch.scaling_parameters

Fields

The following fields are returned by SELECT queries:

describe_scaling_parameters

Name	Datatype	Description
options	string	The desired instance type and desired number of replicas of each index partition.
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_scaling_parameters	select	DomainName, region		Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
update_scaling_parameters	update	DomainName, ScalingParameters, region		Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling 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
ScalingParameters	object
region	string	AWS region (default: us-east-1)

SELECT examples

describe_scaling_parameters

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

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

UPDATE examples

update_scaling_parameters

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

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