@propulsionworks/cloudformation 0.1.39 → 0.1.41

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.
Files changed (72) hide show
  1. package/out/exports/resources.generated/aws-arcregionswitch-plan.d.ts +94 -1
  2. package/out/exports/resources.generated/aws-autoscaling-autoscalinggroup.d.ts +47 -3
  3. package/out/exports/resources.generated/aws-bedrockagentcore-gateway.d.ts +53 -1
  4. package/out/exports/resources.generated/aws-bedrockagentcore-gatewaytarget.d.ts +16 -0
  5. package/out/exports/resources.generated/aws-cases-caserule.d.ts +182 -0
  6. package/out/exports/resources.generated/aws-cases-domain.d.ts +65 -0
  7. package/out/exports/resources.generated/aws-cases-field.d.ts +85 -0
  8. package/out/exports/resources.generated/aws-cases-layout.d.ts +150 -0
  9. package/out/exports/resources.generated/aws-cases-template.d.ts +155 -0
  10. package/out/exports/resources.generated/aws-cloudformation-waitcondition.d.ts +2 -2
  11. package/out/exports/resources.generated/aws-cloudfront-anycastiplist.d.ts +1 -0
  12. package/out/exports/resources.generated/aws-codedeploy-deploymentgroup.d.ts +3 -3
  13. package/out/exports/resources.generated/aws-connect-contactflowmodule.d.ts +13 -0
  14. package/out/exports/resources.generated/aws-connect-hoursofoperation.d.ts +90 -0
  15. package/out/exports/resources.generated/aws-connectcampaignsv2-campaign.d.ts +14 -14
  16. package/out/exports/resources.generated/aws-datasync-agent.d.ts +1 -1
  17. package/out/exports/resources.generated/aws-datasync-locationazureblob.d.ts +9 -9
  18. package/out/exports/resources.generated/aws-datasync-locationefs.d.ts +5 -5
  19. package/out/exports/resources.generated/aws-datasync-locationfsxlustre.d.ts +2 -2
  20. package/out/exports/resources.generated/aws-datasync-locationfsxontap.d.ts +3 -3
  21. package/out/exports/resources.generated/aws-datasync-locationfsxopenzfs.d.ts +2 -2
  22. package/out/exports/resources.generated/aws-datasync-locationfsxwindows.d.ts +2 -2
  23. package/out/exports/resources.generated/aws-datasync-locationhdfs.d.ts +1 -1
  24. package/out/exports/resources.generated/aws-datasync-locationnfs.d.ts +1 -1
  25. package/out/exports/resources.generated/aws-datasync-locationobjectstorage.d.ts +10 -10
  26. package/out/exports/resources.generated/aws-datasync-locations3.d.ts +3 -3
  27. package/out/exports/resources.generated/aws-datasync-locationsmb.d.ts +9 -9
  28. package/out/exports/resources.generated/aws-datasync-task.d.ts +8 -8
  29. package/out/exports/resources.generated/aws-deadline-fleet.d.ts +25 -7
  30. package/out/exports/resources.generated/aws-ec2-clientvpnendpoint.d.ts +10 -0
  31. package/out/exports/resources.generated/aws-ec2-ec2fleet.d.ts +3 -1
  32. package/out/exports/resources.generated/aws-ec2-spotfleet.d.ts +3 -1
  33. package/out/exports/resources.generated/aws-ec2-vpnconcentrator.d.ts +1 -1
  34. package/out/exports/resources.generated/aws-ec2-vpnconnection.d.ts +2 -0
  35. package/out/exports/resources.generated/aws-ecr-repositorycreationtemplate.d.ts +1 -1
  36. package/out/exports/resources.generated/aws-ecs-capacityprovider.d.ts +14 -0
  37. package/out/exports/resources.generated/aws-ecs-expressgatewayservice.d.ts +12 -0
  38. package/out/exports/resources.generated/aws-eks-nodegroup.d.ts +8 -8
  39. package/out/exports/resources.generated/aws-emr-step.d.ts +10 -0
  40. package/out/exports/resources.generated/aws-fsx-s3accesspointattachment.d.ts +14 -10
  41. package/out/exports/resources.generated/aws-groundstation-dataflowendpointgroupv2.d.ts +259 -0
  42. package/out/exports/resources.generated/aws-iot-topicrule.d.ts +25 -0
  43. package/out/exports/resources.generated/aws-iotanalytics-channel.d.ts +4 -4
  44. package/out/exports/resources.generated/aws-iotanalytics-dataset.d.ts +7 -7
  45. package/out/exports/resources.generated/aws-iotanalytics-datastore.d.ts +6 -6
  46. package/out/exports/resources.generated/aws-iotanalytics-pipeline.d.ts +2 -2
  47. package/out/exports/resources.generated/aws-kafkaconnect-connector.d.ts +5 -0
  48. package/out/exports/resources.generated/aws-lex-bot.d.ts +98 -0
  49. package/out/exports/resources.generated/aws-logs-loggroup.d.ts +6 -0
  50. package/out/exports/resources.generated/aws-logs-transformer.d.ts +6 -1
  51. package/out/exports/resources.generated/aws-mediatailor-playbackconfiguration.d.ts +42 -0
  52. package/out/exports/resources.generated/aws-observabilityadmin-organizationtelemetryrule.d.ts +44 -43
  53. package/out/exports/resources.generated/aws-observabilityadmin-s3tableintegration.d.ts +10 -10
  54. package/out/exports/resources.generated/aws-observabilityadmin-telemetrypipelines.d.ts +20 -3
  55. package/out/exports/resources.generated/aws-observabilityadmin-telemetryrule.d.ts +45 -44
  56. package/out/exports/resources.generated/aws-odb-odbpeeringconnection.d.ts +10 -0
  57. package/out/exports/resources.generated/aws-paymentcryptography-key.d.ts +1 -1
  58. package/out/exports/resources.generated/aws-quicksight-dashboard.d.ts +95 -0
  59. package/out/exports/resources.generated/aws-ram-resourceshare.d.ts +5 -1
  60. package/out/exports/resources.generated/aws-resiliencehub-app.d.ts +2 -2
  61. package/out/exports/resources.generated/aws-resourcegroups-group.d.ts +10 -10
  62. package/out/exports/resources.generated/aws-route53profiles-profile.d.ts +1 -1
  63. package/out/exports/resources.generated/aws-route53resolver-resolverendpoint.d.ts +10 -0
  64. package/out/exports/resources.generated/aws-s3-bucket.d.ts +1 -1
  65. package/out/exports/resources.generated/aws-securityhub-connectorv2.d.ts +34 -45
  66. package/out/exports/resources.generated/aws-ses-multiregionendpoint.d.ts +1 -1
  67. package/out/exports/resources.generated/aws-ses-tenant.d.ts +58 -0
  68. package/out/exports/resources.generated/aws-ssm-association.d.ts +2 -2
  69. package/out/exports/resources.generated/aws-ssm-maintenancewindowtarget.d.ts +3 -2
  70. package/out/exports/resources.generated/aws-ssm-maintenancewindowtask.d.ts +3 -2
  71. package/out/exports/resources.generated/aws-workspacesweb-usersettings.d.ts +24 -0
  72. package/package.json +1 -1
