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	`awscc.ssmquicksetup.configuration_managers`

Fields

get (all properties)
list (identifiers only)

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.

Name	Datatype	Description
`manager_arn`	`string`
`region`	`string`	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
`create_resource`	`configuration_managers`	`INSERT`	`ConfigurationDefinitions, region`
`delete_resource`	`configuration_managers`	`DELETE`	`Identifier, region`
`update_resource`	`configuration_managers`	`UPDATE`	`Identifier, PatchDocument, region`
`list_resources`	`configuration_managers_list_only`	`SELECT`	`region`
`get_resource`	`configuration_managers`	`SELECT`	`Identifier, region`

`SELECT` examples

get (all properties)
list (identifiers only)

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 awscc.ssmquicksetup.configuration_managers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ manager_arn }}';

Lists all configuration_managers in a region.

SELECT
  region,
  manager_arn
FROM awscc.ssmquicksetup.configuration_managers_list_only
WHERE
  region = 'us-east-1';

`INSERT` example

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

Required Properties
All Properties
Manifest

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

/*+ create */
INSERT INTO awscc.ssmquicksetup.configuration_managers (
  ConfigurationDefinitions,
  Description,
  Name,
  Tags,
  region
)
SELECT
  '{{ configuration_definitions }}',
  '{{ description }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}';

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configuration_manager
    props:
      - name: configuration_definitions
        value:
          - type: '{{ type }}'
            parameters: {}
            type_version: '{{ type_version }}'
            local_deployment_execution_role_name: '{{ local_deployment_execution_role_name }}'
            local_deployment_administration_role_arn: '{{ local_deployment_administration_role_arn }}'
            id: '{{ id }}'
      - name: description
        value: '{{ description }}'
      - name: name
        value: '{{ name }}'
      - name: tags
        value: {}

`UPDATE` example

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

/*+ update */
UPDATE awscc.ssmquicksetup.configuration_managers
SET PatchDocument = string('{{ {
    "Description": description,
    "Name": name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ manager_arn }}';

`DELETE` example

/*+ delete */
DELETE FROM awscc.ssmquicksetup.configuration_managers
WHERE
  Identifier = '{{ manager_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create
Read
Update
Delete
List

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

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

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

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

ssm-quicksetup:ListConfigurationManagers

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​

Permissions​