Skip to main content

configuration_managers

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

Overview​

Nameconfiguration_managers
TypeResource
DescriptionDefinition of AWS::SSMQuickSetup::ConfigurationManager Resource Type
Idawscc.ssmquicksetup.configuration_managers

Fields​

NameDatatypeDescription
▶configuration_definitionsarray
created_atstring
descriptionstring
last_modified_atstring
manager_arnstring
namestring
▶status_summariesarray
tagsobject
regionstringAWS region.

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

Methods​

NameResourceAccessible byRequired Params
create_resourceconfiguration_managersINSERTConfigurationDefinitions, region
delete_resourceconfiguration_managersDELETEIdentifier, region
update_resourceconfiguration_managersUPDATEIdentifier, PatchDocument, region
list_resourcesconfiguration_managers_list_onlySELECTregion
get_resourceconfiguration_managersSELECTIdentifier, region

SELECT examples​

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 = '{{ region }}' AND
  Identifier = '{{ manager_arn }}';

INSERT example​

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

/*+ create */
INSERT INTO awscc.ssmquicksetup.configuration_managers (
  ConfigurationDefinitions,
  region
)
SELECT
  '{{ configuration_definitions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.ssmquicksetup.configuration_managers
WHERE
  Identifier = '{{ manager_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

Permissions​

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

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