configuration_managers

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

Overview

Name	configuration_managers
Type	Resource
Id	aws.ssm_quicksetup.configuration_managers

Fields

The following fields are returned by SELECT queries:

get_configuration_manager

Name	Datatype	Description
configuration_definitions	array	The configuration definitions association with the configuration manager.
created_at	string (date-time)	The datetime stamp when the configuration manager was created.
description	string	The description of the configuration manager.
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.
name	string	The name of the configuration manager.
status_summaries	array	A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
tags	object	Key-value pairs of metadata to assign to the configuration manager.

list_configuration_managers

Name	Datatype	Description
configuration_definition_summaries	array	A summary of the Quick Setup configuration definition.
description	string	The description of the configuration.
manager_arn	string	The ARN of the Quick Setup configuration.
name	string	The name of the configuration
status_summaries	array	Summaries of the state of the configuration manager. These summaries include an aggregate of the statuses from the configuration definition associated with the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration_manager	select	manager_arn, region		Returns a configuration manager.
list_configuration_managers	select	region		Returns Quick Setup configuration managers.
create_configuration_manager	insert	region, ConfigurationDefinitions		Creates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.
update_configuration_manager	update	manager_arn, region		Updates a Quick Setup configuration manager.
delete_configuration_manager	delete	manager_arn, region		Deletes a configuration manager.

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
manager_arn	string	The ID of the configuration manager.
region	string	AWS region (default: us-east-1)

SELECT examples

get_configuration_manager

Returns a configuration manager.

SELECT
configuration_definitions,
created_at,
description,
last_modified_at,
manager_arn,
name,
status_summaries,
tags
FROM aws.ssm_quicksetup.configuration_managers
WHERE manager_arn = '{{ manager_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_configuration_managers

Returns Quick Setup configuration managers.

SELECT
configuration_definition_summaries,
description,
manager_arn,
name,
status_summaries
FROM aws.ssm_quicksetup.configuration_managers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_configuration_manager

Creates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.

INSERT INTO aws.ssm_quicksetup.configuration_managers (
ConfigurationDefinitions,
Description,
Name,
Tags,
region
)
SELECT 
'{{ ConfigurationDefinitions }}' /* required */,
'{{ Description }}',
'{{ Name }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
manager_arn
;

Manifest

# Description fields are for documentation purposes
- name: configuration_managers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configuration_managers resource.
  - name: ConfigurationDefinitions
    value:
      - LocalDeploymentAdministrationRoleArn: "{{ LocalDeploymentAdministrationRoleArn }}"
        LocalDeploymentExecutionRoleName: "{{ LocalDeploymentExecutionRoleName }}"
        Parameters: "{{ Parameters }}"
        Type: "{{ Type }}"
        TypeVersion: "{{ TypeVersion }}"
  - name: Description
    value: "{{ Description }}"
  - name: Name
    value: "{{ Name }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_configuration_manager

Updates a Quick Setup configuration manager.

UPDATE aws.ssm_quicksetup.configuration_managers
SET 
Description = '{{ Description }}',
Name = '{{ Name }}'
WHERE 
manager_arn = '{{ manager_arn }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_configuration_manager

Deletes a configuration manager.

DELETE FROM aws.ssm_quicksetup.configuration_managers
WHERE manager_arn = '{{ manager_arn }}' --required
AND region = '{{ region }}' --required
;