@gammarers/aws-daily-cloud-watch-logs-archive-stack 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md ADDED
@@ -0,0 +1,1152 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
+
5
+ ### DailyCloudWatchLogsArchiveStack <a name="DailyCloudWatchLogsArchiveStack" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack"></a>
6
+
7
+ #### Initializers <a name="Initializers" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.Initializer"></a>
8
+
9
+ ```typescript
10
+ import { DailyCloudWatchLogsArchiveStack } from '@gammarers/aws-daily-cloud-watch-logs-archive-stack'
11
+
12
+ new DailyCloudWatchLogsArchiveStack(scope: Construct, id: string, props: DailyCloudWatchLogsArchiveStackProps)
13
+ ```
14
+
15
+ | **Name** | **Type** | **Description** |
16
+ | --- | --- | --- |
17
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
18
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
19
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.Initializer.parameter.props">props</a></code> | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps">DailyCloudWatchLogsArchiveStackProps</a></code> | *No description.* |
20
+
21
+ ---
22
+
23
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.Initializer.parameter.scope"></a>
24
+
25
+ - *Type:* constructs.Construct
26
+
27
+ ---
28
+
29
+ ##### `id`<sup>Required</sup> <a name="id" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.Initializer.parameter.id"></a>
30
+
31
+ - *Type:* string
32
+
33
+ ---
34
+
35
+ ##### `props`<sup>Required</sup> <a name="props" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.Initializer.parameter.props"></a>
36
+
37
+ - *Type:* <a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps">DailyCloudWatchLogsArchiveStackProps</a>
38
+
39
+ ---
40
+
41
+ #### Methods <a name="Methods" id="Methods"></a>
42
+
43
+ | **Name** | **Description** |
44
+ | --- | --- |
45
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toString">toString</a></code> | Returns a string representation of this construct. |
46
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addDependency">addDependency</a></code> | Add a dependency between this stack and another stack. |
47
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addMetadata">addMetadata</a></code> | Adds an arbitary key-value pair, with information you want to record about the stack. |
48
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addTransform">addTransform</a></code> | Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. |
49
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.exportStringListValue">exportStringListValue</a></code> | Create a CloudFormation Export for a string list value. |
50
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.exportValue">exportValue</a></code> | Create a CloudFormation Export for a string value. |
51
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.formatArn">formatArn</a></code> | Creates an ARN from components. |
52
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.getLogicalId">getLogicalId</a></code> | Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. |
53
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.regionalFact">regionalFact</a></code> | Look up a fact value for the given fact for the region of this stack. |
54
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.renameLogicalId">renameLogicalId</a></code> | Rename a generated logical identities. |
55
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.reportMissingContextKey">reportMissingContextKey</a></code> | Indicate that a context key was expected. |
56
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.resolve">resolve</a></code> | Resolve a tokenized value in the context of the current stack. |
57
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.splitArn">splitArn</a></code> | Splits the provided ARN into its components. |
58
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toJsonString">toJsonString</a></code> | Convert an object, potentially containing tokens, to a JSON string. |
59
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toYamlString">toYamlString</a></code> | Convert an object, potentially containing tokens, to a YAML string. |
60
+
61
+ ---
62
+
63
+ ##### `toString` <a name="toString" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toString"></a>
64
+
65
+ ```typescript
66
+ public toString(): string
67
+ ```
68
+
69
+ Returns a string representation of this construct.
70
+
71
+ ##### `addDependency` <a name="addDependency" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addDependency"></a>
72
+
73
+ ```typescript
74
+ public addDependency(target: Stack, reason?: string): void
75
+ ```
76
+
77
+ Add a dependency between this stack and another stack.
78
+
79
+ This can be used to define dependencies between any two stacks within an
80
+ app, and also supports nested stacks.
81
+
82
+ ###### `target`<sup>Required</sup> <a name="target" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addDependency.parameter.target"></a>
83
+
84
+ - *Type:* aws-cdk-lib.Stack
85
+
86
+ ---
87
+
88
+ ###### `reason`<sup>Optional</sup> <a name="reason" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addDependency.parameter.reason"></a>
89
+
90
+ - *Type:* string
91
+
92
+ ---
93
+
94
+ ##### `addMetadata` <a name="addMetadata" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addMetadata"></a>
95
+
96
+ ```typescript
97
+ public addMetadata(key: string, value: any): void
98
+ ```
99
+
100
+ Adds an arbitary key-value pair, with information you want to record about the stack.
101
+
102
+ These get translated to the Metadata section of the generated template.
103
+
104
+ > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html)
105
+
106
+ ###### `key`<sup>Required</sup> <a name="key" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addMetadata.parameter.key"></a>
107
+
108
+ - *Type:* string
109
+
110
+ ---
111
+
112
+ ###### `value`<sup>Required</sup> <a name="value" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addMetadata.parameter.value"></a>
113
+
114
+ - *Type:* any
115
+
116
+ ---
117
+
118
+ ##### `addTransform` <a name="addTransform" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addTransform"></a>
119
+
120
+ ```typescript
121
+ public addTransform(transform: string): void
122
+ ```
123
+
124
+ Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.
125
+
126
+ Duplicate values are removed when stack is synthesized.
127
+
128
+ > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html)
129
+
130
+ *Example*
131
+
132
+ ```typescript
133
+ declare const stack: Stack;
134
+
135
+ stack.addTransform('AWS::Serverless-2016-10-31')
136
+ ```
137
+
138
+
139
+ ###### `transform`<sup>Required</sup> <a name="transform" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.addTransform.parameter.transform"></a>
140
+
141
+ - *Type:* string
142
+
143
+ The transform to add.
144
+
145
+ ---
146
+
147
+ ##### `exportStringListValue` <a name="exportStringListValue" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.exportStringListValue"></a>
148
+
149
+ ```typescript
150
+ public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[]
151
+ ```
152
+
153
+ Create a CloudFormation Export for a string list value.
154
+
155
+ Returns a string list representing the corresponding `Fn.importValue()`
156
+ expression for this Export. The export expression is automatically wrapped with an
157
+ `Fn::Join` and the import value with an `Fn::Split`, since CloudFormation can only
158
+ export strings. You can control the name for the export by passing the `name` option.
159
+
160
+ If you don't supply a value for `name`, the value you're exporting must be
161
+ a Resource attribute (for example: `bucket.bucketName`) and it will be
162
+ given the same name as the automatic cross-stack reference that would be created
163
+ if you used the attribute in another Stack.
164
+
165
+ One of the uses for this method is to *remove* the relationship between
166
+ two Stacks established by automatic cross-stack references. It will
167
+ temporarily ensure that the CloudFormation Export still exists while you
168
+ remove the reference from the consuming stack. After that, you can remove
169
+ the resource and the manual export.
170
+
171
+ See `exportValue` for an example of this process.
172
+
173
+ ###### `exportedValue`<sup>Required</sup> <a name="exportedValue" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.exportStringListValue.parameter.exportedValue"></a>
174
+
175
+ - *Type:* any
176
+
177
+ ---
178
+
179
+ ###### `options`<sup>Optional</sup> <a name="options" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.exportStringListValue.parameter.options"></a>
180
+
181
+ - *Type:* aws-cdk-lib.ExportValueOptions
182
+
183
+ ---
184
+
185
+ ##### `exportValue` <a name="exportValue" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.exportValue"></a>
186
+
187
+ ```typescript
188
+ public exportValue(exportedValue: any, options?: ExportValueOptions): string
189
+ ```
190
+
191
+ Create a CloudFormation Export for a string value.
192
+
193
+ Returns a string representing the corresponding `Fn.importValue()`
194
+ expression for this Export. You can control the name for the export by
195
+ passing the `name` option.
196
+
197
+ If you don't supply a value for `name`, the value you're exporting must be
198
+ a Resource attribute (for example: `bucket.bucketName`) and it will be
199
+ given the same name as the automatic cross-stack reference that would be created
200
+ if you used the attribute in another Stack.
201
+
202
+ One of the uses for this method is to *remove* the relationship between
203
+ two Stacks established by automatic cross-stack references. It will
204
+ temporarily ensure that the CloudFormation Export still exists while you
205
+ remove the reference from the consuming stack. After that, you can remove
206
+ the resource and the manual export.
207
+
208
+ ## Example
209
+
210
+ Here is how the process works. Let's say there are two stacks,
211
+ `producerStack` and `consumerStack`, and `producerStack` has a bucket
212
+ called `bucket`, which is referenced by `consumerStack` (perhaps because
213
+ an AWS Lambda Function writes into it, or something like that).
214
+
215
+ It is not safe to remove `producerStack.bucket` because as the bucket is being
216
+ deleted, `consumerStack` might still be using it.
217
+
218
+ Instead, the process takes two deployments:
219
+
220
+ ### Deployment 1: break the relationship
221
+
222
+ - Make sure `consumerStack` no longer references `bucket.bucketName` (maybe the consumer
223
+ stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just
224
+ remove the Lambda Function altogether).
225
+ - In the `ProducerStack` class, call `this.exportValue(this.bucket.bucketName)`. This
226
+ will make sure the CloudFormation Export continues to exist while the relationship
227
+ between the two stacks is being broken.
228
+ - Deploy (this will effectively only change the `consumerStack`, but it's safe to deploy both).
229
+
230
+ ### Deployment 2: remove the bucket resource
231
+
232
+ - You are now free to remove the `bucket` resource from `producerStack`.
233
+ - Don't forget to remove the `exportValue()` call as well.
234
+ - Deploy again (this time only the `producerStack` will be changed -- the bucket will be deleted).
235
+
236
+ ###### `exportedValue`<sup>Required</sup> <a name="exportedValue" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.exportValue.parameter.exportedValue"></a>
237
+
238
+ - *Type:* any
239
+
240
+ ---
241
+
242
+ ###### `options`<sup>Optional</sup> <a name="options" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.exportValue.parameter.options"></a>
243
+
244
+ - *Type:* aws-cdk-lib.ExportValueOptions
245
+
246
+ ---
247
+
248
+ ##### `formatArn` <a name="formatArn" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.formatArn"></a>
249
+
250
+ ```typescript
251
+ public formatArn(components: ArnComponents): string
252
+ ```
253
+
254
+ Creates an ARN from components.
255
+
256
+ If `partition`, `region` or `account` are not specified, the stack's
257
+ partition, region and account will be used.
258
+
259
+ If any component is the empty string, an empty string will be inserted
260
+ into the generated ARN at the location that component corresponds to.
261
+
262
+ The ARN will be formatted as follows:
263
+
264
+ arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}
265
+
266
+ The required ARN pieces that are omitted will be taken from the stack that
267
+ the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope
268
+ can be 'undefined'.
269
+
270
+ ###### `components`<sup>Required</sup> <a name="components" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.formatArn.parameter.components"></a>
271
+
272
+ - *Type:* aws-cdk-lib.ArnComponents
273
+
274
+ ---
275
+
276
+ ##### `getLogicalId` <a name="getLogicalId" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.getLogicalId"></a>
277
+
278
+ ```typescript
279
+ public getLogicalId(element: CfnElement): string
280
+ ```
281
+
282
+ Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
283
+
284
+ This method is called when a `CfnElement` is created and used to render the
285
+ initial logical identity of resources. Logical ID renames are applied at
286
+ this stage.
287
+
288
+ This method uses the protected method `allocateLogicalId` to render the
289
+ logical ID for an element. To modify the naming scheme, extend the `Stack`
290
+ class and override this method.
291
+
292
+ ###### `element`<sup>Required</sup> <a name="element" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.getLogicalId.parameter.element"></a>
293
+
294
+ - *Type:* aws-cdk-lib.CfnElement
295
+
296
+ The CloudFormation element for which a logical identity is needed.
297
+
298
+ ---
299
+
300
+ ##### `regionalFact` <a name="regionalFact" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.regionalFact"></a>
301
+
302
+ ```typescript
303
+ public regionalFact(factName: string, defaultValue?: string): string
304
+ ```
305
+
306
+ Look up a fact value for the given fact for the region of this stack.
307
+
308
+ Will return a definite value only if the region of the current stack is resolved.
309
+ If not, a lookup map will be added to the stack and the lookup will be done at
310
+ CDK deployment time.
311
+
312
+ What regions will be included in the lookup map is controlled by the
313
+ `@aws-cdk/core:target-partitions` context value: it must be set to a list
314
+ of partitions, and only regions from the given partitions will be included.
315
+ If no such context key is set, all regions will be included.
316
+
317
+ This function is intended to be used by construct library authors. Application
318
+ builders can rely on the abstractions offered by construct libraries and do
319
+ not have to worry about regional facts.
320
+
321
+ If `defaultValue` is not given, it is an error if the fact is unknown for
322
+ the given region.
323
+
324
+ ###### `factName`<sup>Required</sup> <a name="factName" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.regionalFact.parameter.factName"></a>
325
+
326
+ - *Type:* string
327
+
328
+ ---
329
+
330
+ ###### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.regionalFact.parameter.defaultValue"></a>
331
+
332
+ - *Type:* string
333
+
334
+ ---
335
+
336
+ ##### `renameLogicalId` <a name="renameLogicalId" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.renameLogicalId"></a>
337
+
338
+ ```typescript
339
+ public renameLogicalId(oldId: string, newId: string): void
340
+ ```
341
+
342
+ Rename a generated logical identities.
343
+
344
+ To modify the naming scheme strategy, extend the `Stack` class and
345
+ override the `allocateLogicalId` method.
346
+
347
+ ###### `oldId`<sup>Required</sup> <a name="oldId" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.renameLogicalId.parameter.oldId"></a>
348
+
349
+ - *Type:* string
350
+
351
+ ---
352
+
353
+ ###### `newId`<sup>Required</sup> <a name="newId" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.renameLogicalId.parameter.newId"></a>
354
+
355
+ - *Type:* string
356
+
357
+ ---
358
+
359
+ ##### `reportMissingContextKey` <a name="reportMissingContextKey" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.reportMissingContextKey"></a>
360
+
361
+ ```typescript
362
+ public reportMissingContextKey(report: MissingContext): void
363
+ ```
364
+
365
+ Indicate that a context key was expected.
366
+
367
+ Contains instructions which will be emitted into the cloud assembly on how
368
+ the key should be supplied.
369
+
370
+ ###### `report`<sup>Required</sup> <a name="report" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.reportMissingContextKey.parameter.report"></a>
371
+
372
+ - *Type:* aws-cdk-lib.cloud_assembly_schema.MissingContext
373
+
374
+ The set of parameters needed to obtain the context.
375
+
376
+ ---
377
+
378
+ ##### `resolve` <a name="resolve" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.resolve"></a>
379
+
380
+ ```typescript
381
+ public resolve(obj: any): any
382
+ ```
383
+
384
+ Resolve a tokenized value in the context of the current stack.
385
+
386
+ ###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.resolve.parameter.obj"></a>
387
+
388
+ - *Type:* any
389
+
390
+ ---
391
+
392
+ ##### `splitArn` <a name="splitArn" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.splitArn"></a>
393
+
394
+ ```typescript
395
+ public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents
396
+ ```
397
+
398
+ Splits the provided ARN into its components.
399
+
400
+ Works both if 'arn' is a string like 'arn:aws:s3:::bucket',
401
+ and a Token representing a dynamic CloudFormation expression
402
+ (in which case the returned components will also be dynamic CloudFormation expressions,
403
+ encoded as Tokens).
404
+
405
+ ###### `arn`<sup>Required</sup> <a name="arn" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.splitArn.parameter.arn"></a>
406
+
407
+ - *Type:* string
408
+
409
+ the ARN to split into its components.
410
+
411
+ ---
412
+
413
+ ###### `arnFormat`<sup>Required</sup> <a name="arnFormat" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.splitArn.parameter.arnFormat"></a>
414
+
415
+ - *Type:* aws-cdk-lib.ArnFormat
416
+
417
+ the expected format of 'arn' - depends on what format the service 'arn' represents uses.
418
+
419
+ ---
420
+
421
+ ##### `toJsonString` <a name="toJsonString" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toJsonString"></a>
422
+
423
+ ```typescript
424
+ public toJsonString(obj: any, space?: number): string
425
+ ```
426
+
427
+ Convert an object, potentially containing tokens, to a JSON string.
428
+
429
+ ###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toJsonString.parameter.obj"></a>
430
+
431
+ - *Type:* any
432
+
433
+ ---
434
+
435
+ ###### `space`<sup>Optional</sup> <a name="space" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toJsonString.parameter.space"></a>
436
+
437
+ - *Type:* number
438
+
439
+ ---
440
+
441
+ ##### `toYamlString` <a name="toYamlString" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toYamlString"></a>
442
+
443
+ ```typescript
444
+ public toYamlString(obj: any): string
445
+ ```
446
+
447
+ Convert an object, potentially containing tokens, to a YAML string.
448
+
449
+ ###### `obj`<sup>Required</sup> <a name="obj" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.toYamlString.parameter.obj"></a>
450
+
451
+ - *Type:* any
452
+
453
+ ---
454
+
455
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
456
+
457
+ | **Name** | **Description** |
458
+ | --- | --- |
459
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
460
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.isStack">isStack</a></code> | Return whether the given object is a Stack. |
461
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.of">of</a></code> | Looks up the first stack scope in which `construct` is defined. |
462
+
463
+ ---
464
+
465
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.isConstruct"></a>
466
+
467
+ ```typescript
468
+ import { DailyCloudWatchLogsArchiveStack } from '@gammarers/aws-daily-cloud-watch-logs-archive-stack'
469
+
470
+ DailyCloudWatchLogsArchiveStack.isConstruct(x: any)
471
+ ```
472
+
473
+ Checks if `x` is a construct.
474
+
475
+ ###### `x`<sup>Required</sup> <a name="x" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.isConstruct.parameter.x"></a>
476
+
477
+ - *Type:* any
478
+
479
+ Any object.
480
+
481
+ ---
482
+
483
+ ##### `isStack` <a name="isStack" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.isStack"></a>
484
+
485
+ ```typescript
486
+ import { DailyCloudWatchLogsArchiveStack } from '@gammarers/aws-daily-cloud-watch-logs-archive-stack'
487
+
488
+ DailyCloudWatchLogsArchiveStack.isStack(x: any)
489
+ ```
490
+
491
+ Return whether the given object is a Stack.
492
+
493
+ We do attribute detection since we can't reliably use 'instanceof'.
494
+
495
+ ###### `x`<sup>Required</sup> <a name="x" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.isStack.parameter.x"></a>
496
+
497
+ - *Type:* any
498
+
499
+ ---
500
+
501
+ ##### `of` <a name="of" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.of"></a>
502
+
503
+ ```typescript
504
+ import { DailyCloudWatchLogsArchiveStack } from '@gammarers/aws-daily-cloud-watch-logs-archive-stack'
505
+
506
+ DailyCloudWatchLogsArchiveStack.of(construct: IConstruct)
507
+ ```
508
+
509
+ Looks up the first stack scope in which `construct` is defined.
510
+
511
+ Fails if there is no stack up the tree.
512
+
513
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.of.parameter.construct"></a>
514
+
515
+ - *Type:* constructs.IConstruct
516
+
517
+ The construct to start the search from.
518
+
519
+ ---
520
+
521
+ #### Properties <a name="Properties" id="Properties"></a>
522
+
523
+ | **Name** | **Type** | **Description** |
524
+ | --- | --- | --- |
525
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
526
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.account">account</a></code> | <code>string</code> | The AWS account into which this stack will be deployed. |
527
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.artifactId">artifactId</a></code> | <code>string</code> | The ID of the cloud assembly artifact for this stack. |
528
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.availabilityZones">availabilityZones</a></code> | <code>string[]</code> | Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. |
529
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.bundlingRequired">bundlingRequired</a></code> | <code>boolean</code> | Indicates whether the stack requires bundling or not. |
530
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.dependencies">dependencies</a></code> | <code>aws-cdk-lib.Stack[]</code> | Return the stacks this stack depends on. |
531
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.environment">environment</a></code> | <code>string</code> | The environment coordinates in which this stack is deployed. |
532
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.nested">nested</a></code> | <code>boolean</code> | Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. |
533
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.notificationArns">notificationArns</a></code> | <code>string[]</code> | Returns the list of notification Amazon Resource Names (ARNs) for the current stack. |
534
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.partition">partition</a></code> | <code>string</code> | The partition in which this stack is defined. |
535
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.region">region</a></code> | <code>string</code> | The AWS region into which this stack will be deployed (e.g. `us-west-2`). |
536
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.stackId">stackId</a></code> | <code>string</code> | The ID of the stack. |
537
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.stackName">stackName</a></code> | <code>string</code> | The concrete CloudFormation physical stack name. |
538
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.synthesizer">synthesizer</a></code> | <code>aws-cdk-lib.IStackSynthesizer</code> | Synthesis method for this stack. |
539
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.tags">tags</a></code> | <code>aws-cdk-lib.TagManager</code> | Tags to be applied to the stack. |
540
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.templateFile">templateFile</a></code> | <code>string</code> | The name of the CloudFormation template file emitted to the output directory during synthesis. |
541
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.templateOptions">templateOptions</a></code> | <code>aws-cdk-lib.ITemplateOptions</code> | Options for CloudFormation template (like version, transform, description). |
542
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.urlSuffix">urlSuffix</a></code> | <code>string</code> | The Amazon domain suffix for the region in which this stack is defined. |
543
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.nestedStackParent">nestedStackParent</a></code> | <code>aws-cdk-lib.Stack</code> | If this is a nested stack, returns it's parent stack. |
544
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.nestedStackResource">nestedStackResource</a></code> | <code>aws-cdk-lib.CfnResource</code> | If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. |
545
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.terminationProtection">terminationProtection</a></code> | <code>boolean</code> | Whether termination protection is enabled for this stack. |
546
+
547
+ ---
548
+
549
+ ##### `node`<sup>Required</sup> <a name="node" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.node"></a>
550
+
551
+ ```typescript
552
+ public readonly node: Node;
553
+ ```
554
+
555
+ - *Type:* constructs.Node
556
+
557
+ The tree node.
558
+
559
+ ---
560
+
561
+ ##### `account`<sup>Required</sup> <a name="account" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.account"></a>
562
+
563
+ ```typescript
564
+ public readonly account: string;
565
+ ```
566
+
567
+ - *Type:* string
568
+
569
+ The AWS account into which this stack will be deployed.
570
+
571
+ This value is resolved according to the following rules:
572
+
573
+ 1. The value provided to `env.account` when the stack is defined. This can
574
+ either be a concrete account (e.g. `585695031111`) or the
575
+ `Aws.ACCOUNT_ID` token.
576
+ 3. `Aws.ACCOUNT_ID`, which represents the CloudFormation intrinsic reference
577
+ `{ "Ref": "AWS::AccountId" }` encoded as a string token.
578
+
579
+ Preferably, you should use the return value as an opaque string and not
580
+ attempt to parse it to implement your logic. If you do, you must first
581
+ check that it is a concrete value an not an unresolved token. If this
582
+ value is an unresolved token (`Token.isUnresolved(stack.account)` returns
583
+ `true`), this implies that the user wishes that this stack will synthesize
584
+ into a **account-agnostic template**. In this case, your code should either
585
+ fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or
586
+ implement some other region-agnostic behavior.
587
+
588
+ ---
589
+
590
+ ##### `artifactId`<sup>Required</sup> <a name="artifactId" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.artifactId"></a>
591
+
592
+ ```typescript
593
+ public readonly artifactId: string;
594
+ ```
595
+
596
+ - *Type:* string
597
+
598
+ The ID of the cloud assembly artifact for this stack.
599
+
600
+ ---
601
+
602
+ ##### `availabilityZones`<sup>Required</sup> <a name="availabilityZones" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.availabilityZones"></a>
603
+
604
+ ```typescript
605
+ public readonly availabilityZones: string[];
606
+ ```
607
+
608
+ - *Type:* string[]
609
+
610
+ Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
611
+
612
+ If the stack is environment-agnostic (either account and/or region are
613
+ tokens), this property will return an array with 2 tokens that will resolve
614
+ at deploy-time to the first two availability zones returned from CloudFormation's
615
+ `Fn::GetAZs` intrinsic function.
616
+
617
+ If they are not available in the context, returns a set of dummy values and
618
+ reports them as missing, and let the CLI resolve them by calling EC2
619
+ `DescribeAvailabilityZones` on the target environment.
620
+
621
+ To specify a different strategy for selecting availability zones override this method.
622
+
623
+ ---
624
+
625
+ ##### `bundlingRequired`<sup>Required</sup> <a name="bundlingRequired" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.bundlingRequired"></a>
626
+
627
+ ```typescript
628
+ public readonly bundlingRequired: boolean;
629
+ ```
630
+
631
+ - *Type:* boolean
632
+
633
+ Indicates whether the stack requires bundling or not.
634
+
635
+ ---
636
+
637
+ ##### `dependencies`<sup>Required</sup> <a name="dependencies" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.dependencies"></a>
638
+
639
+ ```typescript
640
+ public readonly dependencies: Stack[];
641
+ ```
642
+
643
+ - *Type:* aws-cdk-lib.Stack[]
644
+
645
+ Return the stacks this stack depends on.
646
+
647
+ ---
648
+
649
+ ##### `environment`<sup>Required</sup> <a name="environment" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.environment"></a>
650
+
651
+ ```typescript
652
+ public readonly environment: string;
653
+ ```
654
+
655
+ - *Type:* string
656
+
657
+ The environment coordinates in which this stack is deployed.
658
+
659
+ In the form
660
+ `aws://account/region`. Use `stack.account` and `stack.region` to obtain
661
+ the specific values, no need to parse.
662
+
663
+ You can use this value to determine if two stacks are targeting the same
664
+ environment.
665
+
666
+ If either `stack.account` or `stack.region` are not concrete values (e.g.
667
+ `Aws.ACCOUNT_ID` or `Aws.REGION`) the special strings `unknown-account` and/or
668
+ `unknown-region` will be used respectively to indicate this stack is
669
+ region/account-agnostic.
670
+
671
+ ---
672
+
673
+ ##### `nested`<sup>Required</sup> <a name="nested" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.nested"></a>
674
+
675
+ ```typescript
676
+ public readonly nested: boolean;
677
+ ```
678
+
679
+ - *Type:* boolean
680
+
681
+ Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent.
682
+
683
+ ---
684
+
685
+ ##### `notificationArns`<sup>Required</sup> <a name="notificationArns" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.notificationArns"></a>
686
+
687
+ ```typescript
688
+ public readonly notificationArns: string[];
689
+ ```
690
+
691
+ - *Type:* string[]
692
+
693
+ Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
694
+
695
+ ---
696
+
697
+ ##### `partition`<sup>Required</sup> <a name="partition" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.partition"></a>
698
+
699
+ ```typescript
700
+ public readonly partition: string;
701
+ ```
702
+
703
+ - *Type:* string
704
+
705
+ The partition in which this stack is defined.
706
+
707
+ ---
708
+
709
+ ##### `region`<sup>Required</sup> <a name="region" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.region"></a>
710
+
711
+ ```typescript
712
+ public readonly region: string;
713
+ ```
714
+
715
+ - *Type:* string
716
+
717
+ The AWS region into which this stack will be deployed (e.g. `us-west-2`).
718
+
719
+ This value is resolved according to the following rules:
720
+
721
+ 1. The value provided to `env.region` when the stack is defined. This can
722
+ either be a concrete region (e.g. `us-west-2`) or the `Aws.REGION`
723
+ token.
724
+ 3. `Aws.REGION`, which is represents the CloudFormation intrinsic reference
725
+ `{ "Ref": "AWS::Region" }` encoded as a string token.
726
+
727
+ Preferably, you should use the return value as an opaque string and not
728
+ attempt to parse it to implement your logic. If you do, you must first
729
+ check that it is a concrete value an not an unresolved token. If this
730
+ value is an unresolved token (`Token.isUnresolved(stack.region)` returns
731
+ `true`), this implies that the user wishes that this stack will synthesize
732
+ into a **region-agnostic template**. In this case, your code should either
733
+ fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or
734
+ implement some other region-agnostic behavior.
735
+
736
+ ---
737
+
738
+ ##### `stackId`<sup>Required</sup> <a name="stackId" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.stackId"></a>
739
+
740
+ ```typescript
741
+ public readonly stackId: string;
742
+ ```
743
+
744
+ - *Type:* string
745
+
746
+ The ID of the stack.
747
+
748
+ ---
749
+
750
+ *Example*
751
+
752
+ ```typescript
753
+ // After resolving, looks like
754
+ 'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
755
+ ```
756
+
757
+
758
+ ##### `stackName`<sup>Required</sup> <a name="stackName" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.stackName"></a>
759
+
760
+ ```typescript
761
+ public readonly stackName: string;
762
+ ```
763
+
764
+ - *Type:* string
765
+
766
+ The concrete CloudFormation physical stack name.
767
+
768
+ This is either the name defined explicitly in the `stackName` prop or
769
+ allocated based on the stack's location in the construct tree. Stacks that
770
+ are directly defined under the app use their construct `id` as their stack
771
+ name. Stacks that are defined deeper within the tree will use a hashed naming
772
+ scheme based on the construct path to ensure uniqueness.
773
+
774
+ If you wish to obtain the deploy-time AWS::StackName intrinsic,
775
+ you can use `Aws.STACK_NAME` directly.
776
+
777
+ ---
778
+
779
+ ##### `synthesizer`<sup>Required</sup> <a name="synthesizer" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.synthesizer"></a>
780
+
781
+ ```typescript
782
+ public readonly synthesizer: IStackSynthesizer;
783
+ ```
784
+
785
+ - *Type:* aws-cdk-lib.IStackSynthesizer
786
+
787
+ Synthesis method for this stack.
788
+
789
+ ---
790
+
791
+ ##### `tags`<sup>Required</sup> <a name="tags" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.tags"></a>
792
+
793
+ ```typescript
794
+ public readonly tags: TagManager;
795
+ ```
796
+
797
+ - *Type:* aws-cdk-lib.TagManager
798
+
799
+ Tags to be applied to the stack.
800
+
801
+ ---
802
+
803
+ ##### `templateFile`<sup>Required</sup> <a name="templateFile" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.templateFile"></a>
804
+
805
+ ```typescript
806
+ public readonly templateFile: string;
807
+ ```
808
+
809
+ - *Type:* string
810
+
811
+ The name of the CloudFormation template file emitted to the output directory during synthesis.
812
+
813
+ Example value: `MyStack.template.json`
814
+
815
+ ---
816
+
817
+ ##### `templateOptions`<sup>Required</sup> <a name="templateOptions" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.templateOptions"></a>
818
+
819
+ ```typescript
820
+ public readonly templateOptions: ITemplateOptions;
821
+ ```
822
+
823
+ - *Type:* aws-cdk-lib.ITemplateOptions
824
+
825
+ Options for CloudFormation template (like version, transform, description).
826
+
827
+ ---
828
+
829
+ ##### `urlSuffix`<sup>Required</sup> <a name="urlSuffix" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.urlSuffix"></a>
830
+
831
+ ```typescript
832
+ public readonly urlSuffix: string;
833
+ ```
834
+
835
+ - *Type:* string
836
+
837
+ The Amazon domain suffix for the region in which this stack is defined.
838
+
839
+ ---
840
+
841
+ ##### `nestedStackParent`<sup>Optional</sup> <a name="nestedStackParent" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.nestedStackParent"></a>
842
+
843
+ ```typescript
844
+ public readonly nestedStackParent: Stack;
845
+ ```
846
+
847
+ - *Type:* aws-cdk-lib.Stack
848
+
849
+ If this is a nested stack, returns it's parent stack.
850
+
851
+ ---
852
+
853
+ ##### `nestedStackResource`<sup>Optional</sup> <a name="nestedStackResource" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.nestedStackResource"></a>
854
+
855
+ ```typescript
856
+ public readonly nestedStackResource: CfnResource;
857
+ ```
858
+
859
+ - *Type:* aws-cdk-lib.CfnResource
860
+
861
+ If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.
862
+
863
+ `undefined` for top-level (non-nested) stacks.
864
+
865
+ ---
866
+
867
+ ##### `terminationProtection`<sup>Optional</sup> <a name="terminationProtection" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStack.property.terminationProtection"></a>
868
+
869
+ ```typescript
870
+ public readonly terminationProtection: boolean;
871
+ ```
872
+
873
+ - *Type:* boolean
874
+
875
+ Whether termination protection is enabled for this stack.
876
+
877
+ ---
878
+
879
+
880
+ ## Structs <a name="Structs" id="Structs"></a>
881
+
882
+ ### DailyCloudWatchLogsArchiveStackProps <a name="DailyCloudWatchLogsArchiveStackProps" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps"></a>
883
+
884
+ #### Initializer <a name="Initializer" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.Initializer"></a>
885
+
886
+ ```typescript
887
+ import { DailyCloudWatchLogsArchiveStackProps } from '@gammarers/aws-daily-cloud-watch-logs-archive-stack'
888
+
889
+ const dailyCloudWatchLogsArchiveStackProps: DailyCloudWatchLogsArchiveStackProps = { ... }
890
+ ```
891
+
892
+ #### Properties <a name="Properties" id="Properties"></a>
893
+
894
+ | **Name** | **Type** | **Description** |
895
+ | --- | --- | --- |
896
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.analyticsReporting">analyticsReporting</a></code> | <code>boolean</code> | Include runtime versioning information in this Stack. |
897
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.crossRegionReferences">crossRegionReferences</a></code> | <code>boolean</code> | Enable this flag to allow native cross region stack references. |
898
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.description">description</a></code> | <code>string</code> | A description of the stack. |
899
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.env">env</a></code> | <code>aws-cdk-lib.Environment</code> | The AWS environment (account/region) where this stack will be deployed. |
900
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.permissionsBoundary">permissionsBoundary</a></code> | <code>aws-cdk-lib.PermissionsBoundary</code> | Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. |
901
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.stackName">stackName</a></code> | <code>string</code> | Name to deploy the stack with. |
902
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.synthesizer">synthesizer</a></code> | <code>aws-cdk-lib.IStackSynthesizer</code> | Synthesis method to use while deploying this stack. |
903
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.tags">tags</a></code> | <code>{[ key: string ]: string}</code> | Stack tags that will be applied to all the taggable resources and the stack itself. |
904
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.terminationProtection">terminationProtection</a></code> | <code>boolean</code> | Whether to enable termination protection for this stack. |
905
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.targetResourceTag">targetResourceTag</a></code> | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.TargetResourceTagProperty">TargetResourceTagProperty</a></code> | *No description.* |
906
+
907
+ ---
908
+
909
+ ##### `analyticsReporting`<sup>Optional</sup> <a name="analyticsReporting" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.analyticsReporting"></a>
910
+
911
+ ```typescript
912
+ public readonly analyticsReporting: boolean;
913
+ ```
914
+
915
+ - *Type:* boolean
916
+ - *Default:* `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key
917
+
918
+ Include runtime versioning information in this Stack.
919
+
920
+ ---
921
+
922
+ ##### `crossRegionReferences`<sup>Optional</sup> <a name="crossRegionReferences" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.crossRegionReferences"></a>
923
+
924
+ ```typescript
925
+ public readonly crossRegionReferences: boolean;
926
+ ```
927
+
928
+ - *Type:* boolean
929
+ - *Default:* false
930
+
931
+ Enable this flag to allow native cross region stack references.
932
+
933
+ Enabling this will create a CloudFormation custom resource
934
+ in both the producing stack and consuming stack in order to perform the export/import
935
+
936
+ This feature is currently experimental
937
+
938
+ ---
939
+
940
+ ##### `description`<sup>Optional</sup> <a name="description" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.description"></a>
941
+
942
+ ```typescript
943
+ public readonly description: string;
944
+ ```
945
+
946
+ - *Type:* string
947
+ - *Default:* No description.
948
+
949
+ A description of the stack.
950
+
951
+ ---
952
+
953
+ ##### `env`<sup>Optional</sup> <a name="env" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.env"></a>
954
+
955
+ ```typescript
956
+ public readonly env: Environment;
957
+ ```
958
+
959
+ - *Type:* aws-cdk-lib.Environment
960
+ - *Default:* The environment of the containing `Stage` if available, otherwise create the stack will be environment-agnostic.
961
+
962
+ The AWS environment (account/region) where this stack will be deployed.
963
+
964
+ Set the `region`/`account` fields of `env` to either a concrete value to
965
+ select the indicated environment (recommended for production stacks), or to
966
+ the values of environment variables
967
+ `CDK_DEFAULT_REGION`/`CDK_DEFAULT_ACCOUNT` to let the target environment
968
+ depend on the AWS credentials/configuration that the CDK CLI is executed
969
+ under (recommended for development stacks).
970
+
971
+ If the `Stack` is instantiated inside a `Stage`, any undefined
972
+ `region`/`account` fields from `env` will default to the same field on the
973
+ encompassing `Stage`, if configured there.
974
+
975
+ If either `region` or `account` are not set nor inherited from `Stage`, the
976
+ Stack will be considered "*environment-agnostic*"". Environment-agnostic
977
+ stacks can be deployed to any environment but may not be able to take
978
+ advantage of all features of the CDK. For example, they will not be able to
979
+ use environmental context lookups such as `ec2.Vpc.fromLookup` and will not
980
+ automatically translate Service Principals to the right format based on the
981
+ environment's AWS partition, and other such enhancements.
982
+
983
+ ---
984
+
985
+ *Example*
986
+
987
+ ```typescript
988
+ // Use a concrete account and region to deploy this stack to:
989
+ // `.account` and `.region` will simply return these values.
990
+ new Stack(app, 'Stack1', {
991
+ env: {
992
+ account: '123456789012',
993
+ region: 'us-east-1'
994
+ },
995
+ });
996
+
997
+ // Use the CLI's current credentials to determine the target environment:
998
+ // `.account` and `.region` will reflect the account+region the CLI
999
+ // is configured to use (based on the user CLI credentials)
1000
+ new Stack(app, 'Stack2', {
1001
+ env: {
1002
+ account: process.env.CDK_DEFAULT_ACCOUNT,
1003
+ region: process.env.CDK_DEFAULT_REGION
1004
+ },
1005
+ });
1006
+
1007
+ // Define multiple stacks stage associated with an environment
1008
+ const myStage = new Stage(app, 'MyStage', {
1009
+ env: {
1010
+ account: '123456789012',
1011
+ region: 'us-east-1'
1012
+ }
1013
+ });
1014
+
1015
+ // both of these stacks will use the stage's account/region:
1016
+ // `.account` and `.region` will resolve to the concrete values as above
1017
+ new MyStack(myStage, 'Stack1');
1018
+ new YourStack(myStage, 'Stack2');
1019
+
1020
+ // Define an environment-agnostic stack:
1021
+ // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
1022
+ // which will only resolve to actual values by CloudFormation during deployment.
1023
+ new MyStack(app, 'Stack1');
1024
+ ```
1025
+
1026
+
1027
+ ##### `permissionsBoundary`<sup>Optional</sup> <a name="permissionsBoundary" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.permissionsBoundary"></a>
1028
+
1029
+ ```typescript
1030
+ public readonly permissionsBoundary: PermissionsBoundary;
1031
+ ```
1032
+
1033
+ - *Type:* aws-cdk-lib.PermissionsBoundary
1034
+ - *Default:* no permissions boundary is applied
1035
+
1036
+ Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
1037
+
1038
+ ---
1039
+
1040
+ ##### `stackName`<sup>Optional</sup> <a name="stackName" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.stackName"></a>
1041
+
1042
+ ```typescript
1043
+ public readonly stackName: string;
1044
+ ```
1045
+
1046
+ - *Type:* string
1047
+ - *Default:* Derived from construct path.
1048
+
1049
+ Name to deploy the stack with.
1050
+
1051
+ ---
1052
+
1053
+ ##### `synthesizer`<sup>Optional</sup> <a name="synthesizer" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.synthesizer"></a>
1054
+
1055
+ ```typescript
1056
+ public readonly synthesizer: IStackSynthesizer;
1057
+ ```
1058
+
1059
+ - *Type:* aws-cdk-lib.IStackSynthesizer
1060
+ - *Default:* The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise.
1061
+
1062
+ Synthesis method to use while deploying this stack.
1063
+
1064
+ The Stack Synthesizer controls aspects of synthesis and deployment,
1065
+ like how assets are referenced and what IAM roles to use. For more
1066
+ information, see the README of the main CDK package.
1067
+
1068
+ If not specified, the `defaultStackSynthesizer` from `App` will be used.
1069
+ If that is not specified, `DefaultStackSynthesizer` is used if
1070
+ `@aws-cdk/core:newStyleStackSynthesis` is set to `true` or the CDK major
1071
+ version is v2. In CDK v1 `LegacyStackSynthesizer` is the default if no
1072
+ other synthesizer is specified.
1073
+
1074
+ ---
1075
+
1076
+ ##### `tags`<sup>Optional</sup> <a name="tags" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.tags"></a>
1077
+
1078
+ ```typescript
1079
+ public readonly tags: {[ key: string ]: string};
1080
+ ```
1081
+
1082
+ - *Type:* {[ key: string ]: string}
1083
+ - *Default:* {}
1084
+
1085
+ Stack tags that will be applied to all the taggable resources and the stack itself.
1086
+
1087
+ ---
1088
+
1089
+ ##### `terminationProtection`<sup>Optional</sup> <a name="terminationProtection" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.terminationProtection"></a>
1090
+
1091
+ ```typescript
1092
+ public readonly terminationProtection: boolean;
1093
+ ```
1094
+
1095
+ - *Type:* boolean
1096
+ - *Default:* false
1097
+
1098
+ Whether to enable termination protection for this stack.
1099
+
1100
+ ---
1101
+
1102
+ ##### `targetResourceTag`<sup>Required</sup> <a name="targetResourceTag" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.DailyCloudWatchLogsArchiveStackProps.property.targetResourceTag"></a>
1103
+
1104
+ ```typescript
1105
+ public readonly targetResourceTag: TargetResourceTagProperty;
1106
+ ```
1107
+
1108
+ - *Type:* <a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.TargetResourceTagProperty">TargetResourceTagProperty</a>
1109
+
1110
+ ---
1111
+
1112
+ ### TargetResourceTagProperty <a name="TargetResourceTagProperty" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.TargetResourceTagProperty"></a>
1113
+
1114
+ #### Initializer <a name="Initializer" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.TargetResourceTagProperty.Initializer"></a>
1115
+
1116
+ ```typescript
1117
+ import { TargetResourceTagProperty } from '@gammarers/aws-daily-cloud-watch-logs-archive-stack'
1118
+
1119
+ const targetResourceTagProperty: TargetResourceTagProperty = { ... }
1120
+ ```
1121
+
1122
+ #### Properties <a name="Properties" id="Properties"></a>
1123
+
1124
+ | **Name** | **Type** | **Description** |
1125
+ | --- | --- | --- |
1126
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.TargetResourceTagProperty.property.key">key</a></code> | <code>string</code> | *No description.* |
1127
+ | <code><a href="#@gammarers/aws-daily-cloud-watch-logs-archive-stack.TargetResourceTagProperty.property.values">values</a></code> | <code>string[]</code> | *No description.* |
1128
+
1129
+ ---
1130
+
1131
+ ##### `key`<sup>Required</sup> <a name="key" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.TargetResourceTagProperty.property.key"></a>
1132
+
1133
+ ```typescript
1134
+ public readonly key: string;
1135
+ ```
1136
+
1137
+ - *Type:* string
1138
+
1139
+ ---
1140
+
1141
+ ##### `values`<sup>Required</sup> <a name="values" id="@gammarers/aws-daily-cloud-watch-logs-archive-stack.TargetResourceTagProperty.property.values"></a>
1142
+
1143
+ ```typescript
1144
+ public readonly values: string[];
1145
+ ```
1146
+
1147
+ - *Type:* string[]
1148
+
1149
+ ---
1150
+
1151
+
1152
+