service_access_policies

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

Overview

Name	service_access_policies
Type	Resource
Id	aws.cloudsearch.service_access_policies

Fields

The following fields are returned by SELECT queries:

describe_service_access_policies

Name	Datatype	Description
options	string	Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.
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_service_access_policies	select	DomainName, region	Deployed	Gets information about the access policies that control access to the domain's document and search endpoints. 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 Access for a Search Domain in the Amazon CloudSearch Developer Guide.
update_service_access_policies	update	DomainName, AccessPolicies, region		Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

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
AccessPolicies	string	The access rules you want to configure. These rules replace any existing rules.
DomainName	string
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_service_access_policies

Gets information about the access policies that control access to the domain's document and search endpoints. 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 Access for a Search Domain in the Amazon CloudSearch Developer Guide.

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

UPDATE examples

update_service_access_policies

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

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