service_settings

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

Overview

Name	service_settings
Type	Resource
Id	aws.ssm_quicksetup.service_settings

Fields

The following fields are returned by SELECT queries:

get_service_settings

Name	Datatype	Description
explorer_enabling_role_arn	string	The IAM role used to enable Explorer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_settings	select	region		Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
update_service_settings	update	region		Updates settings configured for Quick Setup.

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_service_settings

Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

SELECT
explorer_enabling_role_arn
FROM aws.ssm_quicksetup.service_settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_service_settings

Updates settings configured for Quick Setup.

UPDATE aws.ssm_quicksetup.service_settings
SET 
ExplorerEnablingRoleArn = '{{ ExplorerEnablingRoleArn }}'
WHERE 
region = '{{ region }}' --required;