UNPKG

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