@swamp/aws/ssm
v2026.04.03.2
AWS SSM infrastructure models
Labels
awsssmcloudinfrastructure
Contents
Install
$ swamp extension pull @swamp/aws/ssmRelease Notes
- Updated: association, document, maintenance_window, maintenance_window_target, maintenance_window_task, parameter, patch_baseline, resource_data_sync, resource_policy
@swamp/aws/ssm/associationv2026.04.03.2association.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| AssociationName? | string | The name of the association. |
| CalendarNames? | array | |
| ScheduleExpression? | string | A Cron or Rate expression that specifies when the association is applied to the target. |
| MaxErrors? | string | |
| Parameters? | record | Parameter values that the SSM document uses at runtime. |
| InstanceId? | string | The ID of the instance that the SSM document is associated with. |
| WaitForSuccessTimeoutSeconds? | number | |
| MaxConcurrency? | string | |
| ComplianceSeverity? | enum | |
| Targets? | array | The targets that the SSM document sends commands to. |
| SyncCompliance? | enum | |
| OutputLocation? | object | |
| ScheduleOffset? | number | |
| Name | string | The name of the SSM document. |
| ApplyOnlyAtCronInterval? | boolean | |
| DocumentVersion? | string | The version of the SSM document to associate with the target. |
| AutomationTargetParameterName? | string |
createCreate a SSM Association
getGet a SSM Association
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM Association |
updateUpdate a SSM Association
deleteDelete a SSM Association
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM Association |
syncSync SSM Association state from AWS
Resources
state(infinite)— SSM Association resource state
@swamp/aws/ssm/documentv2026.04.03.2document.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| DocumentFormat? | enum | Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format. |
| Requires? | array | A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document. |
| Content | string | The content for the Systems Manager document in JSON, YAML or String format. |
| TargetType? | string | Specify a target type to define the kinds of resources the document can run on. |
| DocumentType? | enum | The type of document to create. |
| VersionName? | string | An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed. |
| UpdateMethod? | enum | Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version. |
| Attachments? | array | A list of key and value pairs that describe attachments to a version of a document. |
| Tags? | array | 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. |
| Name? | string | A name for the Systems Manager document. |
createCreate a SSM Document
getGet a SSM Document
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM Document |
updateUpdate a SSM Document
deleteDelete a SSM Document
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM Document |
syncSync SSM Document state from AWS
Resources
state(infinite)— SSM Document resource state
@swamp/aws/ssm/maintenance-windowv2026.04.03.2maintenance_window.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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. |
| Description? | string | A description of the maintenance window. |
| AllowUnassociatedTargets | boolean | 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. |
| Cutoff | number | The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution. |
| Schedule | string | The schedule of the maintenance window in the form of a cron or rate expression. |
| Duration | number | The duration of the maintenance window in hours. |
| ScheduleOffset? | number | The number of days to wait to run a maintenance window after the scheduled cron expression date and time. |
| EndDate? | string | The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. |
| Tags? | array | 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. |
| Name | string | The name of the maintenance window. |
| ScheduleTimezone? | string | The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. |
createCreate a SSM MaintenanceWindow
getGet a SSM MaintenanceWindow
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM MaintenanceWindow |
updateUpdate a SSM MaintenanceWindow
deleteDelete a SSM MaintenanceWindow
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM MaintenanceWindow |
syncSync SSM MaintenanceWindow state from AWS
Resources
state(infinite)— SSM MaintenanceWindow resource state
@swamp/aws/ssm/maintenance-window-targetv2026.04.03.2maintenance_window_target.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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. |
| Description? | string | A description for the target. |
| WindowId | string | The ID of the maintenance window to register the target with. |
| ResourceType | string | The type of target that is being registered with the maintenance window. |
| Targets | array | The targets to register with the maintenance window. |
| Name? | string | The name for the maintenance window target. |
createCreate a SSM MaintenanceWindowTarget
getGet a SSM MaintenanceWindowTarget
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM MaintenanceWindowTarget |
updateUpdate a SSM MaintenanceWindowTarget
deleteDelete a SSM MaintenanceWindowTarget
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM MaintenanceWindowTarget |
syncSync SSM MaintenanceWindowTarget state from AWS
Resources
state(infinite)— SSM MaintenanceWindowTarget resource state
@swamp/aws/ssm/maintenance-window-taskv2026.04.03.2maintenance_window_task.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| MaxErrors? | string | The maximum number of errors allowed before this task stops being scheduled. |
| Description? | string | A description of the task. |
| ServiceRoleArn? | string | The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. |
| 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. |
| MaxConcurrency? | string | The maximum number of targets this task can be run for, in parallel. |
| Targets? | array | The targets (either instances or window target ids). |
| Name? | string | The task name. |
| TaskArn | string | The resource that the task uses during execution. |
| TaskInvocationParameters? | object | 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. |
| WindowId | string | The ID of the maintenance window where the task is registered. |
| TaskParameters? | string | The parameters to pass to the task when it runs. |
| TaskType | string | The type of task. |
| CutoffBehavior? | string | The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. |
| LoggingInfo? | object | Information about an Amazon S3 bucket to write Run Command task-level logs to. |
createCreate a SSM MaintenanceWindowTask
getGet a SSM MaintenanceWindowTask
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM MaintenanceWindowTask |
updateUpdate a SSM MaintenanceWindowTask
deleteDelete a SSM MaintenanceWindowTask
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM MaintenanceWindowTask |
syncSync SSM MaintenanceWindowTask state from AWS
Resources
state(infinite)— SSM MaintenanceWindowTask resource state
@swamp/aws/ssm/parameterv2026.04.03.2parameter.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| Type | enum | The type of parameter. Parameters of type SecureString are not supported by CFNlong. |
| 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. |
| Description? | string | Information about the parameter. |
| 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 *User Guide*. |
| 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+$ |
| Tier? | enum | The parameter tier. |
| Tags? | record | 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 SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. |
| DataType? | enum | The data type of the parameter, such as text or aws:ec2:image. The default is text. |
| Name? | string | The name of the parameter. The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters. This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a paramet |
createCreate a SSM Parameter
getGet a SSM Parameter
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM Parameter |
updateUpdate a SSM Parameter
deleteDelete a SSM Parameter
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM Parameter |
syncSync SSM Parameter state from AWS
Resources
state(infinite)— SSM Parameter resource state
@swamp/aws/ssm/patch-baselinev2026.04.03.2patch_baseline.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| DefaultBaseline? | boolean | Set the baseline as default baseline. Only registering to default patch baseline is allowed. |
| OperatingSystem? | enum | Defines the operating system the patch baseline applies to. The Default value is WINDOWS. |
| Description? | string | The description of the patch baseline. |
| ApprovalRules? | object | A set of rules defining the approval rules for a patch baseline. |
| Sources? | array | Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only. |
| Name | string | The name of the patch baseline. |
| RejectedPatches? | array | A list of explicitly rejected patches for the baseline. |
| ApprovedPatches? | array | A list of explicitly approved patches for the baseline. |
| RejectedPatchesAction? | enum | The action for Patch Manager to take on patches included in the RejectedPackages list. |
| PatchGroups? | array | PatchGroups is used to associate instances with a specific patch baseline |
| ApprovedPatchesComplianceLevel? | enum | Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED. |
| ApprovedPatchesEnableNonSecurity? | boolean | Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only. |
| GlobalFilters? | object | A set of global filters used to include patches in the baseline. |
| AvailableSecurityUpdatesComplianceStatus? | enum | The compliance status for vendor recommended security updates that are not approved by this patch baseline. |
| Tags? | array | Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways. |
createCreate a SSM PatchBaseline
getGet a SSM PatchBaseline
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM PatchBaseline |
updateUpdate a SSM PatchBaseline
deleteDelete a SSM PatchBaseline
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM PatchBaseline |
syncSync SSM PatchBaseline state from AWS
Resources
state(infinite)— SSM PatchBaseline resource state
@swamp/aws/ssm/resource-data-syncv2026.04.03.2resource_data_sync.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| S3Destination? | object | |
| KMSKeyArn? | string | |
| SyncSource? | object | |
| BucketName? | string | |
| BucketRegion? | string | |
| SyncFormat? | string | |
| SyncName | string | |
| SyncType? | string | |
| BucketPrefix? | string |
createCreate a SSM ResourceDataSync
getGet a SSM ResourceDataSync
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM ResourceDataSync |
updateUpdate a SSM ResourceDataSync
deleteDelete a SSM ResourceDataSync
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM ResourceDataSync |
syncSync SSM ResourceDataSync state from AWS
Resources
state(infinite)— SSM ResourceDataSync resource state
@swamp/aws/ssm/resource-policyv2026.04.03.2resource_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ResourceArn | string | Arn of OpsItemGroup etc. |
| Policy | string | Actual policy statement. |
createCreate a SSM ResourcePolicy
getGet a SSM ResourcePolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM ResourcePolicy |
updateUpdate a SSM ResourcePolicy
deleteDelete a SSM ResourcePolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSM ResourcePolicy |
syncSync SSM ResourcePolicy state from AWS
Resources
state(infinite)— SSM ResourcePolicy resource state
2026.03.19.11.9 MBMar 19, 2026
AWS SSM infrastructure models
Release Notes
- Updated: association, document, maintenance_window, maintenance_window_target, maintenance_window_task, parameter, patch_baseline, resource_data_sync, resource_policy
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awsssmcloudinfrastructure
2026.03.16.11.8 MBMar 16, 2026
AWS SSM infrastructure models
Release Notes
- Updated: association, document, maintenance_window, maintenance_window_target, maintenance_window_task, parameter, patch_baseline, resource_data_sync, resource_policy
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awsssmcloudinfrastructure
2026.03.10.51.8 MBMar 10, 2026
AWS SSM infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awsssmcloudinfrastructure