Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. ssmquicksetup
  5. ConfigurationManager

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ssmquicksetup.ConfigurationManager

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::SSMQuickSetup::ConfigurationManager Resource Type

    Create ConfigurationManager Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConfigurationManager(name: string, args: ConfigurationManagerArgs, opts?: CustomResourceOptions);
    @overload
def ConfigurationManager(resource_name: str,
                         args: ConfigurationManagerArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def ConfigurationManager(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         configuration_definitions: Optional[Sequence[ConfigurationManagerConfigurationDefinitionArgs]] = None,
                         description: Optional[str] = None,
                         name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
    func NewConfigurationManager(ctx *Context, name string, args ConfigurationManagerArgs, opts ...ResourceOption) (*ConfigurationManager, error)
    public ConfigurationManager(string name, ConfigurationManagerArgs args, CustomResourceOptions? opts = null)
    public ConfigurationManager(String name, ConfigurationManagerArgs args)
public ConfigurationManager(String name, ConfigurationManagerArgs args, CustomResourceOptions options)

    type: aws-native:ssmquicksetup:ConfigurationManager
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ConfigurationManagerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConfigurationManagerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConfigurationManagerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationManagerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationManagerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ConfigurationManager Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ConfigurationManager resource accepts the following input properties:

    ConfigurationDefinitions List<Pulumi.AwsNative.SsmQuickSetup.Inputs.ConfigurationManagerConfigurationDefinition>
    The definition of the Quick Setup configuration that the configuration manager deploys.
    Description string
    The description of the configuration.
    Name string
    The name of the configuration
    Tags Dictionary<string, string>
    Key-value pairs of metadata to assign to the configuration manager.
    ConfigurationDefinitions []ConfigurationManagerConfigurationDefinitionArgs
    The definition of the Quick Setup configuration that the configuration manager deploys.
    Description string
    The description of the configuration.
    Name string
    The name of the configuration
    Tags map[string]string
    Key-value pairs of metadata to assign to the configuration manager.
    configurationDefinitions List<ConfigurationManagerConfigurationDefinition>
    The definition of the Quick Setup configuration that the configuration manager deploys.
    description String
    The description of the configuration.
    name String
    The name of the configuration
    tags Map<String,String>
    Key-value pairs of metadata to assign to the configuration manager.
    configurationDefinitions ConfigurationManagerConfigurationDefinition[]
    The definition of the Quick Setup configuration that the configuration manager deploys.
    description string
    The description of the configuration.
    name string
    The name of the configuration
    tags {[key: string]: string}
    Key-value pairs of metadata to assign to the configuration manager.
    configuration_definitions Sequence[ConfigurationManagerConfigurationDefinitionArgs]
    The definition of the Quick Setup configuration that the configuration manager deploys.
    description str
    The description of the configuration.
    name str
    The name of the configuration
    tags Mapping[str, str]
    Key-value pairs of metadata to assign to the configuration manager.
    configurationDefinitions List<Property Map>
    The definition of the Quick Setup configuration that the configuration manager deploys.
    description String
    The description of the configuration.
    name String
    The name of the configuration
    tags Map<String>
    Key-value pairs of metadata to assign to the configuration manager.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConfigurationManager resource produces the following output properties:

    CreatedAt string
    The datetime stamp when the configuration manager was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    The datetime stamp when the configuration manager was last updated.
    ManagerArn string
    The ARN of the Quick Setup configuration.
    StatusSummaries List<Pulumi.AwsNative.SsmQuickSetup.Outputs.ConfigurationManagerStatusSummary>
    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.
    CreatedAt string
    The datetime stamp when the configuration manager was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    The datetime stamp when the configuration manager was last updated.
    ManagerArn string
    The ARN of the Quick Setup configuration.
    StatusSummaries []ConfigurationManagerStatusSummary
    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.
    createdAt String
    The datetime stamp when the configuration manager was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    The datetime stamp when the configuration manager was last updated.
    managerArn String
    The ARN of the Quick Setup configuration.
    statusSummaries List<ConfigurationManagerStatusSummary>
    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.
    createdAt string
    The datetime stamp when the configuration manager was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt string
    The datetime stamp when the configuration manager was last updated.
    managerArn string
    The ARN of the Quick Setup configuration.
    statusSummaries ConfigurationManagerStatusSummary[]
    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.
    created_at str
    The datetime stamp when the configuration manager was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_at str
    The datetime stamp when the configuration manager was last updated.
    manager_arn str
    The ARN of the Quick Setup configuration.
    status_summaries Sequence[ConfigurationManagerStatusSummary]
    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.
    createdAt String
    The datetime stamp when the configuration manager was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    The datetime stamp when the configuration manager was last updated.
    managerArn String
    The ARN of the Quick Setup configuration.
    statusSummaries List<Property Map>
    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.

    Supporting Types

    ConfigurationManagerConfigurationDefinition, ConfigurationManagerConfigurationDefinitionArgs

    Parameters Dictionary<string, string>

    The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following tables outline the parameters for each configuration type.

    • OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Scheduler (Type: AWS QuickSetupType-Scheduler) - - TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target.

    • ICalendarString

    • Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Default Host Management Configuration (Type: AWS QuickSetupType-DHMC) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer) - - SelectedAggregatorRegion

    • Description: (Required) The AWS Region where you want to create the aggregator index.

    • ReplaceExistingAggregator

    • Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the SelectedAggregatorRegion .

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Change Manager (Type: AWS QuickSetupType-SSMChangeMgr) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • JobFunction

    • Description: (Required) The name for the Change Manager job function.

    • PermissionType

    • Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are CustomPermissions and AdminPermissions . The default value for the parameter is CustomerPermissions .

    • CustomPermissions

    • Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify CustomPermissions for the PermissionType parameter.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru) - - AnalyseAllResources

    • Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " false ".

    • EnableSnsNotifications

    • Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " true ".

    • EnableSsmOpsItems

    • Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " true ".

    • EnableDriftRemediation

    • Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " false ".

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Conformance Packs (Type: AWS QuickSetupType-CFGCPacks) - - DelegatedAccountId

    • Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " none ".

    • CPackNames

    • Description: (Required) A comma separated list of AWS Config conformance packs.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • AWS Config Recording (Type: AWS QuickSetupType-CFGRecording) - - RecordAllResources

    • Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " true ".

    • ResourceTypesToRecord

    • Description: (Optional) A comma separated list of resource types you want to record.

    • RecordGlobalResourceTypes

    • Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " false ".

    • GlobalResourceTypesRegion

    • Description: (Optional) Determines the AWS Region where global resources are recorded.

    • UseCustomBucket

    • Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " false ".

    • DeliveryBucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to.

    • DeliveryBucketPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • NotificationOptions

    • Description: (Optional) Determines the notification configuration for the recorder. The valid values are NoStreaming , UseExistingTopic , and CreateTopic . The default value is NoStreaming .

    • CustomDeliveryTopicAccountId

    • Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • CustomDeliveryTopicName

    • Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(7 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Host Management (Type: AWS QuickSetupType-SSMHostMgmt) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • UpdateEc2LaunchAgent

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " false ".

    • CollectInventory

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " true ".

    • ScanInstances

    • Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " true ".

    • InstallCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " false ".

    • UpdateCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Distributor (Type: AWS QuickSetupType-Distributor) - - PackagesToInstall

    • Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are AWSEFSTools , AWSCWAgent , and AWSEC2LaunchAgent .

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " rate(30 days) ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Patch Policy (Type: AWS QuickSetupType-PatchPolicy) - - PatchPolicyName

    • Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.

    • SelectedPatchBaselines

    • Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.

    • PatchBaselineUseDefault

    • Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided.

    • ConfigurationOptionsPatchOperation

    • Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are Scan and ScanAndInstall . The default value for the parameter is Scan .

    • ConfigurationOptionsScanValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.

    • ConfigurationOptionsInstallValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.

    • ConfigurationOptionsScanNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • ConfigurationOptionsInstallNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • RebootOption

    • Description: (Optional) A boolean value that determines whether instances are rebooted after patches are installed. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • OutputLogEnableS3

    • Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.

    • OutputS3Location

    • Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.

    • OutputS3BucketRegion

    • Description: (Optional) The AWS Region where the Amazon S3 bucket you want AWS Config to deliver command output to is located.

    • OutputS3BucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver command output to.

    • OutputS3KeyPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    Type string
    The type of the Quick Setup configuration.
    Id string
    The ID of the configuration definition.
    LocalDeploymentAdministrationRoleArn string
    The ARN of the IAM role used to administrate local configuration deployments.
    LocalDeploymentExecutionRoleName string
    The name of the IAM role used to deploy local configurations.
    TypeVersion string
    The version of the Quick Setup type used.
    Parameters map[string]string

    The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following tables outline the parameters for each configuration type.

    • OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Scheduler (Type: AWS QuickSetupType-Scheduler) - - TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target.

    • ICalendarString

    • Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Default Host Management Configuration (Type: AWS QuickSetupType-DHMC) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer) - - SelectedAggregatorRegion

    • Description: (Required) The AWS Region where you want to create the aggregator index.

    • ReplaceExistingAggregator

    • Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the SelectedAggregatorRegion .

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Change Manager (Type: AWS QuickSetupType-SSMChangeMgr) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • JobFunction

    • Description: (Required) The name for the Change Manager job function.

    • PermissionType

    • Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are CustomPermissions and AdminPermissions . The default value for the parameter is CustomerPermissions .

    • CustomPermissions

    • Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify CustomPermissions for the PermissionType parameter.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru) - - AnalyseAllResources

    • Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " false ".

    • EnableSnsNotifications

    • Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " true ".

    • EnableSsmOpsItems

    • Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " true ".

    • EnableDriftRemediation

    • Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " false ".

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Conformance Packs (Type: AWS QuickSetupType-CFGCPacks) - - DelegatedAccountId

    • Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " none ".

    • CPackNames

    • Description: (Required) A comma separated list of AWS Config conformance packs.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • AWS Config Recording (Type: AWS QuickSetupType-CFGRecording) - - RecordAllResources

    • Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " true ".

    • ResourceTypesToRecord

    • Description: (Optional) A comma separated list of resource types you want to record.

    • RecordGlobalResourceTypes

    • Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " false ".

    • GlobalResourceTypesRegion

    • Description: (Optional) Determines the AWS Region where global resources are recorded.

    • UseCustomBucket

    • Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " false ".

    • DeliveryBucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to.

    • DeliveryBucketPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • NotificationOptions

    • Description: (Optional) Determines the notification configuration for the recorder. The valid values are NoStreaming , UseExistingTopic , and CreateTopic . The default value is NoStreaming .

    • CustomDeliveryTopicAccountId

    • Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • CustomDeliveryTopicName

    • Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(7 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Host Management (Type: AWS QuickSetupType-SSMHostMgmt) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • UpdateEc2LaunchAgent

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " false ".

    • CollectInventory

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " true ".

    • ScanInstances

    • Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " true ".

    • InstallCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " false ".

    • UpdateCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Distributor (Type: AWS QuickSetupType-Distributor) - - PackagesToInstall

    • Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are AWSEFSTools , AWSCWAgent , and AWSEC2LaunchAgent .

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " rate(30 days) ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Patch Policy (Type: AWS QuickSetupType-PatchPolicy) - - PatchPolicyName

    • Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.

    • SelectedPatchBaselines

    • Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.

    • PatchBaselineUseDefault

    • Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided.

    • ConfigurationOptionsPatchOperation

    • Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are Scan and ScanAndInstall . The default value for the parameter is Scan .

    • ConfigurationOptionsScanValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.

    • ConfigurationOptionsInstallValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.

    • ConfigurationOptionsScanNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • ConfigurationOptionsInstallNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • RebootOption

    • Description: (Optional) A boolean value that determines whether instances are rebooted after patches are installed. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • OutputLogEnableS3

    • Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.

    • OutputS3Location

    • Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.

    • OutputS3BucketRegion

    • Description: (Optional) The AWS Region where the Amazon S3 bucket you want AWS Config to deliver command output to is located.

    • OutputS3BucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver command output to.

    • OutputS3KeyPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    Type string
    The type of the Quick Setup configuration.
    Id string
    The ID of the configuration definition.
    LocalDeploymentAdministrationRoleArn string
    The ARN of the IAM role used to administrate local configuration deployments.
    LocalDeploymentExecutionRoleName string
    The name of the IAM role used to deploy local configurations.
    TypeVersion string
    The version of the Quick Setup type used.
    parameters Map<String,String>

    The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following tables outline the parameters for each configuration type.

    • OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Scheduler (Type: AWS QuickSetupType-Scheduler) - - TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target.

    • ICalendarString

    • Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Default Host Management Configuration (Type: AWS QuickSetupType-DHMC) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer) - - SelectedAggregatorRegion

    • Description: (Required) The AWS Region where you want to create the aggregator index.

    • ReplaceExistingAggregator

    • Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the SelectedAggregatorRegion .

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Change Manager (Type: AWS QuickSetupType-SSMChangeMgr) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • JobFunction

    • Description: (Required) The name for the Change Manager job function.

    • PermissionType

    • Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are CustomPermissions and AdminPermissions . The default value for the parameter is CustomerPermissions .

    • CustomPermissions

    • Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify CustomPermissions for the PermissionType parameter.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru) - - AnalyseAllResources

    • Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " false ".

    • EnableSnsNotifications

    • Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " true ".

    • EnableSsmOpsItems

    • Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " true ".

    • EnableDriftRemediation

    • Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " false ".

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Conformance Packs (Type: AWS QuickSetupType-CFGCPacks) - - DelegatedAccountId

    • Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " none ".

    • CPackNames

    • Description: (Required) A comma separated list of AWS Config conformance packs.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • AWS Config Recording (Type: AWS QuickSetupType-CFGRecording) - - RecordAllResources

    • Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " true ".

    • ResourceTypesToRecord

    • Description: (Optional) A comma separated list of resource types you want to record.

    • RecordGlobalResourceTypes

    • Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " false ".

    • GlobalResourceTypesRegion

    • Description: (Optional) Determines the AWS Region where global resources are recorded.

    • UseCustomBucket

    • Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " false ".

    • DeliveryBucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to.

    • DeliveryBucketPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • NotificationOptions

    • Description: (Optional) Determines the notification configuration for the recorder. The valid values are NoStreaming , UseExistingTopic , and CreateTopic . The default value is NoStreaming .

    • CustomDeliveryTopicAccountId

    • Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • CustomDeliveryTopicName

    • Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(7 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Host Management (Type: AWS QuickSetupType-SSMHostMgmt) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • UpdateEc2LaunchAgent

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " false ".

    • CollectInventory

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " true ".

    • ScanInstances

    • Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " true ".

    • InstallCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " false ".

    • UpdateCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Distributor (Type: AWS QuickSetupType-Distributor) - - PackagesToInstall

    • Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are AWSEFSTools , AWSCWAgent , and AWSEC2LaunchAgent .

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " rate(30 days) ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Patch Policy (Type: AWS QuickSetupType-PatchPolicy) - - PatchPolicyName

    • Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.

    • SelectedPatchBaselines

    • Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.

    • PatchBaselineUseDefault

    • Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided.

    • ConfigurationOptionsPatchOperation

    • Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are Scan and ScanAndInstall . The default value for the parameter is Scan .

    • ConfigurationOptionsScanValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.

    • ConfigurationOptionsInstallValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.

    • ConfigurationOptionsScanNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • ConfigurationOptionsInstallNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • RebootOption

    • Description: (Optional) A boolean value that determines whether instances are rebooted after patches are installed. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • OutputLogEnableS3

    • Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.

    • OutputS3Location

    • Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.

    • OutputS3BucketRegion

    • Description: (Optional) The AWS Region where the Amazon S3 bucket you want AWS Config to deliver command output to is located.

    • OutputS3BucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver command output to.

    • OutputS3KeyPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    type String
    The type of the Quick Setup configuration.
    id String
    The ID of the configuration definition.
    localDeploymentAdministrationRoleArn String
    The ARN of the IAM role used to administrate local configuration deployments.
    localDeploymentExecutionRoleName String
    The name of the IAM role used to deploy local configurations.
    typeVersion String
    The version of the Quick Setup type used.
    parameters {[key: string]: string}

    The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following tables outline the parameters for each configuration type.

    • OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Scheduler (Type: AWS QuickSetupType-Scheduler) - - TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target.

    • ICalendarString

    • Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Default Host Management Configuration (Type: AWS QuickSetupType-DHMC) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer) - - SelectedAggregatorRegion

    • Description: (Required) The AWS Region where you want to create the aggregator index.

    • ReplaceExistingAggregator

    • Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the SelectedAggregatorRegion .

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Change Manager (Type: AWS QuickSetupType-SSMChangeMgr) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • JobFunction

    • Description: (Required) The name for the Change Manager job function.

    • PermissionType

    • Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are CustomPermissions and AdminPermissions . The default value for the parameter is CustomerPermissions .

    • CustomPermissions

    • Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify CustomPermissions for the PermissionType parameter.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru) - - AnalyseAllResources

    • Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " false ".

    • EnableSnsNotifications

    • Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " true ".

    • EnableSsmOpsItems

    • Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " true ".

    • EnableDriftRemediation

    • Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " false ".

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Conformance Packs (Type: AWS QuickSetupType-CFGCPacks) - - DelegatedAccountId

    • Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " none ".

    • CPackNames

    • Description: (Required) A comma separated list of AWS Config conformance packs.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • AWS Config Recording (Type: AWS QuickSetupType-CFGRecording) - - RecordAllResources

    • Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " true ".

    • ResourceTypesToRecord

    • Description: (Optional) A comma separated list of resource types you want to record.

    • RecordGlobalResourceTypes

    • Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " false ".

    • GlobalResourceTypesRegion

    • Description: (Optional) Determines the AWS Region where global resources are recorded.

    • UseCustomBucket

    • Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " false ".

    • DeliveryBucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to.

    • DeliveryBucketPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • NotificationOptions

    • Description: (Optional) Determines the notification configuration for the recorder. The valid values are NoStreaming , UseExistingTopic , and CreateTopic . The default value is NoStreaming .

    • CustomDeliveryTopicAccountId

    • Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • CustomDeliveryTopicName

    • Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(7 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Host Management (Type: AWS QuickSetupType-SSMHostMgmt) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • UpdateEc2LaunchAgent

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " false ".

    • CollectInventory

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " true ".

    • ScanInstances

    • Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " true ".

    • InstallCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " false ".

    • UpdateCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Distributor (Type: AWS QuickSetupType-Distributor) - - PackagesToInstall

    • Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are AWSEFSTools , AWSCWAgent , and AWSEC2LaunchAgent .

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " rate(30 days) ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Patch Policy (Type: AWS QuickSetupType-PatchPolicy) - - PatchPolicyName

    • Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.

    • SelectedPatchBaselines

    • Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.

    • PatchBaselineUseDefault

    • Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided.

    • ConfigurationOptionsPatchOperation

    • Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are Scan and ScanAndInstall . The default value for the parameter is Scan .

    • ConfigurationOptionsScanValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.

    • ConfigurationOptionsInstallValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.

    • ConfigurationOptionsScanNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • ConfigurationOptionsInstallNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • RebootOption

    • Description: (Optional) A boolean value that determines whether instances are rebooted after patches are installed. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • OutputLogEnableS3

    • Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.

    • OutputS3Location

    • Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.

    • OutputS3BucketRegion

    • Description: (Optional) The AWS Region where the Amazon S3 bucket you want AWS Config to deliver command output to is located.

    • OutputS3BucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver command output to.

    • OutputS3KeyPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    type string
    The type of the Quick Setup configuration.
    id string
    The ID of the configuration definition.
    localDeploymentAdministrationRoleArn string
    The ARN of the IAM role used to administrate local configuration deployments.
    localDeploymentExecutionRoleName string
    The name of the IAM role used to deploy local configurations.
    typeVersion string
    The version of the Quick Setup type used.
    parameters Mapping[str, str]

    The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following tables outline the parameters for each configuration type.

    • OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Scheduler (Type: AWS QuickSetupType-Scheduler) - - TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target.

    • ICalendarString

    • Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Default Host Management Configuration (Type: AWS QuickSetupType-DHMC) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer) - - SelectedAggregatorRegion

    • Description: (Required) The AWS Region where you want to create the aggregator index.

    • ReplaceExistingAggregator

    • Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the SelectedAggregatorRegion .

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Change Manager (Type: AWS QuickSetupType-SSMChangeMgr) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • JobFunction

    • Description: (Required) The name for the Change Manager job function.

    • PermissionType

    • Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are CustomPermissions and AdminPermissions . The default value for the parameter is CustomerPermissions .

    • CustomPermissions

    • Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify CustomPermissions for the PermissionType parameter.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru) - - AnalyseAllResources

    • Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " false ".

    • EnableSnsNotifications

    • Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " true ".

    • EnableSsmOpsItems

    • Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " true ".

    • EnableDriftRemediation

    • Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " false ".

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Conformance Packs (Type: AWS QuickSetupType-CFGCPacks) - - DelegatedAccountId

    • Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " none ".

    • CPackNames

    • Description: (Required) A comma separated list of AWS Config conformance packs.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • AWS Config Recording (Type: AWS QuickSetupType-CFGRecording) - - RecordAllResources

    • Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " true ".

    • ResourceTypesToRecord

    • Description: (Optional) A comma separated list of resource types you want to record.

    • RecordGlobalResourceTypes

    • Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " false ".

    • GlobalResourceTypesRegion

    • Description: (Optional) Determines the AWS Region where global resources are recorded.

    • UseCustomBucket

    • Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " false ".

    • DeliveryBucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to.

    • DeliveryBucketPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • NotificationOptions

    • Description: (Optional) Determines the notification configuration for the recorder. The valid values are NoStreaming , UseExistingTopic , and CreateTopic . The default value is NoStreaming .

    • CustomDeliveryTopicAccountId

    • Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • CustomDeliveryTopicName

    • Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(7 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Host Management (Type: AWS QuickSetupType-SSMHostMgmt) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • UpdateEc2LaunchAgent

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " false ".

    • CollectInventory

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " true ".

    • ScanInstances

    • Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " true ".

    • InstallCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " false ".

    • UpdateCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Distributor (Type: AWS QuickSetupType-Distributor) - - PackagesToInstall

    • Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are AWSEFSTools , AWSCWAgent , and AWSEC2LaunchAgent .

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " rate(30 days) ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Patch Policy (Type: AWS QuickSetupType-PatchPolicy) - - PatchPolicyName

    • Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.

    • SelectedPatchBaselines

    • Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.

    • PatchBaselineUseDefault

    • Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided.

    • ConfigurationOptionsPatchOperation

    • Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are Scan and ScanAndInstall . The default value for the parameter is Scan .

    • ConfigurationOptionsScanValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.

    • ConfigurationOptionsInstallValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.

    • ConfigurationOptionsScanNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • ConfigurationOptionsInstallNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • RebootOption

    • Description: (Optional) A boolean value that determines whether instances are rebooted after patches are installed. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • OutputLogEnableS3

    • Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.

    • OutputS3Location

    • Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.

    • OutputS3BucketRegion

    • Description: (Optional) The AWS Region where the Amazon S3 bucket you want AWS Config to deliver command output to is located.

    • OutputS3BucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver command output to.

    • OutputS3KeyPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    type str
    The type of the Quick Setup configuration.
    id str
    The ID of the configuration definition.
    local_deployment_administration_role_arn str
    The ARN of the IAM role used to administrate local configuration deployments.
    local_deployment_execution_role_name str
    The name of the IAM role used to deploy local configurations.
    type_version str
    The version of the Quick Setup type used.
    parameters Map<String>

    The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following tables outline the parameters for each configuration type.

    • OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Scheduler (Type: AWS QuickSetupType-Scheduler) - - TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target.

    • ICalendarString

    • Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Default Host Management Configuration (Type: AWS QuickSetupType-DHMC) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer) - - SelectedAggregatorRegion

    • Description: (Required) The AWS Region where you want to create the aggregator index.

    • ReplaceExistingAggregator

    • Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the SelectedAggregatorRegion .

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Change Manager (Type: AWS QuickSetupType-SSMChangeMgr) - - DelegatedAccountId

    • Description: (Required) The ID of the delegated administrator account.

    • JobFunction

    • Description: (Required) The name for the Change Manager job function.

    • PermissionType

    • Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are CustomPermissions and AdminPermissions . The default value for the parameter is CustomerPermissions .

    • CustomPermissions

    • Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify CustomPermissions for the PermissionType parameter.

    • TargetOrganizationalUnits

    • Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru) - - AnalyseAllResources

    • Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " false ".

    • EnableSnsNotifications

    • Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " true ".

    • EnableSsmOpsItems

    • Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " true ".

    • EnableDriftRemediation

    • Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " false ".

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Conformance Packs (Type: AWS QuickSetupType-CFGCPacks) - - DelegatedAccountId

    • Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " none ".

    • CPackNames

    • Description: (Required) A comma separated list of AWS Config conformance packs.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • AWS Config Recording (Type: AWS QuickSetupType-CFGRecording) - - RecordAllResources

    • Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " true ".

    • ResourceTypesToRecord

    • Description: (Optional) A comma separated list of resource types you want to record.

    • RecordGlobalResourceTypes

    • Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " false ".

    • GlobalResourceTypesRegion

    • Description: (Optional) Determines the AWS Region where global resources are recorded.

    • UseCustomBucket

    • Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " false ".

    • DeliveryBucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to.

    • DeliveryBucketPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • NotificationOptions

    • Description: (Optional) Determines the notification configuration for the recorder. The valid values are NoStreaming , UseExistingTopic , and CreateTopic . The default value is NoStreaming .

    • CustomDeliveryTopicAccountId

    • Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • CustomDeliveryTopicName

    • Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the UseExistingTopic notification option.

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(7 days) , rate(1 days) , and none . The default value is " none ".

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Host Management (Type: AWS QuickSetupType-SSMHostMgmt) - - UpdateSSMAgent

    • Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " true ".

    • UpdateEc2LaunchAgent

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " false ".

    • CollectInventory

    • Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " true ".

    • ScanInstances

    • Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " true ".

    • InstallCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " false ".

    • UpdateCloudWatchAgent

    • Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Distributor (Type: AWS QuickSetupType-Distributor) - - PackagesToInstall

    • Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are AWSEFSTools , AWSCWAgent , and AWSEC2LaunchAgent .

    • RemediationSchedule

    • Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are rate(30 days) , rate(14 days) , rate(2 days) , and none . The default value is " rate(30 days) ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    • Patch Policy (Type: AWS QuickSetupType-PatchPolicy) - - PatchPolicyName

    • Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.

    • SelectedPatchBaselines

    • Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.

    • PatchBaselineUseDefault

    • Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided.

    • ConfigurationOptionsPatchOperation

    • Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are Scan and ScanAndInstall . The default value for the parameter is Scan .

    • ConfigurationOptionsScanValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.

    • ConfigurationOptionsInstallValue

    • Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.

    • ConfigurationOptionsScanNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • ConfigurationOptionsInstallNextInterval

    • Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " false ".

    • RebootOption

    • Description: (Optional) A boolean value that determines whether instances are rebooted after patches are installed. The default value is " false ".

    • IsPolicyAttachAllowed

    • Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " false ".

    • OutputLogEnableS3

    • Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.

    • OutputS3Location

    • Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.

    • OutputS3BucketRegion

    • Description: (Optional) The AWS Region where the Amazon S3 bucket you want AWS Config to deliver command output to is located.

    • OutputS3BucketName

    • Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver command output to.

    • OutputS3KeyPrefix

    • Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.

    • TargetType

    • Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are * , InstanceIds , ResourceGroups , and Tags . Use * to target all instances in the account.

    • TargetInstances

    • Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify InstanceIds for the TargetType parameter.

    • TargetTagKey

    • Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • TargetTagValue

    • Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify Tags for the TargetType parameter.

    • ResourceGroupName

    • Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ResourceGroups for the TargetType parameter.

    • TargetAccounts

    • Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either TargetAccounts or TargetOrganizationalUnits .

    • TargetOrganizationalUnits

    • Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.

    • TargetRegions

    • Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.

    type String
    The type of the Quick Setup configuration.
    id String
    The ID of the configuration definition.
    localDeploymentAdministrationRoleArn String
    The ARN of the IAM role used to administrate local configuration deployments.
    localDeploymentExecutionRoleName String
    The name of the IAM role used to deploy local configurations.
    typeVersion String
    The version of the Quick Setup type used.

    ConfigurationManagerStatus, ConfigurationManagerStatusArgs

    Initializing
    INITIALIZING
    Deploying
    DEPLOYING
    Succeeded
    SUCCEEDED
    Deleting
    DELETING
    Stopping
    STOPPING
    Failed
    FAILED
    Stopped
    STOPPED
    DeleteFailed
    DELETE_FAILED
    StopFailed
    STOP_FAILED
    None
    NONE
    ConfigurationManagerStatusInitializing
    INITIALIZING
    ConfigurationManagerStatusDeploying
    DEPLOYING
    ConfigurationManagerStatusSucceeded
    SUCCEEDED
    ConfigurationManagerStatusDeleting
    DELETING
    ConfigurationManagerStatusStopping
    STOPPING
    ConfigurationManagerStatusFailed
    FAILED
    ConfigurationManagerStatusStopped
    STOPPED
    ConfigurationManagerStatusDeleteFailed
    DELETE_FAILED
    ConfigurationManagerStatusStopFailed
    STOP_FAILED
    ConfigurationManagerStatusNone
    NONE
    Initializing
    INITIALIZING
    Deploying
    DEPLOYING
    Succeeded
    SUCCEEDED
    Deleting
    DELETING
    Stopping
    STOPPING
    Failed
    FAILED
    Stopped
    STOPPED
    DeleteFailed
    DELETE_FAILED
    StopFailed
    STOP_FAILED
    None
    NONE
    Initializing
    INITIALIZING
    Deploying
    DEPLOYING
    Succeeded
    SUCCEEDED
    Deleting
    DELETING
    Stopping
    STOPPING
    Failed
    FAILED
    Stopped
    STOPPED
    DeleteFailed
    DELETE_FAILED
    StopFailed
    STOP_FAILED
    None
    NONE
    INITIALIZING
    INITIALIZING
    DEPLOYING
    DEPLOYING
    SUCCEEDED
    SUCCEEDED
    DELETING
    DELETING
    STOPPING
    STOPPING
    FAILED
    FAILED
    STOPPED
    STOPPED
    DELETE_FAILED
    DELETE_FAILED
    STOP_FAILED
    STOP_FAILED
    NONE
    NONE
    "INITIALIZING"
    INITIALIZING
    "DEPLOYING"
    DEPLOYING
    "SUCCEEDED"
    SUCCEEDED
    "DELETING"
    DELETING
    "STOPPING"
    STOPPING
    "FAILED"
    FAILED
    "STOPPED"
    STOPPED
    "DELETE_FAILED"
    DELETE_FAILED
    "STOP_FAILED"
    STOP_FAILED
    "NONE"
    NONE

    ConfigurationManagerStatusSummary, ConfigurationManagerStatusSummaryArgs

    LastUpdatedAt string
    The datetime stamp when the status was last updated.
    StatusType Pulumi.AwsNative.SsmQuickSetup.ConfigurationManagerStatusType
    The type of a status summary.
    Status Pulumi.AwsNative.SsmQuickSetup.ConfigurationManagerStatus
    The current status.
    StatusDetails Dictionary<string, string>
    Details about the status.
    StatusMessage string
    When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
    LastUpdatedAt string
    The datetime stamp when the status was last updated.
    StatusType ConfigurationManagerStatusType
    The type of a status summary.
    Status ConfigurationManagerStatus
    The current status.
    StatusDetails map[string]string
    Details about the status.
    StatusMessage string
    When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
    lastUpdatedAt String
    The datetime stamp when the status was last updated.
    statusType ConfigurationManagerStatusType
    The type of a status summary.
    status ConfigurationManagerStatus
    The current status.
    statusDetails Map<String,String>
    Details about the status.
    statusMessage String
    When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
    lastUpdatedAt string
    The datetime stamp when the status was last updated.
    statusType ConfigurationManagerStatusType
    The type of a status summary.
    status ConfigurationManagerStatus
    The current status.
    statusDetails {[key: string]: string}
    Details about the status.
    statusMessage string
    When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
    last_updated_at str
    The datetime stamp when the status was last updated.
    status_type ConfigurationManagerStatusType
    The type of a status summary.
    status ConfigurationManagerStatus
    The current status.
    status_details Mapping[str, str]
    Details about the status.
    status_message str
    When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
    lastUpdatedAt String
    The datetime stamp when the status was last updated.
    statusType "Deployment" | "AsyncExecutions"
    The type of a status summary.
    status "INITIALIZING" | "DEPLOYING" | "SUCCEEDED" | "DELETING" | "STOPPING" | "FAILED" | "STOPPED" | "DELETE_FAILED" | "STOP_FAILED" | "NONE"
    The current status.
    statusDetails Map<String>
    Details about the status.
    statusMessage String
    When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.

    ConfigurationManagerStatusType, ConfigurationManagerStatusTypeArgs

    Deployment
    Deployment
    AsyncExecutions
    AsyncExecutions
    ConfigurationManagerStatusTypeDeployment
    Deployment
    ConfigurationManagerStatusTypeAsyncExecutions
    AsyncExecutions
    Deployment
    Deployment
    AsyncExecutions
    AsyncExecutions
    Deployment
    Deployment
    AsyncExecutions
    AsyncExecutions
    DEPLOYMENT
    Deployment
    ASYNC_EXECUTIONS
    AsyncExecutions
    "Deployment"
    Deployment
    "AsyncExecutions"
    AsyncExecutions

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native