@aws-cdk/aws-ssm

  • Version 1.181.1
  • Published
  • 1.66 MB
  • 5 dependencies
  • Apache-2.0 license

Install

npm i @aws-cdk/aws-ssm
yarn add @aws-cdk/aws-ssm
pnpm add @aws-cdk/aws-ssm

Overview

The CDK Construct Library for AWS::SSM

Index

Classes

Interfaces

Enums

Namespaces

Classes

class CfnAssociation

class CfnAssociation extends cdk.CfnResource implements cdk.IInspectable {}
  • A CloudFormation AWS::SSM::Association

    The AWS::SSM::Association resource creates a State Manager association for your managed instances. A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Groups or an AWS Auto Scaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.

    AWS::SSM::Association external

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html

constructor

constructor(scope: cdk.Construct, id: string, props: CfnAssociationProps);
  • Create a new AWS::SSM::Association.

    Parameter scope

    scope in which this resource is defined

    Parameter id

    scoped id of the resource

    Parameter props

    resource properties

property applyOnlyAtCronInterval

applyOnlyAtCronInterval: any;
  • By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval

property associationName

associationName: string;
  • Specify a descriptive name for the association.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname

property attrAssociationId

readonly attrAssociationId: string;
  • The association ID. AssociationId

property automationTargetParameterName

automationTargetParameterName: string;
  • Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of AWS Systems Manager .

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername

property calendarNames

