configurations

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

Overview

Name	configurations
Type	Resource
Id	aws.ssm_quicksetup.configurations

Fields

The following fields are returned by SELECT queries:

get_configuration

Name	Datatype	Description
account	string	The ID of the Amazon Web Services account where the configuration was deployed.
configuration_definition_id	string	The ID of the configuration definition.
created_at	string (date-time)	The datetime stamp when the configuration manager was created.
id	string	A service generated identifier for the configuration.
last_modified_at	string (date-time)	The datetime stamp when the configuration manager was last updated.
manager_arn	string	The ARN of the configuration manager.
parameters	object	The parameters for the configuration definition type.
region	string	The Amazon Web Services Region where the configuration was deployed.
status_summaries	array	A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
type	string	The type of the Quick Setup configuration.
type_version	string	The version of the Quick Setup type used.

list_configurations

Name	Datatype	Description
account	string	The ID of the Amazon Web Services account where the configuration was deployed.
configuration_definition_id	string	The ID of the configuration definition.
created_at	string (date-time)	The datetime stamp when the configuration was created.
first_class_parameters	object	The common parameters and values for the configuration definition.
id	string	A service generated identifier for the configuration.
manager_arn	string	The ARN of the configuration manager.
region	string	The Amazon Web Services Region where the configuration was deployed.
status_summaries	array	A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
type	string	The type of the Quick Setup configuration.
type_version	string	The version of the Quick Setup type used.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration	select	configuration_id, region		Returns details about the specified configuration.
list_configurations	select	region		Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
update_configuration_definition	update	id, manager_arn, region		Updates a Quick Setup configuration definition.

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
configuration_id	string	A service generated identifier for the configuration.
id	string	The ID of the configuration definition you want to update.
manager_arn	string	The ARN of the configuration manager associated with the definition to update.
region	string	AWS region (default: us-east-1)

SELECT examples

get_configuration

Returns details about the specified configuration.

SELECT
account,
configuration_definition_id,
created_at,
id,
last_modified_at,
manager_arn,
parameters,
region,
status_summaries,
type,
type_version
FROM aws.ssm_quicksetup.configurations
WHERE configuration_id = '{{ configuration_id }}' -- required
AND region = '{{ region }}' -- required
;

list_configurations

Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

SELECT
account,
configuration_definition_id,
created_at,
first_class_parameters,
id,
manager_arn,
region,
status_summaries,
type,
type_version
FROM aws.ssm_quicksetup.configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_configuration_definition

Updates a Quick Setup configuration definition.

UPDATE aws.ssm_quicksetup.configurations
SET 
LocalDeploymentAdministrationRoleArn = '{{ LocalDeploymentAdministrationRoleArn }}',
LocalDeploymentExecutionRoleName = '{{ LocalDeploymentExecutionRoleName }}',
Parameters = '{{ Parameters }}',
TypeVersion = '{{ TypeVersion }}'
WHERE 
id = '{{ id }}' --required
AND manager_arn = '{{ manager_arn }}' --required
AND region = '{{ region }}' --required;