AWS::SSMQuickSetup::ConfigurationManager - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SSMQuickSetup::ConfigurationManager

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SSMQuickSetup::ConfigurationManager",
  "Properties" : {
      "ConfigurationDefinitions" : [ ConfigurationDefinition, ... ],
      "Description" : String,
      "Name" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::SSMQuickSetup::ConfigurationManager
Properties:
  ConfigurationDefinitions: 
    - ConfigurationDefinition
  Description: String
  Name: String
  Tags: 
    Key: Value

Properties

ConfigurationDefinitions

The definition of the Quick Setup configuration that the configuration manager deploys.

Required: Yes

Type: Array of ConfigurationDefinition

Update requires: No interruption

Description

The description of the configuration.

Required: No

Type: String

Pattern: ^.{0,512}$

Update requires: No interruption

Name

The name of the configuration

Required: No

Type: String

Pattern: ^[ A-Za-z0-9_-]{1,50}$

Update requires: No interruption

Tags

Key-value pairs of metadata to assign to the configuration manager.

Required: No

Type: Object of String

Pattern: ^[A-Za-z0-9 +=@_\/:.-]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the configuration manager.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The datetime stamp when the configuration manager was created.

LastModifiedAt

The datetime stamp when the configuration manager was last updated.

ManagerArn

The ARN of the Quick Setup configuration.

StatusSummaries

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.

Examples

AWS Config Recording - local

Set up AWS Config Recording for the local account.

YAML

AWSTemplateFormatVersion: '2010-09-09'
Resources:
   SSMQuickSetupTestConfigurationManager:
      Type: "AWS::SSMQuickSetup::ConfigurationManager"
      Properties:
      Name: "Example"
      Description: "Example template"
      ConfigurationDefinitions:
         - Type: "AWSQuickSetupType-PatchPolicy"
            Parameters:
            TargetAccounts:
               Ref: AWS::AccountId
            TargetRegions:
               Ref: AWS::Region
            LocalDeploymentAdministrationRoleArn: !Sub "arn:aws:iam::${AWS::AccountId}:role/AWS-QuickSetup-StackSet-Example-AdministrationRole"
            LocalDeploymentExecutionRoleName: "AWS-QuickSetup-StackSet-Example-ExecutionRole"
      Tags:
         exampleTag: "exampleTagValue"
Outputs:
  Sample:
    Description: This is an example
    Value: !GetAtt SSMQuickSetupTestConfigurationManager.ManagerArn