calendarNames: string[];
  • The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see [AWS Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) .

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;
  • The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

    property complianceSeverity

    complianceSeverity: string;
    • The severity level that is assigned to the association.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity

    property documentVersion

    documentVersion: string;
    • The version of the SSM document to associate with the target.

      > Note the following important information. > > - State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default . > - DocumentVersion is not valid for documents owned by AWS , such as AWS-RunPatchBaseline or AWS-UpdateSSMAgent . If you specify DocumentVersion for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: , HandlerErrorCode: GeneralServiceException).

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion

    property instanceId

    instanceId: string;
    • The ID of the instance that the SSM document is associated with. You must specify the InstanceId or Targets property.

      > InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. If you use the parameter InstanceId , you cannot use the parameters AssociationName , DocumentVersion , MaxErrors , MaxConcurrency , OutputLocation , or ScheduleExpression . To use these parameters, you must use the Targets parameter.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid

    property maxConcurrency

    maxConcurrency: string;
    • The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

      If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency

    property maxErrors

    maxErrors: string;
    • The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

      Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors

    property name

    name: string;
    • The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. The documents can be AWS -predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts , you must specify the complete SSM document ARN, in the following format:

      arn:partition:ssm:region:account-id:document/document-name

      For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

      For AWS -predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS -ApplyPatchBaseline or My-Document.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name

    property outputLocation

    outputLocation: any;
    • An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation

    property parameters

    parameters: any;
    • The parameters for the runtime configuration of the document.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters

    property scheduleExpression

    scheduleExpression: string;
    • A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression

    property scheduleOffset

    scheduleOffset: number;
    • Number of days to wait after the scheduled day to run an association.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset

    property syncCompliance

    syncCompliance: string;
    • The mode for generating association compliance. You can specify AUTO or MANUAL . In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT . If the association execution doesn't run successfully, the association is NON-COMPLIANT .

      In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

      By default, all associations use AUTO mode.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance

    property targets

    targets: any;
    • The targets for the association. You must specify the InstanceId or Targets property. You can target all instances in an AWS account by specifying the InstanceIds key with a value of * . To view a JSON and a YAML example that targets all instances, see "Create an association for all managed instances in an AWS account " on the Examples page.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets

    property waitForSuccessTimeoutSeconds

    waitForSuccessTimeoutSeconds: number;
    • The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution. If the association status doesn't show "Success" after the specified number of seconds, then stack creation fails.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds

    method inspect

    inspect: (inspector: cdk.TreeInspector) => void;
    • Examines the CloudFormation resource and discloses attributes.

      Parameter inspector

      tree inspector to collect and process attributes

    method renderProperties

    protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
    };

      class CfnDocument

      class CfnDocument extends cdk.CfnResource implements cdk.IInspectable {}
      • A CloudFormation AWS::SSM::Document

        The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager . This document defines the actions that Systems Manager performs on your AWS resources.

        > This resource does not support CloudFormation drift detection.

        AWS::SSM::Document external

        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html

      constructor

      constructor(scope: cdk.Construct, id: string, props: CfnDocumentProps);
      • Create a new AWS::SSM::Document.

        Parameter scope

        scope in which this resource is defined

        Parameter id

        scoped id of the resource

        Parameter props

        resource properties

      property attachments

      attachments: any;
      • A list of key-value pairs that describe attachments to a version of a document.

        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments

      property CFN_RESOURCE_TYPE_NAME

      static readonly CFN_RESOURCE_TYPE_NAME: string;
      • The CloudFormation resource type name for this resource class.

      property cfnProperties

      readonly cfnProperties: { [key: string]: any };

        property content

        content: any;
        • The content for the new SSM document in JSON or YAML.

          > This parameter also supports String data types.

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content

        property documentFormat

        documentFormat: string;
        • Specify the document format for the request. JSON is the default format.

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat

        property documentType

        documentType: string;
        • The type of document to create.

          *Allowed Values* : ApplicationConfigurationSchema | Automation | Automation.ChangeTemplate | Command | DeploymentStrategy | Package | Policy | Session

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype

        property name

        name: string;
        • A name for the SSM document.

          > You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: > > - aws- > - amazon > - amzn

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name

        property requires

        requires: any;
        • A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see [What is AWS AppConfig ?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires

        property tags

        readonly tags: cdk.TagManager;
        • AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags

        property targetType

        targetType: string;
        • Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance . If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide* .

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype

        property updateMethod

        updateMethod: string;
        • If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. Replace is the default method. If you specify NewVersion for the UpdateMethod parameter, and the Name of the document does not match an existing resource, a new document is created. When you specify NewVersion , the default version of the document is changed to the newly created version.

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod

        property versionName

        versionName: string;
        • An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1 . This value is unique across all versions of a document, and can't be changed.

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname

        method inspect

        inspect: (inspector: cdk.TreeInspector) => void;
        • Examines the CloudFormation resource and discloses attributes.

          Parameter inspector

          tree inspector to collect and process attributes

        method renderProperties

        protected renderProperties: (props: { [key: string]: any }) => {
        [key: string]: any;
        };

          class CfnMaintenanceWindow

          class CfnMaintenanceWindow extends cdk.CfnResource implements cdk.IInspectable {}
          • A CloudFormation AWS::SSM::MaintenanceWindow

            The AWS::SSM::MaintenanceWindow resource represents general information about a maintenance window for AWS Systems Manager . Maintenance Windows let you define a schedule for when to perform potentially disruptive actions on your instances, such as patching an operating system (OS), updating drivers, or installing software. Each maintenance window has a schedule, a duration, a set of registered targets, and a set of registered tasks.

            For more information, see [Systems Manager Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-maintenance.html) in the *AWS Systems Manager User Guide* and [CreateMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateMaintenanceWindow.html) in the *AWS Systems Manager API Reference* .

            AWS::SSM::MaintenanceWindow external

            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html

          constructor

          constructor(scope: cdk.Construct, id: string, props: CfnMaintenanceWindowProps);
          • Create a new AWS::SSM::MaintenanceWindow.

            Parameter scope

            scope in which this resource is defined

            Parameter id

            scoped id of the resource

            Parameter props

            resource properties

          property allowUnassociatedTargets

          allowUnassociatedTargets: any;
          • Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets

          property CFN_RESOURCE_TYPE_NAME

          static readonly CFN_RESOURCE_TYPE_NAME: string;
          • The CloudFormation resource type name for this resource class.

          property cfnProperties

          readonly cfnProperties: { [key: string]: any };

            property cutoff

            cutoff: number;
            • The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff

            property description

            description: string;
            • A description of the maintenance window.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description

            property duration

            duration: number;
            • The duration of the maintenance window in hours.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration

            property endDate

            endDate: string;
            • The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate

            property name

            name: string;
            • The name of the maintenance window.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name

            property schedule

            schedule: string;
            • The schedule of the maintenance window in the form of a cron or rate expression.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule

            property scheduleOffset

            scheduleOffset: number;
            • The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset

            property scheduleTimezone

            scheduleTimezone: string;
            • The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone

            property startDate

            startDate: string;
            • The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the Maintenance Window until the specified future date.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate

            property tags

            readonly tags: cdk.TagManager;
            • Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags

            method inspect

            inspect: (inspector: cdk.TreeInspector) => void;
            • Examines the CloudFormation resource and discloses attributes.

              Parameter inspector

              tree inspector to collect and process attributes

            method renderProperties

            protected renderProperties: (props: { [key: string]: any }) => {
            [key: string]: any;
            };

              class CfnMaintenanceWindowTarget

              class CfnMaintenanceWindowTarget
              extends cdk.CfnResource
              implements cdk.IInspectable {}
              • A CloudFormation AWS::SSM::MaintenanceWindowTarget

                The AWS::SSM::MaintenanceWindowTarget resource registers a target with a maintenance window for AWS Systems Manager . For more information, see [RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTargetWithMaintenanceWindow.html) in the *AWS Systems Manager API Reference* .

                AWS::SSM::MaintenanceWindowTarget external

                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html

              constructor

              constructor(
              scope: cdk.Construct,
              id: string,
              props: CfnMaintenanceWindowTargetProps
              );
              • Create a new AWS::SSM::MaintenanceWindowTarget.

                Parameter scope

                scope in which this resource is defined

                Parameter id

                scoped id of the resource

                Parameter props

                resource properties

              property CFN_RESOURCE_TYPE_NAME

              static readonly CFN_RESOURCE_TYPE_NAME: string;
              • The CloudFormation resource type name for this resource class.

              property cfnProperties

              readonly cfnProperties: { [key: string]: any };

                property description

                description: string;
                • A description for the target.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description

                property name

                name: string;
                • The name for the maintenance window target.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name

                property ownerInformation

                ownerInformation: string;
                • A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation

                property resourceType

                resourceType: string;
                • The type of target that is being registered with the maintenance window.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype

                property targets

                targets: any;
                • The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

                  You must specify targets by using the WindowTargetIds parameter.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets

                property windowId

                windowId: string;
                • The ID of the maintenance window to register the target with.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid

                method inspect

                inspect: (inspector: cdk.TreeInspector) => void;
                • Examines the CloudFormation resource and discloses attributes.

                  Parameter inspector

                  tree inspector to collect and process attributes

                method renderProperties

                protected renderProperties: (props: { [key: string]: any }) => {
                [key: string]: any;
                };

                  class CfnMaintenanceWindowTask

                  class CfnMaintenanceWindowTask extends cdk.CfnResource implements cdk.IInspectable {}
                  • A CloudFormation AWS::SSM::MaintenanceWindowTask

                    The AWS::SSM::MaintenanceWindowTask resource defines information about a task for an AWS Systems Manager maintenance window. For more information, see [RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTaskWithMaintenanceWindow.html) in the *AWS Systems Manager API Reference* .

                    AWS::SSM::MaintenanceWindowTask external

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html

                  constructor

                  constructor(
                  scope: cdk.Construct,
                  id: string,
                  props: CfnMaintenanceWindowTaskProps
                  );
                  • Create a new AWS::SSM::MaintenanceWindowTask.

                    Parameter scope

                    scope in which this resource is defined

                    Parameter id

                    scoped id of the resource

                    Parameter props

                    resource properties

                  property CFN_RESOURCE_TYPE_NAME

                  static readonly CFN_RESOURCE_TYPE_NAME: string;
                  • The CloudFormation resource type name for this resource class.

                  property cfnProperties

                  readonly cfnProperties: { [key: string]: any };

                    property cutoffBehavior

                    cutoffBehavior: string;
                    • The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior

                    property description

                    description: string;
                    • A description of the task.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description

                    property loggingInfo

                    loggingInfo: any;
                    • Information about an Amazon S3 bucket to write task-level logs to.

                      > LoggingInfo has been deprecated. To specify an Amazon S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) .

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo

                    property maxConcurrency

                    maxConcurrency: string;
                    • The maximum number of targets this task can be run for, in parallel.

                      > Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases. > > For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1 . This value doesn't affect the running of your task.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency

                    property maxErrors

                    maxErrors: string;
                    • The maximum number of errors allowed before this task stops being scheduled.

                      > Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases. > > For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1 . This value doesn't affect the running of your task.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors

                    property name

                    name: string;
                    • The task name.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name

                    property priority

                    priority: number;
                    • The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority

                    property serviceRoleArn

                    serviceRoleArn: string;
                    • The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn

                    property targets

                    targets: any;
                    • The targets, either instances or window target IDs.

                      - Specify instances using Key=InstanceIds,Values= *instanceid1* , *instanceid2* . - Specify window target IDs using Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2* .

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets

                    property taskArn

                    taskArn: string;
                    • The resource that the task uses during execution.

                      For RUN_COMMAND and AUTOMATION task types, TaskArn is the SSM document name or Amazon Resource Name (ARN).

                      For LAMBDA tasks, TaskArn is the function name or ARN.

                      For STEP_FUNCTIONS tasks, TaskArn is the state machine ARN.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn

                    property taskInvocationParameters

                    taskInvocationParameters: any;
                    • The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.

                      > When you update a maintenance window task that has options specified in TaskInvocationParameters , you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment , NotificationConfig , and OutputS3BucketName . If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters

                    property taskParameters

                    taskParameters: any;
                    • The parameters to pass to the task when it runs.

                      > TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html) .

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters

                    property taskType

                    taskType: string;
                    • The type of task. Valid values: RUN_COMMAND , AUTOMATION , LAMBDA , STEP_FUNCTIONS .

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype

                    property windowId

                    windowId: string;
                    • The ID of the maintenance window where the task is registered.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid

                    method inspect

                    inspect: (inspector: cdk.TreeInspector) => void;
                    • Examines the CloudFormation resource and discloses attributes.

                      Parameter inspector

                      tree inspector to collect and process attributes

                    method renderProperties

                    protected renderProperties: (props: { [key: string]: any }) => {
                    [key: string]: any;
                    };

                      class CfnParameter

                      class CfnParameter extends cdk.CfnResource implements cdk.IInspectable {}
                      • A CloudFormation AWS::SSM::Parameter

                        The AWS::SSM::Parameter resource creates an SSM parameter in AWS Systems Manager Parameter Store.

                        > To create an SSM parameter, you must have the AWS Identity and Access Management ( IAM ) permissions ssm:PutParameter and ssm:AddTagsToResource . On stack creation, AWS CloudFormation adds the following three tags to the parameter: aws:cloudformation:stack-name , aws:cloudformation:logical-id , and aws:cloudformation:stack-id , in addition to any custom tags you specify. > > To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource . For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *AWS Systems Manager User Guide* .

                        For information about valid values for parameters, see [Requirements and Constraints for Parameter Names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *AWS Systems Manager User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *AWS Systems Manager API Reference* .

                        AWS::SSM::Parameter external

                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html

                      constructor

                      constructor(scope: cdk.Construct, id: string, props: CfnParameterProps);
                      • Create a new AWS::SSM::Parameter.

                        Parameter scope

                        scope in which this resource is defined

                        Parameter id

                        scoped id of the resource

                        Parameter props

                        resource properties

                      property allowedPattern

                      allowedPattern: string;
                      • A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern

                      property attrType

                      readonly attrType: string;
                      • Returns the type of the parameter. Valid values are String or StringList . Type

                      property attrValue

                      readonly attrValue: string;
                      • Returns the value of the parameter. Value

                      property CFN_RESOURCE_TYPE_NAME

                      static readonly CFN_RESOURCE_TYPE_NAME: string;
                      • The CloudFormation resource type name for this resource class.

                      property cfnProperties

                      readonly cfnProperties: { [key: string]: any };

                        property dataType

                        dataType: string;
                        • The data type of the parameter, such as text or aws:ec2:image . The default is text .

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype

                        property description

                        description: string;
                        • Information about the parameter.

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description

                        property name

                        name: string;
                        • The name of the parameter.

                          > The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name

                        property policies

                        policies: string;
                        • Information about the policies assigned to a parameter.

                          [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *AWS Systems Manager User Guide* .

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies

                        property tags

                        readonly tags: cdk.TagManager;
                        • Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags

                        property tier

                        tier: string;
                        • The parameter tier.

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier

                        property type

                        type: string;
                        • The type of parameter.

                          > AWS CloudFormation doesn't support creating a SecureString parameter type.

                          *Allowed Values* : String | StringList

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type

                        property value

                        value: string;
                        • The parameter value.

                          > If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value

                        method inspect

                        inspect: (inspector: cdk.TreeInspector) => void;
                        • Examines the CloudFormation resource and discloses attributes.

                          Parameter inspector

                          tree inspector to collect and process attributes

                        method renderProperties

                        protected renderProperties: (props: { [key: string]: any }) => {
                        [key: string]: any;
                        };

                          class CfnPatchBaseline

                          class CfnPatchBaseline extends cdk.CfnResource implements cdk.IInspectable {}
                          • A CloudFormation AWS::SSM::PatchBaseline

                            The AWS::SSM::PatchBaseline resource defines the basic information for an AWS Systems Manager patch baseline. A patch baseline defines which patches are approved for installation on your instances.

                            For more information, see [CreatePatchBaseline](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreatePatchBaseline.html) in the *AWS Systems Manager API Reference* .

                            AWS::SSM::PatchBaseline external

                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html

                          constructor

                          constructor(scope: cdk.Construct, id: string, props: CfnPatchBaselineProps);
                          • Create a new AWS::SSM::PatchBaseline.

                            Parameter scope

                            scope in which this resource is defined

                            Parameter id

                            scoped id of the resource

                            Parameter props

                            resource properties

                          property approvalRules

                          approvalRules: any;
                          • A set of rules used to include patches in the baseline.

                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules

                          property approvedPatches

                          approvedPatches: string[];
                          • A list of explicitly approved patches for the baseline.

                            For information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide* .

                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches

                          property approvedPatchesComplianceLevel

                          approvedPatchesComplianceLevel: string;
                          • Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED .

                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel

                          property approvedPatchesEnableNonSecurity

                          approvedPatchesEnableNonSecurity: any;
                          • Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false . Applies to Linux managed nodes only.

                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity

                          property CFN_RESOURCE_TYPE_NAME

                          static readonly CFN_RESOURCE_TYPE_NAME: string;
                          • The CloudFormation resource type name for this resource class.

                          property cfnProperties

                          readonly cfnProperties: { [key: string]: any };

                            property description

                            description: string;
                            • A description of the patch baseline.

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description

                            property globalFilters

                            globalFilters: any;
                            • A set of global filters used to include patches in the baseline.

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters

                            property name

                            name: string;
                            • The name of the patch baseline.

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name

                            property operatingSystem

                            operatingSystem: string;
                            • Defines the operating system the patch baseline applies to. The default value is WINDOWS .

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem

                            property patchGroups

                            patchGroups: string[];
                            • The name of the patch group to be registered with the patch baseline.

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups

                            property rejectedPatches

                            rejectedPatches: string[];
                            • A list of explicitly rejected patches for the baseline.

                              For information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide* .

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches

                            property rejectedPatchesAction

                            rejectedPatchesAction: string;
                            • The action for Patch Manager to take on patches included in the RejectedPackages list.

                              - *ALLOW_AS_DEPENDENCY* : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther . This is the default action if no option is specified. - *BLOCK* : Packages in the RejectedPatches list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected .

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction

                            property sources

                            sources: any;
                            • Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources

                            property tags

                            readonly tags: cdk.TagManager;
                            • Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to.

                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags

                            method inspect

                            inspect: (inspector: cdk.TreeInspector) => void;
                            • Examines the CloudFormation resource and discloses attributes.

                              Parameter inspector

                              tree inspector to collect and process attributes

                            method renderProperties

                            protected renderProperties: (props: { [key: string]: any }) => {
                            [key: string]: any;
                            };

                              class CfnResourceDataSync

                              class CfnResourceDataSync extends cdk.CfnResource implements cdk.IInspectable {}
                              • A CloudFormation AWS::SSM::ResourceDataSync

                                The AWS::SSM::ResourceDataSync resource creates, updates, or deletes a resource data sync for AWS Systems Manager . A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource .

                                You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket.

                                You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions . This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or from an EntireOrganization by using AWS Organizations .

                                A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data.

                                By default, data is not encrypted in Amazon S3 . We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

                                For more information, see [Configuring Inventory Collection](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync) and [Setting Up Systems Manager Explorer to Display Data from Multiple Accounts and Regions](https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) in the *AWS Systems Manager User Guide* .

                                Important: The following *Syntax* section shows all fields that are supported for a resource data sync. The *Examples* section below shows the recommended way to specify configurations for each sync type. Please see the *Examples* section when you create your resource data sync.

                                AWS::SSM::ResourceDataSync external

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html

                              constructor

                              constructor(scope: cdk.Construct, id: string, props: CfnResourceDataSyncProps);
                              • Create a new AWS::SSM::ResourceDataSync.

                                Parameter scope

                                scope in which this resource is defined

                                Parameter id

                                scoped id of the resource

                                Parameter props

                                resource properties

                              property attrSyncName

                              readonly attrSyncName: string;
                              • The name of the resource data sync. SyncName

                              property bucketName

                              bucketName: string;
                              • The name of the S3 bucket where the aggregated data is stored.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname

                              property bucketPrefix

                              bucketPrefix: string;
                              • An Amazon S3 prefix for the bucket.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix

                              property bucketRegion

                              bucketRegion: string;
                              • The AWS Region with the S3 bucket targeted by the resource data sync.

                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion

                              property CFN_RESOURCE_TYPE_NAME

                              static readonly CFN_RESOURCE_TYPE_NAME: string;
                              • The CloudFormation resource type name for this resource class.

                              property cfnProperties

                              readonly cfnProperties: { [key: string]: any };

                                property kmsKeyArn

                                kmsKeyArn: string;
                                • The ARN of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same region as the destination Amazon S3 bucket.

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn

                                property s3Destination

                                s3Destination: any;
                                • Configuration information for the target S3 bucket.

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination

                                property syncFormat

                                syncFormat: string;
                                • A supported sync format. The following format is currently supported: JsonSerDe

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat

                                property syncName

                                syncName: string;
                                • A name for the resource data sync.

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname

                                property syncSource

                                syncSource: any;
                                • Information about the source where the data was synchronized.

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource

                                property syncType

                                syncType: string;
                                • The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .

                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype

                                method inspect

                                inspect: (inspector: cdk.TreeInspector) => void;
                                • Examines the CloudFormation resource and discloses attributes.

                                  Parameter inspector

                                  tree inspector to collect and process attributes

                                method renderProperties

                                protected renderProperties: (props: { [key: string]: any }) => {
                                [key: string]: any;
                                };

                                  class StringListParameter

                                  class StringListParameter extends ParameterBase implements IStringListParameter {}
                                  • Creates a new StringList SSM Parameter. AWS::SSM::Parameter

                                  constructor

                                  constructor(scope: Construct, id: string, props: StringListParameterProps);

                                    property parameterArn

                                    readonly parameterArn: string;

                                      property parameterName

                                      readonly parameterName: string;

                                        property parameterType

                                        readonly parameterType: string;

                                          property stringListValue

                                          readonly stringListValue: string[];

                                            method fromStringListParameterName

                                            static fromStringListParameterName: (
                                            scope: Construct,
                                            id: string,
                                            stringListParameterName: string
                                            ) => IStringListParameter;
                                            • Imports an external parameter of type string list. Returns a token and should not be parsed.

                                            class StringParameter

                                            class StringParameter extends ParameterBase implements IStringParameter {}
                                            • Creates a new String SSM Parameter. AWS::SSM::Parameter

                                            constructor

                                            constructor(scope: Construct, id: string, props: StringParameterProps);

                                              property parameterArn

                                              readonly parameterArn: string;

                                                property parameterName

                                                readonly parameterName: string;

                                                  property parameterType

                                                  readonly parameterType: string;

                                                    property stringValue

                                                    readonly stringValue: string;

                                                      method fromSecureStringParameterAttributes

                                                      static fromSecureStringParameterAttributes: (
                                                      scope: Construct,
                                                      id: string,
                                                      attrs: SecureStringParameterAttributes
                                                      ) => IStringParameter;
                                                      • Imports a secure string parameter from the SSM parameter store.

                                                      method fromStringParameterAttributes

                                                      static fromStringParameterAttributes: (
                                                      scope: Construct,
                                                      id: string,
                                                      attrs: StringParameterAttributes
                                                      ) => IStringParameter;
                                                      • Imports an external string parameter with name and optional version.

                                                      method fromStringParameterName

                                                      static fromStringParameterName: (
                                                      scope: Construct,
                                                      id: string,
                                                      stringParameterName: string
                                                      ) => IStringParameter;
                                                      • Imports an external string parameter by name.

                                                      method valueForSecureStringParameter

                                                      static valueForSecureStringParameter: (
                                                      scope: Construct,
                                                      parameterName: string,
                                                      version: number
                                                      ) => string;
                                                      • Returns a token that will resolve (during deployment)

                                                        Parameter scope

                                                        Some scope within a stack

                                                        Parameter parameterName

                                                        The name of the SSM parameter

                                                        Parameter version

                                                        The parameter version (required for secure strings)

                                                        Deprecated

                                                        Use SecretValue.ssmSecure() instead, it will correctly type the imported value as a SecretValue and allow importing without version.

                                                      method valueForStringParameter

                                                      static valueForStringParameter: (
                                                      scope: Construct,
                                                      parameterName: string,
                                                      version?: number
                                                      ) => string;
                                                      • Returns a token that will resolve (during deployment) to the string value of an SSM string parameter.

                                                        Parameter scope

                                                        Some scope within a stack

                                                        Parameter parameterName

                                                        The name of the SSM parameter.

                                                        Parameter version

                                                        The parameter version (recommended in order to ensure that the value won't change during deployment)

                                                      method valueForTypedStringParameter

                                                      static valueForTypedStringParameter: (
                                                      scope: Construct,
                                                      parameterName: string,
                                                      type?: ParameterType,
                                                      version?: number
                                                      ) => string;
                                                      • Returns a token that will resolve (during deployment) to the string value of an SSM string parameter.

                                                        Parameter scope

                                                        Some scope within a stack

                                                        Parameter parameterName

                                                        The name of the SSM parameter.

                                                        Parameter type

                                                        The type of the SSM parameter.

                                                        Parameter version

                                                        The parameter version (recommended in order to ensure that the value won't change during deployment)

                                                      method valueFromLookup

                                                      static valueFromLookup: (
                                                      scope: CompatConstruct,
                                                      parameterName: string
                                                      ) => string;
                                                      • Reads the value of an SSM parameter during synthesis through an environmental context provider.

                                                        Requires that the stack this scope is defined in will have explicit account/region information. Otherwise, it will fail during synthesis.

                                                      Interfaces

                                                      interface CfnAssociationProps

                                                      interface CfnAssociationProps {}
                                                      • Properties for defining a CfnAssociation

                                                        external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html

                                                      property applyOnlyAtCronInterval

                                                      readonly applyOnlyAtCronInterval?: boolean | cdk.IResolvable;
                                                      • By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval

                                                      property associationName

                                                      readonly associationName?: string;
                                                      • Specify a descriptive name for the association.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname

                                                      property automationTargetParameterName

                                                      readonly automationTargetParameterName?: string;
                                                      • Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of AWS Systems Manager .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername

                                                      property calendarNames

                                                      readonly calendarNames?: string[];
                                                      • The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see [AWS Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames

                                                      property complianceSeverity

                                                      readonly complianceSeverity?: string;
                                                      • The severity level that is assigned to the association.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity

                                                      property documentVersion

                                                      readonly documentVersion?: string;
                                                      • The version of the SSM document to associate with the target.

                                                        > Note the following important information. > > - State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default . > - DocumentVersion is not valid for documents owned by AWS , such as AWS-RunPatchBaseline or AWS-UpdateSSMAgent . If you specify DocumentVersion for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: , HandlerErrorCode: GeneralServiceException).

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion

                                                      property instanceId

                                                      readonly instanceId?: string;
                                                      • The ID of the instance that the SSM document is associated with. You must specify the InstanceId or Targets property.

                                                        > InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. If you use the parameter InstanceId , you cannot use the parameters AssociationName , DocumentVersion , MaxErrors , MaxConcurrency , OutputLocation , or ScheduleExpression . To use these parameters, you must use the Targets parameter.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid

                                                      property maxConcurrency

                                                      readonly maxConcurrency?: string;
                                                      • The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

                                                        If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency

                                                      property maxErrors

                                                      readonly maxErrors?: string;
                                                      • The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

                                                        Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors

                                                      property name

                                                      readonly name: string;
                                                      • The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents. The documents can be AWS -predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts , you must specify the complete SSM document ARN, in the following format:

                                                        arn:partition:ssm:region:account-id:document/document-name

                                                        For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

                                                        For AWS -predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS -ApplyPatchBaseline or My-Document.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name

                                                      property outputLocation

                                                      readonly outputLocation?:
                                                      | CfnAssociation.InstanceAssociationOutputLocationProperty
                                                      | cdk.IResolvable;
                                                      • An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation

                                                      property parameters

                                                      readonly parameters?:
                                                      | {
                                                      [key: string]: any | cdk.IResolvable;
                                                      }
                                                      | cdk.IResolvable;
                                                      • The parameters for the runtime configuration of the document.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters

                                                      property scheduleExpression

                                                      readonly scheduleExpression?: string;
                                                      • A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression

                                                      property scheduleOffset

                                                      readonly scheduleOffset?: number;
                                                      • Number of days to wait after the scheduled day to run an association.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset

                                                      property syncCompliance

                                                      readonly syncCompliance?: string;
                                                      • The mode for generating association compliance. You can specify AUTO or MANUAL . In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT . If the association execution doesn't run successfully, the association is NON-COMPLIANT .

                                                        In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

                                                        By default, all associations use AUTO mode.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance

                                                      property targets

                                                      readonly targets?:
                                                      | Array<CfnAssociation.TargetProperty | cdk.IResolvable>
                                                      | cdk.IResolvable;
                                                      • The targets for the association. You must specify the InstanceId or Targets property. You can target all instances in an AWS account by specifying the InstanceIds key with a value of * . To view a JSON and a YAML example that targets all instances, see "Create an association for all managed instances in an AWS account " on the Examples page.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets

                                                      property waitForSuccessTimeoutSeconds

                                                      readonly waitForSuccessTimeoutSeconds?: number;
                                                      • The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution. If the association status doesn't show "Success" after the specified number of seconds, then stack creation fails.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds

                                                      interface CfnDocumentProps

                                                      interface CfnDocumentProps {}
                                                      • Properties for defining a CfnDocument

                                                        external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html

                                                      property attachments

                                                      readonly attachments?:
                                                      | Array<CfnDocument.AttachmentsSourceProperty | cdk.IResolvable>
                                                      | cdk.IResolvable;
                                                      • A list of key-value pairs that describe attachments to a version of a document.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments

                                                      property content

                                                      readonly content: any | cdk.IResolvable;
                                                      • The content for the new SSM document in JSON or YAML.

                                                        > This parameter also supports String data types.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content

                                                      property documentFormat

                                                      readonly documentFormat?: string;
                                                      • Specify the document format for the request. JSON is the default format.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat

                                                      property documentType

                                                      readonly documentType?: string;
                                                      • The type of document to create.

                                                        *Allowed Values* : ApplicationConfigurationSchema | Automation | Automation.ChangeTemplate | Command | DeploymentStrategy | Package | Policy | Session

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype

                                                      property name

                                                      readonly name?: string;
                                                      • A name for the SSM document.

                                                        > You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: > > - aws- > - amazon > - amzn

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name

                                                      property requires

                                                      readonly requires?:
                                                      | Array<CfnDocument.DocumentRequiresProperty | cdk.IResolvable>
                                                      | cdk.IResolvable;
                                                      • A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see [What is AWS AppConfig ?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires

                                                      property tags

                                                      readonly tags?: cdk.CfnTag[];
                                                      • AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags

                                                      property targetType

                                                      readonly targetType?: string;
                                                      • Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance . If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide* .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype

                                                      property updateMethod

                                                      readonly updateMethod?: string;
                                                      • If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. Replace is the default method. If you specify NewVersion for the UpdateMethod parameter, and the Name of the document does not match an existing resource, a new document is created. When you specify NewVersion , the default version of the document is changed to the newly created version.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod

                                                      property versionName

                                                      readonly versionName?: string;
                                                      • An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1 . This value is unique across all versions of a document, and can't be changed.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname

                                                      interface CfnMaintenanceWindowProps

                                                      interface CfnMaintenanceWindowProps {}
                                                      • Properties for defining a CfnMaintenanceWindow

                                                        external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html

                                                      property allowUnassociatedTargets

                                                      readonly allowUnassociatedTargets: boolean | cdk.IResolvable;
                                                      • Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets

                                                      property cutoff

                                                      readonly cutoff: number;
                                                      • The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff

                                                      property description

                                                      readonly description?: string;
                                                      • A description of the maintenance window.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description

                                                      property duration

                                                      readonly duration: number;
                                                      • The duration of the maintenance window in hours.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration

                                                      property endDate

                                                      readonly endDate?: string;
                                                      • The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate

                                                      property name

                                                      readonly name: string;
                                                      • The name of the maintenance window.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name

                                                      property schedule

                                                      readonly schedule: string;
                                                      • The schedule of the maintenance window in the form of a cron or rate expression.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule

                                                      property scheduleOffset

                                                      readonly scheduleOffset?: number;
                                                      • The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset

                                                      property scheduleTimezone

                                                      readonly scheduleTimezone?: string;
                                                      • The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone

                                                      property startDate

                                                      readonly startDate?: string;
                                                      • The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the Maintenance Window until the specified future date.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate

                                                      property tags

                                                      readonly tags?: cdk.CfnTag[];
                                                      • Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags

                                                      interface CfnMaintenanceWindowTargetProps

                                                      interface CfnMaintenanceWindowTargetProps {}
                                                      • Properties for defining a CfnMaintenanceWindowTarget

                                                        external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html

                                                      property description

                                                      readonly description?: string;
                                                      • A description for the target.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description

                                                      property name

                                                      readonly name?: string;
                                                      • The name for the maintenance window target.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name

                                                      property ownerInformation

                                                      readonly ownerInformation?: string;
                                                      • A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation

                                                      property resourceType

                                                      readonly resourceType: string;
                                                      • The type of target that is being registered with the maintenance window.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype

                                                      property targets

                                                      readonly targets:
                                                      | Array<CfnMaintenanceWindowTarget.TargetsProperty | cdk.IResolvable>
                                                      | cdk.IResolvable;
                                                      • The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

                                                        You must specify targets by using the WindowTargetIds parameter.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets

                                                      property windowId

                                                      readonly windowId: string;
                                                      • The ID of the maintenance window to register the target with.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid

                                                      interface CfnMaintenanceWindowTaskProps

                                                      interface CfnMaintenanceWindowTaskProps {}
                                                      • Properties for defining a CfnMaintenanceWindowTask

                                                        external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html

                                                      property cutoffBehavior

                                                      readonly cutoffBehavior?: string;
                                                      • The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior

                                                      property description

                                                      readonly description?: string;
                                                      • A description of the task.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description

                                                      property loggingInfo

                                                      readonly loggingInfo?:
                                                      | CfnMaintenanceWindowTask.LoggingInfoProperty
                                                      | cdk.IResolvable;
                                                      • Information about an Amazon S3 bucket to write task-level logs to.

                                                        > LoggingInfo has been deprecated. To specify an Amazon S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo

                                                      property maxConcurrency

                                                      readonly maxConcurrency?: string;
                                                      • The maximum number of targets this task can be run for, in parallel.

                                                        > Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases. > > For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1 . This value doesn't affect the running of your task.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency

                                                      property maxErrors

                                                      readonly maxErrors?: string;
                                                      • The maximum number of errors allowed before this task stops being scheduled.

                                                        > Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases. > > For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1 . This value doesn't affect the running of your task.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors

                                                      property name

                                                      readonly name?: string;
                                                      • The task name.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name

                                                      property priority

                                                      readonly priority: number;
                                                      • The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority

                                                      property serviceRoleArn

                                                      readonly serviceRoleArn?: string;
                                                      • The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn

                                                      property targets

                                                      readonly targets?:
                                                      | Array<CfnMaintenanceWindowTask.TargetProperty | cdk.IResolvable>
                                                      | cdk.IResolvable;
                                                      • The targets, either instances or window target IDs.

                                                        - Specify instances using Key=InstanceIds,Values= *instanceid1* , *instanceid2* . - Specify window target IDs using Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2* .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets

                                                      property taskArn

                                                      readonly taskArn: string;
                                                      • The resource that the task uses during execution.

                                                        For RUN_COMMAND and AUTOMATION task types, TaskArn is the SSM document name or Amazon Resource Name (ARN).

                                                        For LAMBDA tasks, TaskArn is the function name or ARN.

                                                        For STEP_FUNCTIONS tasks, TaskArn is the state machine ARN.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn

                                                      property taskInvocationParameters

                                                      readonly taskInvocationParameters?:
                                                      | CfnMaintenanceWindowTask.TaskInvocationParametersProperty
                                                      | cdk.IResolvable;
                                                      • The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.

                                                        > When you update a maintenance window task that has options specified in TaskInvocationParameters , you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment , NotificationConfig , and OutputS3BucketName . If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters

                                                      property taskParameters

                                                      readonly taskParameters?: any | cdk.IResolvable;
                                                      • The parameters to pass to the task when it runs.

                                                        > TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html) .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters

                                                      property taskType

                                                      readonly taskType: string;
                                                      • The type of task. Valid values: RUN_COMMAND , AUTOMATION , LAMBDA , STEP_FUNCTIONS .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype

                                                      property windowId

                                                      readonly windowId: string;
                                                      • The ID of the maintenance window where the task is registered.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid

                                                      interface CfnParameterProps

                                                      interface CfnParameterProps {}
                                                      • Properties for defining a CfnParameter

                                                        external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html

                                                      property allowedPattern

                                                      readonly allowedPattern?: string;
                                                      • A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern

                                                      property dataType

                                                      readonly dataType?: string;
                                                      • The data type of the parameter, such as text or aws:ec2:image . The default is text .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype

                                                      property description

                                                      readonly description?: string;
                                                      • Information about the parameter.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description

                                                      property name

                                                      readonly name?: string;
                                                      • The name of the parameter.

                                                        > The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name

                                                      property policies

                                                      readonly policies?: string;
                                                      • Information about the policies assigned to a parameter.

                                                        [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *AWS Systems Manager User Guide* .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies

                                                      property tags

                                                      readonly tags?: any;
                                                      • Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags

                                                      property tier

                                                      readonly tier?: string;
                                                      • The parameter tier.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier

                                                      property type

                                                      readonly type: string;
                                                      • The type of parameter.

                                                        > AWS CloudFormation doesn't support creating a SecureString parameter type.

                                                        *Allowed Values* : String | StringList

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type

                                                      property value

                                                      readonly value: string;
                                                      • The parameter value.

                                                        > If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value

                                                      interface CfnPatchBaselineProps

                                                      interface CfnPatchBaselineProps {}
                                                      • Properties for defining a CfnPatchBaseline

                                                        external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html

                                                      property approvalRules

                                                      readonly approvalRules?: CfnPatchBaseline.RuleGroupProperty | cdk.IResolvable;
                                                      • A set of rules used to include patches in the baseline.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules

                                                      property approvedPatches

                                                      readonly approvedPatches?: string[];
                                                      • A list of explicitly approved patches for the baseline.

                                                        For information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide* .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches

                                                      property approvedPatchesComplianceLevel

                                                      readonly approvedPatchesComplianceLevel?: string;
                                                      • Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel

                                                      property approvedPatchesEnableNonSecurity

                                                      readonly approvedPatchesEnableNonSecurity?: boolean | cdk.IResolvable;
                                                      • Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false . Applies to Linux managed nodes only.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity

                                                      property description

                                                      readonly description?: string;
                                                      • A description of the patch baseline.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description

                                                      property globalFilters

                                                      readonly globalFilters?:
                                                      | CfnPatchBaseline.PatchFilterGroupProperty
                                                      | cdk.IResolvable;
                                                      • A set of global filters used to include patches in the baseline.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters

                                                      property name

                                                      readonly name: string;
                                                      • The name of the patch baseline.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name

                                                      property operatingSystem

                                                      readonly operatingSystem?: string;
                                                      • Defines the operating system the patch baseline applies to. The default value is WINDOWS .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem

                                                      property patchGroups

                                                      readonly patchGroups?: string[];
                                                      • The name of the patch group to be registered with the patch baseline.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups

                                                      property rejectedPatches

                                                      readonly rejectedPatches?: string[];
                                                      • A list of explicitly rejected patches for the baseline.

                                                        For information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide* .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches

                                                      property rejectedPatchesAction

                                                      readonly rejectedPatchesAction?: string;
                                                      • The action for Patch Manager to take on patches included in the RejectedPackages list.

                                                        - *ALLOW_AS_DEPENDENCY* : A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther . This is the default action if no option is specified. - *BLOCK* : Packages in the RejectedPatches list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction

                                                      property sources

                                                      readonly sources?:
                                                      | Array<CfnPatchBaseline.PatchSourceProperty | cdk.IResolvable>
                                                      | cdk.IResolvable;
                                                      • Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources

                                                      property tags

                                                      readonly tags?: cdk.CfnTag[];
                                                      • Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags

                                                      interface CfnResourceDataSyncProps

                                                      interface CfnResourceDataSyncProps {}
                                                      • Properties for defining a CfnResourceDataSync

                                                        external

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html

                                                      property bucketName

                                                      readonly bucketName?: string;
                                                      • The name of the S3 bucket where the aggregated data is stored.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname

                                                      property bucketPrefix

                                                      readonly bucketPrefix?: string;
                                                      • An Amazon S3 prefix for the bucket.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix

                                                      property bucketRegion

                                                      readonly bucketRegion?: string;
                                                      • The AWS Region with the S3 bucket targeted by the resource data sync.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion

                                                      property kmsKeyArn

                                                      readonly kmsKeyArn?: string;
                                                      • The ARN of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same region as the destination Amazon S3 bucket.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn

                                                      property s3Destination

                                                      readonly s3Destination?:
                                                      | CfnResourceDataSync.S3DestinationProperty
                                                      | cdk.IResolvable;
                                                      • Configuration information for the target S3 bucket.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination

                                                      property syncFormat

                                                      readonly syncFormat?: string;
                                                      • A supported sync format. The following format is currently supported: JsonSerDe

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat

                                                      property syncName

                                                      readonly syncName: string;
                                                      • A name for the resource data sync.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname

                                                      property syncSource

                                                      readonly syncSource?: CfnResourceDataSync.SyncSourceProperty | cdk.IResolvable;
                                                      • Information about the source where the data was synchronized.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource

                                                      property syncType

                                                      readonly syncType?: string;
                                                      • The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype

                                                      interface CommonStringParameterAttributes

                                                      interface CommonStringParameterAttributes {}
                                                      • Common attributes for string parameters.

                                                      property parameterName

                                                      readonly parameterName: string;
                                                      • The name of the parameter store value.

                                                        This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).

                                                      property simpleName

                                                      readonly simpleName?: boolean;
                                                      • Indicates of the parameter name is a simple name (i.e. does not include "/" separators).

                                                        This is only required only if parameterName is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs.

                                                        If parameterName is not specified, simpleName must be true (or undefined) since the name generated by AWS CloudFormation is always a simple name.

                                                        - auto-detect based on parameterName

                                                      interface IParameter

                                                      interface IParameter extends IResource {}
                                                      • An SSM Parameter reference.

                                                      property parameterArn

                                                      readonly parameterArn: string;
                                                      • The ARN of the SSM Parameter resource.

                                                      property parameterName

                                                      readonly parameterName: string;
                                                      • The name of the SSM Parameter resource.

                                                      property parameterType

                                                      readonly parameterType: string;
                                                      • The type of the SSM Parameter resource.

                                                      method grantRead

                                                      grantRead: (grantee: iam.IGrantable) => iam.Grant;
                                                      • Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

                                                        Parameter grantee

                                                        the role to be granted read-only access to the parameter.

                                                      method grantWrite

                                                      grantWrite: (grantee: iam.IGrantable) => iam.Grant;
                                                      • Grants write (PutParameter) permissions on the SSM Parameter.

                                                        Parameter grantee

                                                        the role to be granted write access to the parameter.

                                                      interface IStringListParameter

                                                      interface IStringListParameter extends IParameter {}
                                                      • A StringList SSM Parameter.

                                                      property stringListValue

                                                      readonly stringListValue: string[];
                                                      • The parameter value. Value must not nest another parameter. Do not use {{}} in the value. Values in the array cannot contain commas (``,``).

                                                        Value

                                                      interface IStringParameter

                                                      interface IStringParameter extends IParameter {}
                                                      • A String SSM Parameter.

                                                      property stringValue

                                                      readonly stringValue: string;
                                                      • The parameter value. Value must not nest another parameter. Do not use {{}} in the value.

                                                        Value

                                                      interface ParameterOptions

                                                      interface ParameterOptions {}
                                                      • Properties needed to create a new SSM Parameter.

                                                      property allowedPattern

                                                      readonly allowedPattern?: string;
                                                      • A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ``^\d+$``

                                                        no validation is performed

                                                      property description

                                                      readonly description?: string;
                                                      • Information about the parameter that you want to add to the system.

                                                        none

                                                      property parameterName

                                                      readonly parameterName?: string;
                                                      • The name of the parameter.

                                                        - a name will be generated by CloudFormation

                                                      property simpleName

                                                      readonly simpleName?: boolean;
                                                      • Indicates of the parameter name is a simple name (i.e. does not include "/" separators).

                                                        This is only required only if parameterName is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs.

                                                        If parameterName is not specified, simpleName must be true (or undefined) since the name generated by AWS CloudFormation is always a simple name.

                                                        - auto-detect based on parameterName

                                                      property tier

                                                      readonly tier?: ParameterTier;
                                                      • The tier of the string parameter

                                                        - undefined

                                                      interface SecureStringParameterAttributes

                                                      interface SecureStringParameterAttributes extends CommonStringParameterAttributes {}
                                                      • Attributes for secure string parameters.

                                                      property encryptionKey

                                                      readonly encryptionKey?: kms.IKey;
                                                      • The encryption key that is used to encrypt this parameter

                                                        - default master key

                                                      property version

                                                      readonly version?: number;
                                                      • The version number of the value you wish to retrieve.

                                                        - AWS CloudFormation uses the latest version of the parameter

                                                      interface StringListParameterProps

                                                      interface StringListParameterProps extends ParameterOptions {}
                                                      • Properties needed to create a StringList SSM Parameter

                                                      property stringListValue

                                                      readonly stringListValue: string[];
                                                      • The values of the parameter. It may not reference another parameter and ``{{}}`` cannot be used in the value.

                                                      interface StringParameterAttributes

                                                      interface StringParameterAttributes extends CommonStringParameterAttributes {}
                                                      • Attributes for parameters of various types of string.

                                                        See Also

                                                        • ParameterType

                                                      property type

                                                      readonly type?: ParameterType;
                                                      • The type of the string parameter

                                                        ParameterType.STRING

                                                      property version

                                                      readonly version?: number;
                                                      • The version number of the value you wish to retrieve.

                                                        The latest version will be retrieved.

                                                      interface StringParameterProps

                                                      interface StringParameterProps extends ParameterOptions {}
                                                      • Properties needed to create a String SSM parameter.

                                                      property dataType

                                                      readonly dataType?: ParameterDataType;
                                                      • The data type of the parameter, such as text or aws:ec2:image.

                                                        ParameterDataType.TEXT

                                                      property stringValue

                                                      readonly stringValue: string;
                                                      • The value of the parameter. It may not reference another parameter and ``{{}}`` cannot be used in the value.

                                                      property type

                                                      readonly type?: ParameterType;
                                                      • The type of the string parameter

                                                        ParameterType.STRING

                                                      Enums

                                                      enum ParameterDataType

                                                      enum ParameterDataType {
                                                      TEXT = 'text',
                                                      AWS_EC2_IMAGE = 'aws:ec2:image',
                                                      }
                                                      • SSM parameter data type

                                                      member AWS_EC2_IMAGE

                                                      AWS_EC2_IMAGE = 'aws:ec2:image'
                                                      • Aws Ec2 Image

                                                      member TEXT

                                                      TEXT = 'text'
                                                      • Text

                                                      enum ParameterTier

                                                      enum ParameterTier {
                                                      ADVANCED = 'Advanced',
                                                      INTELLIGENT_TIERING = 'Intelligent-Tiering',
                                                      STANDARD = 'Standard',
                                                      }
                                                      • SSM parameter tier

                                                      member ADVANCED

                                                      ADVANCED = 'Advanced'
                                                      • String

                                                      member INTELLIGENT_TIERING

                                                      INTELLIGENT_TIERING = 'Intelligent-Tiering'
                                                      • String

                                                      member STANDARD

                                                      STANDARD = 'Standard'
                                                      • String

                                                      enum ParameterType

                                                      enum ParameterType {
                                                      STRING = 'String',
                                                      SECURE_STRING = 'SecureString',
                                                      STRING_LIST = 'StringList',
                                                      AWS_EC2_IMAGE_ID = 'AWS::EC2::Image::Id',
                                                      }
                                                      • SSM parameter type

                                                      member AWS_EC2_IMAGE_ID

                                                      AWS_EC2_IMAGE_ID = 'AWS::EC2::Image::Id'
                                                      • An Amazon EC2 image ID, such as ami-0ff8a91507f77f867

                                                      member SECURE_STRING

                                                      SECURE_STRING = 'SecureString'
                                                      • Secure String

                                                        Parameter Store uses an AWS Key Management Service (KMS) customer master key (CMK) to encrypt the parameter value. Parameters of type SecureString cannot be created directly from a CDK application.

                                                      member STRING

                                                      STRING = 'String'
                                                      • String

                                                      member STRING_LIST

                                                      STRING_LIST = 'StringList'
                                                      • String List

                                                      Namespaces

                                                      namespace CfnAssociation

                                                      namespace CfnAssociation {}

                                                        interface InstanceAssociationOutputLocationProperty

                                                        interface InstanceAssociationOutputLocationProperty {}
                                                        • InstanceAssociationOutputLocation is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket where you want to store the results of this association request.

                                                          For the minimal permissions required to enable Amazon S3 output for an association, see [Creating associations](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html) in the *Systems Manager User Guide* .

                                                          external

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html

                                                        property s3Location

                                                        readonly s3Location?: CfnAssociation.S3OutputLocationProperty | cdk.IResolvable;
                                                        • S3OutputLocation is a property of the [InstanceAssociationOutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html) property that specifies an Amazon S3 bucket where you want to store the results of this request.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html#cfn-ssm-association-instanceassociationoutputlocation-s3location

                                                        interface S3OutputLocationProperty

                                                        interface S3OutputLocationProperty {}
                                                        • S3OutputLocation is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket where you want to store the results of this association request.

                                                          external

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html

                                                        property outputS3BucketName

                                                        readonly outputS3BucketName?: string;
                                                        • The name of the S3 bucket.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3bucketname

                                                        property outputS3KeyPrefix

                                                        readonly outputS3KeyPrefix?: string;
                                                        • The S3 bucket subfolder.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3keyprefix

                                                        property outputS3Region

                                                        readonly outputS3Region?: string;
                                                        • The AWS Region of the S3 bucket.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3region

                                                        interface TargetProperty

                                                        interface TargetProperty {}
                                                        • Target is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies the targets for an SSM document in Systems Manager . You can target all instances in an AWS account by specifying the InstanceIds key with a value of * . To view a JSON and a YAML example that targets all instances, see "Create an association for all managed instances in an AWS account " on the Examples page.

                                                          external

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html

                                                        property key

                                                        readonly key: string;
                                                        • User-defined criteria for sending commands that target managed nodes that meet the criteria.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key

                                                        property values

                                                        readonly values: string[];
                                                        • User-defined criteria that maps to Key . For example, if you specified tag:ServerRole , you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer .

                                                          Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values

                                                        namespace CfnDocument

                                                        namespace CfnDocument {}

                                                          interface AttachmentsSourceProperty

                                                          interface AttachmentsSourceProperty {}
                                                          • Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.

                                                            external

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html

                                                          property key

                                                          readonly key?: string;
                                                          • The key of a key-value pair that identifies the location of an attachment to a document.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-key

                                                          property name

                                                          readonly name?: string;
                                                          • The name of the document attachment file.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-name

                                                          property values

                                                          readonly values?: string[];
                                                          • The value of a key-value pair that identifies the location of an attachment to a document. The format for *Value* depends on the type of key you specify.

                                                            - For the key *SourceUrl* , the value is an S3 bucket location. For example:

                                                            "Values": [ "s3://doc-example-bucket/my-folder" ] - For the key *S3FileUrl* , the value is a file in an S3 bucket. For example:

                                                            "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ] - For the key *AttachmentReference* , the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:

                                                            "Values": [ "MyOtherDocument/3/my-other-file.py" ]

                                                            However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:

                                                            "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-values

                                                          interface DocumentRequiresProperty

                                                          interface DocumentRequiresProperty {}
                                                          • An SSM document required by the current document.

                                                            external

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html

                                                          property name

                                                          readonly name?: string;
                                                          • The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-name

                                                          property version

                                                          readonly version?: string;
                                                          • The document version required by the current document.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-version

                                                          namespace CfnMaintenanceWindowTarget

                                                          namespace CfnMaintenanceWindowTarget {}

                                                            interface TargetsProperty

                                                            interface TargetsProperty {}
                                                            • The Targets property type specifies adding a target to a maintenance window target in AWS Systems Manager .

                                                              Targets is a property of the [AWS::SSM::MaintenanceWindowTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html) resource.

                                                              external

                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html

                                                            property key

                                                            readonly key: string;
                                                            • User-defined criteria for sending commands that target managed nodes that meet the criteria.

                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-key

                                                            property values

                                                            readonly values: string[];
                                                            • User-defined criteria that maps to Key . For example, if you specified tag:ServerRole , you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer .

                                                              Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-values

                                                            namespace CfnMaintenanceWindowTask

                                                            namespace CfnMaintenanceWindowTask {}

                                                              interface CloudWatchOutputConfigProperty

                                                              interface CloudWatchOutputConfigProperty {}
                                                              • Configuration options for sending command output to Amazon CloudWatch Logs.

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html

                                                              property cloudWatchLogGroupName

                                                              readonly cloudWatchLogGroupName?: string;
                                                              • The name of the CloudWatch Logs log group where you want to send command output. If you don't specify a group name, AWS Systems Manager automatically creates a log group for you. The log group uses the following naming format:

                                                                aws/ssm/ *SystemsManagerDocumentName*

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchloggroupname

                                                              property cloudWatchOutputEnabled

                                                              readonly cloudWatchOutputEnabled?: boolean | cdk.IResolvable;
                                                              • Enables Systems Manager to send command output to CloudWatch Logs.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchoutputenabled

                                                              interface LoggingInfoProperty

                                                              interface LoggingInfoProperty {}
                                                              • The LoggingInfo property type specifies information about the Amazon S3 bucket to write instance-level logs to.

                                                                LoggingInfo is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) resource.

                                                                > LoggingInfo has been deprecated. To specify an Amazon S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) .

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html

                                                              property region

                                                              readonly region: string;
                                                              • The AWS Region where the S3 bucket is located.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-region

                                                              property s3Bucket

                                                              readonly s3Bucket: string;
                                                              • The name of an S3 bucket where execution logs are stored .

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3bucket

                                                              property s3Prefix

                                                              readonly s3Prefix?: string;
                                                              • The Amazon S3 bucket subfolder.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3prefix

                                                              interface MaintenanceWindowAutomationParametersProperty

                                                              interface MaintenanceWindowAutomationParametersProperty {}
                                                              • The MaintenanceWindowAutomationParameters property type specifies the parameters for an AUTOMATION task type for a maintenance window task in AWS Systems Manager .

                                                                MaintenanceWindowAutomationParameters is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.

                                                                For information about available parameters in Automation runbooks, you can view the content of the runbook itself in the Systems Manager console. For information, see [View runbook content](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-documents-reference-details.html#view-automation-json) in the *AWS Systems Manager User Guide* .

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html

                                                              property documentVersion

                                                              readonly documentVersion?: string;
                                                              • The version of an Automation runbook to use during task execution.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-documentversion

                                                              property parameters

                                                              readonly parameters?: any | cdk.IResolvable;
                                                              • The parameters for the AUTOMATION task.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-parameters

                                                              interface MaintenanceWindowLambdaParametersProperty

                                                              interface MaintenanceWindowLambdaParametersProperty {}
                                                              • The MaintenanceWindowLambdaParameters property type specifies the parameters for a LAMBDA task type for a maintenance window task in AWS Systems Manager .

                                                                MaintenanceWindowLambdaParameters is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html

                                                              property clientContext

                                                              readonly clientContext?: string;
                                                              • Client-specific information to pass to the AWS Lambda function that you're invoking. You can then use the context variable to process the client information in your AWS Lambda function.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-clientcontext

                                                              property payload

                                                              readonly payload?: string;
                                                              • JSON to provide to your AWS Lambda function as input.

                                                                > Although Type is listed as "String" for this property, the payload content must be formatted as a Base64-encoded binary data object.

                                                                *Length Constraint:* 4096

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-payload

                                                              property qualifier

                                                              readonly qualifier?: string;
                                                              • An AWS Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-qualifier

                                                              interface MaintenanceWindowRunCommandParametersProperty

                                                              interface MaintenanceWindowRunCommandParametersProperty {}
                                                              • The MaintenanceWindowRunCommandParameters property type specifies the parameters for a RUN_COMMAND task type for a maintenance window task in AWS Systems Manager . This means that these parameters are the same as those for the SendCommand API call. For more information about SendCommand parameters, see [SendCommand](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_SendCommand.html) in the *AWS Systems Manager API Reference* .

                                                                For information about available parameters in SSM Command documents, you can view the content of the document itself in the Systems Manager console. For information, see [Viewing SSM command document content](https://docs.aws.amazon.com/systems-manager/latest/userguide/viewing-ssm-document-content.html) in the *AWS Systems Manager User Guide* .

                                                                MaintenanceWindowRunCommandParameters is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html

                                                              property cloudWatchOutputConfig

                                                              readonly cloudWatchOutputConfig?:
                                                              | CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty
                                                              | cdk.IResolvable;
                                                              • Configuration options for sending command output to Amazon CloudWatch Logs.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-cloudwatchoutputconfig

                                                              property comment

                                                              readonly comment?: string;
                                                              • Information about the command or commands to run.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment

                                                              property documentHash

                                                              readonly documentHash?: string;
                                                              • The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash

                                                              property documentHashType

                                                              readonly documentHashType?: string;
                                                              • The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype

                                                              property documentVersion

                                                              readonly documentVersion?: string;
                                                              • The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

                                                                --document-version "\$DEFAULT"

                                                                --document-version "\$LATEST"

                                                                --document-version "3"

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documentversion

                                                              property notificationConfig

                                                              readonly notificationConfig?:
                                                              | CfnMaintenanceWindowTask.NotificationConfigProperty
                                                              | cdk.IResolvable;
                                                              • Configurations for sending notifications about command status changes on a per-managed node basis.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig

                                                              property outputS3BucketName

                                                              readonly outputS3BucketName?: string;
                                                              • The name of the Amazon Simple Storage Service (Amazon S3) bucket.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname

                                                              property outputS3KeyPrefix

                                                              readonly outputS3KeyPrefix?: string;
                                                              • The S3 bucket subfolder.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix

                                                              property parameters

                                                              readonly parameters?: any | cdk.IResolvable;
                                                              • The parameters for the RUN_COMMAND task execution.

                                                                The supported parameters are the same as those for the SendCommand API call. For more information, see [SendCommand](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_SendCommand.html) in the *AWS Systems Manager API Reference* .

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters

                                                              property serviceRoleArn

                                                              readonly serviceRoleArn?: string;
                                                              • The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-servicerolearn

                                                              property timeoutSeconds

                                                              readonly timeoutSeconds?: number;
                                                              • If this time is reached and the command hasn't already started running, it doesn't run.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds

                                                              interface MaintenanceWindowStepFunctionsParametersProperty

                                                              interface MaintenanceWindowStepFunctionsParametersProperty {}
                                                              • The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for the execution of a STEP_FUNCTIONS task in a Systems Manager maintenance window.

                                                                MaintenanceWindowStepFunctionsParameters is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html

                                                              property input

                                                              readonly input?: string;
                                                              • The inputs for the STEP_FUNCTIONS task.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input

                                                              property name

                                                              readonly name?: string;
                                                              • The name of the STEP_FUNCTIONS task.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-name

                                                              interface NotificationConfigProperty

                                                              interface NotificationConfigProperty {}
                                                              • The NotificationConfig property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager .

                                                                NotificationConfig is a property of the [MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) property type.

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html

                                                              property notificationArn

                                                              readonly notificationArn: string;
                                                              • An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn

                                                              property notificationEvents

                                                              readonly notificationEvents?: string[];
                                                              • The different events that you can receive notifications for. These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see [Configuring Amazon SNS Notifications for AWS Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) in the *AWS Systems Manager User Guide* .

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents

                                                              property notificationType

                                                              readonly notificationType?: string;
                                                              • The notification type.

                                                                - Command : Receive notification when the status of a command changes. - Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype

                                                              interface TargetProperty

                                                              interface TargetProperty {}
                                                              • The Target property type specifies targets (either instances or window target IDs). You specify instances by using Key=InstanceIds,Values=< *instanceid1* >,< *instanceid2* > . You specify window target IDs using Key=WindowTargetIds,Values=< *window-target-id-1* >,< *window-target-id-2* > for a maintenance window task in AWS Systems Manager .

                                                                Target is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) property type.

                                                                > To use resource-groups:Name as the key for a maintenance window target, specify the resource group as a AWS::SSM::MaintenanceWindowTarget type, and use the Ref function to specify the target for AWS::SSM::MaintenanceWindowTask . For an example, see *Create a Run Command task that targets instances using a resource group name* in [AWS::SSM::MaintenanceWindowTask Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#aws-resource-ssm-maintenancewindowtask--examples) .

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html

                                                              property key

                                                              readonly key: string;
                                                              • User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see [About 'register-task-with-maintenance-window' Options and Values](https://docs.aws.amazon.com/systems-manager/latest/userguide/register-tasks-options.html) in the *AWS Systems Manager User Guide* .

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key

                                                              property values

                                                              readonly values: string[];
                                                              • User-defined criteria that maps to Key . For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see [About 'register-task-with-maintenance-window' Options and Values](https://docs.aws.amazon.com/systems-manager/latest/userguide/register-tasks-options.html) in the *AWS Systems Manager User Guide* .

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values

                                                              interface TaskInvocationParametersProperty

                                                              interface TaskInvocationParametersProperty {}
                                                              • The TaskInvocationParameters property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager .

                                                                TaskInvocationParameters is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) property type.

                                                                external

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html

                                                              property maintenanceWindowAutomationParameters

                                                              readonly maintenanceWindowAutomationParameters?:
                                                              | CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty
                                                              | cdk.IResolvable;
                                                              • The parameters for an AUTOMATION task type.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowautomationparameters

                                                              property maintenanceWindowLambdaParameters

                                                              readonly maintenanceWindowLambdaParameters?:
                                                              | CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty
                                                              | cdk.IResolvable;
                                                              • The parameters for a LAMBDA task type.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowlambdaparameters

                                                              property maintenanceWindowRunCommandParameters

                                                              readonly maintenanceWindowRunCommandParameters?:
                                                              | CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty
                                                              | cdk.IResolvable;
                                                              • The parameters for a RUN_COMMAND task type.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowruncommandparameters

                                                              property maintenanceWindowStepFunctionsParameters

                                                              readonly maintenanceWindowStepFunctionsParameters?:
                                                              | CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty
                                                              | cdk.IResolvable;
                                                              • The parameters for a STEP_FUNCTIONS task type.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowstepfunctionsparameters

                                                              namespace CfnPatchBaseline

                                                              namespace CfnPatchBaseline {}

                                                                interface PatchFilterGroupProperty

                                                                interface PatchFilterGroupProperty {}
                                                                • The PatchFilterGroup property type specifies a set of patch filters for an AWS Systems Manager patch baseline, typically used for approval rules for a Systems Manager patch baseline.

                                                                  PatchFilterGroup is the property type for the GlobalFilters property of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource and the PatchFilterGroup property of the [Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html) property type.

                                                                  external

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html

                                                                property patchFilters

                                                                readonly patchFilters?:
                                                                | Array<CfnPatchBaseline.PatchFilterProperty | cdk.IResolvable>
                                                                | cdk.IResolvable;
                                                                • The set of patch filters that make up the group.

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters

                                                                interface PatchFilterProperty

                                                                interface PatchFilterProperty {}
                                                                • The PatchFilter property type defines a patch filter for an AWS Systems Manager patch baseline.

                                                                  The PatchFilters property of the [PatchFilterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html) property type contains a list of PatchFilter property types.

                                                                  You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For more information, see [DescribePatchProperties](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribePatchProperties.html) in the *AWS Systems Manager API Reference* .

                                                                  external

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html

                                                                property key

                                                                readonly key?: string;
                                                                • The key for the filter.

                                                                  For information about valid keys, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference* .

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-key

                                                                property values

                                                                readonly values?: string[];
                                                                • The value for the filter key.

                                                                  For information about valid values for each key based on operating system type, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference* .

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-values

                                                                interface PatchSourceProperty

                                                                interface PatchSourceProperty {}
                                                                • PatchSource is the property type for the Sources resource of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource.

                                                                  The AWS CloudFormation AWS::SSM::PatchSource resource is used to provide information about the patches to use to update target instances, including target operating systems and source repository. Applies to Linux instances only.

                                                                  external

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html

                                                                property configuration

                                                                readonly configuration?: string;
                                                                • The value of the yum repo configuration. For example:

                                                                  [main]

                                                                  name=MyCustomRepository

                                                                  baseurl=https://my-custom-repository

                                                                  enabled=1

                                                                  > For information about other options available for your yum repository configuration, see [dnf.conf(5)](https://docs.aws.amazon.com/https://man7.org/linux/man-pages/man5/dnf.conf.5.html) .

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-configuration

                                                                property name

                                                                readonly name?: string;
                                                                • The name specified to identify the patch source.

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-name

                                                                property products

                                                                readonly products?: string[];
                                                                • The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference* .

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-products

                                                                interface RuleGroupProperty

                                                                interface RuleGroupProperty {}
                                                                • The RuleGroup property type specifies a set of rules that define the approval rules for an AWS Systems Manager patch baseline.

                                                                  RuleGroup is the property type for the ApprovalRules property of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource.

                                                                  external

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html

                                                                property patchRules

                                                                readonly patchRules?:
                                                                | Array<CfnPatchBaseline.RuleProperty | cdk.IResolvable>
                                                                | cdk.IResolvable;
                                                                • The rules that make up the rule group.

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html#cfn-ssm-patchbaseline-rulegroup-patchrules

                                                                interface RuleProperty

                                                                interface RuleProperty {}
                                                                • The Rule property type specifies an approval rule for a Systems Manager patch baseline.

                                                                  The PatchRules property of the [RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html) property type contains a list of Rule property types.

                                                                  external

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html

                                                                property approveAfterDays

                                                                readonly approveAfterDays?: number;
                                                                • The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.

                                                                  You must specify a value for ApproveAfterDays .

                                                                  Exception: Not supported on Debian Server or Ubuntu Server.

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveafterdays

                                                                property approveUntilDate

                                                                readonly approveUntilDate?: string;
                                                                • The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Debian Server or Ubuntu Server.

                                                                  Enter dates in the format YYYY-MM-DD . For example, 2021-12-31 .

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveuntildate

                                                                property complianceLevel

                                                                readonly complianceLevel?: string;
                                                                • A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: UNSPECIFIED , CRITICAL , HIGH , MEDIUM , LOW , and INFORMATIONAL .

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-compliancelevel

                                                                property enableNonSecurity

                                                                readonly enableNonSecurity?: boolean | cdk.IResolvable;
                                                                • For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is false . Applies to Linux managed nodes only.

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-enablenonsecurity

                                                                property patchFilterGroup

                                                                readonly patchFilterGroup?:
                                                                | CfnPatchBaseline.PatchFilterGroupProperty
                                                                | cdk.IResolvable;
                                                                • The patch filter group that defines the criteria for the rule.

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-patchfiltergroup

                                                                namespace CfnResourceDataSync

                                                                namespace CfnResourceDataSync {}

                                                                  interface AwsOrganizationsSourceProperty

                                                                  interface AwsOrganizationsSourceProperty {}
                                                                  • Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations or, if an AWS organization isn't present, from multiple AWS Regions .

                                                                    external

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html

                                                                  property organizationalUnits

                                                                  readonly organizationalUnits?: string[];
                                                                  • The AWS Organizations organization units included in the sync.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationalunits

                                                                  property organizationSourceType

                                                                  readonly organizationSourceType: string;
                                                                  • If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationsourcetype

                                                                  interface S3DestinationProperty

                                                                  interface S3DestinationProperty {}
                                                                  • Information about the target S3 bucket for the resource data sync.

                                                                    external

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html

                                                                  property bucketName

                                                                  readonly bucketName: string;
                                                                  • The name of the S3 bucket where the aggregated data is stored.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketname

                                                                  property bucketPrefix

                                                                  readonly bucketPrefix?: string;
                                                                  • An Amazon S3 prefix for the bucket.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketprefix

                                                                  property bucketRegion

                                                                  readonly bucketRegion: string;
                                                                  • The AWS Region with the S3 bucket targeted by the resource data sync.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketregion

                                                                  property kmsKeyArn

                                                                  readonly kmsKeyArn?: string;
                                                                  • The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-kmskeyarn

                                                                  property syncFormat

                                                                  readonly syncFormat: string;
                                                                  • A supported sync format. The following format is currently supported: JsonSerDe

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-syncformat

                                                                  interface SyncSourceProperty

                                                                  interface SyncSourceProperty {}
                                                                  • Information about the source of the data included in the resource data sync.

                                                                    external

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html

                                                                  property awsOrganizationsSource

                                                                  readonly awsOrganizationsSource?:
                                                                  | CfnResourceDataSync.AwsOrganizationsSourceProperty
                                                                  | cdk.IResolvable;
                                                                  • Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-awsorganizationssource

                                                                  property includeFutureRegions

                                                                  readonly includeFutureRegions?: boolean | cdk.IResolvable;
                                                                  • Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-includefutureregions

                                                                  property sourceRegions

                                                                  readonly sourceRegions: string[];
                                                                  • The SyncSource AWS Regions included in the resource data sync.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourceregions

                                                                  property sourceType

                                                                  readonly sourceType: string;
                                                                  • The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations ) or SingleAccountMultiRegions .

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourcetype

                                                                  Package Files (3)

                                                                  Dependencies (5)

                                                                  Dev Dependencies (7)

                                                                  Peer Dependencies (5)

                                                                  Badge

                                                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-cdk/aws-ssm.

                                                                  • Markdown
                                                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-cdk/aws-ssm)
                                                                  • HTML
                                                                    <a href="https://www.jsdocs.io/package/@aws-cdk/aws-ssm"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>