@@ -26,6 +26,12 @@ export type LogsLogGroupProps = {
26
26
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy}
27
27
  */
28
28
  DataProtectionPolicy?: Record<string, unknown> | undefined;
29
+ /**
30
+ * Indicates whether deletion protection is enabled for this log group. When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.
31
+ * @default false
32
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-deletionprotectionenabled}
33
+ */
34
+ DeletionProtectionEnabled?: boolean | undefined;
29
35
  /**
30
36
  * Creates or updates a *field index policy* for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html) .
31
37
  *
@@ -119,7 +119,7 @@ export type MoveKeyEntry = {
119
119
  /**
120
120
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-ocsfversion.html}
121
121
  */
122
- export type OcsfVersion = "V1.1";
122
+ export type OcsfVersion = "V1.1" | "V1.5";
123
123
  /**
124
124
  * This processor parses CloudFront vended logs, extract fields, and convert them into JSON format. Encoded field values are decoded. Values that are integers and doubles are treated as such. For more information about this processor including examples, see [parseCloudfront](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-parseCloudfront)
125
125
  *
@@ -175,6 +175,11 @@ export type ParseToOCSF = {
175
175
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsetoocsf.html#cfn-logs-transformer-parsetoocsf-eventsource}
176
176
  */
177
177
  EventSource: EventSource;
178
+ /**
179
+ * The version of the OCSF mapping to use for parsing log data.
180
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsetoocsf.html#cfn-logs-transformer-parsetoocsf-mappingversion}
181
+ */
182
+ MappingVersion?: string | undefined;
178
183
  /**
179
184
  * Specify which version of the OCSF schema to use for the transformed log events.
180
185
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsetoocsf.html#cfn-logs-transformer-parsetoocsf-ocsfversion}
@@ -14,6 +14,11 @@ export type MediaTailorPlaybackConfigurationProps = {
14
14
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-adconditioningconfiguration}
15
15
  */
16
16
  AdConditioningConfiguration?: AdConditioningConfiguration | undefined;
17
+ /**
18
+ * The configuration for the request to the specified Ad Decision Server URL.
19
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverconfiguration}
20
+ */
21
+ AdDecisionServerConfiguration?: AdDecisionServerConfiguration | undefined;
17
22
  /**
18
23
  * The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
19
24
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverurl}
@@ -139,6 +144,17 @@ export type AdConditioningConfiguration = {
139
144
  */
140
145
  StreamingMediaFileConditioning: StreamingMediaFileConditioning;
