default_application_settings

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

Overview

Name	default_application_settings
Type	Resource
Id	aws.opensearch.default_application_settings

Fields

The following fields are returned by SELECT queries:

get_default_application_setting

Name	Datatype	Description
application_arn	string	The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_default_application_setting	select	region		Gets the ARN of the current default application. If the default application isn't set, the operation returns a resource not found error.
put_default_application_setting	replace	region, applicationArn, setAsDefault		Sets the default application to the application with the specified ARN. To remove the default application, use the GetDefaultApplicationSetting operation to get the current default and then call the PutDefaultApplicationSetting with the current applications ARN and the setAsDefault parameter set to false.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_default_application_setting

Gets the ARN of the current default application. If the default application isn't set, the operation returns a resource not found error.

SELECT
application_arn
FROM aws.opensearch.default_application_settings
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_default_application_setting

Sets the default application to the application with the specified ARN. To remove the default application, use the GetDefaultApplicationSetting operation to get the current default and then call the PutDefaultApplicationSetting with the current applications ARN and the setAsDefault parameter set to false.

REPLACE aws.opensearch.default_application_settings
SET 
applicationArn = '{{ applicationArn }}',
setAsDefault = {{ setAsDefault }}
WHERE 
region = '{{ region }}' --required
AND applicationArn = '{{ applicationArn }}' --required
AND setAsDefault = {{ setAsDefault }} --required
RETURNING
application_arn;