configuration_managers

Creates, updates, deletes or gets a configuration_manager resource or lists configuration_managers in a region

Overview

Name	configuration_managers
Type	Resource
Description	Definition of AWS::SSMQuickSetup::ConfigurationManager Resource Type
Id	aws.ssmquicksetup.configuration_managers

Fields

Name	Datatype	Description
configuration_definitions	array
created_at	string
description	string
last_modified_at	string
manager_arn	string
name	string
status_summaries	array
tags	object
region	string	AWS region.

For more information, see AWS::SSMQuickSetup::ConfigurationManager.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ConfigurationDefinitions, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all configuration_managers in a region.

SELECT
region,
configuration_definitions,
created_at,
description,
last_modified_at,
manager_arn,
name,
status_summaries,
tags
FROM aws.ssmquicksetup.configuration_managers
WHERE region = 'us-east-1';

Gets all properties from an individual configuration_manager.

SELECT
region,
configuration_definitions,
created_at,
description,
last_modified_at,
manager_arn,
name,
status_summaries,
tags
FROM aws.ssmquicksetup.configuration_managers
WHERE region = 'us-east-1' AND data__Identifier = '<ManagerArn>';

INSERT example

Use the following StackQL query and manifest file to create a new configuration_manager resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ssmquicksetup.configuration_managers (
 ConfigurationDefinitions,
 region
)
SELECT 
'{{ ConfigurationDefinitions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ssmquicksetup.configuration_managers (
 ConfigurationDefinitions,
 Description,
 Name,
 Tags,
 region
)
SELECT 
 '{{ ConfigurationDefinitions }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configuration_manager
    props:
      - name: ConfigurationDefinitions
        value:
          - Type: '{{ Type }}'
            Parameters: {}
            TypeVersion: '{{ TypeVersion }}'
            LocalDeploymentExecutionRoleName: '{{ LocalDeploymentExecutionRoleName }}'
            LocalDeploymentAdministrationRoleArn: '{{ LocalDeploymentAdministrationRoleArn }}'
            id: '{{ id }}'
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.ssmquicksetup.configuration_managers
WHERE data__Identifier = '<ManagerArn>'
AND region = 'us-east-1';

Permissions

To operate on the configuration_managers resource, the following permissions are required:

Create

iam:GetRole,
iam:CreateServiceLinkedRole,
iam:ListRoles,
iam:PassRole,
ssm-quicksetup:CreateConfigurationManager,
ssm-quicksetup:GetConfigurationManager,
ssm-quicksetup:TagResource,
ssm-quicksetup:UntagResource,
ssm-quicksetup:UpdateConfigurationManager,
ssm:Describe*,
ssm:Get*,
ssm:List*,
ssm:DeleteAssociation,
ssm:CreateResourceDataSync,
ssm:UpdateResourceDataSync,
ssm:StartAutomationExecution,
ssm:CreateAssociation,
ssm:StartAssociationsOnce,
cloudformation:List*,
cloudformation:Describe*,
cloudformation:CreateStack,
cloudformation:CreateStackInstances,
cloudformation:CreateStackSet,
cloudformation:DeleteStack,
cloudformation:DeleteStackInstances,
cloudformation:DeleteStackSet,
cloudformation:UpdateStack,
cloudformation:UpdateStackSet,
cloudformation:StopStackSetOperation,
cloudformation:GetTemplate,
cloudformation:RollbackStack,
cloudformation:TagResource,
cloudformation:UntagResource,
organizations:Describe*,
organizations:List*,
organizations:RegisterDelegatedAdministrator,
organizations:DeregisterDelegatedAdministrator,
organizations:EnableAWSServiceAccess

Read

ssm-quicksetup:GetConfigurationManager,
iam:GetRole,
iam:PassRole,
iam:ListRoles,
ssm:DescribeDocument,
ssm:GetDocument

Update

iam:GetRole,
iam:CreateServiceLinkedRole,
iam:ListRoles,
iam:PassRole,
ssm-quicksetup:GetConfigurationManager,
ssm-quicksetup:TagResource,
ssm-quicksetup:UntagResource,
ssm-quicksetup:UpdateConfigurationManager,
ssm-quicksetup:UpdateConfigurationDefinition,
ssm:Describe*,
ssm:Get*,
ssm:List*,
ssm:DeleteAssociation,
ssm:CreateResourceDataSync,
ssm:UpdateResourceDataSync,
ssm:StartAutomationExecution,
ssm:CreateAssociation,
ssm:StartAssociationsOnce,
cloudformation:List*,
cloudformation:Describe*,
cloudformation:CreateStack,
cloudformation:CreateStackInstances,
cloudformation:CreateStackSet,
cloudformation:DeleteStack,
cloudformation:DeleteStackInstances,
cloudformation:DeleteStackSet,
cloudformation:UpdateStack,
cloudformation:UpdateStackSet,
cloudformation:StopStackSetOperation,
cloudformation:GetTemplate,
cloudformation:RollbackStack,
cloudformation:TagResource,
cloudformation:UntagResource,
organizations:Describe*,
organizations:List*,
organizations:RegisterDelegatedAdministrator,
organizations:DeregisterDelegatedAdministrator,
organizations:EnableAWSServiceAccess

Delete

ssm-quicksetup:DeleteConfigurationManager,
iam:GetRole,
iam:CreateServiceLinkedRole,
iam:ListRoles,
iam:PassRole,
ssm-quicksetup:GetConfigurationManager,
ssm-quicksetup:ListConfigurationManagers,
ssm-quicksetup:TagResource,
ssm-quicksetup:UntagResource,
ssm-quicksetup:UpdateConfigurationManager,
ssm:Describe*,
ssm:Get*,
ssm:List*,
ssm:DeleteAssociation,
ssm:CreateResourceDataSync,
ssm:UpdateResourceDataSync,
ssm:StartAutomationExecution,
ssm:CreateAssociation,
ssm:StartAssociationsOnce,
cloudformation:List*,
cloudformation:Describe*,
cloudformation:CreateStack,
cloudformation:CreateStackInstances,
cloudformation:CreateStackSet,
cloudformation:DeleteStack,
cloudformation:DeleteStackInstances,
cloudformation:DeleteStackSet,
cloudformation:UpdateStack,
cloudformation:UpdateStackSet,
cloudformation:StopStackSetOperation,
cloudformation:GetTemplate,
cloudformation:RollbackStack,
cloudformation:TagResource,
cloudformation:UntagResource,
organizations:Describe*,
organizations:List*,
organizations:RegisterDelegatedAdministrator,
organizations:DeregisterDelegatedAdministrator,
organizations:EnableAWSServiceAccess

List

ssm-quicksetup:ListConfigurationManagers