141
146
  };
147
+ /**
148
+ * The configuration for the request to the specified Ad Decision Server URL.
149
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-addecisionserverconfiguration.html}
150
+ */
151
+ export type AdDecisionServerConfiguration = {
152
+ /**
153
+ * The configuration for the request to the Ad Decision Server URL.
154
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-addecisionserverconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverconfiguration-httprequest}
155
+ */
156
+ HttpRequest: HttpRequest;
157
+ };
142
158
  /**
143
159
  * For HLS, when set to `true` , MediaTailor passes through `EXT-X-CUE-IN` , `EXT-X-CUE-OUT` , and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest.
144
160
  *
@@ -239,6 +255,32 @@ export type DashConfiguration = {
239
255
  */
240
256
  OriginManifestType?: "SINGLE_PERIOD" | "MULTI_PERIOD" | undefined;
241
257
  };
258
+ /**
259
+ * The configuration for the request to the Ad Decision Server URL.
260
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html}
261
+ */
262
+ export type HttpRequest = {
263
+ /**
264
+ * The body of the request to the Ad Decision Server URL. The maximum length is 100,000 characters.
265
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-body}
266
+ */
267
+ Body?: string | undefined;
268
+ /**
269
+ * The compression type of the request sent to the Ad Decision Server URL. Only the POST HTTP Method permits compression other than NONE.
270
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-compressrequest}
271
+ */
272
+ CompressRequest?: "NONE" | "GZIP" | undefined;
273
+ /**
274
+ * The headers in the request sent to the Ad Decision Server URL. The max length is 10,000 characters.
275
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-headers}
276
+ */
277
+ Headers?: Record<string, string> | undefined;
278
+ /**
279
+ * Supported HTTP Methods for the request to the Ad Decision Server URL.
280
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-httpmethod}
281
+ */
282
+ HttpMethod?: "GET" | "POST" | undefined;
283
+ };
242
284
  /**
243
285
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-insertionmode.html}
244
286
  */
