UNPKG

157 kBTypeScriptView Raw
1import * as cdk from '@aws-cdk/core';
2import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
3/**
4 * Properties for defining a `CfnAssociation`
5 *
6 * @struct
7 * @stability external
8 *
9 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html
10 */
11export interface CfnAssociationProps {
12 /**
13 * 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:
14 *
15 * `arn:partition:ssm:region:account-id:document/document-name`
16 *
17 * For example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
18 *
19 * 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` .
20 *
21 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name
22 */
23 readonly name: string;
24 /**
25 * 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.
26 *
27 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval
28 */
29 readonly applyOnlyAtCronInterval?: boolean | cdk.IResolvable;
30 /**
31 * Specify a descriptive name for the association.
32 *
33 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname
34 */
35 readonly associationName?: string;
36 /**
37 * 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 .
38 *
39 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername
40 */
41 readonly automationTargetParameterName?: string;
42 /**
43 * 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) .
44 *
45 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames
46 */
47 readonly calendarNames?: string[];
48 /**
49 * The severity level that is assigned to the association.
50 *
51 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity
52 */
53 readonly complianceSeverity?: string;
54 /**
55 * The version of the SSM document to associate with the target.
56 *
57 * > Note the following important information.
58 * >
59 * > - 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` .
60 * > - `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: <token>, HandlerErrorCode: GeneralServiceException).
61 *
62 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion
63 */
64 readonly documentVersion?: string;
65 /**
66 * The ID of the instance that the SSM document is associated with. You must specify the `InstanceId` or `Targets` property.
67 *
68 * > `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.
69 *
70 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid
71 */
72 readonly instanceId?: string;
73 /**
74 * 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.
75 *
76 * 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` .
77 *
78 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency
79 */
80 readonly maxConcurrency?: string;
81 /**
82 * 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.
83 *
84 * 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.
85 *
86 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors
87 */
88 readonly maxErrors?: string;
89 /**
90 * An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
91 *
92 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation
93 */
94 readonly outputLocation?: CfnAssociation.InstanceAssociationOutputLocationProperty | cdk.IResolvable;
95 /**
96 * The parameters for the runtime configuration of the document.
97 *
98 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters
99 */
100 readonly parameters?: any | cdk.IResolvable;
101 /**
102 * A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
103 *
104 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression
105 */
106 readonly scheduleExpression?: string;
107 /**
108 * Number of days to wait after the scheduled day to run an association.
109 *
110 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset
111 */
112 readonly scheduleOffset?: number;
113 /**
114 * 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` .
115 *
116 * 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.
117 *
118 * By default, all associations use `AUTO` mode.
119 *
120 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance
121 */
122 readonly syncCompliance?: string;
123 /**
124 * 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.
125 *
126 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets
127 */
128 readonly targets?: Array<CfnAssociation.TargetProperty | cdk.IResolvable> | cdk.IResolvable;
129 /**
130 * 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.
131 *
132 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds
133 */
134 readonly waitForSuccessTimeoutSeconds?: number;
135}
136/**
137 * A CloudFormation `AWS::SSM::Association`
138 *
139 * 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.
140 *
141 * @cloudformationResource AWS::SSM::Association
142 * @stability external
143 *
144 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html
145 */
146export declare class CfnAssociation extends cdk.CfnResource implements cdk.IInspectable {
147 /**
148 * The CloudFormation resource type name for this resource class.
149 */
150 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::Association";
151 /**
152 * A factory method that creates a new instance of this class from an object
153 * containing the CloudFormation properties of this resource.
154 * Used in the @aws-cdk/cloudformation-include module.
155 *
156 * @internal
157 */
158 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAssociation;
159 /**
160 * The association ID.
161 * @cloudformationAttribute AssociationId
162 */
163 readonly attrAssociationId: string;
164 /**
165 * 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:
166 *
167 * `arn:partition:ssm:region:account-id:document/document-name`
168 *
169 * For example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
170 *
171 * 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` .
172 *
173 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name
174 */
175 name: string;
176 /**
177 * 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.
178 *
179 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval
180 */
181 applyOnlyAtCronInterval: boolean | cdk.IResolvable | undefined;
182 /**
183 * Specify a descriptive name for the association.
184 *
185 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname
186 */
187 associationName: string | undefined;
188 /**
189 * 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 .
190 *
191 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername
192 */
193 automationTargetParameterName: string | undefined;
194 /**
195 * 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) .
196 *
197 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames
198 */
199 calendarNames: string[] | undefined;
200 /**
201 * The severity level that is assigned to the association.
202 *
203 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity
204 */
205 complianceSeverity: string | undefined;
206 /**
207 * The version of the SSM document to associate with the target.
208 *
209 * > Note the following important information.
210 * >
211 * > - 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` .
212 * > - `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: <token>, HandlerErrorCode: GeneralServiceException).
213 *
214 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion
215 */
216 documentVersion: string | undefined;
217 /**
218 * The ID of the instance that the SSM document is associated with. You must specify the `InstanceId` or `Targets` property.
219 *
220 * > `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.
221 *
222 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid
223 */
224 instanceId: string | undefined;
225 /**
226 * 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.
227 *
228 * 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` .
229 *
230 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency
231 */
232 maxConcurrency: string | undefined;
233 /**
234 * 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.
235 *
236 * 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.
237 *
238 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors
239 */
240 maxErrors: string | undefined;
241 /**
242 * An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
243 *
244 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation
245 */
246 outputLocation: CfnAssociation.InstanceAssociationOutputLocationProperty | cdk.IResolvable | undefined;
247 /**
248 * The parameters for the runtime configuration of the document.
249 *
250 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters
251 */
252 parameters: any | cdk.IResolvable | undefined;
253 /**
254 * A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
255 *
256 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression
257 */
258 scheduleExpression: string | undefined;
259 /**
260 * Number of days to wait after the scheduled day to run an association.
261 *
262 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset
263 */
264 scheduleOffset: number | undefined;
265 /**
266 * 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` .
267 *
268 * 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.
269 *
270 * By default, all associations use `AUTO` mode.
271 *
272 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance
273 */
274 syncCompliance: string | undefined;
275 /**
276 * 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.
277 *
278 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets
279 */
280 targets: Array<CfnAssociation.TargetProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
281 /**
282 * 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.
283 *
284 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds
285 */
286 waitForSuccessTimeoutSeconds: number | undefined;
287 /**
288 * Create a new `AWS::SSM::Association`.
289 *
290 * @param scope - scope in which this resource is defined
291 * @param id - scoped id of the resource
292 * @param props - resource properties
293 */
294 constructor(scope: cdk.Construct, id: string, props: CfnAssociationProps);
295 /**
296 * Examines the CloudFormation resource and discloses attributes.
297 *
298 * @param inspector - tree inspector to collect and process attributes
299 *
300 */
301 inspect(inspector: cdk.TreeInspector): void;
302 protected get cfnProperties(): {
303 [key: string]: any;
304 };
305 protected renderProperties(props: {
306 [key: string]: any;
307 }): {
308 [key: string]: any;
309 };
310}
311export declare namespace CfnAssociation {
312 /**
313 * `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.
314 *
315 * 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* .
316 *
317 * @struct
318 * @stability external
319 *
320 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html
321 */
322 interface InstanceAssociationOutputLocationProperty {
323 /**
324 * `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.
325 *
326 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html#cfn-ssm-association-instanceassociationoutputlocation-s3location
327 */
328 readonly s3Location?: CfnAssociation.S3OutputLocationProperty | cdk.IResolvable;
329 }
330}
331export declare namespace CfnAssociation {
332 /**
333 * `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.
334 *
335 * @struct
336 * @stability external
337 *
338 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html
339 */
340 interface S3OutputLocationProperty {
341 /**
342 * The name of the S3 bucket.
343 *
344 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3bucketname
345 */
346 readonly outputS3BucketName?: string;
347 /**
348 * The S3 bucket subfolder.
349 *
350 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3keyprefix
351 */
352 readonly outputS3KeyPrefix?: string;
353 /**
354 * The AWS Region of the S3 bucket.
355 *
356 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3region
357 */
358 readonly outputS3Region?: string;
359 }
360}
361export declare namespace CfnAssociation {
362 /**
363 * `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.
364 *
365 * @struct
366 * @stability external
367 *
368 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html
369 */
370 interface TargetProperty {
371 /**
372 * User-defined criteria for sending commands that target managed nodes that meet the criteria.
373 *
374 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key
375 */
376 readonly key: string;
377 /**
378 * 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` .
379 *
380 * Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
381 *
382 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values
383 */
384 readonly values: string[];
385 }
386}
387/**
388 * Properties for defining a `CfnDocument`
389 *
390 * @struct
391 * @stability external
392 *
393 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html
394 */
395export interface CfnDocumentProps {
396 /**
397 * The content for the new SSM document in JSON or YAML. For more information about the schemas for SSM document content, see [SSM document schema features and examples](https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html) in the *AWS Systems Manager User Guide* .
398 *
399 * > This parameter also supports `String` data types.
400 *
401 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content
402 */
403 readonly content: any | cdk.IResolvable;
404 /**
405 * A list of key-value pairs that describe attachments to a version of a document.
406 *
407 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments
408 */
409 readonly attachments?: Array<CfnDocument.AttachmentsSourceProperty | cdk.IResolvable> | cdk.IResolvable;
410 /**
411 * Specify the document format for the request. JSON is the default format.
412 *
413 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat
414 */
415 readonly documentFormat?: string;
416 /**
417 * The type of document to create.
418 *
419 * *Allowed Values* : `ApplicationConfigurationSchema` | `Automation` | `Automation.ChangeTemplate` | `Command` | `DeploymentStrategy` | `Package` | `Policy` | `Session`
420 *
421 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype
422 */
423 readonly documentType?: string;
424 /**
425 * A name for the SSM document.
426 *
427 * > You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:
428 * >
429 * > - `aws`
430 * > - `amazon`
431 * > - `amzn`
432 *
433 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name
434 */
435 readonly name?: string;
436 /**
437 * 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* .
438 *
439 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires
440 */
441 readonly requires?: Array<CfnDocument.DocumentRequiresProperty | cdk.IResolvable> | cdk.IResolvable;
442 /**
443 * AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.
444 *
445 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags
446 */
447 readonly tags?: cdk.CfnTag[];
448 /**
449 * 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* .
450 *
451 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype
452 */
453 readonly targetType?: string;
454 /**
455 * 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.
456 *
457 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod
458 */
459 readonly updateMethod?: string;
460 /**
461 * 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.
462 *
463 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname
464 */
465 readonly versionName?: string;
466}
467/**
468 * A CloudFormation `AWS::SSM::Document`
469 *
470 * 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.
471 *
472 * > This resource does not support CloudFormation drift detection.
473 *
474 * @cloudformationResource AWS::SSM::Document
475 * @stability external
476 *
477 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html
478 */
479export declare class CfnDocument extends cdk.CfnResource implements cdk.IInspectable {
480 /**
481 * The CloudFormation resource type name for this resource class.
482 */
483 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::Document";
484 /**
485 * A factory method that creates a new instance of this class from an object
486 * containing the CloudFormation properties of this resource.
487 * Used in the @aws-cdk/cloudformation-include module.
488 *
489 * @internal
490 */
491 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDocument;
492 /**
493 * The content for the new SSM document in JSON or YAML. For more information about the schemas for SSM document content, see [SSM document schema features and examples](https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html) in the *AWS Systems Manager User Guide* .
494 *
495 * > This parameter also supports `String` data types.
496 *
497 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content
498 */
499 content: any | cdk.IResolvable;
500 /**
501 * A list of key-value pairs that describe attachments to a version of a document.
502 *
503 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments
504 */
505 attachments: Array<CfnDocument.AttachmentsSourceProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
506 /**
507 * Specify the document format for the request. JSON is the default format.
508 *
509 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat
510 */
511 documentFormat: string | undefined;
512 /**
513 * The type of document to create.
514 *
515 * *Allowed Values* : `ApplicationConfigurationSchema` | `Automation` | `Automation.ChangeTemplate` | `Command` | `DeploymentStrategy` | `Package` | `Policy` | `Session`
516 *
517 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype
518 */
519 documentType: string | undefined;
520 /**
521 * A name for the SSM document.
522 *
523 * > You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:
524 * >
525 * > - `aws`
526 * > - `amazon`
527 * > - `amzn`
528 *
529 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name
530 */
531 name: string | undefined;
532 /**
533 * 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* .
534 *
535 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires
536 */
537 requires: Array<CfnDocument.DocumentRequiresProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
538 /**
539 * AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.
540 *
541 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags
542 */
543 readonly tags: cdk.TagManager;
544 /**
545 * 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* .
546 *
547 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype
548 */
549 targetType: string | undefined;
550 /**
551 * 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.
552 *
553 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod
554 */
555 updateMethod: string | undefined;
556 /**
557 * 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.
558 *
559 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname
560 */
561 versionName: string | undefined;
562 /**
563 * Create a new `AWS::SSM::Document`.
564 *
565 * @param scope - scope in which this resource is defined
566 * @param id - scoped id of the resource
567 * @param props - resource properties
568 */
569 constructor(scope: cdk.Construct, id: string, props: CfnDocumentProps);
570 /**
571 * Examines the CloudFormation resource and discloses attributes.
572 *
573 * @param inspector - tree inspector to collect and process attributes
574 *
575 */
576 inspect(inspector: cdk.TreeInspector): void;
577 protected get cfnProperties(): {
578 [key: string]: any;
579 };
580 protected renderProperties(props: {
581 [key: string]: any;
582 }): {
583 [key: string]: any;
584 };
585}
586export declare namespace CfnDocument {
587 /**
588 * 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.
589 *
590 * @struct
591 * @stability external
592 *
593 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html
594 */
595 interface AttachmentsSourceProperty {
596 /**
597 * The key of a key-value pair that identifies the location of an attachment to a document.
598 *
599 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-key
600 */
601 readonly key?: string;
602 /**
603 * The name of the document attachment file.
604 *
605 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-name
606 */
607 readonly name?: string;
608 /**
609 * 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.
610 *
611 * - For the key *SourceUrl* , the value is an S3 bucket location. For example:
612 *
613 * `"Values": [ "s3://doc-example-bucket/my-folder" ]`
614 * - For the key *S3FileUrl* , the value is a file in an S3 bucket. For example:
615 *
616 * `"Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]`
617 * - 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:
618 *
619 * `"Values": [ "MyOtherDocument/3/my-other-file.py" ]`
620 *
621 * 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:
622 *
623 * `"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]`
624 *
625 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-values
626 */
627 readonly values?: string[];
628 }
629}
630export declare namespace CfnDocument {
631 /**
632 * An SSM document required by the current document.
633 *
634 * @struct
635 * @stability external
636 *
637 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html
638 */
639 interface DocumentRequiresProperty {
640 /**
641 * The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
642 *
643 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-name
644 */
645 readonly name?: string;
646 /**
647 * The document version required by the current document.
648 *
649 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-version
650 */
651 readonly version?: string;
652 }
653}
654/**
655 * Properties for defining a `CfnMaintenanceWindow`
656 *
657 * @struct
658 * @stability external
659 *
660 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html
661 */
662export interface CfnMaintenanceWindowProps {
663 /**
664 * 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.
665 *
666 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets
667 */
668 readonly allowUnassociatedTargets: boolean | cdk.IResolvable;
669 /**
670 * The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
671 *
672 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff
673 */
674 readonly cutoff: number;
675 /**
676 * The duration of the maintenance window in hours.
677 *
678 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration
679 */
680 readonly duration: number;
681 /**
682 * The name of the maintenance window.
683 *
684 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name
685 */
686 readonly name: string;
687 /**
688 * The schedule of the maintenance window in the form of a cron or rate expression.
689 *
690 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule
691 */
692 readonly schedule: string;
693 /**
694 * A description of the maintenance window.
695 *
696 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description
697 */
698 readonly description?: string;
699 /**
700 * The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
701 *
702 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate
703 */
704 readonly endDate?: string;
705 /**
706 * The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
707 *
708 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset
709 */
710 readonly scheduleOffset?: number;
711 /**
712 * The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
713 *
714 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone
715 */
716 readonly scheduleTimezone?: string;
717 /**
718 * 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.
719 *
720 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate
721 */
722 readonly startDate?: string;
723 /**
724 * 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.
725 *
726 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags
727 */
728 readonly tags?: cdk.CfnTag[];
729}
730/**
731 * A CloudFormation `AWS::SSM::MaintenanceWindow`
732 *
733 * 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.
734 *
735 * 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* .
736 *
737 * @cloudformationResource AWS::SSM::MaintenanceWindow
738 * @stability external
739 *
740 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html
741 */
742export declare class CfnMaintenanceWindow extends cdk.CfnResource implements cdk.IInspectable {
743 /**
744 * The CloudFormation resource type name for this resource class.
745 */
746 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::MaintenanceWindow";
747 /**
748 * A factory method that creates a new instance of this class from an object
749 * containing the CloudFormation properties of this resource.
750 * Used in the @aws-cdk/cloudformation-include module.
751 *
752 * @internal
753 */
754 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMaintenanceWindow;
755 /**
756 * 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.
757 *
758 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets
759 */
760 allowUnassociatedTargets: boolean | cdk.IResolvable;
761 /**
762 * The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
763 *
764 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff
765 */
766 cutoff: number;
767 /**
768 * The duration of the maintenance window in hours.
769 *
770 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration
771 */
772 duration: number;
773 /**
774 * The name of the maintenance window.
775 *
776 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name
777 */
778 name: string;
779 /**
780 * The schedule of the maintenance window in the form of a cron or rate expression.
781 *
782 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule
783 */
784 schedule: string;
785 /**
786 * A description of the maintenance window.
787 *
788 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description
789 */
790 description: string | undefined;
791 /**
792 * The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
793 *
794 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate
795 */
796 endDate: string | undefined;
797 /**
798 * The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
799 *
800 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset
801 */
802 scheduleOffset: number | undefined;
803 /**
804 * The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
805 *
806 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone
807 */
808 scheduleTimezone: string | undefined;
809 /**
810 * 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.
811 *
812 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate
813 */
814 startDate: string | undefined;
815 /**
816 * 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.
817 *
818 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags
819 */
820 readonly tags: cdk.TagManager;
821 /**
822 * Create a new `AWS::SSM::MaintenanceWindow`.
823 *
824 * @param scope - scope in which this resource is defined
825 * @param id - scoped id of the resource
826 * @param props - resource properties
827 */
828 constructor(scope: cdk.Construct, id: string, props: CfnMaintenanceWindowProps);
829 /**
830 * Examines the CloudFormation resource and discloses attributes.
831 *
832 * @param inspector - tree inspector to collect and process attributes
833 *
834 */
835 inspect(inspector: cdk.TreeInspector): void;
836 protected get cfnProperties(): {
837 [key: string]: any;
838 };
839 protected renderProperties(props: {
840 [key: string]: any;
841 }): {
842 [key: string]: any;
843 };
844}
845/**
846 * Properties for defining a `CfnMaintenanceWindowTarget`
847 *
848 * @struct
849 * @stability external
850 *
851 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html
852 */
853export interface CfnMaintenanceWindowTargetProps {
854 /**
855 * The type of target that is being registered with the maintenance window.
856 *
857 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype
858 */
859 readonly resourceType: string;
860 /**
861 * The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.
862 *
863 * You must specify targets by using the `WindowTargetIds` parameter.
864 *
865 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets
866 */
867 readonly targets: Array<CfnMaintenanceWindowTarget.TargetsProperty | cdk.IResolvable> | cdk.IResolvable;
868 /**
869 * The ID of the maintenance window to register the target with.
870 *
871 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid
872 */
873 readonly windowId: string;
874 /**
875 * A description for the target.
876 *
877 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description
878 */
879 readonly description?: string;
880 /**
881 * The name for the maintenance window target.
882 *
883 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name
884 */
885 readonly name?: string;
886 /**
887 * 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.
888 *
889 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation
890 */
891 readonly ownerInformation?: string;
892}
893/**
894 * A CloudFormation `AWS::SSM::MaintenanceWindowTarget`
895 *
896 * 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* .
897 *
898 * @cloudformationResource AWS::SSM::MaintenanceWindowTarget
899 * @stability external
900 *
901 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html
902 */
903export declare class CfnMaintenanceWindowTarget extends cdk.CfnResource implements cdk.IInspectable {
904 /**
905 * The CloudFormation resource type name for this resource class.
906 */
907 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::MaintenanceWindowTarget";
908 /**
909 * A factory method that creates a new instance of this class from an object
910 * containing the CloudFormation properties of this resource.
911 * Used in the @aws-cdk/cloudformation-include module.
912 *
913 * @internal
914 */
915 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMaintenanceWindowTarget;
916 /**
917 * The type of target that is being registered with the maintenance window.
918 *
919 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype
920 */
921 resourceType: string;
922 /**
923 * The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.
924 *
925 * You must specify targets by using the `WindowTargetIds` parameter.
926 *
927 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets
928 */
929 targets: Array<CfnMaintenanceWindowTarget.TargetsProperty | cdk.IResolvable> | cdk.IResolvable;
930 /**
931 * The ID of the maintenance window to register the target with.
932 *
933 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid
934 */
935 windowId: string;
936 /**
937 * A description for the target.
938 *
939 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description
940 */
941 description: string | undefined;
942 /**
943 * The name for the maintenance window target.
944 *
945 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name
946 */
947 name: string | undefined;
948 /**
949 * 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.
950 *
951 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation
952 */
953 ownerInformation: string | undefined;
954 /**
955 * Create a new `AWS::SSM::MaintenanceWindowTarget`.
956 *
957 * @param scope - scope in which this resource is defined
958 * @param id - scoped id of the resource
959 * @param props - resource properties
960 */
961 constructor(scope: cdk.Construct, id: string, props: CfnMaintenanceWindowTargetProps);
962 /**
963 * Examines the CloudFormation resource and discloses attributes.
964 *
965 * @param inspector - tree inspector to collect and process attributes
966 *
967 */
968 inspect(inspector: cdk.TreeInspector): void;
969 protected get cfnProperties(): {
970 [key: string]: any;
971 };
972 protected renderProperties(props: {
973 [key: string]: any;
974 }): {
975 [key: string]: any;
976 };
977}
978export declare namespace CfnMaintenanceWindowTarget {
979 /**
980 * The `Targets` property type specifies adding a target to a maintenance window target in AWS Systems Manager .
981 *
982 * `Targets` is a property of the [AWS::SSM::MaintenanceWindowTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html) resource.
983 *
984 * @struct
985 * @stability external
986 *
987 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html
988 */
989 interface TargetsProperty {
990 /**
991 * User-defined criteria for sending commands that target managed nodes that meet the criteria.
992 *
993 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-key
994 */
995 readonly key: string;
996 /**
997 * 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` .
998 *
999 * Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
1000 *
1001 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-values
1002 */
1003 readonly values: string[];
1004 }
1005}
1006/**
1007 * Properties for defining a `CfnMaintenanceWindowTask`
1008 *
1009 * @struct
1010 * @stability external
1011 *
1012 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html
1013 */
1014export interface CfnMaintenanceWindowTaskProps {
1015 /**
1016 * 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.
1017 *
1018 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority
1019 */
1020 readonly priority: number;
1021 /**
1022 * The resource that the task uses during execution.
1023 *
1024 * For `RUN_COMMAND` and `AUTOMATION` task types, `TaskArn` is the SSM document name or Amazon Resource Name (ARN).
1025 *
1026 * For `LAMBDA` tasks, `TaskArn` is the function name or ARN.
1027 *
1028 * For `STEP_FUNCTIONS` tasks, `TaskArn` is the state machine ARN.
1029 *
1030 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn
1031 */
1032 readonly taskArn: string;
1033 /**
1034 * The type of task. Valid values: `RUN_COMMAND` , `AUTOMATION` , `LAMBDA` , `STEP_FUNCTIONS` .
1035 *
1036 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype
1037 */
1038 readonly taskType: string;
1039 /**
1040 * The ID of the maintenance window where the task is registered.
1041 *
1042 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid
1043 */
1044 readonly windowId: string;
1045 /**
1046 * The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
1047 *
1048 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior
1049 */
1050 readonly cutoffBehavior?: string;
1051 /**
1052 * A description of the task.
1053 *
1054 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description
1055 */
1056 readonly description?: string;
1057 /**
1058 * Information about an Amazon S3 bucket to write Run Command task-level logs to.
1059 *
1060 * > `LoggingInfo` has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, 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 ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) .
1061 *
1062 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo
1063 */
1064 readonly loggingInfo?: CfnMaintenanceWindowTask.LoggingInfoProperty | cdk.IResolvable;
1065 /**
1066 * The maximum number of targets this task can be run for, in parallel.
1067 *
1068 * > 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.
1069 * >
1070 * > 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.
1071 *
1072 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency
1073 */
1074 readonly maxConcurrency?: string;
1075 /**
1076 * The maximum number of errors allowed before this task stops being scheduled.
1077 *
1078 * > 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.
1079 * >
1080 * > 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.
1081 *
1082 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors
1083 */
1084 readonly maxErrors?: string;
1085 /**
1086 * The task name.
1087 *
1088 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name
1089 */
1090 readonly name?: string;
1091 /**
1092 * 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.
1093 *
1094 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn
1095 */
1096 readonly serviceRoleArn?: string;
1097 /**
1098 * The targets, either instances or window target IDs.
1099 *
1100 * - Specify instances using `Key=InstanceIds,Values= *instanceid1* , *instanceid2*` .
1101 * - Specify window target IDs using `Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2*` .
1102 *
1103 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets
1104 */
1105 readonly targets?: Array<CfnMaintenanceWindowTask.TargetProperty | cdk.IResolvable> | cdk.IResolvable;
1106 /**
1107 * 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.
1108 *
1109 * > 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.
1110 *
1111 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters
1112 */
1113 readonly taskInvocationParameters?: CfnMaintenanceWindowTask.TaskInvocationParametersProperty | cdk.IResolvable;
1114 /**
1115 * The parameters to pass to the task when it runs.
1116 *
1117 * > `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) .
1118 *
1119 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters
1120 */
1121 readonly taskParameters?: any | cdk.IResolvable;
1122}
1123/**
1124 * A CloudFormation `AWS::SSM::MaintenanceWindowTask`
1125 *
1126 * 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* .
1127 *
1128 * @cloudformationResource AWS::SSM::MaintenanceWindowTask
1129 * @stability external
1130 *
1131 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html
1132 */
1133export declare class CfnMaintenanceWindowTask extends cdk.CfnResource implements cdk.IInspectable {
1134 /**
1135 * The CloudFormation resource type name for this resource class.
1136 */
1137 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::MaintenanceWindowTask";
1138 /**
1139 * A factory method that creates a new instance of this class from an object
1140 * containing the CloudFormation properties of this resource.
1141 * Used in the @aws-cdk/cloudformation-include module.
1142 *
1143 * @internal
1144 */
1145 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMaintenanceWindowTask;
1146 /**
1147 * 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.
1148 *
1149 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority
1150 */
1151 priority: number;
1152 /**
1153 * The resource that the task uses during execution.
1154 *
1155 * For `RUN_COMMAND` and `AUTOMATION` task types, `TaskArn` is the SSM document name or Amazon Resource Name (ARN).
1156 *
1157 * For `LAMBDA` tasks, `TaskArn` is the function name or ARN.
1158 *
1159 * For `STEP_FUNCTIONS` tasks, `TaskArn` is the state machine ARN.
1160 *
1161 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn
1162 */
1163 taskArn: string;
1164 /**
1165 * The type of task. Valid values: `RUN_COMMAND` , `AUTOMATION` , `LAMBDA` , `STEP_FUNCTIONS` .
1166 *
1167 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype
1168 */
1169 taskType: string;
1170 /**
1171 * The ID of the maintenance window where the task is registered.
1172 *
1173 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid
1174 */
1175 windowId: string;
1176 /**
1177 * The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
1178 *
1179 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior
1180 */
1181 cutoffBehavior: string | undefined;
1182 /**
1183 * A description of the task.
1184 *
1185 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description
1186 */
1187 description: string | undefined;
1188 /**
1189 * Information about an Amazon S3 bucket to write Run Command task-level logs to.
1190 *
1191 * > `LoggingInfo` has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, 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 ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) .
1192 *
1193 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo
1194 */
1195 loggingInfo: CfnMaintenanceWindowTask.LoggingInfoProperty | cdk.IResolvable | undefined;
1196 /**
1197 * The maximum number of targets this task can be run for, in parallel.
1198 *
1199 * > 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.
1200 * >
1201 * > 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.
1202 *
1203 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency
1204 */
1205 maxConcurrency: string | undefined;
1206 /**
1207 * The maximum number of errors allowed before this task stops being scheduled.
1208 *
1209 * > 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.
1210 * >
1211 * > 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.
1212 *
1213 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors
1214 */
1215 maxErrors: string | undefined;
1216 /**
1217 * The task name.
1218 *
1219 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name
1220 */
1221 name: string | undefined;
1222 /**
1223 * 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.
1224 *
1225 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn
1226 */
1227 serviceRoleArn: string | undefined;
1228 /**
1229 * The targets, either instances or window target IDs.
1230 *
1231 * - Specify instances using `Key=InstanceIds,Values= *instanceid1* , *instanceid2*` .
1232 * - Specify window target IDs using `Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2*` .
1233 *
1234 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets
1235 */
1236 targets: Array<CfnMaintenanceWindowTask.TargetProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
1237 /**
1238 * 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.
1239 *
1240 * > 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.
1241 *
1242 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters
1243 */
1244 taskInvocationParameters: CfnMaintenanceWindowTask.TaskInvocationParametersProperty | cdk.IResolvable | undefined;
1245 /**
1246 * The parameters to pass to the task when it runs.
1247 *
1248 * > `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) .
1249 *
1250 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters
1251 */
1252 taskParameters: any | cdk.IResolvable | undefined;
1253 /**
1254 * Create a new `AWS::SSM::MaintenanceWindowTask`.
1255 *
1256 * @param scope - scope in which this resource is defined
1257 * @param id - scoped id of the resource
1258 * @param props - resource properties
1259 */
1260 constructor(scope: cdk.Construct, id: string, props: CfnMaintenanceWindowTaskProps);
1261 /**
1262 * Examines the CloudFormation resource and discloses attributes.
1263 *
1264 * @param inspector - tree inspector to collect and process attributes
1265 *
1266 */
1267 inspect(inspector: cdk.TreeInspector): void;
1268 protected get cfnProperties(): {
1269 [key: string]: any;
1270 };
1271 protected renderProperties(props: {
1272 [key: string]: any;
1273 }): {
1274 [key: string]: any;
1275 };
1276}
1277export declare namespace CfnMaintenanceWindowTask {
1278 /**
1279 * Configuration options for sending command output to Amazon CloudWatch Logs.
1280 *
1281 * @struct
1282 * @stability external
1283 *
1284 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html
1285 */
1286 interface CloudWatchOutputConfigProperty {
1287 /**
1288 * 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:
1289 *
1290 * `aws/ssm/ *SystemsManagerDocumentName*`
1291 *
1292 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchloggroupname
1293 */
1294 readonly cloudWatchLogGroupName?: string;
1295 /**
1296 * Enables Systems Manager to send command output to CloudWatch Logs.
1297 *
1298 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchoutputenabled
1299 */
1300 readonly cloudWatchOutputEnabled?: boolean | cdk.IResolvable;
1301 }
1302}
1303export declare namespace CfnMaintenanceWindowTask {
1304 /**
1305 * The `LoggingInfo` property type specifies information about the Amazon S3 bucket to write instance-level logs to.
1306 *
1307 * `LoggingInfo` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) resource.
1308 *
1309 * > `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 ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) .
1310 *
1311 * @struct
1312 * @stability external
1313 *
1314 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html
1315 */
1316 interface LoggingInfoProperty {
1317 /**
1318 * The AWS Region where the S3 bucket is located.
1319 *
1320 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-region
1321 */
1322 readonly region: string;
1323 /**
1324 * The name of an S3 bucket where execution logs are stored.
1325 *
1326 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3bucket
1327 */
1328 readonly s3Bucket: string;
1329 /**
1330 * The Amazon S3 bucket subfolder.
1331 *
1332 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3prefix
1333 */
1334 readonly s3Prefix?: string;
1335 }
1336}
1337export declare namespace CfnMaintenanceWindowTask {
1338 /**
1339 * The `MaintenanceWindowAutomationParameters` property type specifies the parameters for an `AUTOMATION` task type for a maintenance window task in AWS Systems Manager .
1340 *
1341 * `MaintenanceWindowAutomationParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.
1342 *
1343 * 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* .
1344 *
1345 * @struct
1346 * @stability external
1347 *
1348 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html
1349 */
1350 interface MaintenanceWindowAutomationParametersProperty {
1351 /**
1352 * The version of an Automation runbook to use during task execution.
1353 *
1354 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-documentversion
1355 */
1356 readonly documentVersion?: string;
1357 /**
1358 * The parameters for the AUTOMATION task.
1359 *
1360 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-parameters
1361 */
1362 readonly parameters?: any | cdk.IResolvable;
1363 }
1364}
1365export declare namespace CfnMaintenanceWindowTask {
1366 /**
1367 * The `MaintenanceWindowLambdaParameters` property type specifies the parameters for a `LAMBDA` task type for a maintenance window task in AWS Systems Manager .
1368 *
1369 * `MaintenanceWindowLambdaParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.
1370 *
1371 * @struct
1372 * @stability external
1373 *
1374 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html
1375 */
1376 interface MaintenanceWindowLambdaParametersProperty {
1377 /**
1378 * 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.
1379 *
1380 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-clientcontext
1381 */
1382 readonly clientContext?: string;
1383 /**
1384 * JSON to provide to your AWS Lambda function as input.
1385 *
1386 * > Although `Type` is listed as "String" for this property, the payload content must be formatted as a Base64-encoded binary data object.
1387 *
1388 * *Length Constraint:* 4096
1389 *
1390 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-payload
1391 */
1392 readonly payload?: string;
1393 /**
1394 * 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.
1395 *
1396 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-qualifier
1397 */
1398 readonly qualifier?: string;
1399 }
1400}
1401export declare namespace CfnMaintenanceWindowTask {
1402 /**
1403 * 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* .
1404 *
1405 * 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* .
1406 *
1407 * `MaintenanceWindowRunCommandParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.
1408 *
1409 * @struct
1410 * @stability external
1411 *
1412 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html
1413 */
1414 interface MaintenanceWindowRunCommandParametersProperty {
1415 /**
1416 * Configuration options for sending command output to Amazon CloudWatch Logs.
1417 *
1418 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-cloudwatchoutputconfig
1419 */
1420 readonly cloudWatchOutputConfig?: CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty | cdk.IResolvable;
1421 /**
1422 * Information about the command or commands to run.
1423 *
1424 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment
1425 */
1426 readonly comment?: string;
1427 /**
1428 * The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
1429 *
1430 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash
1431 */
1432 readonly documentHash?: string;
1433 /**
1434 * The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
1435 *
1436 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype
1437 */
1438 readonly documentHashType?: string;
1439 /**
1440 * 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:
1441 *
1442 * `--document-version "\$DEFAULT"`
1443 *
1444 * `--document-version "\$LATEST"`
1445 *
1446 * `--document-version "3"`
1447 *
1448 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documentversion
1449 */
1450 readonly documentVersion?: string;
1451 /**
1452 * Configurations for sending notifications about command status changes on a per-managed node basis.
1453 *
1454 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig
1455 */
1456 readonly notificationConfig?: CfnMaintenanceWindowTask.NotificationConfigProperty | cdk.IResolvable;
1457 /**
1458 * The name of the Amazon Simple Storage Service (Amazon S3) bucket.
1459 *
1460 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname
1461 */
1462 readonly outputS3BucketName?: string;
1463 /**
1464 * The S3 bucket subfolder.
1465 *
1466 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix
1467 */
1468 readonly outputS3KeyPrefix?: string;
1469 /**
1470 * The parameters for the `RUN_COMMAND` task execution.
1471 *
1472 * 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* .
1473 *
1474 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters
1475 */
1476 readonly parameters?: any | cdk.IResolvable;
1477 /**
1478 * 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.
1479 *
1480 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-servicerolearn
1481 */
1482 readonly serviceRoleArn?: string;
1483 /**
1484 * If this time is reached and the command hasn't already started running, it doesn't run.
1485 *
1486 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds
1487 */
1488 readonly timeoutSeconds?: number;
1489 }
1490}
1491export declare namespace CfnMaintenanceWindowTask {
1492 /**
1493 * The `MaintenanceWindowStepFunctionsParameters` property type specifies the parameters for the execution of a `STEP_FUNCTIONS` task in a Systems Manager maintenance window.
1494 *
1495 * `MaintenanceWindowStepFunctionsParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.
1496 *
1497 * @struct
1498 * @stability external
1499 *
1500 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html
1501 */
1502 interface MaintenanceWindowStepFunctionsParametersProperty {
1503 /**
1504 * The inputs for the `STEP_FUNCTIONS` task.
1505 *
1506 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input
1507 */
1508 readonly input?: string;
1509 /**
1510 * The name of the `STEP_FUNCTIONS` task.
1511 *
1512 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-name
1513 */
1514 readonly name?: string;
1515 }
1516}
1517export declare namespace CfnMaintenanceWindowTask {
1518 /**
1519 * The `NotificationConfig` property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager .
1520 *
1521 * `NotificationConfig` is a property of the [MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) property type.
1522 *
1523 * @struct
1524 * @stability external
1525 *
1526 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html
1527 */
1528 interface NotificationConfigProperty {
1529 /**
1530 * 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.
1531 *
1532 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn
1533 */
1534 readonly notificationArn: string;
1535 /**
1536 * 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* .
1537 *
1538 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents
1539 */
1540 readonly notificationEvents?: string[];
1541 /**
1542 * The notification type.
1543 *
1544 * - `Command` : Receive notification when the status of a command changes.
1545 * - `Invocation` : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
1546 *
1547 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype
1548 */
1549 readonly notificationType?: string;
1550 }
1551}
1552export declare namespace CfnMaintenanceWindowTask {
1553 /**
1554 * 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 .
1555 *
1556 * `Target` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) property type.
1557 *
1558 * > 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) .
1559 *
1560 * @struct
1561 * @stability external
1562 *
1563 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html
1564 */
1565 interface TargetProperty {
1566 /**
1567 * 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* .
1568 *
1569 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key
1570 */
1571 readonly key: string;
1572 /**
1573 * 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* .
1574 *
1575 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values
1576 */
1577 readonly values: string[];
1578 }
1579}
1580export declare namespace CfnMaintenanceWindowTask {
1581 /**
1582 * The `TaskInvocationParameters` property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager .
1583 *
1584 * `TaskInvocationParameters` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) property type.
1585 *
1586 * @struct
1587 * @stability external
1588 *
1589 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html
1590 */
1591 interface TaskInvocationParametersProperty {
1592 /**
1593 * The parameters for an `AUTOMATION` task type.
1594 *
1595 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowautomationparameters
1596 */
1597 readonly maintenanceWindowAutomationParameters?: CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty | cdk.IResolvable;
1598 /**
1599 * The parameters for a `LAMBDA` task type.
1600 *
1601 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowlambdaparameters
1602 */
1603 readonly maintenanceWindowLambdaParameters?: CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty | cdk.IResolvable;
1604 /**
1605 * The parameters for a `RUN_COMMAND` task type.
1606 *
1607 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowruncommandparameters
1608 */
1609 readonly maintenanceWindowRunCommandParameters?: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty | cdk.IResolvable;
1610 /**
1611 * The parameters for a `STEP_FUNCTIONS` task type.
1612 *
1613 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowstepfunctionsparameters
1614 */
1615 readonly maintenanceWindowStepFunctionsParameters?: CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty | cdk.IResolvable;
1616 }
1617}
1618/**
1619 * Properties for defining a `CfnParameter`
1620 *
1621 * @struct
1622 * @stability external
1623 *
1624 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html
1625 */
1626export interface CfnParameterProps {
1627 /**
1628 * The type of parameter.
1629 *
1630 * > AWS CloudFormation doesn't support creating a `SecureString` parameter type.
1631 *
1632 * *Allowed Values* : String | StringList
1633 *
1634 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type
1635 */
1636 readonly type: string;
1637 /**
1638 * The parameter value.
1639 *
1640 * > If type is `StringList` , the system returns a comma-separated string with no spaces between commas in the `Value` field.
1641 *
1642 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value
1643 */
1644 readonly value: string;
1645 /**
1646 * 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+$`
1647 *
1648 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern
1649 */
1650 readonly allowedPattern?: string;
1651 /**
1652 * The data type of the parameter, such as `text` or `aws:ec2:image` . The default is `text` .
1653 *
1654 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype
1655 */
1656 readonly dataType?: string;
1657 /**
1658 * Information about the parameter.
1659 *
1660 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description
1661 */
1662 readonly description?: string;
1663 /**
1664 * The name of the parameter.
1665 *
1666 * > 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`
1667 *
1668 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name
1669 */
1670 readonly name?: string;
1671 /**
1672 * Information about the policies assigned to a parameter.
1673 *
1674 * [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *AWS Systems Manager User Guide* .
1675 *
1676 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies
1677 */
1678 readonly policies?: string;
1679 /**
1680 * 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.
1681 *
1682 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags
1683 */
1684 readonly tags?: any;
1685 /**
1686 * The parameter tier.
1687 *
1688 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier
1689 */
1690 readonly tier?: string;
1691}
1692/**
1693 * A CloudFormation `AWS::SSM::Parameter`
1694 *
1695 * The `AWS::SSM::Parameter` resource creates an SSM parameter in AWS Systems Manager Parameter Store.
1696 *
1697 * > 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.
1698 * >
1699 * > 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* .
1700 *
1701 * 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* .
1702 *
1703 * @cloudformationResource AWS::SSM::Parameter
1704 * @stability external
1705 *
1706 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html
1707 */
1708export declare class CfnParameter extends cdk.CfnResource implements cdk.IInspectable {
1709 /**
1710 * The CloudFormation resource type name for this resource class.
1711 */
1712 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::Parameter";
1713 /**
1714 * A factory method that creates a new instance of this class from an object
1715 * containing the CloudFormation properties of this resource.
1716 * Used in the @aws-cdk/cloudformation-include module.
1717 *
1718 * @internal
1719 */
1720 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnParameter;
1721 /**
1722 * Returns the type of the parameter. Valid values are `String` or `StringList` .
1723 * @cloudformationAttribute Type
1724 */
1725 readonly attrType: string;
1726 /**
1727 * Returns the value of the parameter.
1728 * @cloudformationAttribute Value
1729 */
1730 readonly attrValue: string;
1731 /**
1732 * The type of parameter.
1733 *
1734 * > AWS CloudFormation doesn't support creating a `SecureString` parameter type.
1735 *
1736 * *Allowed Values* : String | StringList
1737 *
1738 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type
1739 */
1740 type: string;
1741 /**
1742 * The parameter value.
1743 *
1744 * > If type is `StringList` , the system returns a comma-separated string with no spaces between commas in the `Value` field.
1745 *
1746 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value
1747 */
1748 value: string;
1749 /**
1750 * 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+$`
1751 *
1752 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern
1753 */
1754 allowedPattern: string | undefined;
1755 /**
1756 * The data type of the parameter, such as `text` or `aws:ec2:image` . The default is `text` .
1757 *
1758 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype
1759 */
1760 dataType: string | undefined;
1761 /**
1762 * Information about the parameter.
1763 *
1764 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description
1765 */
1766 description: string | undefined;
1767 /**
1768 * The name of the parameter.
1769 *
1770 * > 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`
1771 *
1772 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name
1773 */
1774 name: string | undefined;
1775 /**
1776 * Information about the policies assigned to a parameter.
1777 *
1778 * [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *AWS Systems Manager User Guide* .
1779 *
1780 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies
1781 */
1782 policies: string | undefined;
1783 /**
1784 * 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.
1785 *
1786 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags
1787 */
1788 readonly tags: cdk.TagManager;
1789 /**
1790 * The parameter tier.
1791 *
1792 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier
1793 */
1794 tier: string | undefined;
1795 /**
1796 * Create a new `AWS::SSM::Parameter`.
1797 *
1798 * @param scope - scope in which this resource is defined
1799 * @param id - scoped id of the resource
1800 * @param props - resource properties
1801 */
1802 constructor(scope: cdk.Construct, id: string, props: CfnParameterProps);
1803 /**
1804 * Examines the CloudFormation resource and discloses attributes.
1805 *
1806 * @param inspector - tree inspector to collect and process attributes
1807 *
1808 */
1809 inspect(inspector: cdk.TreeInspector): void;
1810 protected get cfnProperties(): {
1811 [key: string]: any;
1812 };
1813 protected renderProperties(props: {
1814 [key: string]: any;
1815 }): {
1816 [key: string]: any;
1817 };
1818}
1819/**
1820 * Properties for defining a `CfnPatchBaseline`
1821 *
1822 * @struct
1823 * @stability external
1824 *
1825 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html
1826 */
1827export interface CfnPatchBaselineProps {
1828 /**
1829 * The name of the patch baseline.
1830 *
1831 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name
1832 */
1833 readonly name: string;
1834 /**
1835 * A set of rules used to include patches in the baseline.
1836 *
1837 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules
1838 */
1839 readonly approvalRules?: CfnPatchBaseline.RuleGroupProperty | cdk.IResolvable;
1840 /**
1841 * A list of explicitly approved patches for the baseline.
1842 *
1843 * 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* .
1844 *
1845 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches
1846 */
1847 readonly approvedPatches?: string[];
1848 /**
1849 * 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` .
1850 *
1851 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel
1852 */
1853 readonly approvedPatchesComplianceLevel?: string;
1854 /**
1855 * 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.
1856 *
1857 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity
1858 */
1859 readonly approvedPatchesEnableNonSecurity?: boolean | cdk.IResolvable;
1860 /**
1861 * A description of the patch baseline.
1862 *
1863 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description
1864 */
1865 readonly description?: string;
1866 /**
1867 * A set of global filters used to include patches in the baseline.
1868 *
1869 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters
1870 */
1871 readonly globalFilters?: CfnPatchBaseline.PatchFilterGroupProperty | cdk.IResolvable;
1872 /**
1873 * Defines the operating system the patch baseline applies to. The default value is `WINDOWS` .
1874 *
1875 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem
1876 */
1877 readonly operatingSystem?: string;
1878 /**
1879 * The name of the patch group to be registered with the patch baseline.
1880 *
1881 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups
1882 */
1883 readonly patchGroups?: string[];
1884 /**
1885 * A list of explicitly rejected patches for the baseline.
1886 *
1887 * 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* .
1888 *
1889 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches
1890 */
1891 readonly rejectedPatches?: string[];
1892 /**
1893 * The action for Patch Manager to take on patches included in the `RejectedPackages` list.
1894 *
1895 * - *`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.
1896 * - *`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` .
1897 *
1898 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction
1899 */
1900 readonly rejectedPatchesAction?: string;
1901 /**
1902 * Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
1903 *
1904 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources
1905 */
1906 readonly sources?: Array<CfnPatchBaseline.PatchSourceProperty | cdk.IResolvable> | cdk.IResolvable;
1907 /**
1908 * 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.
1909 *
1910 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags
1911 */
1912 readonly tags?: cdk.CfnTag[];
1913}
1914/**
1915 * A CloudFormation `AWS::SSM::PatchBaseline`
1916 *
1917 * 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.
1918 *
1919 * For more information, see [CreatePatchBaseline](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreatePatchBaseline.html) in the *AWS Systems Manager API Reference* .
1920 *
1921 * @cloudformationResource AWS::SSM::PatchBaseline
1922 * @stability external
1923 *
1924 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html
1925 */
1926export declare class CfnPatchBaseline extends cdk.CfnResource implements cdk.IInspectable {
1927 /**
1928 * The CloudFormation resource type name for this resource class.
1929 */
1930 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::PatchBaseline";
1931 /**
1932 * A factory method that creates a new instance of this class from an object
1933 * containing the CloudFormation properties of this resource.
1934 * Used in the @aws-cdk/cloudformation-include module.
1935 *
1936 * @internal
1937 */
1938 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPatchBaseline;
1939 /**
1940 * The name of the patch baseline.
1941 *
1942 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name
1943 */
1944 name: string;
1945 /**
1946 * A set of rules used to include patches in the baseline.
1947 *
1948 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules
1949 */
1950 approvalRules: CfnPatchBaseline.RuleGroupProperty | cdk.IResolvable | undefined;
1951 /**
1952 * A list of explicitly approved patches for the baseline.
1953 *
1954 * 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* .
1955 *
1956 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches
1957 */
1958 approvedPatches: string[] | undefined;
1959 /**
1960 * 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` .
1961 *
1962 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel
1963 */
1964 approvedPatchesComplianceLevel: string | undefined;
1965 /**
1966 * 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.
1967 *
1968 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity
1969 */
1970 approvedPatchesEnableNonSecurity: boolean | cdk.IResolvable | undefined;
1971 /**
1972 * A description of the patch baseline.
1973 *
1974 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description
1975 */
1976 description: string | undefined;
1977 /**
1978 * A set of global filters used to include patches in the baseline.
1979 *
1980 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters
1981 */
1982 globalFilters: CfnPatchBaseline.PatchFilterGroupProperty | cdk.IResolvable | undefined;
1983 /**
1984 * Defines the operating system the patch baseline applies to. The default value is `WINDOWS` .
1985 *
1986 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem
1987 */
1988 operatingSystem: string | undefined;
1989 /**
1990 * The name of the patch group to be registered with the patch baseline.
1991 *
1992 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups
1993 */
1994 patchGroups: string[] | undefined;
1995 /**
1996 * A list of explicitly rejected patches for the baseline.
1997 *
1998 * 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* .
1999 *
2000 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches
2001 */
2002 rejectedPatches: string[] | undefined;
2003 /**
2004 * The action for Patch Manager to take on patches included in the `RejectedPackages` list.
2005 *
2006 * - *`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.
2007 * - *`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` .
2008 *
2009 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction
2010 */
2011 rejectedPatchesAction: string | undefined;
2012 /**
2013 * Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
2014 *
2015 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources
2016 */
2017 sources: Array<CfnPatchBaseline.PatchSourceProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
2018 /**
2019 * 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.
2020 *
2021 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags
2022 */
2023 readonly tags: cdk.TagManager;
2024 /**
2025 * Create a new `AWS::SSM::PatchBaseline`.
2026 *
2027 * @param scope - scope in which this resource is defined
2028 * @param id - scoped id of the resource
2029 * @param props - resource properties
2030 */
2031 constructor(scope: cdk.Construct, id: string, props: CfnPatchBaselineProps);
2032 /**
2033 * Examines the CloudFormation resource and discloses attributes.
2034 *
2035 * @param inspector - tree inspector to collect and process attributes
2036 *
2037 */
2038 inspect(inspector: cdk.TreeInspector): void;
2039 protected get cfnProperties(): {
2040 [key: string]: any;
2041 };
2042 protected renderProperties(props: {
2043 [key: string]: any;
2044 }): {
2045 [key: string]: any;
2046 };
2047}
2048export declare namespace CfnPatchBaseline {
2049 /**
2050 * The `PatchFilter` property type defines a patch filter for an AWS Systems Manager patch baseline.
2051 *
2052 * 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.
2053 *
2054 * 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* .
2055 *
2056 * @struct
2057 * @stability external
2058 *
2059 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html
2060 */
2061 interface PatchFilterProperty {
2062 /**
2063 * The key for the filter.
2064 *
2065 * 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* .
2066 *
2067 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-key
2068 */
2069 readonly key?: string;
2070 /**
2071 * The value for the filter key.
2072 *
2073 * 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* .
2074 *
2075 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-values
2076 */
2077 readonly values?: string[];
2078 }
2079}
2080export declare namespace CfnPatchBaseline {
2081 /**
2082 * 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.
2083 *
2084 * `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.
2085 *
2086 * @struct
2087 * @stability external
2088 *
2089 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html
2090 */
2091 interface PatchFilterGroupProperty {
2092 /**
2093 * The set of patch filters that make up the group.
2094 *
2095 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters
2096 */
2097 readonly patchFilters?: Array<CfnPatchBaseline.PatchFilterProperty | cdk.IResolvable> | cdk.IResolvable;
2098 }
2099}
2100export declare namespace CfnPatchBaseline {
2101 /**
2102 * `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.
2103 *
2104 * 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.
2105 *
2106 * @struct
2107 * @stability external
2108 *
2109 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html
2110 */
2111 interface PatchSourceProperty {
2112 /**
2113 * The value of the yum repo configuration. For example:
2114 *
2115 * `[main]`
2116 *
2117 * `name=MyCustomRepository`
2118 *
2119 * `baseurl=https://my-custom-repository`
2120 *
2121 * `enabled=1`
2122 *
2123 * > 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) .
2124 *
2125 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-configuration
2126 */
2127 readonly configuration?: string;
2128 /**
2129 * The name specified to identify the patch source.
2130 *
2131 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-name
2132 */
2133 readonly name?: string;
2134 /**
2135 * 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* .
2136 *
2137 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-products
2138 */
2139 readonly products?: string[];
2140 }
2141}
2142export declare namespace CfnPatchBaseline {
2143 /**
2144 * The `Rule` property type specifies an approval rule for a Systems Manager patch baseline.
2145 *
2146 * 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.
2147 *
2148 * @struct
2149 * @stability external
2150 *
2151 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html
2152 */
2153 interface RuleProperty {
2154 /**
2155 * 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.
2156 *
2157 * You must specify a value for `ApproveAfterDays` .
2158 *
2159 * Exception: Not supported on Debian Server or Ubuntu Server.
2160 *
2161 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveafterdays
2162 */
2163 readonly approveAfterDays?: number;
2164 /**
2165 * 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.
2166 *
2167 * Enter dates in the format `YYYY-MM-DD` . For example, `2021-12-31` .
2168 *
2169 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveuntildate
2170 */
2171 readonly approveUntilDate?: string;
2172 /**
2173 * 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` .
2174 *
2175 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-compliancelevel
2176 */
2177 readonly complianceLevel?: string;
2178 /**
2179 * 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.
2180 *
2181 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-enablenonsecurity
2182 */
2183 readonly enableNonSecurity?: boolean | cdk.IResolvable;
2184 /**
2185 * The patch filter group that defines the criteria for the rule.
2186 *
2187 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-patchfiltergroup
2188 */
2189 readonly patchFilterGroup?: CfnPatchBaseline.PatchFilterGroupProperty | cdk.IResolvable;
2190 }
2191}
2192export declare namespace CfnPatchBaseline {
2193 /**
2194 * The `RuleGroup` property type specifies a set of rules that define the approval rules for an AWS Systems Manager patch baseline.
2195 *
2196 * `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.
2197 *
2198 * @struct
2199 * @stability external
2200 *
2201 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html
2202 */
2203 interface RuleGroupProperty {
2204 /**
2205 * The rules that make up the rule group.
2206 *
2207 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html#cfn-ssm-patchbaseline-rulegroup-patchrules
2208 */
2209 readonly patchRules?: Array<CfnPatchBaseline.RuleProperty | cdk.IResolvable> | cdk.IResolvable;
2210 }
2211}
2212/**
2213 * Properties for defining a `CfnResourceDataSync`
2214 *
2215 * @struct
2216 * @stability external
2217 *
2218 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html
2219 */
2220export interface CfnResourceDataSyncProps {
2221 /**
2222 * A name for the resource data sync.
2223 *
2224 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname
2225 */
2226 readonly syncName: string;
2227 /**
2228 * The name of the S3 bucket where the aggregated data is stored.
2229 *
2230 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname
2231 */
2232 readonly bucketName?: string;
2233 /**
2234 * An Amazon S3 prefix for the bucket.
2235 *
2236 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix
2237 */
2238 readonly bucketPrefix?: string;
2239 /**
2240 * The AWS Region with the S3 bucket targeted by the resource data sync.
2241 *
2242 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion
2243 */
2244 readonly bucketRegion?: string;
2245 /**
2246 * 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.
2247 *
2248 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn
2249 */
2250 readonly kmsKeyArn?: string;
2251 /**
2252 * Configuration information for the target S3 bucket.
2253 *
2254 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination
2255 */
2256 readonly s3Destination?: CfnResourceDataSync.S3DestinationProperty | cdk.IResolvable;
2257 /**
2258 * A supported sync format. The following format is currently supported: JsonSerDe
2259 *
2260 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat
2261 */
2262 readonly syncFormat?: string;
2263 /**
2264 * Information about the source where the data was synchronized.
2265 *
2266 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource
2267 */
2268 readonly syncSource?: CfnResourceDataSync.SyncSourceProperty | cdk.IResolvable;
2269 /**
2270 * 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 .
2271 *
2272 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype
2273 */
2274 readonly syncType?: string;
2275}
2276/**
2277 * A CloudFormation `AWS::SSM::ResourceDataSync`
2278 *
2279 * 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` .
2280 *
2281 * 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.
2282 *
2283 * 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 .
2284 *
2285 * A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data.
2286 *
2287 * 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.
2288 *
2289 * 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* .
2290 *
2291 * 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.
2292 *
2293 * @cloudformationResource AWS::SSM::ResourceDataSync
2294 * @stability external
2295 *
2296 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html
2297 */
2298export declare class CfnResourceDataSync extends cdk.CfnResource implements cdk.IInspectable {
2299 /**
2300 * The CloudFormation resource type name for this resource class.
2301 */
2302 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::ResourceDataSync";
2303 /**
2304 * A factory method that creates a new instance of this class from an object
2305 * containing the CloudFormation properties of this resource.
2306 * Used in the @aws-cdk/cloudformation-include module.
2307 *
2308 * @internal
2309 */
2310 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnResourceDataSync;
2311 /**
2312 * The name of the resource data sync.
2313 * @cloudformationAttribute SyncName
2314 */
2315 readonly attrSyncName: string;
2316 /**
2317 * A name for the resource data sync.
2318 *
2319 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname
2320 */
2321 syncName: string;
2322 /**
2323 * The name of the S3 bucket where the aggregated data is stored.
2324 *
2325 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname
2326 */
2327 bucketName: string | undefined;
2328 /**
2329 * An Amazon S3 prefix for the bucket.
2330 *
2331 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix
2332 */
2333 bucketPrefix: string | undefined;
2334 /**
2335 * The AWS Region with the S3 bucket targeted by the resource data sync.
2336 *
2337 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion
2338 */
2339 bucketRegion: string | undefined;
2340 /**
2341 * 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.
2342 *
2343 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn
2344 */
2345 kmsKeyArn: string | undefined;
2346 /**
2347 * Configuration information for the target S3 bucket.
2348 *
2349 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination
2350 */
2351 s3Destination: CfnResourceDataSync.S3DestinationProperty | cdk.IResolvable | undefined;
2352 /**
2353 * A supported sync format. The following format is currently supported: JsonSerDe
2354 *
2355 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat
2356 */
2357 syncFormat: string | undefined;
2358 /**
2359 * Information about the source where the data was synchronized.
2360 *
2361 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource
2362 */
2363 syncSource: CfnResourceDataSync.SyncSourceProperty | cdk.IResolvable | undefined;
2364 /**
2365 * 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 .
2366 *
2367 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype
2368 */
2369 syncType: string | undefined;
2370 /**
2371 * Create a new `AWS::SSM::ResourceDataSync`.
2372 *
2373 * @param scope - scope in which this resource is defined
2374 * @param id - scoped id of the resource
2375 * @param props - resource properties
2376 */
2377 constructor(scope: cdk.Construct, id: string, props: CfnResourceDataSyncProps);
2378 /**
2379 * Examines the CloudFormation resource and discloses attributes.
2380 *
2381 * @param inspector - tree inspector to collect and process attributes
2382 *
2383 */
2384 inspect(inspector: cdk.TreeInspector): void;
2385 protected get cfnProperties(): {
2386 [key: string]: any;
2387 };
2388 protected renderProperties(props: {
2389 [key: string]: any;
2390 }): {
2391 [key: string]: any;
2392 };
2393}
2394export declare namespace CfnResourceDataSync {
2395 /**
2396 * 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 .
2397 *
2398 * @struct
2399 * @stability external
2400 *
2401 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html
2402 */
2403 interface AwsOrganizationsSourceProperty {
2404 /**
2405 * 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.
2406 *
2407 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationsourcetype
2408 */
2409 readonly organizationSourceType: string;
2410 /**
2411 * The AWS Organizations organization units included in the sync.
2412 *
2413 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationalunits
2414 */
2415 readonly organizationalUnits?: string[];
2416 }
2417}
2418export declare namespace CfnResourceDataSync {
2419 /**
2420 * Information about the target S3 bucket for the resource data sync.
2421 *
2422 * @struct
2423 * @stability external
2424 *
2425 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html
2426 */
2427 interface S3DestinationProperty {
2428 /**
2429 * The name of the S3 bucket where the aggregated data is stored.
2430 *
2431 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketname
2432 */
2433 readonly bucketName: string;
2434 /**
2435 * An Amazon S3 prefix for the bucket.
2436 *
2437 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketprefix
2438 */
2439 readonly bucketPrefix?: string;
2440 /**
2441 * The AWS Region with the S3 bucket targeted by the resource data sync.
2442 *
2443 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketregion
2444 */
2445 readonly bucketRegion: string;
2446 /**
2447 * The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
2448 *
2449 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-kmskeyarn
2450 */
2451 readonly kmsKeyArn?: string;
2452 /**
2453 * A supported sync format. The following format is currently supported: JsonSerDe
2454 *
2455 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-syncformat
2456 */
2457 readonly syncFormat: string;
2458 }
2459}
2460export declare namespace CfnResourceDataSync {
2461 /**
2462 * Information about the source of the data included in the resource data sync.
2463 *
2464 * @struct
2465 * @stability external
2466 *
2467 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html
2468 */
2469 interface SyncSourceProperty {
2470 /**
2471 * Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .
2472 *
2473 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-awsorganizationssource
2474 */
2475 readonly awsOrganizationsSource?: CfnResourceDataSync.AwsOrganizationsSourceProperty | cdk.IResolvable;
2476 /**
2477 * Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
2478 *
2479 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-includefutureregions
2480 */
2481 readonly includeFutureRegions?: boolean | cdk.IResolvable;
2482 /**
2483 * The `SyncSource` AWS Regions included in the resource data sync.
2484 *
2485 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourceregions
2486 */
2487 readonly sourceRegions: string[];
2488 /**
2489 * The type of data source for the resource data sync. `SourceType` is either `AwsOrganizations` (if an organization is present in AWS Organizations ) or `SingleAccountMultiRegions` .
2490 *
2491 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourcetype
2492 */
2493 readonly sourceType: string;
2494 }
2495}
2496/**
2497 * Properties for defining a `CfnResourcePolicy`
2498 *
2499 * @struct
2500 * @stability external
2501 *
2502 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html
2503 */
2504export interface CfnResourcePolicyProps {
2505 /**
2506 * A policy you want to associate with a resource.
2507 *
2508 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-policy
2509 */
2510 readonly policy: any | cdk.IResolvable;
2511 /**
2512 * Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
2513 *
2514 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-resourcearn
2515 */
2516 readonly resourceArn: string;
2517}
2518/**
2519 * A CloudFormation `AWS::SSM::ResourcePolicy`
2520 *
2521 * Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an AWS account ) that can manage your Systems Manager resources. Currently, `OpsItemGroup` is the only resource that supports Systems Manager resource policies. The resource policy for `OpsItemGroup` enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). OpsCenter is a capability of Systems Manager .
2522 *
2523 * @cloudformationResource AWS::SSM::ResourcePolicy
2524 * @stability external
2525 *
2526 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html
2527 */
2528export declare class CfnResourcePolicy extends cdk.CfnResource implements cdk.IInspectable {
2529 /**
2530 * The CloudFormation resource type name for this resource class.
2531 */
2532 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::SSM::ResourcePolicy";
2533 /**
2534 * A factory method that creates a new instance of this class from an object
2535 * containing the CloudFormation properties of this resource.
2536 * Used in the @aws-cdk/cloudformation-include module.
2537 *
2538 * @internal
2539 */
2540 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnResourcePolicy;
2541 /**
2542 * ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash and the policy ID when updating or deleting a policy.
2543 * @cloudformationAttribute PolicyHash
2544 */
2545 readonly attrPolicyHash: string;
2546 /**
2547 * ID of the current policy version.
2548 * @cloudformationAttribute PolicyId
2549 */
2550 readonly attrPolicyId: string;
2551 /**
2552 * A policy you want to associate with a resource.
2553 *
2554 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-policy
2555 */
2556 policy: any | cdk.IResolvable;
2557 /**
2558 * Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
2559 *
2560 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-resourcearn
2561 */
2562 resourceArn: string;
2563 /**
2564 * Create a new `AWS::SSM::ResourcePolicy`.
2565 *
2566 * @param scope - scope in which this resource is defined
2567 * @param id - scoped id of the resource
2568 * @param props - resource properties
2569 */
2570 constructor(scope: cdk.Construct, id: string, props: CfnResourcePolicyProps);
2571 /**
2572 * Examines the CloudFormation resource and discloses attributes.
2573 *
2574 * @param inspector - tree inspector to collect and process attributes
2575 *
2576 */
2577 inspect(inspector: cdk.TreeInspector): void;
2578 protected get cfnProperties(): {
2579 [key: string]: any;
2580 };
2581 protected renderProperties(props: {
2582 [key: string]: any;
2583 }): {
2584 [key: string]: any;
2585 };
2586}