Skip to content

Commit a1a2300

Browse files
author
AWS
committed
Amazon Simple Systems Manager (SSM) Update: This release adds an optional Duration parameter to StateManager Associations. This allows customers to specify how long an apply-only-on-cron association execution should run. Once the specified Duration is out all the ongoing cancellable commands or automations are cancelled.
1 parent 7c6b203 commit a1a2300

File tree

2 files changed

+54
-12
lines changed

2 files changed

+54
-12
lines changed

‎.changes/next-release/feature-AmazonSimpleSystemsManagerSSM-0468918.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Simple Systems Manager (SSM)",
4+
"contributor": "",
5+
"description": "This release adds an optional Duration parameter to StateManager Associations. This allows customers to specify how long an apply-only-on-cron association execution should run. Once the specified Duration is out all the ongoing cancellable commands or automations are cancelled."
6+
}

‎services/ssm/src/main/resources/codegen-resources/service-2.json

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@
582582
"errors":[
583583
{"shape":"InternalServerError"}
584584
],
585-
"documentation":"<p>Lists all patches eligible to be included in a patch baseline.</p>"
585+
"documentation":"<p>Lists all patches eligible to be included in a patch baseline.</p> <note> <p>Currently, <code>DescribeAvailablePatches</code> supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.</p> </note>"
586586
},
587587
"DescribeDocument":{
588588
"name":"DescribeDocument",
@@ -2504,6 +2504,11 @@
25042504
"documentation":"<p>Number of days to wait after the scheduled day to run an association.</p>",
25052505
"box":true
25062506
},
2507+
"Duration":{
2508+
"shape":"Duration",
2509+
"documentation":"<p>The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.</p>",
2510+
"box":true
2511+
},
25072512
"TargetMaps":{
25082513
"shape":"TargetMaps",
25092514
"documentation":"<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>",
@@ -2633,6 +2638,11 @@
26332638
"documentation":"<p>Number of days to wait after the scheduled day to run an association.</p>",
26342639
"box":true
26352640
},
2641+
"Duration":{
2642+
"shape":"Duration",
2643+
"documentation":"<p>The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.</p>",
2644+
"box":true
2645+
},
26362646
"TargetMaps":{
26372647
"shape":"TargetMaps",
26382648
"documentation":"<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>",
@@ -3066,6 +3076,11 @@
30663076
"documentation":"<p>Number of days to wait after the scheduled day to run an association.</p>",
30673077
"box":true
30683078
},
3079+
"Duration":{
3080+
"shape":"Duration",
3081+
"documentation":"<p>The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.</p>",
3082+
"box":true
3083+
},
30693084
"TargetMaps":{
30703085
"shape":"TargetMaps",
30713086
"documentation":"<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>",
@@ -4560,6 +4575,11 @@
45604575
"documentation":"<p>Number of days to wait after the scheduled day to run an association.</p>",
45614576
"box":true
45624577
},
4578+
"Duration":{
4579+
"shape":"Duration",
4580+
"documentation":"<p>The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot. </p> <p>The <code>Duration</code> parameter applies only when both these conditions are true:</p> <ul> <li> <p>The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. </p> </li> <li> <p>The command specifies the <code> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociationBatchRequestEntry.html#systemsmanager-Type-CreateAssociationBatchRequestEntry-ApplyOnlyAtCronInterval\">ApplyOnlyAtCronInterval</a> </code> parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.</p> </li> </ul>",
4581+
"box":true
4582+
},
45634583
"TargetMaps":{
45644584
"shape":"TargetMaps",
45654585
"documentation":"<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>",
@@ -4655,6 +4675,11 @@
46554675
"documentation":"<p>Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html\">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p> <note> <p>To use offsets, you must specify the <code>ApplyOnlyAtCronInterval</code> parameter. This option tells the system not to run an association immediately after you create it. </p> </note>",
46564676
"box":true
46574677
},
4678+
"Duration":{
4679+
"shape":"Duration",
4680+
"documentation":"<p>The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot. </p> <p>The <code>Duration</code> parameter applies only when both these conditions are true:</p> <ul> <li> <p>The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. </p> </li> <li> <p>The command specifies the <code> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html#systemsmanager-CreateAssociation-request-ApplyOnlyAtCronInterval\">ApplyOnlyAtCronInterval</a> </code> parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.</p> </li> </ul>",
4681+
"box":true
4682+
},
46584683
"TargetMaps":{
46594684
"shape":"TargetMaps",
46604685
"documentation":"<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>",
@@ -5726,7 +5751,7 @@
57265751
},
57275752
"VersionName":{
57285753
"shape":"DocumentVersionName",
5729-
"documentation":"<p>An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.</p>"
5754+
"documentation":"<p>An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>"
57305755
}
57315756
}
57325757
},
@@ -6845,7 +6870,7 @@
68456870
},
68466871
"VersionName":{
68476872
"shape":"DocumentVersionName",
6848-
"documentation":"<p>An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.</p>"
6873+
"documentation":"<p>An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>"
68496874
},
68506875
"PlatformTypes":{
68516876
"shape":"PlatformTypeList",
@@ -7026,7 +7051,7 @@
70267051
},
70277052
"VersionName":{
70287053
"shape":"DocumentVersionName",
7029-
"documentation":"<p>An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.</p>"
7054+
"documentation":"<p>An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>"
70307055
}
70317056
},
70327057
"documentation":"<p>An SSM document required by the current document.</p>"
@@ -7178,7 +7203,7 @@
71787203
},
71797204
"VersionName":{
71807205
"shape":"DocumentVersionName",
7181-
"documentation":"<p>The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.</p>"
7206+
"documentation":"<p>The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>"
71827207
},
71837208
"CreatedDate":{
71847209
"shape":"DateTime",
@@ -7260,6 +7285,12 @@
72607285
"documentation":"<p>You can't specify a managed node ID in more than one association.</p>",
72617286
"exception":true
72627287
},
7288+
"Duration":{
7289+
"type":"integer",
7290+
"box":true,
7291+
"max":24,
7292+
"min":1
7293+
},
72637294
"EffectiveInstanceAssociationMaxResults":{
72647295
"type":"integer",
72657296
"max":5,
@@ -7524,7 +7555,7 @@
75247555
},
75257556
"Status":{
75267557
"shape":"ConnectionStatus",
7527-
"documentation":"<p>The status of the connection to the managed node. For example, 'Connected' or 'Not Connected'.</p>"
7558+
"documentation":"<p>The status of the connection to the managed node.</p>"
75287559
}
75297560
}
75307561
},
@@ -7602,7 +7633,7 @@
76027633
},
76037634
"VersionName":{
76047635
"shape":"DocumentVersionName",
7605-
"documentation":"<p>An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document and can't be changed.</p>"
7636+
"documentation":"<p>An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document and can't be changed.</p>"
76067637
},
76077638
"DocumentVersion":{
76087639
"shape":"DocumentVersion",
@@ -7631,7 +7662,7 @@
76317662
},
76327663
"VersionName":{
76337664
"shape":"DocumentVersionName",
7634-
"documentation":"<p>The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.</p>"
7665+
"documentation":"<p>The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>"
76357666
},
76367667
"DocumentVersion":{
76377668
"shape":"DocumentVersion",
@@ -12551,7 +12582,7 @@
1255112582
},
1255212583
"KeyId":{
1255312584
"shape":"ParameterKeyId",
12554-
"documentation":"<p>The ID of the query key used for this parameter.</p>"
12585+
"documentation":"<p>The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to <code>SecureString</code> parameters only</p>"
1255512586
},
1255612587
"LastModifiedDate":{
1255712588
"shape":"DateTime",
@@ -12668,7 +12699,7 @@
1266812699
},
1266912700
"KeyId":{
1267012701
"shape":"ParameterKeyId",
12671-
"documentation":"<p>The ID of the query key used for this parameter.</p>"
12702+
"documentation":"<p>The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to <code>SecureString</code> parameters only.</p>"
1267212703
},
1267312704
"LastModifiedDate":{
1267412705
"shape":"DateTime",
@@ -13095,7 +13126,7 @@
1309513126
},
1309613127
"CVEIds":{
1309713128
"shape":"PatchCVEIds",
13098-
"documentation":"<p>The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.</p>"
13129+
"documentation":"<p>The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.</p> <note> <p>Currently, CVE ID values are reported only for patches with a status of <code>Missing</code> or <code>Failed</code>.</p> </note>"
1309913130
}
1310013131
},
1310113132
"documentation":"<p>Information about the state of a patch on a particular managed node as it relates to the patch baseline used to patch the node.</p>"
@@ -15894,6 +15925,11 @@
1589415925
"documentation":"<p>Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html\">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p> <note> <p>To use offsets, you must specify the <code>ApplyOnlyAtCronInterval</code> parameter. This option tells the system not to run an association immediately after you create it. </p> </note>",
1589515926
"box":true
1589615927
},
15928+
"Duration":{
15929+
"shape":"Duration",
15930+
"documentation":"<p>The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot. </p> <p>The <code>Duration</code> parameter applies only when both these conditions are true:</p> <ul> <li> <p>The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. </p> </li> <li> <p>The command specifies the <code> <a href=\"https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_UpdateAssociation.html#systemsmanager-UpdateAssociation-request-ApplyOnlyAtCronInterval\">ApplyOnlyAtCronInterval</a> </code> parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.</p> </li> </ul>",
15931+
"box":true
15932+
},
1589715933
"TargetMaps":{
1589815934
"shape":"TargetMaps",
1589915935
"documentation":"<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>",
@@ -16019,7 +16055,7 @@
1601916055
},
1602016056
"VersionName":{
1602116057
"shape":"DocumentVersionName",
16022-
"documentation":"<p>An optional field specifying the version of the artifact you are updating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed.</p>"
16058+
"documentation":"<p>An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>"
1602316059
},
1602416060
"DocumentVersion":{
1602516061
"shape":"DocumentVersion",

0 commit comments

Comments
 (0)