@@ -47,18 +47,18 @@ export type ObservabilityAdminOrganizationTelemetryRuleAttribs = {
47
47
  */
48
48
  export type Action = "ALLOW" | "BLOCK" | "COUNT" | "CAPTCHA" | "CHALLENGE" | "EXCLUDED_AS_COUNT";
49
49
  /**
50
- * The condition of the action desired in the filter.
50
+ * Condition that matches based on the specific WAF action taken on the request.
51
51
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-actioncondition.html}
52
52
  */
53
53
  export type ActionCondition = {
54
54
  /**
55
- * The enumerated action to take.
55
+ * The WAF action to match against (ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE, EXCLUDED_AS_COUNT).
56
56
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-actioncondition.html#cfn-observabilityadmin-organizationtelemetryrule-actioncondition-action}
57
57
  */
58
58
  Action?: Action | undefined;
59
59
  };
60
60
  /**
61
- * An advanced event selector that includes optional name and field selectors
61
+ * Advanced event selectors let you create fine-grained selectors for management, data, and network activity events.
62
62
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedeventselector.html}
63
63
  */
64
64
  export type AdvancedEventSelector = {
@@ -68,77 +68,77 @@ export type AdvancedEventSelector = {
68
68
  */
69
69
  FieldSelectors: AdvancedFieldSelector[];
70
70
  /**
71
- * An optional descriptive name for the advanced event selector
71
+ * An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
72
72
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedeventselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedeventselector-name}
73
73
  */
74
74
  Name?: string | undefined;
75
75
  };
76
76
  /**
77
- * A single selector statement in an advanced event selector.
77
+ * Defines criteria for selecting resources based on field values.
78
78
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html}
79
79
  */
80
80
  export type AdvancedFieldSelector = {
81
81
  /**
82
- * An operator that includes events that match the last few characters of the event record field specified as the value of Field.
82
+ * Matches if the field value ends with the specified value.
83
83
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-endswith}
84
84
  */
85
85
  EndsWith?: string[] | undefined;
86
86
  /**
87
- * An operator that includes events that match the exact value of the event record field specified as the value of Field.
87
+ * Matches if the field value equals the specified value.
88
88
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-equals}
89
89
  */
90
90
  Equals?: string[] | undefined;
91
91
  /**
92
- * A field in a CloudTrail event record on which to filter events to be logged
92
+ * The name of the field to use for selection.
93
93
  * @minLength 1
94
94
  * @maxLength 1000
95
95
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-field}
96
96
  */
97
97
  Field?: string | undefined;
98
98
  /**
99
- * An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
99
+ * Matches if the field value does not end with the specified value.
100
100
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-notendswith}
101
101
  */
102
102
  NotEndsWith?: string[] | undefined;
103
103
  /**
104
- * An operator that excludes events that match the exact value of the event record field specified as the value of Field.
104
+ * Matches if the field value does not equal the specified value.
105
105
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-notequals}
106
106
  */
107
107
  NotEquals?: string[] | undefined;
108
108
  /**
109
- * An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
109
+ * Matches if the field value does not start with the specified value.
110
110
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-notstartswith}
111
111
  */
112
112
  NotStartsWith?: string[] | undefined;
113
113
  /**
114
- * An operator that includes events that match the first few characters of the event record field specified as the value of Field.
114
+ * Matches if the field value starts with the specified value.
115
115
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-advancedfieldselector.html#cfn-observabilityadmin-organizationtelemetryrule-advancedfieldselector-startswith}
116
116
  */
117
117
  StartsWith?: string[] | undefined;
118
118
  };
119
119
  /**
120
- * Telemetry parameters for Cloudtrail
120
+ * Parameters specific to AWS CloudTrail telemetry configuration.
121
121
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-cloudtrailparameters.html}
122
122
  */
123
123
  export type CloudtrailParameters = {
124
124
  /**
125
- * Create fine-grained selectors for AWS CloudTrail management and data.
125
+ * The advanced event selectors to use for filtering AWS CloudTrail events.
126
126
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-cloudtrailparameters.html#cfn-observabilityadmin-organizationtelemetryrule-cloudtrailparameters-advancedeventselectors}
127
127
  */
128
128
  AdvancedEventSelectors: AdvancedEventSelector[];
129
129
  };
130
130
  /**
131
- * A condition for a filter.
131
+ * A single condition that can match based on WAF rule action or label name.
132
132
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-condition.html}
133
133
  */
134
134
  export type Condition = {
135
135
  /**
136
- * The condition of the action desired in the filter.
136
+ * Matches log records based on the WAF rule action taken (ALLOW, BLOCK, COUNT, etc.).
137
137
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-condition.html#cfn-observabilityadmin-organizationtelemetryrule-condition-actioncondition}
138
138
  */
139
139
  ActionCondition?: ActionCondition | undefined;
140
140
  /**
141
- * The label name of the condition.
141
+ * Matches log records based on WAF rule labels applied to the request.
142
142
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-condition.html#cfn-observabilityadmin-organizationtelemetryrule-condition-labelnamecondition}
143
143
  */
144
144
  LabelNameCondition?: LabelNameCondition | undefined;
@@ -149,63 +149,64 @@ export type Condition = {
149
149
  */
150
150
  export type DestinationType = "cloud-watch-logs";
151
151
  /**
152
- * Telemetry parameters for ELB/NLB Load Balancer Logs
152
+ * Configuration parameters for ELB load balancer logging, including output format and field delimiter settings.
153
153
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters.html}
154
154
  */
155
155
  export type ELBLoadBalancerLoggingParameters = {
156
156
  /**
157
- * A delimiter to delineate log fields
157
+ * The delimiter character used to separate fields in ELB access log entries when using plain text format.
158
158
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters-fielddelimiter}
159
159
  */
160
160
  FieldDelimiter?: string | undefined;
161
161
  /**
162
+ * The format for ELB access log entries (plain text or JSON format).
162
163
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-elbloadbalancerloggingparameters-outputformat}
163
164
  */
164
165
  OutputFormat?: "plain" | "json" | undefined;
165
166
  };
166
167
  /**
167
- * The field that we want to match this rule to.
168
+ * Specifies a field in the request to redact from WAF logs, such as headers, query parameters, or body content.
168
169
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html}
169
170
  */
170
171
  export type FieldToMatch = {
171
172
  /**
172
- * The method with which to match this rule.
173
+ * Redacts the HTTP method from WAF logs.
173
174
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html#cfn-observabilityadmin-organizationtelemetryrule-fieldtomatch-method}
174
175
  */
175
176
  Method?: string | undefined;
176
177
  /**
177
- * The query string to find the resource to match this field to.
178
+ * Redacts the entire query string from WAF logs.
178
179
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html#cfn-observabilityadmin-organizationtelemetryrule-fieldtomatch-querystring}
179
180
  */
180
181
  QueryString?: string | undefined;
181
182
  /**
182
- * Header for the field to match.
183
+ * Redacts a specific header field by name from WAF logs.
183
184
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html#cfn-observabilityadmin-organizationtelemetryrule-fieldtomatch-singleheader}
184
185
  */
185
186
  SingleHeader?: SingleHeader | undefined;
186
187
  /**
187
- * This is the URI path to match this rule to.
188
+ * Redacts the URI path from WAF logs.
188
189
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-fieldtomatch.html#cfn-observabilityadmin-organizationtelemetryrule-fieldtomatch-uripath}
189
190
  */
190
191
  UriPath?: string | undefined;
191
192
  };
192
193
  /**
193
- * A filter to be applied
194
+ * A single filter condition that specifies behavior, requirement, and matching conditions for WAF log records.
194
195
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-filter.html}
195
196
  */
196
197
  export type Filter = {
197
198
  /**
198
- * The behavior required of the filter.
199
+ * The action to take for log records matching this filter (KEEP or DROP).
199
200
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-filter.html#cfn-observabilityadmin-organizationtelemetryrule-filter-behavior}
200
201
  */
201
202
  Behavior?: FilterBehavior | undefined;
202
203
  /**
203
- * A list of conditions for a filter.
204
+ * The list of conditions that determine if a log record matches this filter.
204
205
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-filter.html#cfn-observabilityadmin-organizationtelemetryrule-filter-conditions}
205
206
  */
206
207
  Conditions?: Condition[] | undefined;
207
208
  /**
208
- * The requirement portion of the filter.
209
+ * Whether the log record must meet all conditions (MEETS_ALL) or any condition (MEETS_ANY) to match this filter.
209
210
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-filter.html#cfn-observabilityadmin-organizationtelemetryrule-filter-requirement}
210
211
  */
211
212
  Requirement?: FilterRequirement | undefined;
@@ -221,12 +222,12 @@ export type FilterBehavior = "KEEP" | "DROP";
221
222
  */
222
223
  export type FilterRequirement = "MEETS_ALL" | "MEETS_ANY";
223
224
  /**
224
- * The label name of the condition.
225
+ * Condition that matches based on WAF rule labels, with label names limited to 1024 characters.
225
226
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-labelnamecondition.html}
226
227
  */
227
228
  export type LabelNameCondition = {
228
229
  /**
229
- * The label name of the condition.
230
+ * The label name to match, supporting alphanumeric characters, underscores, hyphens, and colons.
230
231
  * @minLength 1
231
232
  * @maxLength 1024
232
233
  * @pattern ^[0-9A-Za-z_\-:]+$
@@ -235,17 +236,17 @@ export type LabelNameCondition = {
235
236
  LabelName?: string | undefined;
236
237
  };
237
238
  /**
238
- * Default handling for logs that don't match any of the specified filtering conditions.
239
+ * Configuration that determines which WAF log records to keep or drop based on specified conditions.
239
240
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-loggingfilter.html}
240
241
  */
241
242
  export type LoggingFilter = {
242
243
  /**
243
- * The behavior required of the filter.
244
+ * The default action (KEEP or DROP) for log records that don't match any filter conditions.
244
245
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-loggingfilter.html#cfn-observabilityadmin-organizationtelemetryrule-loggingfilter-defaultbehavior}
245
246
  */
246
247
  DefaultBehavior?: FilterBehavior | undefined;
247
248
  /**
248
- * A list of filters to be applied.
249
+ * A list of filter conditions that determine log record handling behavior.
249
250
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-loggingfilter.html#cfn-observabilityadmin-organizationtelemetryrule-loggingfilter-filters}
250
251
  */
251
252
  Filters?: Filter[] | undefined;
@@ -256,12 +257,12 @@ export type LoggingFilter = {
256
257
  */
257
258
  export type ResourceType = "AWS::EC2::VPC" | "AWS::WAFv2::WebACL" | "AWS::CloudTrail" | "AWS::EKS::Cluster" | "AWS::ElasticLoadBalancingV2::LoadBalancer";
258
259
  /**
259
- * Header for the field to match.
260
+ * Structure containing a name field limited to 64 characters for header or query parameter identification.
260
261
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-singleheader.html}
261
262
  */
262
263
  export type SingleHeader = {
263
264
  /**
264
- * The name of the header
265
+ * The name value, limited to 64 characters.
265
266
  * @minLength 1
266
267
  * @maxLength 64
267
268
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-singleheader.html#cfn-observabilityadmin-organizationtelemetryrule-singleheader-name}
@@ -274,7 +275,7 @@ export type SingleHeader = {
274
275
  */
275
276
  export type TelemetryDestinationConfiguration = {
276
277
  /**
277
- * Telemetry parameters for Cloudtrail
278
+ * Configuration parameters specific to AWS CloudTrail when CloudTrail is the source type.
278
279
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-cloudtrailparameters}
279
280
  */
280
281
  CloudtrailParameters?: CloudtrailParameters | undefined;
@@ -289,7 +290,7 @@ export type TelemetryDestinationConfiguration = {
289
290
  */
290
291
  DestinationType?: DestinationType | undefined;
291
292
  /**
292
- * Telemetry parameters for ELB/NLB Load Balancer Logs
293
+ * Configuration parameters specific to ELB load balancer logging when ELB is the resource type.
293
294
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-elbloadbalancerloggingparameters}
294
295
  */
295
296
  ELBLoadBalancerLoggingParameters?: ELBLoadBalancerLoggingParameters | undefined;
@@ -304,7 +305,7 @@ export type TelemetryDestinationConfiguration = {
304
305
  */
305
306
  VPCFlowLogParameters?: VPCFlowLogParameters | undefined;
306
307
  /**
307
- * Telemetry parameters for WAF v2 Web ACL
308
+ * Configuration parameters specific to WAF logging when WAF is the resource type.
308
309
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-organizationtelemetryrule-telemetrydestinationconfiguration-wafloggingparameters}
309
310
  */
310
311
  WAFLoggingParameters?: WAFLoggingParameters | undefined;
@@ -335,7 +336,7 @@ export type TelemetryRule = {
335
336
  */
336
337
  SelectionCriteria?: string | undefined;
337
338
  /**
338
- * The telemetry source types for a telemetry rule.
339
+ * The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.
339
340
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-telemetryrule.html#cfn-observabilityadmin-organizationtelemetryrule-telemetryrule-telemetrysourcetypes}
340
341
  */
341
342
  TelemetrySourceTypes?: TelemetrySourceType[] | undefined;
@@ -382,22 +383,22 @@ export type VPCFlowLogParameters = {
382
383
  */
383
384
  export type WAFLogType = "WAF_LOGS";
384
385
  /**
385
- * Telemetry parameters for WAF v2 Web ACL
386
+ * Configuration parameters for WAF logging, including redacted fields and logging filters.
386
387
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html}
387
388
  */
388
389
  export type WAFLoggingParameters = {
389
390
  /**
390
- * The type of logs to generate for WAF.
391
+ * The type of WAF logs to collect (currently supports WAF_LOGS).
391
392
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-wafloggingparameters-logtype}
392
393
  */
393
394
  LogType?: WAFLogType | undefined;
394
395
  /**
395
- * Default handling for logs that don't match any of the specified filtering conditions.
396
+ * A filter configuration that determines which WAF log records to include or exclude.
396
397
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-wafloggingparameters-loggingfilter}
397
398
  */
398
399
  LoggingFilter?: LoggingFilter | undefined;
399
400
  /**
400
- * Fields not to be included in the logs.
401
+ * The fields to redact from WAF logs to protect sensitive information.
401
402
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-organizationtelemetryrule-wafloggingparameters.html#cfn-observabilityadmin-organizationtelemetryrule-wafloggingparameters-redactedfields}
402
403
  */
403
404
  RedactedFields?: FieldToMatch[] | undefined;
@@ -15,12 +15,12 @@ export type ObservabilityAdminS3TableIntegrationProps = {
15
15
  */
16
16
  Encryption: EncryptionConfig;
17
17
  /**
18
- * The CloudWatch Logs data sources to associate with the S3 Table Integration
18
+ * A data source with an S3 Table integration for query access in the `logs` namespace.
19
19
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-s3tableintegration.html#cfn-observabilityadmin-s3tableintegration-logsources}
20
20
  */
21
21
  LogSources?: LogSource[] | undefined;
22
22
  /**
23
- * The ARN of the role used to access the S3 Table Integration
23
+ * The Amazon Resource Name (ARN) of the IAM role that grants permissions for the S3 Table integration to access necessary resources.
24
24
  * @minLength 1
25
25
  * @maxLength 1011
26
26
  * @pattern ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$
@@ -28,7 +28,7 @@ export type ObservabilityAdminS3TableIntegrationProps = {
28
28
  */
29
29
  RoleArn: string;
30
30
  /**
31
- * An array of key-value pairs to apply to this resource
31
+ * The key-value pairs to associate with the S3 Table integration resource for categorization and management purposes.
32
32
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-s3tableintegration.html#cfn-observabilityadmin-s3tableintegration-tags}
33
33
  */
34
34
  Tags?: Tag[] | undefined;
@@ -38,7 +38,7 @@ export type ObservabilityAdminS3TableIntegrationProps = {
38
38
  */
39
39
  export type ObservabilityAdminS3TableIntegrationAttribs = {
40
40
  /**
41
- * The ARN of the S3 Table Integration
41
+ * The Amazon Resource Name (ARN) of the S3 Table integration.
42
42
  * @minLength 1
43
43
  * @maxLength 1011
44
44
  * @pattern ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$
@@ -47,12 +47,12 @@ export type ObservabilityAdminS3TableIntegrationAttribs = {
47
47
  Arn: string;
48
48
  };
49
49
  /**
50
- * Encryption configuration for the S3 Table Integration
50
+ * Defines the encryption configuration for S3 Table integrations, including the encryption algorithm and KMS key settings.
51
51
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-encryptionconfig.html}
52
52
  */
53
53
  export type EncryptionConfig = {
54
54
  /**
55
- * The ARN of the KMS key used to encrypt the S3 Table Integration
55
+ * The Amazon Resource Name (ARN) of the KMS key used for encryption when using customer-managed keys.
56
56
  * @minLength 1
57
57
  * @maxLength 1011
58
58
  * @pattern ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$
@@ -60,25 +60,25 @@ export type EncryptionConfig = {
60
60
  */
61
61
  KmsKeyArn?: string | undefined;
62
62
  /**
63
- * The server-side encryption algorithm used to encrypt the S3 Table(s) data
63
+ * The server-side encryption algorithm used for encrypting data in the S3 Table integration.
64
64
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-encryptionconfig.html#cfn-observabilityadmin-s3tableintegration-encryptionconfig-ssealgorithm}
65
65
  */
66
66
  SseAlgorithm: "AES256" | "aws:kms";
67
67
  };
68
68
  /**
69
- * CloudWatch Logs data source to associate with the S3 Table Integration
69
+ * A data source with an S3 Table integration for query access in the `logs` namespace.
70
70
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-logsource.html}
71
71
  */
72
72
  export type LogSource = {
73
73
  /**
74
- * The name of the CloudWatch Logs data source
74
+ * The name of the data source.
75
75
  * @minLength 1
76
76
  * @maxLength 256
77
77
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-logsource.html#cfn-observabilityadmin-s3tableintegration-logsource-name}
78
78
  */
79
79
  Name: string;
80
80
  /**
81
- * The type of the CloudWatch Logs data source
81
+ * The type of the data source.
82
82
  * @minLength 1
83
83
  * @maxLength 256
84
84
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-s3tableintegration-logsource.html#cfn-observabilityadmin-s3tableintegration-logsource-type}
@@ -1,19 +1,33 @@
1
1
  import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
2
2
  /**
3
- * Resource Type definition for AWS::ObservabilityAdmin::TelemetryPipelines
3
+ * Creates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.
4
+ *
5
+ * **Using CloudWatch as a pipeline source** The following is an example of a `Body` property value for the `Configuration` object. { "Type": "AWS::ObservabilityAdmin::TelemetryPipelines", "Properties": { "Configuration": { "Body": "pipeline:\n source:\n cloudwatch_logs:\n log_event_metadata:\n data_source_name: \"my_data_source\"\n data_source_type: \"default\"\n aws:\n sts_role_arn: \"arn:aws:iam::123456789012:role/MyPipelineAccessRole\"\n processor:\n - parse_json: {}\n sink:\n - cloudwatch_logs:\n log_group: \"@original\"" } }
6
+ * } Type: AWS::ObservabilityAdmin::TelemetryPipelines
7
+ * Properties: Configuration: Body: | pipeline: source: cloudwatch_logs: log_event_metadata: data_source_name: "my_data_source" data_source_type: "default" aws: sts_role_arn: "arn:aws:iam::123456789012:role/MyPipelineAccessRole" processor: - parse_json: {} sink: - cloudwatch_logs: log_group: "@original" **Using Amazon S3 as a pipeline source** The following is an example of a `Body` property value for the `Configuration` object. { "Type": "AWS::ObservabilityAdmin::TelemetryPipelines", "Properties": { "Configuration": { "Body": "pipeline:\n source:\n s3:\n sqs:\n visibility_timeout: \"PT60S\"\n visibility_duplication_protection: true\n maximum_messages: 10\n queue_url: \"https://sqs.us-east-1.amazonaws.com/123456789012/my-sqs-queue\"\n notification_type: \"sqs\"\n codec:\n ndjson: {}\n aws:\n region: \"us-east-1\"\n sts_role_arn: \"arn:aws:iam::123456789012:role/MyAccessRole\"\n data_source_name: \"crowdstrike_falcon\"\n processor:\n - ocsf:\n version: \"1.5\"\n mapping_version: \"1.5.0\"\n schema:\n crowdstrike_falcon:\n sink:\n - cloudwatch_logs:\n log_group: \"my-log-group\"" } }
8
+ * } Type: AWS::ObservabilityAdmin::TelemetryPipelines
9
+ * Properties: Configuration: Body: | pipeline: source: s3: sqs: visibility_timeout: "PT60S" visibility_duplication_protection: true maximum_messages: 10 queue_url: "https://sqs.us-east-1.amazonaws.com/123456789012/my-sqs-queue" notification_type: "sqs" codec: ndjson: {} aws: region: "us-east-1" sts_role_arn: "arn:aws:iam::123456789012:role/MyAccessRole" data_source_name: "crowdstrike_falcon" processor: - ocsf: version: "1.5" mapping_version: "1.5.0" schema: crowdstrike_falcon: sink: - cloudwatch_logs: log_group: "my-log-group"
4
10
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html}
5
11
  */
6
12
  export type ObservabilityAdminTelemetryPipelines = ResourceDefinitionWithAttributes<"AWS::ObservabilityAdmin::TelemetryPipelines", ObservabilityAdminTelemetryPipelinesProps, ObservabilityAdminTelemetryPipelinesAttribs>;
7
13
  /**
8
- * Resource Type definition for AWS::ObservabilityAdmin::TelemetryPipelines
14
+ * Creates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.
15
+ *
16
+ * **Using CloudWatch as a pipeline source** The following is an example of a `Body` property value for the `Configuration` object. { "Type": "AWS::ObservabilityAdmin::TelemetryPipelines", "Properties": { "Configuration": { "Body": "pipeline:\n source:\n cloudwatch_logs:\n log_event_metadata:\n data_source_name: \"my_data_source\"\n data_source_type: \"default\"\n aws:\n sts_role_arn: \"arn:aws:iam::123456789012:role/MyPipelineAccessRole\"\n processor:\n - parse_json: {}\n sink:\n - cloudwatch_logs:\n log_group: \"@original\"" } }
17
+ * } Type: AWS::ObservabilityAdmin::TelemetryPipelines
18
+ * Properties: Configuration: Body: | pipeline: source: cloudwatch_logs: log_event_metadata: data_source_name: "my_data_source" data_source_type: "default" aws: sts_role_arn: "arn:aws:iam::123456789012:role/MyPipelineAccessRole" processor: - parse_json: {} sink: - cloudwatch_logs: log_group: "@original" **Using Amazon S3 as a pipeline source** The following is an example of a `Body` property value for the `Configuration` object. { "Type": "AWS::ObservabilityAdmin::TelemetryPipelines", "Properties": { "Configuration": { "Body": "pipeline:\n source:\n s3:\n sqs:\n visibility_timeout: \"PT60S\"\n visibility_duplication_protection: true\n maximum_messages: 10\n queue_url: \"https://sqs.us-east-1.amazonaws.com/123456789012/my-sqs-queue\"\n notification_type: \"sqs\"\n codec:\n ndjson: {}\n aws:\n region: \"us-east-1\"\n sts_role_arn: \"arn:aws:iam::123456789012:role/MyAccessRole\"\n data_source_name: \"crowdstrike_falcon\"\n processor:\n - ocsf:\n version: \"1.5\"\n mapping_version: \"1.5.0\"\n schema:\n crowdstrike_falcon:\n sink:\n - cloudwatch_logs:\n log_group: \"my-log-group\"" } }
19
+ * } Type: AWS::ObservabilityAdmin::TelemetryPipelines
20
+ * Properties: Configuration: Body: | pipeline: source: s3: sqs: visibility_timeout: "PT60S" visibility_duplication_protection: true maximum_messages: 10 queue_url: "https://sqs.us-east-1.amazonaws.com/123456789012/my-sqs-queue" notification_type: "sqs" codec: ndjson: {} aws: region: "us-east-1" sts_role_arn: "arn:aws:iam::123456789012:role/MyAccessRole" data_source_name: "crowdstrike_falcon" processor: - ocsf: version: "1.5" mapping_version: "1.5.0" schema: crowdstrike_falcon: sink: - cloudwatch_logs: log_group: "my-log-group"
9
21
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html}
10
22
  */
11
23
  export type ObservabilityAdminTelemetryPipelinesProps = {
12
24
  /**
25
+ * The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations. For more information, see the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Creating-pipelines.html) .
13
26
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#cfn-observabilityadmin-telemetrypipelines-configuration}
14
27
  */
15
28
  Configuration: TelemetryPipelineConfiguration;
16
29
  /**
30
+ * The name of the telemetry pipeline to create. The name must be unique within your account.
17
31
  * @minLength 3
18
32
  * @maxLength 28
19
33
  * @pattern [a-z][a-z0-9\-]+
@@ -21,7 +35,7 @@ export type ObservabilityAdminTelemetryPipelinesProps = {
21
35
  */
22
36
  Name?: string | undefined;
23
37
  /**
24
- * An array of key-value pairs to apply to this resource
38
+ * The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.
25
39
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#cfn-observabilityadmin-telemetrypipelines-tags}
26
40
  */
27
41
  Tags?: Tag[] | undefined;
@@ -31,6 +45,7 @@ export type ObservabilityAdminTelemetryPipelinesProps = {
31
45
  */
32
46
  export type ObservabilityAdminTelemetryPipelinesAttribs = {
33
47
  /**
48
+ * The Amazon Resource Name (ARN) of the created telemetry pipeline.
34
49
  * @minLength 1
35
50
  * @maxLength 1011
36
51
  * @pattern ^arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)$
@@ -38,12 +53,14 @@ export type ObservabilityAdminTelemetryPipelinesAttribs = {
38
53
  */
39
54
  Arn: string;
40
55
  /**
56
+ * The Amazon Resource Name (ARN) of the telemetry pipeline.
41
57
  * @minLength 1
42
58
  * @maxLength 512
43
59
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#cfn-observabilityadmin-telemetrypipelines-pipelineidentifier}
44
60
  */
45
61
  PipelineIdentifier: string;
46
62
  /**
63
+ * The current status of the telemetry pipeline.
47
64
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html#cfn-observabilityadmin-telemetrypipelines-status}
48
65
  */
49
66
  Status: TelemetryPipelineStatus;