@aws-sdk/client-network-firewall 3.379.1 → 3.382.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.
@@ -13,6 +13,7 @@ import { NetworkFirewallServiceException as __BaseException } from "./NetworkFir
13
13
  */
14
14
  export interface Dimension {
15
15
  /**
16
+ * @public
16
17
  * <p>The value to use in the custom metric dimension.</p>
17
18
  */
18
19
  Value: string | undefined;
@@ -24,6 +25,7 @@ export interface Dimension {
24
25
  */
25
26
  export interface PublishMetricAction {
26
27
  /**
28
+ * @public
27
29
  * <p></p>
28
30
  */
29
31
  Dimensions: Dimension[] | undefined;
@@ -34,6 +36,7 @@ export interface PublishMetricAction {
34
36
  */
35
37
  export interface ActionDefinition {
36
38
  /**
39
+ * @public
37
40
  * <p>Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the
38
41
  * matching packet. This setting defines a CloudWatch dimension value to be published.</p>
39
42
  * <p>You can pair this custom action with any of the standard stateless rule actions. For
@@ -50,6 +53,7 @@ export interface ActionDefinition {
50
53
  */
51
54
  export interface Address {
52
55
  /**
56
+ * @public
53
57
  * <p>Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6. </p>
54
58
  * <p>Examples: </p>
55
59
  * <ul>
@@ -76,22 +80,26 @@ export interface Address {
76
80
  */
77
81
  export interface AssociateFirewallPolicyRequest {
78
82
  /**
83
+ * @public
79
84
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
80
85
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
81
86
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
82
87
  */
83
88
  UpdateToken?: string;
84
89
  /**
90
+ * @public
85
91
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
86
92
  * <p>You must specify the ARN or the name, and you can specify both. </p>
87
93
  */
88
94
  FirewallArn?: string;
89
95
  /**
96
+ * @public
90
97
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
91
98
  * <p>You must specify the ARN or the name, and you can specify both. </p>
92
99
  */
93
100
  FirewallName?: string;
94
101
  /**
102
+ * @public
95
103
  * <p>The Amazon Resource Name (ARN) of the firewall policy.</p>
96
104
  */
97
105
  FirewallPolicyArn: string | undefined;
@@ -101,18 +109,22 @@ export interface AssociateFirewallPolicyRequest {
101
109
  */
102
110
  export interface AssociateFirewallPolicyResponse {
103
111
  /**
112
+ * @public
104
113
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
105
114
  */
106
115
  FirewallArn?: string;
107
116
  /**
117
+ * @public
108
118
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
109
119
  */
110
120
  FirewallName?: string;
111
121
  /**
122
+ * @public
112
123
  * <p>The Amazon Resource Name (ARN) of the firewall policy.</p>
113
124
  */
114
125
  FirewallPolicyArn?: string;
115
126
  /**
127
+ * @public
116
128
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
117
129
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
118
130
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
@@ -234,10 +246,12 @@ export type IPAddressType = (typeof IPAddressType)[keyof typeof IPAddressType];
234
246
  */
235
247
  export interface SubnetMapping {
236
248
  /**
249
+ * @public
237
250
  * <p>The unique identifier for the subnet. </p>
238
251
  */
239
252
  SubnetId: string | undefined;
240
253
  /**
254
+ * @public
241
255
  * <p>The subnet's IP address type. You can't change the IP address type after you create the subnet.</p>
242
256
  */
243
257
  IPAddressType?: IPAddressType | string;
@@ -247,22 +261,26 @@ export interface SubnetMapping {
247
261
  */
248
262
  export interface AssociateSubnetsRequest {
249
263
  /**
264
+ * @public
250
265
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
251
266
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
252
267
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
253
268
  */
254
269
  UpdateToken?: string;
255
270
  /**
271
+ * @public
256
272
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
257
273
  * <p>You must specify the ARN or the name, and you can specify both. </p>
258
274
  */
259
275
  FirewallArn?: string;
260
276
  /**
277
+ * @public
261
278
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
262
279
  * <p>You must specify the ARN or the name, and you can specify both. </p>
263
280
  */
264
281
  FirewallName?: string;
265
282
  /**
283
+ * @public
266
284
  * <p>The IDs of the subnets that you want to associate with the firewall. </p>
267
285
  */
268
286
  SubnetMappings: SubnetMapping[] | undefined;
@@ -272,18 +290,22 @@ export interface AssociateSubnetsRequest {
272
290
  */
273
291
  export interface AssociateSubnetsResponse {
274
292
  /**
293
+ * @public
275
294
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
276
295
  */
277
296
  FirewallArn?: string;
278
297
  /**
298
+ * @public
279
299
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
280
300
  */
281
301
  FirewallName?: string;
282
302
  /**
303
+ * @public
283
304
  * <p>The IDs of the subnets that are associated with the firewall. </p>
284
305
  */
285
306
  SubnetMappings?: SubnetMapping[];
286
307
  /**
308
+ * @public
287
309
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
288
310
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
289
311
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
@@ -327,17 +349,20 @@ export type AttachmentStatus = (typeof AttachmentStatus)[keyof typeof Attachment
327
349
  */
328
350
  export interface Attachment {
329
351
  /**
352
+ * @public
330
353
  * <p>The unique identifier of the subnet that you've specified to be used for a firewall
331
354
  * endpoint. </p>
332
355
  */
333
356
  SubnetId?: string;
334
357
  /**
358
+ * @public
335
359
  * <p>The identifier of the firewall endpoint that Network Firewall has instantiated in the
336
360
  * subnet. You use this to identify the firewall endpoint in the VPC route tables, when you
337
361
  * redirect the VPC traffic through the endpoint. </p>
338
362
  */
339
363
  EndpointId?: string;
340
364
  /**
365
+ * @public
341
366
  * <p>The current status of the firewall endpoint in the subnet. This value reflects both the
342
367
  * instantiation of the endpoint in the VPC subnet and the sync states that are reported in
343
368
  * the <code>Config</code> settings. When this value is <code>READY</code>, the endpoint is
@@ -347,6 +372,7 @@ export interface Attachment {
347
372
  */
348
373
  Status?: AttachmentStatus | string;
349
374
  /**
375
+ * @public
350
376
  * <p>If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A <code>FAILED</code> status indicates a non-recoverable state, and a <code>ERROR</code> status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-troubleshooting-endpoint-failures.html">Troubleshooting firewall endpoint failures</a> in the <i>Network Firewall Developer Guide</i>.</p>
351
377
  */
352
378
  StatusMessage?: string;
@@ -357,6 +383,7 @@ export interface Attachment {
357
383
  */
358
384
  export interface IPSetMetadata {
359
385
  /**
386
+ * @public
360
387
  * <p>Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call <code>AvailableCIDRCount</code>.</p>
361
388
  */
362
389
  ResolvedCIDRCount?: number;
@@ -367,14 +394,17 @@ export interface IPSetMetadata {
367
394
  */
368
395
  export interface CIDRSummary {
369
396
  /**
397
+ * @public
370
398
  * <p>The number of CIDR blocks available for use by the IP set references in a firewall.</p>
371
399
  */
372
400
  AvailableCIDRCount?: number;
373
401
  /**
402
+ * @public
374
403
  * <p>The number of CIDR blocks used by the IP set references in a firewall.</p>
375
404
  */
376
405
  UtilizedCIDRCount?: number;
377
406
  /**
407
+ * @public
378
408
  * <p>The list of the IP set references used by a firewall.</p>
379
409
  */
380
410
  IPSetReferences?: Record<string, IPSetMetadata>;
@@ -385,6 +415,7 @@ export interface CIDRSummary {
385
415
  */
386
416
  export interface CapacityUsageSummary {
387
417
  /**
418
+ * @public
388
419
  * <p>Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.</p>
389
420
  */
390
421
  CIDRs?: CIDRSummary;
@@ -395,18 +426,22 @@ export interface CapacityUsageSummary {
395
426
  */
396
427
  export interface TlsCertificateData {
397
428
  /**
429
+ * @public
398
430
  * <p>The Amazon Resource Name (ARN) of the certificate.</p>
399
431
  */
400
432
  CertificateArn?: string;
401
433
  /**
434
+ * @public
402
435
  * <p>The serial number of the certificate.</p>
403
436
  */
404
437
  CertificateSerial?: string;
405
438
  /**
439
+ * @public
406
440
  * <p>The status of the certificate.</p>
407
441
  */
408
442
  Status?: string;
409
443
  /**
444
+ * @public
410
445
  * <p>Contains details about the certificate status, including information about certificate errors.</p>
411
446
  */
412
447
  StatusMessage?: string;
@@ -442,10 +477,12 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
442
477
  */
443
478
  export interface EncryptionConfiguration {
444
479
  /**
480
+ * @public
445
481
  * <p>The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key ID</a> in the <i>Amazon Web Services KMS Developer Guide</i>.</p>
446
482
  */
447
483
  KeyId?: string;
448
484
  /**
485
+ * @public
449
486
  * <p>The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.</p>
450
487
  */
451
488
  Type: EncryptionType | string | undefined;
@@ -459,11 +496,13 @@ export interface EncryptionConfiguration {
459
496
  */
460
497
  export interface Tag {
461
498
  /**
499
+ * @public
462
500
  * <p>The part of the key:value pair that defines a tag. You can use a tag key to describe a
463
501
  * category of information, such as "customer." Tag keys are case-sensitive.</p>
464
502
  */
465
503
  Key: string | undefined;
466
504
  /**
505
+ * @public
467
506
  * <p>The part of the key:value pair that defines a tag. You can use a tag value to describe a
468
507
  * specific value within a category, such as "companyA" or "companyB." Tag values are
469
508
  * case-sensitive.</p>
@@ -475,52 +514,62 @@ export interface Tag {
475
514
  */
476
515
  export interface CreateFirewallRequest {
477
516
  /**
517
+ * @public
478
518
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
479
519
  */
480
520
  FirewallName: string | undefined;
481
521
  /**
522
+ * @public
482
523
  * <p>The Amazon Resource Name (ARN) of the <a>FirewallPolicy</a> that you want to
483
524
  * use for the firewall.</p>
484
525
  */
485
526
  FirewallPolicyArn: string | undefined;
486
527
  /**
528
+ * @public
487
529
  * <p>The unique identifier of the VPC where Network Firewall should create the firewall. </p>
488
530
  * <p>You can't change this setting after you create the firewall. </p>
489
531
  */
490
532
  VpcId: string | undefined;
491
533
  /**
534
+ * @public
492
535
  * <p>The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a
493
536
  * different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each
494
537
  * subnet. </p>
495
538
  */
496
539
  SubnetMappings: SubnetMapping[] | undefined;
497
540
  /**
541
+ * @public
498
542
  * <p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> indicates
499
543
  * that the firewall is protected against deletion. Use this setting to protect against
500
544
  * accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to <code>TRUE</code>.</p>
501
545
  */
502
546
  DeleteProtection?: boolean;
503
547
  /**
548
+ * @public
504
549
  * <p>A setting indicating whether the firewall is protected against changes to the subnet associations.
505
550
  * Use this setting to protect against
506
551
  * accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to <code>TRUE</code>.</p>
507
552
  */
508
553
  SubnetChangeProtection?: boolean;
509
554
  /**
555
+ * @public
510
556
  * <p>A setting indicating whether the firewall is protected against a change to the firewall policy association.
511
557
  * Use this setting to protect against
512
558
  * accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to <code>TRUE</code>.</p>
513
559
  */
514
560
  FirewallPolicyChangeProtection?: boolean;
515
561
  /**
562
+ * @public
516
563
  * <p>A description of the firewall.</p>
517
564
  */
518
565
  Description?: string;
519
566
  /**
567
+ * @public
520
568
  * <p>The key:value pairs to associate with the resource.</p>
521
569
  */
522
570
  Tags?: Tag[];
523
571
  /**
572
+ * @public
524
573
  * <p>A complex type that contains settings for encryption of your firewall resources.</p>
525
574
  */
526
575
  EncryptionConfiguration?: EncryptionConfiguration;
@@ -534,14 +583,17 @@ export interface CreateFirewallRequest {
534
583
  */
535
584
  export interface Firewall {
536
585
  /**
586
+ * @public
537
587
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
538
588
  */
539
589
  FirewallName?: string;
540
590
  /**
591
+ * @public
541
592
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
542
593
  */
543
594
  FirewallArn?: string;
544
595
  /**
596
+ * @public
545
597
  * <p>The Amazon Resource Name (ARN) of the firewall policy.</p>
546
598
  * <p>The relationship of firewall to firewall policy is many to one. Each firewall requires
547
599
  * one firewall policy association, and you can use the same firewall policy for multiple
@@ -549,45 +601,54 @@ export interface Firewall {
549
601
  */
550
602
  FirewallPolicyArn: string | undefined;
551
603
  /**
604
+ * @public
552
605
  * <p>The unique identifier of the VPC where the firewall is in use. </p>
553
606
  */
554
607
  VpcId: string | undefined;
555
608
  /**
609
+ * @public
556
610
  * <p>The public subnets that Network Firewall is using for the firewall. Each subnet must belong
557
611
  * to a different Availability Zone. </p>
558
612
  */
559
613
  SubnetMappings: SubnetMapping[] | undefined;
560
614
  /**
615
+ * @public
561
616
  * <p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> indicates
562
617
  * that the firewall is protected against deletion. Use this setting to protect against
563
618
  * accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to <code>TRUE</code>.</p>
564
619
  */
565
620
  DeleteProtection?: boolean;
566
621
  /**
622
+ * @public
567
623
  * <p>A setting indicating whether the firewall is protected against changes to the subnet associations.
568
624
  * Use this setting to protect against
569
625
  * accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to <code>TRUE</code>.</p>
570
626
  */
571
627
  SubnetChangeProtection?: boolean;
572
628
  /**
629
+ * @public
573
630
  * <p>A setting indicating whether the firewall is protected against a change to the firewall policy association.
574
631
  * Use this setting to protect against
575
632
  * accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to <code>TRUE</code>.</p>
576
633
  */
577
634
  FirewallPolicyChangeProtection?: boolean;
578
635
  /**
636
+ * @public
579
637
  * <p>A description of the firewall.</p>
580
638
  */
581
639
  Description?: string;
582
640
  /**
641
+ * @public
583
642
  * <p>The unique identifier for the firewall. </p>
584
643
  */
585
644
  FirewallId: string | undefined;
586
645
  /**
646
+ * @public
587
647
  * <p></p>
588
648
  */
589
649
  Tags?: Tag[];
590
650
  /**
651
+ * @public
591
652
  * <p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.</p>
592
653
  */
593
654
  EncryptionConfiguration?: EncryptionConfiguration;
@@ -627,10 +688,12 @@ export type PerObjectSyncStatus = (typeof PerObjectSyncStatus)[keyof typeof PerO
627
688
  */
628
689
  export interface PerObjectStatus {
629
690
  /**
691
+ * @public
630
692
  * <p>Indicates whether this object is in sync with the version indicated in the update token.</p>
631
693
  */
632
694
  SyncStatus?: PerObjectSyncStatus | string;
633
695
  /**
696
+ * @public
634
697
  * <p>The current version of the object that is either in sync or pending synchronization. </p>
635
698
  */
636
699
  UpdateToken?: string;
@@ -656,12 +719,14 @@ export interface PerObjectStatus {
656
719
  */
657
720
  export interface SyncState {
658
721
  /**
722
+ * @public
659
723
  * <p>The attachment status of the firewall's association with a single VPC subnet. For each
660
724
  * configured subnet, Network Firewall creates the attachment by instantiating the firewall
661
725
  * endpoint in the subnet so that it's ready to take traffic. This is part of the <a>FirewallStatus</a>.</p>
662
726
  */
663
727
  Attachment?: Attachment;
664
728
  /**
729
+ * @public
665
730
  * <p>The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall
666
731
  * provides each endpoint with the rules that are configured in the firewall policy. Each time
667
732
  * you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the
@@ -675,6 +740,7 @@ export interface SyncState {
675
740
  */
676
741
  export interface FirewallStatus {
677
742
  /**
743
+ * @public
678
744
  * <p>The readiness of the configured firewall to handle network traffic across all of the
679
745
  * Availability Zones where you've configured it. This setting is <code>READY</code> only when
680
746
  * the <code>ConfigurationSyncStateSummary</code> value is <code>IN_SYNC</code> and the
@@ -684,6 +750,7 @@ export interface FirewallStatus {
684
750
  */
685
751
  Status: FirewallStatusValue | string | undefined;
686
752
  /**
753
+ * @public
687
754
  * <p>The configuration sync state for the firewall. This summarizes the sync states reported
688
755
  * in the <code>Config</code> settings for all of the Availability Zones where you have
689
756
  * configured the firewall. </p>
@@ -697,6 +764,7 @@ export interface FirewallStatus {
697
764
  */
698
765
  ConfigurationSyncStateSummary: ConfigurationSyncState | string | undefined;
699
766
  /**
767
+ * @public
700
768
  * <p>The subnets that you've configured for use by the Network Firewall firewall. This contains
701
769
  * one array element per Availability Zone where you've configured a subnet. These objects
702
770
  * provide details of the information that is summarized in the
@@ -705,6 +773,7 @@ export interface FirewallStatus {
705
773
  */
706
774
  SyncStates?: Record<string, SyncState>;
707
775
  /**
776
+ * @public
708
777
  * <p>Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.</p>
709
778
  */
710
779
  CapacityUsageSummary?: CapacityUsageSummary;
@@ -714,10 +783,12 @@ export interface FirewallStatus {
714
783
  */
715
784
  export interface CreateFirewallResponse {
716
785
  /**
786
+ * @public
717
787
  * <p>The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints. </p>
718
788
  */
719
789
  Firewall?: Firewall;
720
790
  /**
791
+ * @public
721
792
  * <p>Detailed information about the current status of a <a>Firewall</a>. You can retrieve this for a firewall by calling <a>DescribeFirewall</a> and providing the firewall name and ARN.</p>
722
793
  */
723
794
  FirewallStatus?: FirewallStatus;
@@ -741,6 +812,7 @@ export declare class LimitExceededException extends __BaseException {
741
812
  */
742
813
  export interface IPSet {
743
814
  /**
815
+ * @public
744
816
  * <p>The list of IP addresses and address ranges, in CIDR notation.
745
817
  *
746
818
  * </p>
@@ -753,6 +825,7 @@ export interface IPSet {
753
825
  */
754
826
  export interface PolicyVariables {
755
827
  /**
828
+ * @public
756
829
  * <p>The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata <code>HOME_NET</code> variable. If your firewall uses an inspection VPC, you might want to override the <code>HOME_NET</code> variable with the CIDRs of your home networks. If you don't override <code>HOME_NET</code> with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.</p>
757
830
  */
758
831
  RuleVariables?: Record<string, IPSet>;
@@ -788,6 +861,7 @@ export type StreamExceptionPolicy = (typeof StreamExceptionPolicy)[keyof typeof
788
861
  */
789
862
  export interface StatefulEngineOptions {
790
863
  /**
864
+ * @public
791
865
  * <p>Indicates how to manage the order of stateful rule evaluation for the policy. <code>DEFAULT_ACTION_ORDER</code> is
792
866
  * the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them
793
867
  * based on certain settings. For more information, see
@@ -796,6 +870,7 @@ export interface StatefulEngineOptions {
796
870
  */
797
871
  RuleOrder?: RuleOrder | string;
798
872
  /**
873
+ * @public
799
874
  * <p>Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.</p>
800
875
  * <ul>
801
876
  * <li>
@@ -831,6 +906,7 @@ export type OverrideAction = (typeof OverrideAction)[keyof typeof OverrideAction
831
906
  */
832
907
  export interface StatefulRuleGroupOverride {
833
908
  /**
909
+ * @public
834
910
  * <p>The action that changes the rule group from <code>DROP</code> to <code>ALERT</code>. This only applies to
835
911
  * managed rule groups.</p>
836
912
  */
@@ -843,10 +919,12 @@ export interface StatefulRuleGroupOverride {
843
919
  */
844
920
  export interface StatefulRuleGroupReference {
845
921
  /**
922
+ * @public
846
923
  * <p>The Amazon Resource Name (ARN) of the stateful rule group.</p>
847
924
  */
848
925
  ResourceArn: string | undefined;
849
926
  /**
927
+ * @public
850
928
  * <p>An integer setting that indicates the order in which to run the stateful rule groups in
851
929
  * a single <a>FirewallPolicy</a>. This setting only applies to firewall policies
852
930
  * that specify the <code>STRICT_ORDER</code> rule order in the stateful engine options settings.</p>
@@ -859,6 +937,7 @@ export interface StatefulRuleGroupReference {
859
937
  */
860
938
  Priority?: number;
861
939
  /**
940
+ * @public
862
941
  * <p>The action that allows the policy owner to override the behavior of the rule group within a policy.</p>
863
942
  */
864
943
  Override?: StatefulRuleGroupOverride;
@@ -889,10 +968,12 @@ export interface StatefulRuleGroupReference {
889
968
  */
890
969
  export interface CustomAction {
891
970
  /**
971
+ * @public
892
972
  * <p>The descriptive name of the custom action. You can't change the name of a custom action after you create it.</p>
893
973
  */
894
974
  ActionName: string | undefined;
895
975
  /**
976
+ * @public
896
977
  * <p>The custom action associated with the action name.</p>
897
978
  */
898
979
  ActionDefinition: ActionDefinition | undefined;
@@ -904,10 +985,12 @@ export interface CustomAction {
904
985
  */
905
986
  export interface StatelessRuleGroupReference {
906
987
  /**
988
+ * @public
907
989
  * <p>The Amazon Resource Name (ARN) of the stateless rule group.</p>
908
990
  */
909
991
  ResourceArn: string | undefined;
910
992
  /**
993
+ * @public
911
994
  * <p>An integer setting that indicates the order in which to run the stateless rule groups in
912
995
  * a single <a>FirewallPolicy</a>. Network Firewall applies each stateless rule group
913
996
  * to a packet starting with the group that has the lowest priority setting. You must ensure
@@ -925,11 +1008,13 @@ export interface StatelessRuleGroupReference {
925
1008
  */
926
1009
  export interface FirewallPolicy {
927
1010
  /**
1011
+ * @public
928
1012
  * <p>References to the stateless rule groups that are used in the policy. These define the
929
1013
  * matching criteria in stateless rules. </p>
930
1014
  */
931
1015
  StatelessRuleGroupReferences?: StatelessRuleGroupReference[];
932
1016
  /**
1017
+ * @public
933
1018
  * <p>The actions to take on a packet if it doesn't match any of the stateless rules in the
934
1019
  * policy. If you want non-matching packets to be forwarded for stateful inspection, specify
935
1020
  * <code>aws:forward_to_sfe</code>. </p>
@@ -942,6 +1027,7 @@ export interface FirewallPolicy {
942
1027
  */
943
1028
  StatelessDefaultActions: string[] | undefined;
944
1029
  /**
1030
+ * @public
945
1031
  * <p>The actions to take on a fragmented UDP packet if it doesn't match any of the stateless
946
1032
  * rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols.
947
1033
  * If you want non-matching fragmented UDP packets to be forwarded for
@@ -955,17 +1041,20 @@ export interface FirewallPolicy {
955
1041
  */
956
1042
  StatelessFragmentDefaultActions: string[] | undefined;
957
1043
  /**
1044
+ * @public
958
1045
  * <p>The custom action definitions that are available for use in the firewall policy's
959
1046
  * <code>StatelessDefaultActions</code> setting. You name each custom action that you
960
1047
  * define, and then you can use it by name in your default actions specifications.</p>
961
1048
  */
962
1049
  StatelessCustomActions?: CustomAction[];
963
1050
  /**
1051
+ * @public
964
1052
  * <p>References to the stateful rule groups that are used in the policy. These define the
965
1053
  * inspection criteria in stateful rules. </p>
966
1054
  */
967
1055
  StatefulRuleGroupReferences?: StatefulRuleGroupReference[];
968
1056
  /**
1057
+ * @public
969
1058
  * <p>The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional,
970
1059
  * and is only valid when using the strict rule order.</p>
971
1060
  * <p>Valid values of the stateful default action:</p>
@@ -989,15 +1078,18 @@ export interface FirewallPolicy {
989
1078
  */
990
1079
  StatefulDefaultActions?: string[];
991
1080
  /**
1081
+ * @public
992
1082
  * <p>Additional options governing how Network Firewall handles stateful rules. The stateful
993
1083
  * rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.</p>
994
1084
  */
995
1085
  StatefulEngineOptions?: StatefulEngineOptions;
996
1086
  /**
1087
+ * @public
997
1088
  * <p>The Amazon Resource Name (ARN) of the TLS inspection configuration.</p>
998
1089
  */
999
1090
  TLSInspectionConfigurationArn?: string;
1000
1091
  /**
1092
+ * @public
1001
1093
  * <p>Contains variables that you can use to override default Suricata settings in your firewall policy.</p>
1002
1094
  */
1003
1095
  PolicyVariables?: PolicyVariables;
@@ -1007,22 +1099,27 @@ export interface FirewallPolicy {
1007
1099
  */
1008
1100
  export interface CreateFirewallPolicyRequest {
1009
1101
  /**
1102
+ * @public
1010
1103
  * <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>
1011
1104
  */
1012
1105
  FirewallPolicyName: string | undefined;
1013
1106
  /**
1107
+ * @public
1014
1108
  * <p>The rule groups and policy actions to use in the firewall policy.</p>
1015
1109
  */
1016
1110
  FirewallPolicy: FirewallPolicy | undefined;
1017
1111
  /**
1112
+ * @public
1018
1113
  * <p>A description of the firewall policy.</p>
1019
1114
  */
1020
1115
  Description?: string;
1021
1116
  /**
1117
+ * @public
1022
1118
  * <p>The key:value pairs to associate with the resource.</p>
1023
1119
  */
1024
1120
  Tags?: Tag[];
1025
1121
  /**
1122
+ * @public
1026
1123
  * <p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>
1027
1124
  * <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully,
1028
1125
  * but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with
@@ -1032,6 +1129,7 @@ export interface CreateFirewallPolicyRequest {
1032
1129
  */
1033
1130
  DryRun?: boolean;
1034
1131
  /**
1132
+ * @public
1035
1133
  * <p>A complex type that contains settings for encryption of your firewall policy resources.</p>
1036
1134
  */
1037
1135
  EncryptionConfiguration?: EncryptionConfiguration;
@@ -1054,10 +1152,12 @@ export type ResourceStatus = (typeof ResourceStatus)[keyof typeof ResourceStatus
1054
1152
  */
1055
1153
  export interface FirewallPolicyResponse {
1056
1154
  /**
1155
+ * @public
1057
1156
  * <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>
1058
1157
  */
1059
1158
  FirewallPolicyName: string | undefined;
1060
1159
  /**
1160
+ * @public
1061
1161
  * <p>The Amazon Resource Name (ARN) of the firewall policy.</p>
1062
1162
  * <note>
1063
1163
  * <p>If this response is for a create request that had <code>DryRun</code> set to
@@ -1067,40 +1167,49 @@ export interface FirewallPolicyResponse {
1067
1167
  */
1068
1168
  FirewallPolicyArn: string | undefined;
1069
1169
  /**
1170
+ * @public
1070
1171
  * <p>The unique identifier for the firewall policy. </p>
1071
1172
  */
1072
1173
  FirewallPolicyId: string | undefined;
1073
1174
  /**
1175
+ * @public
1074
1176
  * <p>A description of the firewall policy.</p>
1075
1177
  */
1076
1178
  Description?: string;
1077
1179
  /**
1180
+ * @public
1078
1181
  * <p>The current status of the firewall policy. You can retrieve this for a firewall policy
1079
1182
  * by calling <a>DescribeFirewallPolicy</a> and providing the firewall policy's
1080
1183
  * name or ARN.</p>
1081
1184
  */
1082
1185
  FirewallPolicyStatus?: ResourceStatus | string;
1083
1186
  /**
1187
+ * @public
1084
1188
  * <p>The key:value pairs to associate with the resource.</p>
1085
1189
  */
1086
1190
  Tags?: Tag[];
1087
1191
  /**
1192
+ * @public
1088
1193
  * <p>The number of capacity units currently consumed by the policy's stateless rules.</p>
1089
1194
  */
1090
1195
  ConsumedStatelessRuleCapacity?: number;
1091
1196
  /**
1197
+ * @public
1092
1198
  * <p>The number of capacity units currently consumed by the policy's stateful rules.</p>
1093
1199
  */
1094
1200
  ConsumedStatefulRuleCapacity?: number;
1095
1201
  /**
1202
+ * @public
1096
1203
  * <p>The number of firewalls that are associated with this firewall policy.</p>
1097
1204
  */
1098
1205
  NumberOfAssociations?: number;
1099
1206
  /**
1207
+ * @public
1100
1208
  * <p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.</p>
1101
1209
  */
1102
1210
  EncryptionConfiguration?: EncryptionConfiguration;
1103
1211
  /**
1212
+ * @public
1104
1213
  * <p>The last time that the firewall policy was changed.</p>
1105
1214
  */
1106
1215
  LastModifiedTime?: Date;
@@ -1110,11 +1219,13 @@ export interface FirewallPolicyResponse {
1110
1219
  */
1111
1220
  export interface CreateFirewallPolicyResponse {
1112
1221
  /**
1222
+ * @public
1113
1223
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. </p>
1114
1224
  * <p>To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token. </p>
1115
1225
  */
1116
1226
  UpdateToken: string | undefined;
1117
1227
  /**
1228
+ * @public
1118
1229
  * <p>The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. </p>
1119
1230
  */
1120
1231
  FirewallPolicyResponse: FirewallPolicyResponse | undefined;
@@ -1128,6 +1239,7 @@ export interface CreateFirewallPolicyResponse {
1128
1239
  */
1129
1240
  export interface IPSetReference {
1130
1241
  /**
1242
+ * @public
1131
1243
  * <p>The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.</p>
1132
1244
  */
1133
1245
  ReferenceArn?: string;
@@ -1138,6 +1250,7 @@ export interface IPSetReference {
1138
1250
  */
1139
1251
  export interface ReferenceSets {
1140
1252
  /**
1253
+ * @public
1141
1254
  * <p>The list of IP set references.</p>
1142
1255
  */
1143
1256
  IPSetReferences?: Record<string, IPSetReference>;
@@ -1174,6 +1287,7 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType];
1174
1287
  */
1175
1288
  export interface RulesSourceList {
1176
1289
  /**
1290
+ * @public
1177
1291
  * <p>The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:</p>
1178
1292
  * <ul>
1179
1293
  * <li>
@@ -1186,10 +1300,12 @@ export interface RulesSourceList {
1186
1300
  */
1187
1301
  Targets: string[] | undefined;
1188
1302
  /**
1303
+ * @public
1189
1304
  * <p>The protocols you want to inspect. Specify <code>TLS_SNI</code> for <code>HTTPS</code>. Specify <code>HTTP_HOST</code> for <code>HTTP</code>. You can specify either or both. </p>
1190
1305
  */
1191
1306
  TargetTypes: (TargetType | string)[] | undefined;
1192
1307
  /**
1308
+ * @public
1193
1309
  * <p>Whether you want to allow or deny access to the domains in your target list.</p>
1194
1310
  */
1195
1311
  GeneratedRulesType: GeneratedRulesType | string | undefined;
@@ -1257,10 +1373,12 @@ export type StatefulRuleProtocol = (typeof StatefulRuleProtocol)[keyof typeof St
1257
1373
  */
1258
1374
  export interface Header {
1259
1375
  /**
1376
+ * @public
1260
1377
  * <p>The protocol to inspect for. To specify all, you can use <code>IP</code>, because all traffic on Amazon Web Services and on the internet is IP.</p>
1261
1378
  */
1262
1379
  Protocol: StatefulRuleProtocol | string | undefined;
1263
1380
  /**
1381
+ * @public
1264
1382
  * <p>The source IP address or address range to inspect for, in CIDR notation.
1265
1383
  * To match with any address, specify <code>ANY</code>. </p>
1266
1384
  * <p>Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6. </p>
@@ -1284,6 +1402,7 @@ export interface Header {
1284
1402
  */
1285
1403
  Source: string | undefined;
1286
1404
  /**
1405
+ * @public
1287
1406
  * <p>The source port to inspect for. You can specify an individual port, for
1288
1407
  * example <code>1994</code> and you can specify a port
1289
1408
  * range, for example <code>1990:1994</code>.
@@ -1291,6 +1410,7 @@ export interface Header {
1291
1410
  */
1292
1411
  SourcePort: string | undefined;
1293
1412
  /**
1413
+ * @public
1294
1414
  * <p>The direction of traffic flow to inspect. If set to <code>ANY</code>, the inspection
1295
1415
  * matches bidirectional traffic, both from the source to the destination and from the
1296
1416
  * destination to the source. If set to <code>FORWARD</code>, the inspection only matches
@@ -1298,6 +1418,7 @@ export interface Header {
1298
1418
  */
1299
1419
  Direction: StatefulRuleDirection | string | undefined;
1300
1420
  /**
1421
+ * @public
1301
1422
  * <p>The destination IP address or address range to inspect for, in CIDR notation.
1302
1423
  * To match with any address, specify <code>ANY</code>. </p>
1303
1424
  * <p>Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6. </p>
@@ -1321,6 +1442,7 @@ export interface Header {
1321
1442
  */
1322
1443
  Destination: string | undefined;
1323
1444
  /**
1445
+ * @public
1324
1446
  * <p>The destination port to inspect for. You can specify an individual port, for
1325
1447
  * example <code>1994</code> and you can specify
1326
1448
  * a port range, for example <code>1990:1994</code>.
@@ -1334,10 +1456,12 @@ export interface Header {
1334
1456
  */
1335
1457
  export interface RuleOption {
1336
1458
  /**
1459
+ * @public
1337
1460
  * <p></p>
1338
1461
  */
1339
1462
  Keyword: string | undefined;
1340
1463
  /**
1464
+ * @public
1341
1465
  * <p></p>
1342
1466
  */
1343
1467
  Settings?: string[];
@@ -1351,6 +1475,7 @@ export interface RuleOption {
1351
1475
  */
1352
1476
  export interface StatefulRule {
1353
1477
  /**
1478
+ * @public
1354
1479
  * <p>Defines what Network Firewall should do with the packets in a traffic flow when the flow
1355
1480
  * matches the stateful rule criteria. For all actions, Network Firewall performs the specified
1356
1481
  * action and discontinues stateful inspection of the traffic flow. </p>
@@ -1387,11 +1512,13 @@ export interface StatefulRule {
1387
1512
  */
1388
1513
  Action: StatefulAction | string | undefined;
1389
1514
  /**
1515
+ * @public
1390
1516
  * <p>The stateful inspection criteria for this rule, used to inspect traffic flows.
1391
1517
  * </p>
1392
1518
  */
1393
1519
  Header: Header | undefined;
1394
1520
  /**
1521
+ * @public
1395
1522
  * <p>Additional options for the rule. These are the Suricata <code>RuleOptions</code> settings.</p>
1396
1523
  */
1397
1524
  RuleOptions: RuleOption[] | undefined;
@@ -1404,11 +1531,13 @@ export interface StatefulRule {
1404
1531
  */
1405
1532
  export interface PortRange {
1406
1533
  /**
1534
+ * @public
1407
1535
  * <p>The lower limit of the port range. This must be less than or equal to the
1408
1536
  * <code>ToPort</code> specification. </p>
1409
1537
  */
1410
1538
  FromPort: number | undefined;
1411
1539
  /**
1540
+ * @public
1412
1541
  * <p>The upper limit of the port range. This must be greater than or equal to the
1413
1542
  * <code>FromPort</code> specification. </p>
1414
1543
  */
@@ -1438,6 +1567,7 @@ export type TCPFlag = (typeof TCPFlag)[keyof typeof TCPFlag];
1438
1567
  */
1439
1568
  export interface TCPFlagField {
1440
1569
  /**
1570
+ * @public
1441
1571
  * <p>Used in conjunction with the <code>Masks</code> setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the <code>Masks</code> setting.</p>
1442
1572
  * <p>For the flags that are specified in the masks setting, the following must be true for the packet to match: </p>
1443
1573
  * <ul>
@@ -1451,6 +1581,7 @@ export interface TCPFlagField {
1451
1581
  */
1452
1582
  Flags: (TCPFlag | string)[] | undefined;
1453
1583
  /**
1584
+ * @public
1454
1585
  * <p>The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.</p>
1455
1586
  */
1456
1587
  Masks?: (TCPFlag | string)[];
@@ -1461,16 +1592,19 @@ export interface TCPFlagField {
1461
1592
  */
1462
1593
  export interface MatchAttributes {
1463
1594
  /**
1595
+ * @public
1464
1596
  * <p>The source IP addresses and address ranges to inspect for, in CIDR notation. If not
1465
1597
  * specified, this matches with any source address. </p>
1466
1598
  */
1467
1599
  Sources?: Address[];
1468
1600
  /**
1601
+ * @public
1469
1602
  * <p>The destination IP addresses and address ranges to inspect for, in CIDR notation. If not
1470
1603
  * specified, this matches with any destination address. </p>
1471
1604
  */
1472
1605
  Destinations?: Address[];
1473
1606
  /**
1607
+ * @public
1474
1608
  * <p>The source ports to inspect for. If not specified, this matches with any source port.
1475
1609
  * This setting is only used for protocols 6 (TCP) and 17 (UDP). </p>
1476
1610
  * <p>You can specify individual ports, for example <code>1994</code> and you can specify port
@@ -1478,6 +1612,7 @@ export interface MatchAttributes {
1478
1612
  */
1479
1613
  SourcePorts?: PortRange[];
1480
1614
  /**
1615
+ * @public
1481
1616
  * <p>The destination ports to inspect for. If not specified, this matches with any
1482
1617
  * destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP). </p>
1483
1618
  * <p>You can specify individual ports, for example <code>1994</code> and you can specify port
@@ -1485,11 +1620,13 @@ export interface MatchAttributes {
1485
1620
  */
1486
1621
  DestinationPorts?: PortRange[];
1487
1622
  /**
1623
+ * @public
1488
1624
  * <p>The protocols to inspect for, specified using each protocol's assigned internet protocol
1489
1625
  * number (IANA). If not specified, this matches with any protocol. </p>
1490
1626
  */
1491
1627
  Protocols?: number[];
1492
1628
  /**
1629
+ * @public
1493
1630
  * <p>The TCP flags and masks to inspect for. If not specified, this matches with any
1494
1631
  * settings. This setting is only used for protocol 6 (TCP).</p>
1495
1632
  */
@@ -1503,10 +1640,12 @@ export interface MatchAttributes {
1503
1640
  */
1504
1641
  export interface RuleDefinition {
1505
1642
  /**
1643
+ * @public
1506
1644
  * <p>Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags. </p>
1507
1645
  */
1508
1646
  MatchAttributes: MatchAttributes | undefined;
1509
1647
  /**
1648
+ * @public
1510
1649
  * <p>The actions to take on a packet that matches one of the stateless rule definition's
1511
1650
  * match attributes. You must specify a standard action and you can add custom actions. </p>
1512
1651
  * <note>
@@ -1553,11 +1692,13 @@ export interface RuleDefinition {
1553
1692
  */
1554
1693
  export interface StatelessRule {
1555
1694
  /**
1695
+ * @public
1556
1696
  * <p>Defines the stateless 5-tuple packet inspection criteria and the action to take on a
1557
1697
  * packet that matches the criteria. </p>
1558
1698
  */
1559
1699
  RuleDefinition: RuleDefinition | undefined;
1560
1700
  /**
1701
+ * @public
1561
1702
  * <p>Indicates the order in which to run this rule relative to all of the
1562
1703
  * rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a
1563
1704
  * rule group starting with the lowest priority setting. You must ensure that the priority
@@ -1580,10 +1721,12 @@ export interface StatelessRule {
1580
1721
  */
1581
1722
  export interface StatelessRulesAndCustomActions {
1582
1723
  /**
1724
+ * @public
1583
1725
  * <p>Defines the set of stateless rules for use in a stateless rule group. </p>
1584
1726
  */
1585
1727
  StatelessRules: StatelessRule[] | undefined;
1586
1728
  /**
1729
+ * @public
1587
1730
  * <p>Defines an array of individual custom action definitions that are available for use by
1588
1731
  * the stateless rules in this <code>StatelessRulesAndCustomActions</code> specification. You
1589
1732
  * name each custom action that you define, and then you can use it by name in your <a>StatelessRule</a>
@@ -1600,6 +1743,7 @@ export interface StatelessRulesAndCustomActions {
1600
1743
  */
1601
1744
  export interface RulesSource {
1602
1745
  /**
1746
+ * @public
1603
1747
  * <p>Stateful inspection criteria, provided in Suricata compatible intrusion prevention
1604
1748
  * system (IPS) rules. Suricata is an open-source network IPS that includes a standard
1605
1749
  * rule-based language for network traffic inspection.</p>
@@ -1609,10 +1753,12 @@ export interface RulesSource {
1609
1753
  */
1610
1754
  RulesString?: string;
1611
1755
  /**
1756
+ * @public
1612
1757
  * <p>Stateful inspection criteria for a domain list rule group. </p>
1613
1758
  */
1614
1759
  RulesSourceList?: RulesSourceList;
1615
1760
  /**
1761
+ * @public
1616
1762
  * <p>An array of individual stateful rules inspection criteria to be used together in a stateful rule group.
1617
1763
  * Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options.
1618
1764
  * For information about the Suricata <code>Rules</code> format, see
@@ -1620,6 +1766,7 @@ export interface RulesSource {
1620
1766
  */
1621
1767
  StatefulRules?: StatefulRule[];
1622
1768
  /**
1769
+ * @public
1623
1770
  * <p>Stateless inspection criteria to be used in a stateless rule group. </p>
1624
1771
  */
1625
1772
  StatelessRulesAndCustomActions?: StatelessRulesAndCustomActions;
@@ -1630,6 +1777,7 @@ export interface RulesSource {
1630
1777
  */
1631
1778
  export interface PortSet {
1632
1779
  /**
1780
+ * @public
1633
1781
  * <p>The set of port ranges.
1634
1782
  * </p>
1635
1783
  */
@@ -1642,10 +1790,12 @@ export interface PortSet {
1642
1790
  */
1643
1791
  export interface RuleVariables {
1644
1792
  /**
1793
+ * @public
1645
1794
  * <p>A list of IP addresses and address ranges, in CIDR notation. </p>
1646
1795
  */
1647
1796
  IPSets?: Record<string, IPSet>;
1648
1797
  /**
1798
+ * @public
1649
1799
  * <p>A list of port ranges. </p>
1650
1800
  */
1651
1801
  PortSets?: Record<string, PortSet>;
@@ -1656,6 +1806,7 @@ export interface RuleVariables {
1656
1806
  */
1657
1807
  export interface StatefulRuleOptions {
1658
1808
  /**
1809
+ * @public
1659
1810
  * <p>Indicates how to manage the order of the rule evaluation for the rule group. <code>DEFAULT_ACTION_ORDER</code> is
1660
1811
  * the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them
1661
1812
  * based on certain settings. For more information, see
@@ -1675,19 +1826,23 @@ export interface StatefulRuleOptions {
1675
1826
  */
1676
1827
  export interface RuleGroup {
1677
1828
  /**
1829
+ * @public
1678
1830
  * <p>Settings that are available for use in the rules in the rule group. You can only use
1679
1831
  * these for stateful rule groups. </p>
1680
1832
  */
1681
1833
  RuleVariables?: RuleVariables;
1682
1834
  /**
1835
+ * @public
1683
1836
  * <p>The list of a rule group's reference sets.</p>
1684
1837
  */
1685
1838
  ReferenceSets?: ReferenceSets;
1686
1839
  /**
1840
+ * @public
1687
1841
  * <p>The stateful rules or stateless rules for the rule group. </p>
1688
1842
  */
1689
1843
  RulesSource: RulesSource | undefined;
1690
1844
  /**
1845
+ * @public
1691
1846
  * <p>Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful
1692
1847
  * rule group must have stateful rule options settings that are compatible with these settings.</p>
1693
1848
  */
@@ -1699,10 +1854,12 @@ export interface RuleGroup {
1699
1854
  */
1700
1855
  export interface SourceMetadata {
1701
1856
  /**
1857
+ * @public
1702
1858
  * <p>The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.</p>
1703
1859
  */
1704
1860
  SourceArn?: string;
1705
1861
  /**
1862
+ * @public
1706
1863
  * <p>The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call <a href="https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html#networkfirewall-DescribeRuleGroup-response-UpdateToken">DescribeRuleGroup</a>.</p>
1707
1864
  */
1708
1865
  SourceUpdateToken?: string;
@@ -1724,10 +1881,12 @@ export type RuleGroupType = (typeof RuleGroupType)[keyof typeof RuleGroupType];
1724
1881
  */
1725
1882
  export interface CreateRuleGroupRequest {
1726
1883
  /**
1884
+ * @public
1727
1885
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
1728
1886
  */
1729
1887
  RuleGroupName: string | undefined;
1730
1888
  /**
1889
+ * @public
1731
1890
  * <p>An object that defines the rule group rules. </p>
1732
1891
  * <note>
1733
1892
  * <p>You must provide either this rule group setting or a <code>Rules</code> setting, but not both. </p>
@@ -1735,6 +1894,7 @@ export interface CreateRuleGroupRequest {
1735
1894
  */
1736
1895
  RuleGroup?: RuleGroup;
1737
1896
  /**
1897
+ * @public
1738
1898
  * <p>A string containing stateful rule group rules specifications in Suricata flat format, with one rule
1739
1899
  * per line. Use this to import your existing Suricata compatible rule groups. </p>
1740
1900
  * <note>
@@ -1745,15 +1905,18 @@ export interface CreateRuleGroupRequest {
1745
1905
  */
1746
1906
  Rules?: string;
1747
1907
  /**
1908
+ * @public
1748
1909
  * <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
1749
1910
  * stateless rules. If it is stateful, it contains stateful rules. </p>
1750
1911
  */
1751
1912
  Type: RuleGroupType | string | undefined;
1752
1913
  /**
1914
+ * @public
1753
1915
  * <p>A description of the rule group. </p>
1754
1916
  */
1755
1917
  Description?: string;
1756
1918
  /**
1919
+ * @public
1757
1920
  * <p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.
1758
1921
  * When you update a rule group, you are limited to this capacity. When you reference a rule group
1759
1922
  * from a firewall policy, Network Firewall reserves this capacity for the rule group. </p>
@@ -1798,10 +1961,12 @@ export interface CreateRuleGroupRequest {
1798
1961
  */
1799
1962
  Capacity: number | undefined;
1800
1963
  /**
1964
+ * @public
1801
1965
  * <p>The key:value pairs to associate with the resource.</p>
1802
1966
  */
1803
1967
  Tags?: Tag[];
1804
1968
  /**
1969
+ * @public
1805
1970
  * <p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>
1806
1971
  * <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully,
1807
1972
  * but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with
@@ -1811,10 +1976,12 @@ export interface CreateRuleGroupRequest {
1811
1976
  */
1812
1977
  DryRun?: boolean;
1813
1978
  /**
1979
+ * @public
1814
1980
  * <p>A complex type that contains settings for encryption of your rule group resources.</p>
1815
1981
  */
1816
1982
  EncryptionConfiguration?: EncryptionConfiguration;
1817
1983
  /**
1984
+ * @public
1818
1985
  * <p>A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.</p>
1819
1986
  */
1820
1987
  SourceMetadata?: SourceMetadata;
@@ -1825,6 +1992,7 @@ export interface CreateRuleGroupRequest {
1825
1992
  */
1826
1993
  export interface RuleGroupResponse {
1827
1994
  /**
1995
+ * @public
1828
1996
  * <p>The Amazon Resource Name (ARN) of the rule group.</p>
1829
1997
  * <note>
1830
1998
  * <p>If this response is for a create request that had <code>DryRun</code> set to
@@ -1834,23 +2002,28 @@ export interface RuleGroupResponse {
1834
2002
  */
1835
2003
  RuleGroupArn: string | undefined;
1836
2004
  /**
2005
+ * @public
1837
2006
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
1838
2007
  */
1839
2008
  RuleGroupName: string | undefined;
1840
2009
  /**
2010
+ * @public
1841
2011
  * <p>The unique identifier for the rule group. </p>
1842
2012
  */
1843
2013
  RuleGroupId: string | undefined;
1844
2014
  /**
2015
+ * @public
1845
2016
  * <p>A description of the rule group. </p>
1846
2017
  */
1847
2018
  Description?: string;
1848
2019
  /**
2020
+ * @public
1849
2021
  * <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
1850
2022
  * stateless rules. If it is stateful, it contains stateful rules. </p>
1851
2023
  */
1852
2024
  Type?: RuleGroupType | string;
1853
2025
  /**
2026
+ * @public
1854
2027
  * <p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.
1855
2028
  * When you update a rule group, you are limited to this capacity. When you reference a rule group
1856
2029
  * from a firewall policy, Network Firewall reserves this capacity for the rule group. </p>
@@ -1859,30 +2032,37 @@ export interface RuleGroupResponse {
1859
2032
  */
1860
2033
  Capacity?: number;
1861
2034
  /**
2035
+ * @public
1862
2036
  * <p>Detailed information about the current status of a rule group. </p>
1863
2037
  */
1864
2038
  RuleGroupStatus?: ResourceStatus | string;
1865
2039
  /**
2040
+ * @public
1866
2041
  * <p>The key:value pairs to associate with the resource.</p>
1867
2042
  */
1868
2043
  Tags?: Tag[];
1869
2044
  /**
2045
+ * @public
1870
2046
  * <p>The number of capacity units currently consumed by the rule group rules. </p>
1871
2047
  */
1872
2048
  ConsumedCapacity?: number;
1873
2049
  /**
2050
+ * @public
1874
2051
  * <p>The number of firewall policies that use this rule group.</p>
1875
2052
  */
1876
2053
  NumberOfAssociations?: number;
1877
2054
  /**
2055
+ * @public
1878
2056
  * <p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.</p>
1879
2057
  */
1880
2058
  EncryptionConfiguration?: EncryptionConfiguration;
1881
2059
  /**
2060
+ * @public
1882
2061
  * <p>A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.</p>
1883
2062
  */
1884
2063
  SourceMetadata?: SourceMetadata;
1885
2064
  /**
2065
+ * @public
1886
2066
  * <p>The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's
1887
2067
  * used to record changes to the managed rule group. You can subscribe to the SNS topic to receive
1888
2068
  * notifications when the managed rule group is modified, such as for new versions and for version
@@ -1890,6 +2070,7 @@ export interface RuleGroupResponse {
1890
2070
  */
1891
2071
  SnsTopic?: string;
1892
2072
  /**
2073
+ * @public
1893
2074
  * <p>The last time that the rule group was changed.</p>
1894
2075
  */
1895
2076
  LastModifiedTime?: Date;
@@ -1899,11 +2080,13 @@ export interface RuleGroupResponse {
1899
2080
  */
1900
2081
  export interface CreateRuleGroupResponse {
1901
2082
  /**
2083
+ * @public
1902
2084
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. </p>
1903
2085
  * <p>To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>
1904
2086
  */
1905
2087
  UpdateToken: string | undefined;
1906
2088
  /**
2089
+ * @public
1907
2090
  * <p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>
1908
2091
  */
1909
2092
  RuleGroupResponse: RuleGroupResponse | undefined;
@@ -1914,26 +2097,31 @@ export interface CreateRuleGroupResponse {
1914
2097
  */
1915
2098
  export interface ServerCertificateScope {
1916
2099
  /**
2100
+ * @public
1917
2101
  * <p>The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this
1918
2102
  * matches with any source address.</p>
1919
2103
  */
1920
2104
  Sources?: Address[];
1921
2105
  /**
2106
+ * @public
1922
2107
  * <p>The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this
1923
2108
  * matches with any destination address.</p>
1924
2109
  */
1925
2110
  Destinations?: Address[];
1926
2111
  /**
2112
+ * @public
1927
2113
  * <p>The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.</p>
1928
2114
  * <p>You can specify individual ports, for example <code>1994</code>, and you can specify port ranges, such as <code>1990:1994</code>.</p>
1929
2115
  */
1930
2116
  SourcePorts?: PortRange[];
1931
2117
  /**
2118
+ * @public
1932
2119
  * <p>The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.</p>
1933
2120
  * <p>You can specify individual ports, for example <code>1994</code>, and you can specify port ranges, such as <code>1990:1994</code>.</p>
1934
2121
  */
1935
2122
  DestinationPorts?: PortRange[];
1936
2123
  /**
2124
+ * @public
1937
2125
  * <p>The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number
1938
2126
  * (IANA). Network Firewall currently supports only TCP.</p>
1939
2127
  */
@@ -1945,6 +2133,7 @@ export interface ServerCertificateScope {
1945
2133
  */
1946
2134
  export interface ServerCertificate {
1947
2135
  /**
2136
+ * @public
1948
2137
  * <p>The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate.</p>
1949
2138
  */
1950
2139
  ResourceArn?: string;
@@ -1958,10 +2147,12 @@ export interface ServerCertificate {
1958
2147
  */
1959
2148
  export interface ServerCertificateConfiguration {
1960
2149
  /**
2150
+ * @public
1961
2151
  * <p>The list of a server certificate configuration's Certificate Manager SSL/TLS certificates.</p>
1962
2152
  */
1963
2153
  ServerCertificates?: ServerCertificate[];
1964
2154
  /**
2155
+ * @public
1965
2156
  * <p>A list of a server certificate configuration's scopes.</p>
1966
2157
  */
1967
2158
  Scopes?: ServerCertificateScope[];
@@ -1975,6 +2166,7 @@ export interface ServerCertificateConfiguration {
1975
2166
  */
1976
2167
  export interface TLSInspectionConfiguration {
1977
2168
  /**
2169
+ * @public
1978
2170
  * <p>Lists the server certificate configurations that are associated with the TLS configuration.</p>
1979
2171
  */
1980
2172
  ServerCertificateConfigurations?: ServerCertificateConfiguration[];
@@ -1984,10 +2176,12 @@ export interface TLSInspectionConfiguration {
1984
2176
  */
1985
2177
  export interface CreateTLSInspectionConfigurationRequest {
1986
2178
  /**
2179
+ * @public
1987
2180
  * <p>The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.</p>
1988
2181
  */
1989
2182
  TLSInspectionConfigurationName: string | undefined;
1990
2183
  /**
2184
+ * @public
1991
2185
  * <p>The object that defines a TLS inspection configuration. This, along with <a>TLSInspectionConfigurationResponse</a>, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a>. </p>
1992
2186
  * <p>Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.</p>
1993
2187
  * <p>To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html">Decrypting SSL/TLS traffic with TLS
@@ -1995,14 +2189,17 @@ export interface CreateTLSInspectionConfigurationRequest {
1995
2189
  */
1996
2190
  TLSInspectionConfiguration: TLSInspectionConfiguration | undefined;
1997
2191
  /**
2192
+ * @public
1998
2193
  * <p>A description of the TLS inspection configuration. </p>
1999
2194
  */
2000
2195
  Description?: string;
2001
2196
  /**
2197
+ * @public
2002
2198
  * <p>The key:value pairs to associate with the resource.</p>
2003
2199
  */
2004
2200
  Tags?: Tag[];
2005
2201
  /**
2202
+ * @public
2006
2203
  * <p>A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html">Encryption at rest with Amazon Web Services Key Managment Service</a> in the <i>Network Firewall Developer Guide</i>.</p>
2007
2204
  */
2008
2205
  EncryptionConfiguration?: EncryptionConfiguration;
@@ -2013,42 +2210,52 @@ export interface CreateTLSInspectionConfigurationRequest {
2013
2210
  */
2014
2211
  export interface TLSInspectionConfigurationResponse {
2015
2212
  /**
2213
+ * @public
2016
2214
  * <p>The Amazon Resource Name (ARN) of the TLS inspection configuration.</p>
2017
2215
  */
2018
2216
  TLSInspectionConfigurationArn: string | undefined;
2019
2217
  /**
2218
+ * @public
2020
2219
  * <p>The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.</p>
2021
2220
  */
2022
2221
  TLSInspectionConfigurationName: string | undefined;
2023
2222
  /**
2223
+ * @public
2024
2224
  * <p>A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.</p>
2025
2225
  */
2026
2226
  TLSInspectionConfigurationId: string | undefined;
2027
2227
  /**
2228
+ * @public
2028
2229
  * <p>Detailed information about the current status of a <a>TLSInspectionConfiguration</a>. You can retrieve this for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a> and providing the TLS inspection configuration name and ARN.</p>
2029
2230
  */
2030
2231
  TLSInspectionConfigurationStatus?: ResourceStatus | string;
2031
2232
  /**
2233
+ * @public
2032
2234
  * <p>A description of the TLS inspection configuration. </p>
2033
2235
  */
2034
2236
  Description?: string;
2035
2237
  /**
2238
+ * @public
2036
2239
  * <p>The key:value pairs to associate with the resource.</p>
2037
2240
  */
2038
2241
  Tags?: Tag[];
2039
2242
  /**
2243
+ * @public
2040
2244
  * <p>The last time that the TLS inspection configuration was changed.</p>
2041
2245
  */
2042
2246
  LastModifiedTime?: Date;
2043
2247
  /**
2248
+ * @public
2044
2249
  * <p>The number of firewall policies that use this TLS inspection configuration.</p>
2045
2250
  */
2046
2251
  NumberOfAssociations?: number;
2047
2252
  /**
2253
+ * @public
2048
2254
  * <p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.</p>
2049
2255
  */
2050
2256
  EncryptionConfiguration?: EncryptionConfiguration;
2051
2257
  /**
2258
+ * @public
2052
2259
  * <p>A list of the certificates associated with the TLS inspection configuration.</p>
2053
2260
  */
2054
2261
  Certificates?: TlsCertificateData[];
@@ -2058,11 +2265,13 @@ export interface TLSInspectionConfigurationResponse {
2058
2265
  */
2059
2266
  export interface CreateTLSInspectionConfigurationResponse {
2060
2267
  /**
2268
+ * @public
2061
2269
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request. </p>
2062
2270
  * <p>To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>
2063
2271
  */
2064
2272
  UpdateToken: string | undefined;
2065
2273
  /**
2274
+ * @public
2066
2275
  * <p>The high-level properties of a TLS inspection configuration. This, along with the <a>TLSInspectionConfiguration</a>, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a>. </p>
2067
2276
  */
2068
2277
  TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponse | undefined;
@@ -2072,11 +2281,13 @@ export interface CreateTLSInspectionConfigurationResponse {
2072
2281
  */
2073
2282
  export interface DeleteFirewallRequest {
2074
2283
  /**
2284
+ * @public
2075
2285
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
2076
2286
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2077
2287
  */
2078
2288
  FirewallName?: string;
2079
2289
  /**
2290
+ * @public
2080
2291
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
2081
2292
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2082
2293
  */
@@ -2087,6 +2298,7 @@ export interface DeleteFirewallRequest {
2087
2298
  */
2088
2299
  export interface DeleteFirewallResponse {
2089
2300
  /**
2301
+ * @public
2090
2302
  * <p>The firewall defines the configuration settings for an Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource. </p>
2091
2303
  * <p>The status of the firewall, for example whether it's ready to filter network traffic,
2092
2304
  * is provided in the corresponding <a>FirewallStatus</a>. You can retrieve both
@@ -2094,6 +2306,7 @@ export interface DeleteFirewallResponse {
2094
2306
  */
2095
2307
  Firewall?: Firewall;
2096
2308
  /**
2309
+ * @public
2097
2310
  * <p>Detailed information about the current status of a <a>Firewall</a>. You can retrieve this for a firewall by calling <a>DescribeFirewall</a> and providing the firewall name and ARN.</p>
2098
2311
  */
2099
2312
  FirewallStatus?: FirewallStatus;
@@ -2116,11 +2329,13 @@ export declare class UnsupportedOperationException extends __BaseException {
2116
2329
  */
2117
2330
  export interface DeleteFirewallPolicyRequest {
2118
2331
  /**
2332
+ * @public
2119
2333
  * <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>
2120
2334
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2121
2335
  */
2122
2336
  FirewallPolicyName?: string;
2123
2337
  /**
2338
+ * @public
2124
2339
  * <p>The Amazon Resource Name (ARN) of the firewall policy.</p>
2125
2340
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2126
2341
  */
@@ -2131,6 +2346,7 @@ export interface DeleteFirewallPolicyRequest {
2131
2346
  */
2132
2347
  export interface DeleteFirewallPolicyResponse {
2133
2348
  /**
2349
+ * @public
2134
2350
  * <p>The object containing the definition of the <a>FirewallPolicyResponse</a>
2135
2351
  * that you asked to delete. </p>
2136
2352
  */
@@ -2141,6 +2357,7 @@ export interface DeleteFirewallPolicyResponse {
2141
2357
  */
2142
2358
  export interface DeleteResourcePolicyRequest {
2143
2359
  /**
2360
+ * @public
2144
2361
  * <p>The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete. </p>
2145
2362
  */
2146
2363
  ResourceArn: string | undefined;
@@ -2168,16 +2385,19 @@ export declare class InvalidResourcePolicyException extends __BaseException {
2168
2385
  */
2169
2386
  export interface DeleteRuleGroupRequest {
2170
2387
  /**
2388
+ * @public
2171
2389
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
2172
2390
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2173
2391
  */
2174
2392
  RuleGroupName?: string;
2175
2393
  /**
2394
+ * @public
2176
2395
  * <p>The Amazon Resource Name (ARN) of the rule group.</p>
2177
2396
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2178
2397
  */
2179
2398
  RuleGroupArn?: string;
2180
2399
  /**
2400
+ * @public
2181
2401
  * <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
2182
2402
  * stateless rules. If it is stateful, it contains stateful rules. </p>
2183
2403
  * <note>
@@ -2191,6 +2411,7 @@ export interface DeleteRuleGroupRequest {
2191
2411
  */
2192
2412
  export interface DeleteRuleGroupResponse {
2193
2413
  /**
2414
+ * @public
2194
2415
  * <p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>
2195
2416
  */
2196
2417
  RuleGroupResponse: RuleGroupResponse | undefined;
@@ -2200,11 +2421,13 @@ export interface DeleteRuleGroupResponse {
2200
2421
  */
2201
2422
  export interface DeleteTLSInspectionConfigurationRequest {
2202
2423
  /**
2424
+ * @public
2203
2425
  * <p>The Amazon Resource Name (ARN) of the TLS inspection configuration.</p>
2204
2426
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2205
2427
  */
2206
2428
  TLSInspectionConfigurationArn?: string;
2207
2429
  /**
2430
+ * @public
2208
2431
  * <p>The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.</p>
2209
2432
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2210
2433
  */
@@ -2215,6 +2438,7 @@ export interface DeleteTLSInspectionConfigurationRequest {
2215
2438
  */
2216
2439
  export interface DeleteTLSInspectionConfigurationResponse {
2217
2440
  /**
2441
+ * @public
2218
2442
  * <p>The high-level properties of a TLS inspection configuration. This, along with the <a>TLSInspectionConfiguration</a>, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a>. </p>
2219
2443
  */
2220
2444
  TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponse | undefined;
@@ -2224,11 +2448,13 @@ export interface DeleteTLSInspectionConfigurationResponse {
2224
2448
  */
2225
2449
  export interface DescribeFirewallRequest {
2226
2450
  /**
2451
+ * @public
2227
2452
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
2228
2453
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2229
2454
  */
2230
2455
  FirewallName?: string;
2231
2456
  /**
2457
+ * @public
2232
2458
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
2233
2459
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2234
2460
  */
@@ -2239,16 +2465,19 @@ export interface DescribeFirewallRequest {
2239
2465
  */
2240
2466
  export interface DescribeFirewallResponse {
2241
2467
  /**
2468
+ * @public
2242
2469
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
2243
2470
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
2244
2471
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
2245
2472
  */
2246
2473
  UpdateToken?: string;
2247
2474
  /**
2475
+ * @public
2248
2476
  * <p>The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints. </p>
2249
2477
  */
2250
2478
  Firewall?: Firewall;
2251
2479
  /**
2480
+ * @public
2252
2481
  * <p>Detailed information about the current status of a <a>Firewall</a>. You can retrieve this for a firewall by calling <a>DescribeFirewall</a> and providing the firewall name and ARN.</p>
2253
2482
  */
2254
2483
  FirewallStatus?: FirewallStatus;
@@ -2258,11 +2487,13 @@ export interface DescribeFirewallResponse {
2258
2487
  */
2259
2488
  export interface DescribeFirewallPolicyRequest {
2260
2489
  /**
2490
+ * @public
2261
2491
  * <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>
2262
2492
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2263
2493
  */
2264
2494
  FirewallPolicyName?: string;
2265
2495
  /**
2496
+ * @public
2266
2497
  * <p>The Amazon Resource Name (ARN) of the firewall policy.</p>
2267
2498
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2268
2499
  */
@@ -2273,15 +2504,18 @@ export interface DescribeFirewallPolicyRequest {
2273
2504
  */
2274
2505
  export interface DescribeFirewallPolicyResponse {
2275
2506
  /**
2507
+ * @public
2276
2508
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. </p>
2277
2509
  * <p>To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token. </p>
2278
2510
  */
2279
2511
  UpdateToken: string | undefined;
2280
2512
  /**
2513
+ * @public
2281
2514
  * <p>The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. </p>
2282
2515
  */
2283
2516
  FirewallPolicyResponse: FirewallPolicyResponse | undefined;
2284
2517
  /**
2518
+ * @public
2285
2519
  * <p>The policy for the specified firewall policy. </p>
2286
2520
  */
2287
2521
  FirewallPolicy?: FirewallPolicy;
@@ -2291,11 +2525,13 @@ export interface DescribeFirewallPolicyResponse {
2291
2525
  */
2292
2526
  export interface DescribeLoggingConfigurationRequest {
2293
2527
  /**
2528
+ * @public
2294
2529
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
2295
2530
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2296
2531
  */
2297
2532
  FirewallArn?: string;
2298
2533
  /**
2534
+ * @public
2299
2535
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
2300
2536
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2301
2537
  */
@@ -2337,16 +2573,19 @@ export type LogType = (typeof LogType)[keyof typeof LogType];
2337
2573
  */
2338
2574
  export interface LogDestinationConfig {
2339
2575
  /**
2576
+ * @public
2340
2577
  * <p>The type of log to send. Alert logs report traffic that matches a <a>StatefulRule</a> with an action setting that sends an alert log message. Flow logs are
2341
2578
  * standard network traffic flow logs. </p>
2342
2579
  */
2343
2580
  LogType: LogType | string | undefined;
2344
2581
  /**
2582
+ * @public
2345
2583
  * <p>The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket,
2346
2584
  * a CloudWatch log group, or a Kinesis Data Firehose delivery stream.</p>
2347
2585
  */
2348
2586
  LogDestinationType: LogDestinationType | string | undefined;
2349
2587
  /**
2588
+ * @public
2350
2589
  * <p>The named location for the logs, provided in a key:value mapping that is specific to the
2351
2590
  * chosen destination type. </p>
2352
2591
  * <ul>
@@ -2387,6 +2626,7 @@ export interface LogDestinationConfig {
2387
2626
  */
2388
2627
  export interface LoggingConfiguration {
2389
2628
  /**
2629
+ * @public
2390
2630
  * <p>Defines the logging destinations for the logs for a firewall. Network Firewall generates
2391
2631
  * logs for stateful rule groups. </p>
2392
2632
  */
@@ -2397,10 +2637,12 @@ export interface LoggingConfiguration {
2397
2637
  */
2398
2638
  export interface DescribeLoggingConfigurationResponse {
2399
2639
  /**
2640
+ * @public
2400
2641
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
2401
2642
  */
2402
2643
  FirewallArn?: string;
2403
2644
  /**
2645
+ * @public
2404
2646
  * <p>Defines how Network Firewall performs logging for a <a>Firewall</a>. </p>
2405
2647
  */
2406
2648
  LoggingConfiguration?: LoggingConfiguration;
@@ -2410,6 +2652,7 @@ export interface DescribeLoggingConfigurationResponse {
2410
2652
  */
2411
2653
  export interface DescribeResourcePolicyRequest {
2412
2654
  /**
2655
+ * @public
2413
2656
  * <p>The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve. </p>
2414
2657
  */
2415
2658
  ResourceArn: string | undefined;
@@ -2419,6 +2662,7 @@ export interface DescribeResourcePolicyRequest {
2419
2662
  */
2420
2663
  export interface DescribeResourcePolicyResponse {
2421
2664
  /**
2665
+ * @public
2422
2666
  * <p>The IAM policy for the resource. </p>
2423
2667
  */
2424
2668
  Policy?: string;
@@ -2428,16 +2672,19 @@ export interface DescribeResourcePolicyResponse {
2428
2672
  */
2429
2673
  export interface DescribeRuleGroupRequest {
2430
2674
  /**
2675
+ * @public
2431
2676
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
2432
2677
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2433
2678
  */
2434
2679
  RuleGroupName?: string;
2435
2680
  /**
2681
+ * @public
2436
2682
  * <p>The Amazon Resource Name (ARN) of the rule group.</p>
2437
2683
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2438
2684
  */
2439
2685
  RuleGroupArn?: string;
2440
2686
  /**
2687
+ * @public
2441
2688
  * <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
2442
2689
  * stateless rules. If it is stateful, it contains stateful rules. </p>
2443
2690
  * <note>
@@ -2451,11 +2698,13 @@ export interface DescribeRuleGroupRequest {
2451
2698
  */
2452
2699
  export interface DescribeRuleGroupResponse {
2453
2700
  /**
2701
+ * @public
2454
2702
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. </p>
2455
2703
  * <p>To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>
2456
2704
  */
2457
2705
  UpdateToken: string | undefined;
2458
2706
  /**
2707
+ * @public
2459
2708
  * <p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>
2460
2709
  * <p>Network Firewall uses a rule group to inspect and control network traffic.
2461
2710
  * You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their
@@ -2465,6 +2714,7 @@ export interface DescribeRuleGroupResponse {
2465
2714
  */
2466
2715
  RuleGroup?: RuleGroup;
2467
2716
  /**
2717
+ * @public
2468
2718
  * <p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>
2469
2719
  */
2470
2720
  RuleGroupResponse: RuleGroupResponse | undefined;
@@ -2474,16 +2724,19 @@ export interface DescribeRuleGroupResponse {
2474
2724
  */
2475
2725
  export interface DescribeRuleGroupMetadataRequest {
2476
2726
  /**
2727
+ * @public
2477
2728
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
2478
2729
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2479
2730
  */
2480
2731
  RuleGroupName?: string;
2481
2732
  /**
2733
+ * @public
2482
2734
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
2483
2735
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2484
2736
  */
2485
2737
  RuleGroupArn?: string;
2486
2738
  /**
2739
+ * @public
2487
2740
  * <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
2488
2741
  * stateless rules. If it is stateful, it contains stateful rules. </p>
2489
2742
  * <note>
@@ -2497,21 +2750,25 @@ export interface DescribeRuleGroupMetadataRequest {
2497
2750
  */
2498
2751
  export interface DescribeRuleGroupMetadataResponse {
2499
2752
  /**
2753
+ * @public
2500
2754
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
2501
2755
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2502
2756
  */
2503
2757
  RuleGroupArn: string | undefined;
2504
2758
  /**
2759
+ * @public
2505
2760
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
2506
2761
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2507
2762
  */
2508
2763
  RuleGroupName: string | undefined;
2509
2764
  /**
2765
+ * @public
2510
2766
  * <p>Returns the metadata objects for the specified rule group.
2511
2767
  * </p>
2512
2768
  */
2513
2769
  Description?: string;
2514
2770
  /**
2771
+ * @public
2515
2772
  * <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
2516
2773
  * stateless rules. If it is stateful, it contains stateful rules. </p>
2517
2774
  * <note>
@@ -2520,6 +2777,7 @@ export interface DescribeRuleGroupMetadataResponse {
2520
2777
  */
2521
2778
  Type?: RuleGroupType | string;
2522
2779
  /**
2780
+ * @public
2523
2781
  * <p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.
2524
2782
  * When you update a rule group, you are limited to this capacity. When you reference a rule group
2525
2783
  * from a firewall policy, Network Firewall reserves this capacity for the rule group. </p>
@@ -2528,10 +2786,12 @@ export interface DescribeRuleGroupMetadataResponse {
2528
2786
  */
2529
2787
  Capacity?: number;
2530
2788
  /**
2789
+ * @public
2531
2790
  * <p>Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.</p>
2532
2791
  */
2533
2792
  StatefulRuleOptions?: StatefulRuleOptions;
2534
2793
  /**
2794
+ * @public
2535
2795
  * <p>The last time that the rule group was changed.</p>
2536
2796
  */
2537
2797
  LastModifiedTime?: Date;
@@ -2541,11 +2801,13 @@ export interface DescribeRuleGroupMetadataResponse {
2541
2801
  */
2542
2802
  export interface DescribeTLSInspectionConfigurationRequest {
2543
2803
  /**
2804
+ * @public
2544
2805
  * <p>The Amazon Resource Name (ARN) of the TLS inspection configuration.</p>
2545
2806
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2546
2807
  */
2547
2808
  TLSInspectionConfigurationArn?: string;
2548
2809
  /**
2810
+ * @public
2549
2811
  * <p>The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.</p>
2550
2812
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2551
2813
  */
@@ -2556,11 +2818,13 @@ export interface DescribeTLSInspectionConfigurationRequest {
2556
2818
  */
2557
2819
  export interface DescribeTLSInspectionConfigurationResponse {
2558
2820
  /**
2821
+ * @public
2559
2822
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request. </p>
2560
2823
  * <p>To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>
2561
2824
  */
2562
2825
  UpdateToken: string | undefined;
2563
2826
  /**
2827
+ * @public
2564
2828
  * <p>The object that defines a TLS inspection configuration. This, along with <a>TLSInspectionConfigurationResponse</a>, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a>. </p>
2565
2829
  * <p>Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.</p>
2566
2830
  * <p>To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html">Decrypting SSL/TLS traffic with TLS
@@ -2568,6 +2832,7 @@ export interface DescribeTLSInspectionConfigurationResponse {
2568
2832
  */
2569
2833
  TLSInspectionConfiguration?: TLSInspectionConfiguration;
2570
2834
  /**
2835
+ * @public
2571
2836
  * <p>The high-level properties of a TLS inspection configuration. This, along with the <a>TLSInspectionConfiguration</a>, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a>. </p>
2572
2837
  */
2573
2838
  TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponse | undefined;
@@ -2577,22 +2842,26 @@ export interface DescribeTLSInspectionConfigurationResponse {
2577
2842
  */
2578
2843
  export interface DisassociateSubnetsRequest {
2579
2844
  /**
2845
+ * @public
2580
2846
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
2581
2847
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
2582
2848
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
2583
2849
  */
2584
2850
  UpdateToken?: string;
2585
2851
  /**
2852
+ * @public
2586
2853
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
2587
2854
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2588
2855
  */
2589
2856
  FirewallArn?: string;
2590
2857
  /**
2858
+ * @public
2591
2859
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
2592
2860
  * <p>You must specify the ARN or the name, and you can specify both. </p>
2593
2861
  */
2594
2862
  FirewallName?: string;
2595
2863
  /**
2864
+ * @public
2596
2865
  * <p>The unique identifiers for the subnets that you want to disassociate. </p>
2597
2866
  */
2598
2867
  SubnetIds: string[] | undefined;
@@ -2602,18 +2871,22 @@ export interface DisassociateSubnetsRequest {
2602
2871
  */
2603
2872
  export interface DisassociateSubnetsResponse {
2604
2873
  /**
2874
+ * @public
2605
2875
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
2606
2876
  */
2607
2877
  FirewallArn?: string;
2608
2878
  /**
2879
+ * @public
2609
2880
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
2610
2881
  */
2611
2882
  FirewallName?: string;
2612
2883
  /**
2884
+ * @public
2613
2885
  * <p>The IDs of the subnets that are associated with the firewall. </p>
2614
2886
  */
2615
2887
  SubnetMappings?: SubnetMapping[];
2616
2888
  /**
2889
+ * @public
2617
2890
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
2618
2891
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
2619
2892
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
@@ -2628,10 +2901,12 @@ export interface DisassociateSubnetsResponse {
2628
2901
  */
2629
2902
  export interface FirewallMetadata {
2630
2903
  /**
2904
+ * @public
2631
2905
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
2632
2906
  */
2633
2907
  FirewallName?: string;
2634
2908
  /**
2909
+ * @public
2635
2910
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
2636
2911
  */
2637
2912
  FirewallArn?: string;
@@ -2644,10 +2919,12 @@ export interface FirewallMetadata {
2644
2919
  */
2645
2920
  export interface FirewallPolicyMetadata {
2646
2921
  /**
2922
+ * @public
2647
2923
  * <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>
2648
2924
  */
2649
2925
  Name?: string;
2650
2926
  /**
2927
+ * @public
2651
2928
  * <p>The Amazon Resource Name (ARN) of the firewall policy.</p>
2652
2929
  */
2653
2930
  Arn?: string;
@@ -2657,12 +2934,14 @@ export interface FirewallPolicyMetadata {
2657
2934
  */
2658
2935
  export interface ListFirewallPoliciesRequest {
2659
2936
  /**
2937
+ * @public
2660
2938
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2661
2939
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2662
2940
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2663
2941
  */
2664
2942
  NextToken?: string;
2665
2943
  /**
2944
+ * @public
2666
2945
  * <p>The maximum number of objects that you want Network Firewall to return for this request. If more
2667
2946
  * objects are available, in the response, Network Firewall provides a
2668
2947
  * <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
@@ -2674,12 +2953,14 @@ export interface ListFirewallPoliciesRequest {
2674
2953
  */
2675
2954
  export interface ListFirewallPoliciesResponse {
2676
2955
  /**
2956
+ * @public
2677
2957
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2678
2958
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2679
2959
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2680
2960
  */
2681
2961
  NextToken?: string;
2682
2962
  /**
2963
+ * @public
2683
2964
  * <p>The metadata for the firewall policies. Depending on your setting for max results and
2684
2965
  * the number of firewall policies that you have, this might not be the full list. </p>
2685
2966
  */
@@ -2690,17 +2971,20 @@ export interface ListFirewallPoliciesResponse {
2690
2971
  */
2691
2972
  export interface ListFirewallsRequest {
2692
2973
  /**
2974
+ * @public
2693
2975
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2694
2976
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2695
2977
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2696
2978
  */
2697
2979
  NextToken?: string;
2698
2980
  /**
2981
+ * @public
2699
2982
  * <p>The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls
2700
2983
  * for. Leave this blank to retrieve all firewalls that you have defined.</p>
2701
2984
  */
2702
2985
  VpcIds?: string[];
2703
2986
  /**
2987
+ * @public
2704
2988
  * <p>The maximum number of objects that you want Network Firewall to return for this request. If more
2705
2989
  * objects are available, in the response, Network Firewall provides a
2706
2990
  * <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
@@ -2712,12 +2996,14 @@ export interface ListFirewallsRequest {
2712
2996
  */
2713
2997
  export interface ListFirewallsResponse {
2714
2998
  /**
2999
+ * @public
2715
3000
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2716
3001
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2717
3002
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2718
3003
  */
2719
3004
  NextToken?: string;
2720
3005
  /**
3006
+ * @public
2721
3007
  * <p>The firewall metadata objects for the VPCs that you specified. Depending on your setting
2722
3008
  * for max results and the number of firewalls you have, a single call might not be the full
2723
3009
  * list. </p>
@@ -2753,28 +3039,33 @@ export type ResourceManagedStatus = (typeof ResourceManagedStatus)[keyof typeof
2753
3039
  */
2754
3040
  export interface ListRuleGroupsRequest {
2755
3041
  /**
3042
+ * @public
2756
3043
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2757
3044
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2758
3045
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2759
3046
  */
2760
3047
  NextToken?: string;
2761
3048
  /**
3049
+ * @public
2762
3050
  * <p>The maximum number of objects that you want Network Firewall to return for this request. If more
2763
3051
  * objects are available, in the response, Network Firewall provides a
2764
3052
  * <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
2765
3053
  */
2766
3054
  MaxResults?: number;
2767
3055
  /**
3056
+ * @public
2768
3057
  * <p>The scope of the request. The default setting of <code>ACCOUNT</code> or a setting of
2769
3058
  * <code>NULL</code> returns all of the rule groups in your account. A setting of
2770
3059
  * <code>MANAGED</code> returns all available managed rule groups.</p>
2771
3060
  */
2772
3061
  Scope?: ResourceManagedStatus | string;
2773
3062
  /**
3063
+ * @public
2774
3064
  * <p>Indicates the general category of the Amazon Web Services managed rule group.</p>
2775
3065
  */
2776
3066
  ManagedType?: ResourceManagedType | string;
2777
3067
  /**
3068
+ * @public
2778
3069
  * <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.</p>
2779
3070
  */
2780
3071
  Type?: RuleGroupType | string;
@@ -2787,10 +3078,12 @@ export interface ListRuleGroupsRequest {
2787
3078
  */
2788
3079
  export interface RuleGroupMetadata {
2789
3080
  /**
3081
+ * @public
2790
3082
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
2791
3083
  */
2792
3084
  Name?: string;
2793
3085
  /**
3086
+ * @public
2794
3087
  * <p>The Amazon Resource Name (ARN) of the rule group.</p>
2795
3088
  */
2796
3089
  Arn?: string;
@@ -2800,12 +3093,14 @@ export interface RuleGroupMetadata {
2800
3093
  */
2801
3094
  export interface ListRuleGroupsResponse {
2802
3095
  /**
3096
+ * @public
2803
3097
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2804
3098
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2805
3099
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2806
3100
  */
2807
3101
  NextToken?: string;
2808
3102
  /**
3103
+ * @public
2809
3104
  * <p>The rule group metadata objects that you've defined. Depending on your setting for max
2810
3105
  * results and the number of rule groups, this might not be the full list. </p>
2811
3106
  */
@@ -2816,18 +3111,21 @@ export interface ListRuleGroupsResponse {
2816
3111
  */
2817
3112
  export interface ListTagsForResourceRequest {
2818
3113
  /**
3114
+ * @public
2819
3115
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2820
3116
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2821
3117
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2822
3118
  */
2823
3119
  NextToken?: string;
2824
3120
  /**
3121
+ * @public
2825
3122
  * <p>The maximum number of objects that you want Network Firewall to return for this request. If more
2826
3123
  * objects are available, in the response, Network Firewall provides a
2827
3124
  * <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
2828
3125
  */
2829
3126
  MaxResults?: number;
2830
3127
  /**
3128
+ * @public
2831
3129
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2832
3130
  */
2833
3131
  ResourceArn: string | undefined;
@@ -2837,12 +3135,14 @@ export interface ListTagsForResourceRequest {
2837
3135
  */
2838
3136
  export interface ListTagsForResourceResponse {
2839
3137
  /**
3138
+ * @public
2840
3139
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2841
3140
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2842
3141
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2843
3142
  */
2844
3143
  NextToken?: string;
2845
3144
  /**
3145
+ * @public
2846
3146
  * <p>The tags that are associated with the resource. </p>
2847
3147
  */
2848
3148
  Tags?: Tag[];
@@ -2852,12 +3152,14 @@ export interface ListTagsForResourceResponse {
2852
3152
  */
2853
3153
  export interface ListTLSInspectionConfigurationsRequest {
2854
3154
  /**
3155
+ * @public
2855
3156
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2856
3157
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2857
3158
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2858
3159
  */
2859
3160
  NextToken?: string;
2860
3161
  /**
3162
+ * @public
2861
3163
  * <p>The maximum number of objects that you want Network Firewall to return for this request. If more
2862
3164
  * objects are available, in the response, Network Firewall provides a
2863
3165
  * <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
@@ -2870,10 +3172,12 @@ export interface ListTLSInspectionConfigurationsRequest {
2870
3172
  */
2871
3173
  export interface TLSInspectionConfigurationMetadata {
2872
3174
  /**
3175
+ * @public
2873
3176
  * <p>The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.</p>
2874
3177
  */
2875
3178
  Name?: string;
2876
3179
  /**
3180
+ * @public
2877
3181
  * <p>The Amazon Resource Name (ARN) of the TLS inspection configuration.</p>
2878
3182
  */
2879
3183
  Arn?: string;
@@ -2883,12 +3187,14 @@ export interface TLSInspectionConfigurationMetadata {
2883
3187
  */
2884
3188
  export interface ListTLSInspectionConfigurationsResponse {
2885
3189
  /**
3190
+ * @public
2886
3191
  * <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available
2887
3192
  * for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>
2888
3193
  * value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
2889
3194
  */
2890
3195
  NextToken?: string;
2891
3196
  /**
3197
+ * @public
2892
3198
  * <p>The TLS inspection configuration metadata objects that you've defined. Depending on your setting for max results and the number of TLS inspection configurations, this might not be the full list.</p>
2893
3199
  */
2894
3200
  TLSInspectionConfigurations?: TLSInspectionConfigurationMetadata[];
@@ -2911,10 +3217,12 @@ export declare class LogDestinationPermissionException extends __BaseException {
2911
3217
  */
2912
3218
  export interface PutResourcePolicyRequest {
2913
3219
  /**
3220
+ * @public
2914
3221
  * <p>The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with.</p>
2915
3222
  */
2916
3223
  ResourceArn: string | undefined;
2917
3224
  /**
3225
+ * @public
2918
3226
  * <p>The IAM policy statement that lists the accounts that you want to share your rule group or firewall policy with
2919
3227
  * and the operations that you want the accounts to be able to perform. </p>
2920
3228
  * <p>For a rule group resource, you can specify the following operations in the Actions section of the statement:</p>
@@ -2952,10 +3260,12 @@ export interface PutResourcePolicyResponse {
2952
3260
  */
2953
3261
  export interface TagResourceRequest {
2954
3262
  /**
3263
+ * @public
2955
3264
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2956
3265
  */
2957
3266
  ResourceArn: string | undefined;
2958
3267
  /**
3268
+ * @public
2959
3269
  * <p></p>
2960
3270
  */
2961
3271
  Tags: Tag[] | undefined;
@@ -2970,10 +3280,12 @@ export interface TagResourceResponse {
2970
3280
  */
2971
3281
  export interface UntagResourceRequest {
2972
3282
  /**
3283
+ * @public
2973
3284
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2974
3285
  */
2975
3286
  ResourceArn: string | undefined;
2976
3287
  /**
3288
+ * @public
2977
3289
  * <p></p>
2978
3290
  */
2979
3291
  TagKeys: string[] | undefined;
@@ -3001,22 +3313,26 @@ export declare class ResourceOwnerCheckException extends __BaseException {
3001
3313
  */
3002
3314
  export interface UpdateFirewallDeleteProtectionRequest {
3003
3315
  /**
3316
+ * @public
3004
3317
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3005
3318
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3006
3319
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
3007
3320
  */
3008
3321
  UpdateToken?: string;
3009
3322
  /**
3323
+ * @public
3010
3324
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3011
3325
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3012
3326
  */
3013
3327
  FirewallArn?: string;
3014
3328
  /**
3329
+ * @public
3015
3330
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3016
3331
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3017
3332
  */
3018
3333
  FirewallName?: string;
3019
3334
  /**
3335
+ * @public
3020
3336
  * <p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> indicates
3021
3337
  * that the firewall is protected against deletion. Use this setting to protect against
3022
3338
  * accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to <code>TRUE</code>.</p>
@@ -3028,20 +3344,24 @@ export interface UpdateFirewallDeleteProtectionRequest {
3028
3344
  */
3029
3345
  export interface UpdateFirewallDeleteProtectionResponse {
3030
3346
  /**
3347
+ * @public
3031
3348
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3032
3349
  */
3033
3350
  FirewallArn?: string;
3034
3351
  /**
3352
+ * @public
3035
3353
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3036
3354
  */
3037
3355
  FirewallName?: string;
3038
3356
  /**
3357
+ * @public
3039
3358
  * <p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> indicates
3040
3359
  * that the firewall is protected against deletion. Use this setting to protect against
3041
3360
  * accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to <code>TRUE</code>.</p>
3042
3361
  */
3043
3362
  DeleteProtection?: boolean;
3044
3363
  /**
3364
+ * @public
3045
3365
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3046
3366
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3047
3367
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
@@ -3053,22 +3373,26 @@ export interface UpdateFirewallDeleteProtectionResponse {
3053
3373
  */
3054
3374
  export interface UpdateFirewallDescriptionRequest {
3055
3375
  /**
3376
+ * @public
3056
3377
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3057
3378
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3058
3379
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
3059
3380
  */
3060
3381
  UpdateToken?: string;
3061
3382
  /**
3383
+ * @public
3062
3384
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3063
3385
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3064
3386
  */
3065
3387
  FirewallArn?: string;
3066
3388
  /**
3389
+ * @public
3067
3390
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3068
3391
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3069
3392
  */
3070
3393
  FirewallName?: string;
3071
3394
  /**
3395
+ * @public
3072
3396
  * <p>The new description for the firewall. If you omit this setting, Network Firewall removes
3073
3397
  * the description for the firewall.</p>
3074
3398
  */
@@ -3079,18 +3403,22 @@ export interface UpdateFirewallDescriptionRequest {
3079
3403
  */
3080
3404
  export interface UpdateFirewallDescriptionResponse {
3081
3405
  /**
3406
+ * @public
3082
3407
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3083
3408
  */
3084
3409
  FirewallArn?: string;
3085
3410
  /**
3411
+ * @public
3086
3412
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3087
3413
  */
3088
3414
  FirewallName?: string;
3089
3415
  /**
3416
+ * @public
3090
3417
  * <p>A description of the firewall.</p>
3091
3418
  */
3092
3419
  Description?: string;
3093
3420
  /**
3421
+ * @public
3094
3422
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3095
3423
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3096
3424
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
@@ -3102,20 +3430,24 @@ export interface UpdateFirewallDescriptionResponse {
3102
3430
  */
3103
3431
  export interface UpdateFirewallEncryptionConfigurationRequest {
3104
3432
  /**
3433
+ * @public
3105
3434
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3106
3435
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3107
3436
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
3108
3437
  */
3109
3438
  UpdateToken?: string;
3110
3439
  /**
3440
+ * @public
3111
3441
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3112
3442
  */
3113
3443
  FirewallArn?: string;
3114
3444
  /**
3445
+ * @public
3115
3446
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3116
3447
  */
3117
3448
  FirewallName?: string;
3118
3449
  /**
3450
+ * @public
3119
3451
  * <p>A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html">Encryption at rest with Amazon Web Services Key Managment Service</a> in the <i>Network Firewall Developer Guide</i>.</p>
3120
3452
  */
3121
3453
  EncryptionConfiguration?: EncryptionConfiguration;
@@ -3125,20 +3457,24 @@ export interface UpdateFirewallEncryptionConfigurationRequest {
3125
3457
  */
3126
3458
  export interface UpdateFirewallEncryptionConfigurationResponse {
3127
3459
  /**
3460
+ * @public
3128
3461
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3129
3462
  */
3130
3463
  FirewallArn?: string;
3131
3464
  /**
3465
+ * @public
3132
3466
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3133
3467
  */
3134
3468
  FirewallName?: string;
3135
3469
  /**
3470
+ * @public
3136
3471
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3137
3472
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3138
3473
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
3139
3474
  */
3140
3475
  UpdateToken?: string;
3141
3476
  /**
3477
+ * @public
3142
3478
  * <p>A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html">Encryption at rest with Amazon Web Services Key Managment Service</a> in the <i>Network Firewall Developer Guide</i>.</p>
3143
3479
  */
3144
3480
  EncryptionConfiguration?: EncryptionConfiguration;
@@ -3148,29 +3484,35 @@ export interface UpdateFirewallEncryptionConfigurationResponse {
3148
3484
  */
3149
3485
  export interface UpdateFirewallPolicyRequest {
3150
3486
  /**
3487
+ * @public
3151
3488
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. </p>
3152
3489
  * <p>To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token. </p>
3153
3490
  */
3154
3491
  UpdateToken: string | undefined;
3155
3492
  /**
3493
+ * @public
3156
3494
  * <p>The Amazon Resource Name (ARN) of the firewall policy.</p>
3157
3495
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3158
3496
  */
3159
3497
  FirewallPolicyArn?: string;
3160
3498
  /**
3499
+ * @public
3161
3500
  * <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>
3162
3501
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3163
3502
  */
3164
3503
  FirewallPolicyName?: string;
3165
3504
  /**
3505
+ * @public
3166
3506
  * <p>The updated firewall policy to use for the firewall. </p>
3167
3507
  */
3168
3508
  FirewallPolicy: FirewallPolicy | undefined;
3169
3509
  /**
3510
+ * @public
3170
3511
  * <p>A description of the firewall policy.</p>
3171
3512
  */
3172
3513
  Description?: string;
3173
3514
  /**
3515
+ * @public
3174
3516
  * <p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>
3175
3517
  * <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully,
3176
3518
  * but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with
@@ -3180,6 +3522,7 @@ export interface UpdateFirewallPolicyRequest {
3180
3522
  */
3181
3523
  DryRun?: boolean;
3182
3524
  /**
3525
+ * @public
3183
3526
  * <p>A complex type that contains settings for encryption of your firewall policy resources.</p>
3184
3527
  */
3185
3528
  EncryptionConfiguration?: EncryptionConfiguration;
@@ -3189,11 +3532,13 @@ export interface UpdateFirewallPolicyRequest {
3189
3532
  */
3190
3533
  export interface UpdateFirewallPolicyResponse {
3191
3534
  /**
3535
+ * @public
3192
3536
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. </p>
3193
3537
  * <p>To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token. </p>
3194
3538
  */
3195
3539
  UpdateToken: string | undefined;
3196
3540
  /**
3541
+ * @public
3197
3542
  * <p>The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. </p>
3198
3543
  */
3199
3544
  FirewallPolicyResponse: FirewallPolicyResponse | undefined;
@@ -3203,22 +3548,26 @@ export interface UpdateFirewallPolicyResponse {
3203
3548
  */
3204
3549
  export interface UpdateFirewallPolicyChangeProtectionRequest {
3205
3550
  /**
3551
+ * @public
3206
3552
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3207
3553
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3208
3554
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
3209
3555
  */
3210
3556
  UpdateToken?: string;
3211
3557
  /**
3558
+ * @public
3212
3559
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3213
3560
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3214
3561
  */
3215
3562
  FirewallArn?: string;
3216
3563
  /**
3564
+ * @public
3217
3565
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3218
3566
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3219
3567
  */
3220
3568
  FirewallName?: string;
3221
3569
  /**
3570
+ * @public
3222
3571
  * <p>A setting indicating whether the firewall is protected against a change to the firewall policy association.
3223
3572
  * Use this setting to protect against
3224
3573
  * accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to <code>TRUE</code>.</p>
@@ -3230,20 +3579,24 @@ export interface UpdateFirewallPolicyChangeProtectionRequest {
3230
3579
  */
3231
3580
  export interface UpdateFirewallPolicyChangeProtectionResponse {
3232
3581
  /**
3582
+ * @public
3233
3583
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3234
3584
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3235
3585
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
3236
3586
  */
3237
3587
  UpdateToken?: string;
3238
3588
  /**
3589
+ * @public
3239
3590
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3240
3591
  */
3241
3592
  FirewallArn?: string;
3242
3593
  /**
3594
+ * @public
3243
3595
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3244
3596
  */
3245
3597
  FirewallName?: string;
3246
3598
  /**
3599
+ * @public
3247
3600
  * <p>A setting indicating whether the firewall is protected against a change to the firewall policy association.
3248
3601
  * Use this setting to protect against
3249
3602
  * accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to <code>TRUE</code>.</p>
@@ -3255,16 +3608,19 @@ export interface UpdateFirewallPolicyChangeProtectionResponse {
3255
3608
  */
3256
3609
  export interface UpdateLoggingConfigurationRequest {
3257
3610
  /**
3611
+ * @public
3258
3612
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3259
3613
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3260
3614
  */
3261
3615
  FirewallArn?: string;
3262
3616
  /**
3617
+ * @public
3263
3618
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3264
3619
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3265
3620
  */
3266
3621
  FirewallName?: string;
3267
3622
  /**
3623
+ * @public
3268
3624
  * <p>Defines how Network Firewall performs logging for a firewall. If you omit this setting,
3269
3625
  * Network Firewall disables logging for the firewall.</p>
3270
3626
  */
@@ -3275,14 +3631,17 @@ export interface UpdateLoggingConfigurationRequest {
3275
3631
  */
3276
3632
  export interface UpdateLoggingConfigurationResponse {
3277
3633
  /**
3634
+ * @public
3278
3635
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3279
3636
  */
3280
3637
  FirewallArn?: string;
3281
3638
  /**
3639
+ * @public
3282
3640
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3283
3641
  */
3284
3642
  FirewallName?: string;
3285
3643
  /**
3644
+ * @public
3286
3645
  * <p>Defines how Network Firewall performs logging for a <a>Firewall</a>. </p>
3287
3646
  */
3288
3647
  LoggingConfiguration?: LoggingConfiguration;
@@ -3292,21 +3651,25 @@ export interface UpdateLoggingConfigurationResponse {
3292
3651
  */
3293
3652
  export interface UpdateRuleGroupRequest {
3294
3653
  /**
3654
+ * @public
3295
3655
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. </p>
3296
3656
  * <p>To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>
3297
3657
  */
3298
3658
  UpdateToken: string | undefined;
3299
3659
  /**
3660
+ * @public
3300
3661
  * <p>The Amazon Resource Name (ARN) of the rule group.</p>
3301
3662
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3302
3663
  */
3303
3664
  RuleGroupArn?: string;
3304
3665
  /**
3666
+ * @public
3305
3667
  * <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
3306
3668
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3307
3669
  */
3308
3670
  RuleGroupName?: string;
3309
3671
  /**
3672
+ * @public
3310
3673
  * <p>An object that defines the rule group rules. </p>
3311
3674
  * <note>
3312
3675
  * <p>You must provide either this rule group setting or a <code>Rules</code> setting, but not both. </p>
@@ -3314,6 +3677,7 @@ export interface UpdateRuleGroupRequest {
3314
3677
  */
3315
3678
  RuleGroup?: RuleGroup;
3316
3679
  /**
3680
+ * @public
3317
3681
  * <p>A string containing stateful rule group rules specifications in Suricata flat format, with one rule
3318
3682
  * per line. Use this to import your existing Suricata compatible rule groups. </p>
3319
3683
  * <note>
@@ -3324,6 +3688,7 @@ export interface UpdateRuleGroupRequest {
3324
3688
  */
3325
3689
  Rules?: string;
3326
3690
  /**
3691
+ * @public
3327
3692
  * <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
3328
3693
  * stateless rules. If it is stateful, it contains stateful rules. </p>
3329
3694
  * <note>
@@ -3332,10 +3697,12 @@ export interface UpdateRuleGroupRequest {
3332
3697
  */
3333
3698
  Type?: RuleGroupType | string;
3334
3699
  /**
3700
+ * @public
3335
3701
  * <p>A description of the rule group. </p>
3336
3702
  */
3337
3703
  Description?: string;
3338
3704
  /**
3705
+ * @public
3339
3706
  * <p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>
3340
3707
  * <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully,
3341
3708
  * but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with
@@ -3345,10 +3712,12 @@ export interface UpdateRuleGroupRequest {
3345
3712
  */
3346
3713
  DryRun?: boolean;
3347
3714
  /**
3715
+ * @public
3348
3716
  * <p>A complex type that contains settings for encryption of your rule group resources.</p>
3349
3717
  */
3350
3718
  EncryptionConfiguration?: EncryptionConfiguration;
3351
3719
  /**
3720
+ * @public
3352
3721
  * <p>A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.</p>
3353
3722
  */
3354
3723
  SourceMetadata?: SourceMetadata;
@@ -3358,11 +3727,13 @@ export interface UpdateRuleGroupRequest {
3358
3727
  */
3359
3728
  export interface UpdateRuleGroupResponse {
3360
3729
  /**
3730
+ * @public
3361
3731
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. </p>
3362
3732
  * <p>To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>
3363
3733
  */
3364
3734
  UpdateToken: string | undefined;
3365
3735
  /**
3736
+ * @public
3366
3737
  * <p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>
3367
3738
  */
3368
3739
  RuleGroupResponse: RuleGroupResponse | undefined;
@@ -3372,22 +3743,26 @@ export interface UpdateRuleGroupResponse {
3372
3743
  */
3373
3744
  export interface UpdateSubnetChangeProtectionRequest {
3374
3745
  /**
3746
+ * @public
3375
3747
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3376
3748
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3377
3749
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
3378
3750
  */
3379
3751
  UpdateToken?: string;
3380
3752
  /**
3753
+ * @public
3381
3754
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3382
3755
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3383
3756
  */
3384
3757
  FirewallArn?: string;
3385
3758
  /**
3759
+ * @public
3386
3760
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3387
3761
  * <p>You must specify the ARN or the name, and you can specify both. </p>
3388
3762
  */
3389
3763
  FirewallName?: string;
3390
3764
  /**
3765
+ * @public
3391
3766
  * <p>A setting indicating whether the firewall is protected against changes to the subnet associations.
3392
3767
  * Use this setting to protect against
3393
3768
  * accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to <code>TRUE</code>.</p>
@@ -3399,20 +3774,24 @@ export interface UpdateSubnetChangeProtectionRequest {
3399
3774
  */
3400
3775
  export interface UpdateSubnetChangeProtectionResponse {
3401
3776
  /**
3777
+ * @public
3402
3778
  * <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p>
3403
3779
  * <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p>
3404
3780
  * <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
3405
3781
  */
3406
3782
  UpdateToken?: string;
3407
3783
  /**
3784
+ * @public
3408
3785
  * <p>The Amazon Resource Name (ARN) of the firewall.</p>
3409
3786
  */
3410
3787
  FirewallArn?: string;
3411
3788
  /**
3789
+ * @public
3412
3790
  * <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>
3413
3791
  */
3414
3792
  FirewallName?: string;
3415
3793
  /**
3794
+ * @public
3416
3795
  * <p>A setting indicating whether the firewall is protected against changes to the subnet associations.
3417
3796
  * Use this setting to protect against
3418
3797
  * accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to <code>TRUE</code>.</p>
@@ -3424,14 +3803,17 @@ export interface UpdateSubnetChangeProtectionResponse {
3424
3803
  */
3425
3804
  export interface UpdateTLSInspectionConfigurationRequest {
3426
3805
  /**
3806
+ * @public
3427
3807
  * <p>The Amazon Resource Name (ARN) of the TLS inspection configuration.</p>
3428
3808
  */
3429
3809
  TLSInspectionConfigurationArn?: string;
3430
3810
  /**
3811
+ * @public
3431
3812
  * <p>The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.</p>
3432
3813
  */
3433
3814
  TLSInspectionConfigurationName?: string;
3434
3815
  /**
3816
+ * @public
3435
3817
  * <p>The object that defines a TLS inspection configuration. This, along with <a>TLSInspectionConfigurationResponse</a>, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a>. </p>
3436
3818
  * <p>Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.</p>
3437
3819
  * <p>To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html">Decrypting SSL/TLS traffic with TLS
@@ -3439,14 +3821,17 @@ export interface UpdateTLSInspectionConfigurationRequest {
3439
3821
  */
3440
3822
  TLSInspectionConfiguration: TLSInspectionConfiguration | undefined;
3441
3823
  /**
3824
+ * @public
3442
3825
  * <p>A description of the TLS inspection configuration. </p>
3443
3826
  */
3444
3827
  Description?: string;
3445
3828
  /**
3829
+ * @public
3446
3830
  * <p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.</p>
3447
3831
  */
3448
3832
  EncryptionConfiguration?: EncryptionConfiguration;
3449
3833
  /**
3834
+ * @public
3450
3835
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request. </p>
3451
3836
  * <p>To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>
3452
3837
  */
@@ -3457,11 +3842,13 @@ export interface UpdateTLSInspectionConfigurationRequest {
3457
3842
  */
3458
3843
  export interface UpdateTLSInspectionConfigurationResponse {
3459
3844
  /**
3845
+ * @public
3460
3846
  * <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request. </p>
3461
3847
  * <p>To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>
3462
3848
  */
3463
3849
  UpdateToken: string | undefined;
3464
3850
  /**
3851
+ * @public
3465
3852
  * <p>The high-level properties of a TLS inspection configuration. This, along with the <a>TLSInspectionConfiguration</a>, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a>. </p>
3466
3853
  */
3467
3854
  TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponse | undefined;