UNPKG

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