aws-sdk-networkfirewall 1.60.0 → 1.62.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-networkfirewall/client.rb +303 -33
- data/lib/aws-sdk-networkfirewall/client_api.rb +162 -2
- data/lib/aws-sdk-networkfirewall/types.rb +429 -6
- data/lib/aws-sdk-networkfirewall.rb +1 -1
- data/sig/client.rbs +66 -3
- data/sig/types.rbs +92 -0
- metadata +2 -2
@@ -74,6 +74,45 @@ module Aws::NetworkFirewall
|
|
74
74
|
include Aws::Structure
|
75
75
|
end
|
76
76
|
|
77
|
+
# A report that captures key activity from the last 30 days of network
|
78
|
+
# traffic monitored by your firewall.
|
79
|
+
#
|
80
|
+
# You can generate up to one report per traffic type, per 30 day period.
|
81
|
+
# For example, when you successfully create an HTTP traffic report, you
|
82
|
+
# cannot create another HTTP traffic report until 30 days pass.
|
83
|
+
# Alternatively, if you generate a report that combines metrics on both
|
84
|
+
# HTTP and HTTPS traffic, you cannot create another report for either
|
85
|
+
# traffic type until 30 days pass.
|
86
|
+
#
|
87
|
+
# @!attribute [rw] analysis_report_id
|
88
|
+
# The unique ID of the query that ran when you requested an analysis
|
89
|
+
# report.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] analysis_type
|
93
|
+
# The type of traffic that will be used to generate a report.
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] report_time
|
97
|
+
# The date and time the analysis report was ran.
|
98
|
+
# @return [Time]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] status
|
101
|
+
# The status of the analysis report you specify. Statuses include
|
102
|
+
# `RUNNING`, `COMPLETED`, or `FAILED`.
|
103
|
+
# @return [String]
|
104
|
+
#
|
105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/AnalysisReport AWS API Documentation
|
106
|
+
#
|
107
|
+
class AnalysisReport < Struct.new(
|
108
|
+
:analysis_report_id,
|
109
|
+
:analysis_type,
|
110
|
+
:report_time,
|
111
|
+
:status)
|
112
|
+
SENSITIVE = []
|
113
|
+
include Aws::Structure
|
114
|
+
end
|
115
|
+
|
77
116
|
# The analysis result for Network Firewall's stateless rule group
|
78
117
|
# analyzer. Every time you call CreateRuleGroup, UpdateRuleGroup, or
|
79
118
|
# DescribeRuleGroup on a stateless rule group, Network Firewall analyzes
|
@@ -84,6 +123,10 @@ module Aws::NetworkFirewall
|
|
84
123
|
# process traffic, the service includes the rule in a list of analysis
|
85
124
|
# results.
|
86
125
|
#
|
126
|
+
# The `AnalysisResult` data type is not related to traffic analysis
|
127
|
+
# reports you generate using StartAnalysisReport. For information on
|
128
|
+
# traffic analysis report results, see AnalysisTypeReportResult.
|
129
|
+
#
|
87
130
|
# @!attribute [rw] identified_rule_ids
|
88
131
|
# The priority number of the stateless rules identified in the
|
89
132
|
# analysis.
|
@@ -138,6 +181,51 @@ module Aws::NetworkFirewall
|
|
138
181
|
include Aws::Structure
|
139
182
|
end
|
140
183
|
|
184
|
+
# The results of a `COMPLETED` analysis report generated with
|
185
|
+
# StartAnalysisReport.
|
186
|
+
#
|
187
|
+
# For an example of traffic analysis report results, see the response
|
188
|
+
# syntax of GetAnalysisReportResults.
|
189
|
+
#
|
190
|
+
# @!attribute [rw] protocol
|
191
|
+
# The type of traffic captured by the analysis report.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] first_accessed
|
195
|
+
# The date and time any domain was first accessed (within the last 30
|
196
|
+
# day period).
|
197
|
+
# @return [Time]
|
198
|
+
#
|
199
|
+
# @!attribute [rw] last_accessed
|
200
|
+
# The date and time any domain was last accessed (within the last 30
|
201
|
+
# day period).
|
202
|
+
# @return [Time]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] domain
|
205
|
+
# The most frequently accessed domains.
|
206
|
+
# @return [String]
|
207
|
+
#
|
208
|
+
# @!attribute [rw] hits
|
209
|
+
# The number of attempts made to access a observed domain.
|
210
|
+
# @return [Types::Hits]
|
211
|
+
#
|
212
|
+
# @!attribute [rw] unique_sources
|
213
|
+
# The number of unique source IP addresses that connected to a domain.
|
214
|
+
# @return [Types::UniqueSources]
|
215
|
+
#
|
216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/AnalysisTypeReportResult AWS API Documentation
|
217
|
+
#
|
218
|
+
class AnalysisTypeReportResult < Struct.new(
|
219
|
+
:protocol,
|
220
|
+
:first_accessed,
|
221
|
+
:last_accessed,
|
222
|
+
:domain,
|
223
|
+
:hits,
|
224
|
+
:unique_sources)
|
225
|
+
SENSITIVE = []
|
226
|
+
include Aws::Structure
|
227
|
+
end
|
228
|
+
|
141
229
|
# @!attribute [rw] update_token
|
142
230
|
# An optional token that you can use for optimistic locking. Network
|
143
231
|
# Firewall returns a token to your requests that access the firewall.
|
@@ -608,6 +696,11 @@ module Aws::NetworkFirewall
|
|
608
696
|
# firewall resources.
|
609
697
|
# @return [Types::EncryptionConfiguration]
|
610
698
|
#
|
699
|
+
# @!attribute [rw] enabled_analysis_types
|
700
|
+
# An optional setting indicating the specific traffic analysis types
|
701
|
+
# to enable on the firewall.
|
702
|
+
# @return [Array<String>]
|
703
|
+
#
|
611
704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateFirewallRequest AWS API Documentation
|
612
705
|
#
|
613
706
|
class CreateFirewallRequest < Struct.new(
|
@@ -620,7 +713,8 @@ module Aws::NetworkFirewall
|
|
620
713
|
:firewall_policy_change_protection,
|
621
714
|
:description,
|
622
715
|
:tags,
|
623
|
-
:encryption_configuration
|
716
|
+
:encryption_configuration,
|
717
|
+
:enabled_analysis_types)
|
624
718
|
SENSITIVE = []
|
625
719
|
include Aws::Structure
|
626
720
|
end
|
@@ -1837,6 +1931,11 @@ module Aws::NetworkFirewall
|
|
1837
1931
|
# configuration settings for your firewall.
|
1838
1932
|
# @return [Types::EncryptionConfiguration]
|
1839
1933
|
#
|
1934
|
+
# @!attribute [rw] enabled_analysis_types
|
1935
|
+
# An optional setting indicating the specific traffic analysis types
|
1936
|
+
# to enable on the firewall.
|
1937
|
+
# @return [Array<String>]
|
1938
|
+
#
|
1840
1939
|
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/Firewall AWS API Documentation
|
1841
1940
|
#
|
1842
1941
|
class Firewall < Struct.new(
|
@@ -1851,7 +1950,8 @@ module Aws::NetworkFirewall
|
|
1851
1950
|
:description,
|
1852
1951
|
:firewall_id,
|
1853
1952
|
:tags,
|
1854
|
-
:encryption_configuration
|
1953
|
+
:encryption_configuration,
|
1954
|
+
:enabled_analysis_types)
|
1855
1955
|
SENSITIVE = []
|
1856
1956
|
include Aws::Structure
|
1857
1957
|
end
|
@@ -2178,6 +2278,102 @@ module Aws::NetworkFirewall
|
|
2178
2278
|
include Aws::Structure
|
2179
2279
|
end
|
2180
2280
|
|
2281
|
+
# @!attribute [rw] firewall_name
|
2282
|
+
# The descriptive name of the firewall. You can't change the name of
|
2283
|
+
# a firewall after you create it.
|
2284
|
+
#
|
2285
|
+
# You must specify the ARN or the name, and you can specify both.
|
2286
|
+
# @return [String]
|
2287
|
+
#
|
2288
|
+
# @!attribute [rw] analysis_report_id
|
2289
|
+
# The unique ID of the query that ran when you requested an analysis
|
2290
|
+
# report.
|
2291
|
+
# @return [String]
|
2292
|
+
#
|
2293
|
+
# @!attribute [rw] firewall_arn
|
2294
|
+
# The Amazon Resource Name (ARN) of the firewall.
|
2295
|
+
#
|
2296
|
+
# You must specify the ARN or the name, and you can specify both.
|
2297
|
+
# @return [String]
|
2298
|
+
#
|
2299
|
+
# @!attribute [rw] next_token
|
2300
|
+
# When you request a list of objects with a `MaxResults` setting, if
|
2301
|
+
# the number of objects that are still available for retrieval exceeds
|
2302
|
+
# the maximum you requested, Network Firewall returns a `NextToken`
|
2303
|
+
# value in the response. To retrieve the next batch of objects, use
|
2304
|
+
# the token returned from the prior request in your next request.
|
2305
|
+
# @return [String]
|
2306
|
+
#
|
2307
|
+
# @!attribute [rw] max_results
|
2308
|
+
# The maximum number of objects that you want Network Firewall to
|
2309
|
+
# return for this request. If more objects are available, in the
|
2310
|
+
# response, Network Firewall provides a `NextToken` value that you can
|
2311
|
+
# use in a subsequent call to get the next batch of objects.
|
2312
|
+
# @return [Integer]
|
2313
|
+
#
|
2314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/GetAnalysisReportResultsRequest AWS API Documentation
|
2315
|
+
#
|
2316
|
+
class GetAnalysisReportResultsRequest < Struct.new(
|
2317
|
+
:firewall_name,
|
2318
|
+
:analysis_report_id,
|
2319
|
+
:firewall_arn,
|
2320
|
+
:next_token,
|
2321
|
+
:max_results)
|
2322
|
+
SENSITIVE = []
|
2323
|
+
include Aws::Structure
|
2324
|
+
end
|
2325
|
+
|
2326
|
+
# @!attribute [rw] status
|
2327
|
+
# The status of the analysis report you specify. Statuses include
|
2328
|
+
# `RUNNING`, `COMPLETED`, or `FAILED`.
|
2329
|
+
# @return [String]
|
2330
|
+
#
|
2331
|
+
# @!attribute [rw] start_time
|
2332
|
+
# The date and time within the last 30 days from which to start
|
2333
|
+
# retrieving analysis data, in UTC format (for example,
|
2334
|
+
# `YYYY-MM-DDTHH:MM:SSZ`.
|
2335
|
+
# @return [Time]
|
2336
|
+
#
|
2337
|
+
# @!attribute [rw] end_time
|
2338
|
+
# The date and time, up to the current date, from which to stop
|
2339
|
+
# retrieving analysis data, in UTC format (for example,
|
2340
|
+
# `YYYY-MM-DDTHH:MM:SSZ`).
|
2341
|
+
# @return [Time]
|
2342
|
+
#
|
2343
|
+
# @!attribute [rw] report_time
|
2344
|
+
# The date and time the analysis report was ran.
|
2345
|
+
# @return [Time]
|
2346
|
+
#
|
2347
|
+
# @!attribute [rw] analysis_type
|
2348
|
+
# The type of traffic that will be used to generate a report.
|
2349
|
+
# @return [String]
|
2350
|
+
#
|
2351
|
+
# @!attribute [rw] next_token
|
2352
|
+
# When you request a list of objects with a `MaxResults` setting, if
|
2353
|
+
# the number of objects that are still available for retrieval exceeds
|
2354
|
+
# the maximum you requested, Network Firewall returns a `NextToken`
|
2355
|
+
# value in the response. To retrieve the next batch of objects, use
|
2356
|
+
# the token returned from the prior request in your next request.
|
2357
|
+
# @return [String]
|
2358
|
+
#
|
2359
|
+
# @!attribute [rw] analysis_report_results
|
2360
|
+
# Retrieves the results of a traffic analysis report.
|
2361
|
+
# @return [Array<Types::AnalysisTypeReportResult>]
|
2362
|
+
#
|
2363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/GetAnalysisReportResultsResponse AWS API Documentation
|
2364
|
+
#
|
2365
|
+
class GetAnalysisReportResultsResponse < Struct.new(
|
2366
|
+
:status,
|
2367
|
+
:start_time,
|
2368
|
+
:end_time,
|
2369
|
+
:report_time,
|
2370
|
+
:analysis_type,
|
2371
|
+
:next_token,
|
2372
|
+
:analysis_report_results)
|
2373
|
+
SENSITIVE = []
|
2374
|
+
include Aws::Structure
|
2375
|
+
end
|
2376
|
+
|
2181
2377
|
# The basic rule criteria for Network Firewall to use to inspect packet
|
2182
2378
|
# headers in stateful traffic flow inspection. Traffic flows that match
|
2183
2379
|
# the criteria are a match for the corresponding StatefulRule.
|
@@ -2287,6 +2483,20 @@ module Aws::NetworkFirewall
|
|
2287
2483
|
include Aws::Structure
|
2288
2484
|
end
|
2289
2485
|
|
2486
|
+
# Attempts made to a access domain.
|
2487
|
+
#
|
2488
|
+
# @!attribute [rw] count
|
2489
|
+
# The number of attempts made to access a domain.
|
2490
|
+
# @return [Integer]
|
2491
|
+
#
|
2492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/Hits AWS API Documentation
|
2493
|
+
#
|
2494
|
+
class Hits < Struct.new(
|
2495
|
+
:count)
|
2496
|
+
SENSITIVE = []
|
2497
|
+
include Aws::Structure
|
2498
|
+
end
|
2499
|
+
|
2290
2500
|
# A list of IP addresses and address ranges, in CIDR notation. This is
|
2291
2501
|
# part of a RuleVariables.
|
2292
2502
|
#
|
@@ -2457,6 +2667,67 @@ module Aws::NetworkFirewall
|
|
2457
2667
|
include Aws::Structure
|
2458
2668
|
end
|
2459
2669
|
|
2670
|
+
# @!attribute [rw] firewall_name
|
2671
|
+
# The descriptive name of the firewall. You can't change the name of
|
2672
|
+
# a firewall after you create it.
|
2673
|
+
#
|
2674
|
+
# You must specify the ARN or the name, and you can specify both.
|
2675
|
+
# @return [String]
|
2676
|
+
#
|
2677
|
+
# @!attribute [rw] firewall_arn
|
2678
|
+
# The Amazon Resource Name (ARN) of the firewall.
|
2679
|
+
#
|
2680
|
+
# You must specify the ARN or the name, and you can specify both.
|
2681
|
+
# @return [String]
|
2682
|
+
#
|
2683
|
+
# @!attribute [rw] next_token
|
2684
|
+
# When you request a list of objects with a `MaxResults` setting, if
|
2685
|
+
# the number of objects that are still available for retrieval exceeds
|
2686
|
+
# the maximum you requested, Network Firewall returns a `NextToken`
|
2687
|
+
# value in the response. To retrieve the next batch of objects, use
|
2688
|
+
# the token returned from the prior request in your next request.
|
2689
|
+
# @return [String]
|
2690
|
+
#
|
2691
|
+
# @!attribute [rw] max_results
|
2692
|
+
# The maximum number of objects that you want Network Firewall to
|
2693
|
+
# return for this request. If more objects are available, in the
|
2694
|
+
# response, Network Firewall provides a `NextToken` value that you can
|
2695
|
+
# use in a subsequent call to get the next batch of objects.
|
2696
|
+
# @return [Integer]
|
2697
|
+
#
|
2698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListAnalysisReportsRequest AWS API Documentation
|
2699
|
+
#
|
2700
|
+
class ListAnalysisReportsRequest < Struct.new(
|
2701
|
+
:firewall_name,
|
2702
|
+
:firewall_arn,
|
2703
|
+
:next_token,
|
2704
|
+
:max_results)
|
2705
|
+
SENSITIVE = []
|
2706
|
+
include Aws::Structure
|
2707
|
+
end
|
2708
|
+
|
2709
|
+
# @!attribute [rw] analysis_reports
|
2710
|
+
# The `id` and `ReportTime` associated with a requested analysis
|
2711
|
+
# report. Does not provide the status of the analysis report.
|
2712
|
+
# @return [Array<Types::AnalysisReport>]
|
2713
|
+
#
|
2714
|
+
# @!attribute [rw] next_token
|
2715
|
+
# When you request a list of objects with a `MaxResults` setting, if
|
2716
|
+
# the number of objects that are still available for retrieval exceeds
|
2717
|
+
# the maximum you requested, Network Firewall returns a `NextToken`
|
2718
|
+
# value in the response. To retrieve the next batch of objects, use
|
2719
|
+
# the token returned from the prior request in your next request.
|
2720
|
+
# @return [String]
|
2721
|
+
#
|
2722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListAnalysisReportsResponse AWS API Documentation
|
2723
|
+
#
|
2724
|
+
class ListAnalysisReportsResponse < Struct.new(
|
2725
|
+
:analysis_reports,
|
2726
|
+
:next_token)
|
2727
|
+
SENSITIVE = []
|
2728
|
+
include Aws::Structure
|
2729
|
+
end
|
2730
|
+
|
2460
2731
|
# @!attribute [rw] next_token
|
2461
2732
|
# When you request a list of objects with a `MaxResults` setting, if
|
2462
2733
|
# the number of objects that are still available for retrieval exceeds
|
@@ -3331,7 +3602,7 @@ module Aws::NetworkFirewall
|
|
3331
3602
|
#
|
3332
3603
|
#
|
3333
3604
|
#
|
3334
|
-
# [1]: https://suricata.readthedocs.io/en/suricata-
|
3605
|
+
# [1]: https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html#rule-options
|
3335
3606
|
# @return [String]
|
3336
3607
|
#
|
3337
3608
|
# @!attribute [rw] settings
|
@@ -3342,7 +3613,7 @@ module Aws::NetworkFirewall
|
|
3342
3613
|
#
|
3343
3614
|
#
|
3344
3615
|
#
|
3345
|
-
# [1]: https://suricata.readthedocs.io/en/suricata-
|
3616
|
+
# [1]: https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html#rule-options
|
3346
3617
|
# @return [Array<String>]
|
3347
3618
|
#
|
3348
3619
|
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/RuleOption AWS API Documentation
|
@@ -3406,7 +3677,7 @@ module Aws::NetworkFirewall
|
|
3406
3677
|
#
|
3407
3678
|
#
|
3408
3679
|
#
|
3409
|
-
# [1]: https://suricata.readthedocs.io/en/suricata-
|
3680
|
+
# [1]: https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html
|
3410
3681
|
# @return [Array<Types::StatefulRule>]
|
3411
3682
|
#
|
3412
3683
|
# @!attribute [rw] stateless_rules_and_custom_actions
|
@@ -3665,6 +3936,46 @@ module Aws::NetworkFirewall
|
|
3665
3936
|
include Aws::Structure
|
3666
3937
|
end
|
3667
3938
|
|
3939
|
+
# @!attribute [rw] firewall_name
|
3940
|
+
# The descriptive name of the firewall. You can't change the name of
|
3941
|
+
# a firewall after you create it.
|
3942
|
+
#
|
3943
|
+
# You must specify the ARN or the name, and you can specify both.
|
3944
|
+
# @return [String]
|
3945
|
+
#
|
3946
|
+
# @!attribute [rw] firewall_arn
|
3947
|
+
# The Amazon Resource Name (ARN) of the firewall.
|
3948
|
+
#
|
3949
|
+
# You must specify the ARN or the name, and you can specify both.
|
3950
|
+
# @return [String]
|
3951
|
+
#
|
3952
|
+
# @!attribute [rw] analysis_type
|
3953
|
+
# The type of traffic that will be used to generate a report.
|
3954
|
+
# @return [String]
|
3955
|
+
#
|
3956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/StartAnalysisReportRequest AWS API Documentation
|
3957
|
+
#
|
3958
|
+
class StartAnalysisReportRequest < Struct.new(
|
3959
|
+
:firewall_name,
|
3960
|
+
:firewall_arn,
|
3961
|
+
:analysis_type)
|
3962
|
+
SENSITIVE = []
|
3963
|
+
include Aws::Structure
|
3964
|
+
end
|
3965
|
+
|
3966
|
+
# @!attribute [rw] analysis_report_id
|
3967
|
+
# The unique ID of the query that ran when you requested an analysis
|
3968
|
+
# report.
|
3969
|
+
# @return [String]
|
3970
|
+
#
|
3971
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/StartAnalysisReportResponse AWS API Documentation
|
3972
|
+
#
|
3973
|
+
class StartAnalysisReportResponse < Struct.new(
|
3974
|
+
:analysis_report_id)
|
3975
|
+
SENSITIVE = []
|
3976
|
+
include Aws::Structure
|
3977
|
+
end
|
3978
|
+
|
3668
3979
|
# Configuration settings for the handling of the stateful rule groups in
|
3669
3980
|
# a firewall policy.
|
3670
3981
|
#
|
@@ -3738,7 +4049,7 @@ module Aws::NetworkFirewall
|
|
3738
4049
|
#
|
3739
4050
|
#
|
3740
4051
|
#
|
3741
|
-
# [1]: https://suricata.readthedocs.io/en/suricata-
|
4052
|
+
# [1]: https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html
|
3742
4053
|
#
|
3743
4054
|
# @!attribute [rw] action
|
3744
4055
|
# Defines what Network Firewall should do with the packets in a
|
@@ -4281,6 +4592,20 @@ module Aws::NetworkFirewall
|
|
4281
4592
|
include Aws::Structure
|
4282
4593
|
end
|
4283
4594
|
|
4595
|
+
# A unique source IP address that connected to a domain.
|
4596
|
+
#
|
4597
|
+
# @!attribute [rw] count
|
4598
|
+
# The number of unique source IP addresses that connected to a domain.
|
4599
|
+
# @return [Integer]
|
4600
|
+
#
|
4601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UniqueSources AWS API Documentation
|
4602
|
+
#
|
4603
|
+
class UniqueSources < Struct.new(
|
4604
|
+
:count)
|
4605
|
+
SENSITIVE = []
|
4606
|
+
include Aws::Structure
|
4607
|
+
end
|
4608
|
+
|
4284
4609
|
# The operation you requested isn't supported by Network Firewall.
|
4285
4610
|
#
|
4286
4611
|
# @!attribute [rw] message
|
@@ -4314,6 +4639,104 @@ module Aws::NetworkFirewall
|
|
4314
4639
|
#
|
4315
4640
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
4316
4641
|
|
4642
|
+
# @!attribute [rw] enabled_analysis_types
|
4643
|
+
# An optional setting indicating the specific traffic analysis types
|
4644
|
+
# to enable on the firewall.
|
4645
|
+
# @return [Array<String>]
|
4646
|
+
#
|
4647
|
+
# @!attribute [rw] firewall_arn
|
4648
|
+
# The Amazon Resource Name (ARN) of the firewall.
|
4649
|
+
#
|
4650
|
+
# You must specify the ARN or the name, and you can specify both.
|
4651
|
+
# @return [String]
|
4652
|
+
#
|
4653
|
+
# @!attribute [rw] firewall_name
|
4654
|
+
# The descriptive name of the firewall. You can't change the name of
|
4655
|
+
# a firewall after you create it.
|
4656
|
+
#
|
4657
|
+
# You must specify the ARN or the name, and you can specify both.
|
4658
|
+
# @return [String]
|
4659
|
+
#
|
4660
|
+
# @!attribute [rw] update_token
|
4661
|
+
# An optional token that you can use for optimistic locking. Network
|
4662
|
+
# Firewall returns a token to your requests that access the firewall.
|
4663
|
+
# The token marks the state of the firewall resource at the time of
|
4664
|
+
# the request.
|
4665
|
+
#
|
4666
|
+
# To make an unconditional change to the firewall, omit the token in
|
4667
|
+
# your update request. Without the token, Network Firewall performs
|
4668
|
+
# your updates regardless of whether the firewall has changed since
|
4669
|
+
# you last retrieved it.
|
4670
|
+
#
|
4671
|
+
# To make a conditional change to the firewall, provide the token in
|
4672
|
+
# your update request. Network Firewall uses the token to ensure that
|
4673
|
+
# the firewall hasn't changed since you last retrieved it. If it has
|
4674
|
+
# changed, the operation fails with an `InvalidTokenException`. If
|
4675
|
+
# this happens, retrieve the firewall again to get a current copy of
|
4676
|
+
# it with a new token. Reapply your changes as needed, then try the
|
4677
|
+
# operation again using the new token.
|
4678
|
+
# @return [String]
|
4679
|
+
#
|
4680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallAnalysisSettingsRequest AWS API Documentation
|
4681
|
+
#
|
4682
|
+
class UpdateFirewallAnalysisSettingsRequest < Struct.new(
|
4683
|
+
:enabled_analysis_types,
|
4684
|
+
:firewall_arn,
|
4685
|
+
:firewall_name,
|
4686
|
+
:update_token)
|
4687
|
+
SENSITIVE = []
|
4688
|
+
include Aws::Structure
|
4689
|
+
end
|
4690
|
+
|
4691
|
+
# @!attribute [rw] enabled_analysis_types
|
4692
|
+
# An optional setting indicating the specific traffic analysis types
|
4693
|
+
# to enable on the firewall.
|
4694
|
+
# @return [Array<String>]
|
4695
|
+
#
|
4696
|
+
# @!attribute [rw] firewall_arn
|
4697
|
+
# The Amazon Resource Name (ARN) of the firewall.
|
4698
|
+
#
|
4699
|
+
# You must specify the ARN or the name, and you can specify both.
|
4700
|
+
# @return [String]
|
4701
|
+
#
|
4702
|
+
# @!attribute [rw] firewall_name
|
4703
|
+
# The descriptive name of the firewall. You can't change the name of
|
4704
|
+
# a firewall after you create it.
|
4705
|
+
#
|
4706
|
+
# You must specify the ARN or the name, and you can specify both.
|
4707
|
+
# @return [String]
|
4708
|
+
#
|
4709
|
+
# @!attribute [rw] update_token
|
4710
|
+
# An optional token that you can use for optimistic locking. Network
|
4711
|
+
# Firewall returns a token to your requests that access the firewall.
|
4712
|
+
# The token marks the state of the firewall resource at the time of
|
4713
|
+
# the request.
|
4714
|
+
#
|
4715
|
+
# To make an unconditional change to the firewall, omit the token in
|
4716
|
+
# your update request. Without the token, Network Firewall performs
|
4717
|
+
# your updates regardless of whether the firewall has changed since
|
4718
|
+
# you last retrieved it.
|
4719
|
+
#
|
4720
|
+
# To make a conditional change to the firewall, provide the token in
|
4721
|
+
# your update request. Network Firewall uses the token to ensure that
|
4722
|
+
# the firewall hasn't changed since you last retrieved it. If it has
|
4723
|
+
# changed, the operation fails with an `InvalidTokenException`. If
|
4724
|
+
# this happens, retrieve the firewall again to get a current copy of
|
4725
|
+
# it with a new token. Reapply your changes as needed, then try the
|
4726
|
+
# operation again using the new token.
|
4727
|
+
# @return [String]
|
4728
|
+
#
|
4729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallAnalysisSettingsResponse AWS API Documentation
|
4730
|
+
#
|
4731
|
+
class UpdateFirewallAnalysisSettingsResponse < Struct.new(
|
4732
|
+
:enabled_analysis_types,
|
4733
|
+
:firewall_arn,
|
4734
|
+
:firewall_name,
|
4735
|
+
:update_token)
|
4736
|
+
SENSITIVE = []
|
4737
|
+
include Aws::Structure
|
4738
|
+
end
|
4739
|
+
|
4317
4740
|
# @!attribute [rw] update_token
|
4318
4741
|
# An optional token that you can use for optimistic locking. Network
|
4319
4742
|
# Firewall returns a token to your requests that access the firewall.
|
data/sig/client.rbs
CHANGED
@@ -124,8 +124,8 @@ module Aws
|
|
124
124
|
def create_firewall: (
|
125
125
|
firewall_name: ::String,
|
126
126
|
firewall_policy_arn: ::String,
|
127
|
-
vpc_id: ::String,
|
128
|
-
subnet_mappings: Array[
|
127
|
+
?vpc_id: ::String,
|
128
|
+
?subnet_mappings: Array[
|
129
129
|
{
|
130
130
|
subnet_id: ::String,
|
131
131
|
ip_address_type: ("DUALSTACK" | "IPV4" | "IPV6")?
|
@@ -144,7 +144,8 @@ module Aws
|
|
144
144
|
?encryption_configuration: {
|
145
145
|
key_id: ::String?,
|
146
146
|
type: ("CUSTOMER_KMS" | "AWS_OWNED_KMS_KEY")
|
147
|
-
}
|
147
|
+
},
|
148
|
+
?enabled_analysis_types: Array[("TLS_SNI" | "HTTP_HOST")]
|
148
149
|
) -> _CreateFirewallResponseSuccess
|
149
150
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateFirewallResponseSuccess
|
150
151
|
|
@@ -579,6 +580,40 @@ module Aws
|
|
579
580
|
) -> _DisassociateSubnetsResponseSuccess
|
580
581
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateSubnetsResponseSuccess
|
581
582
|
|
583
|
+
interface _GetAnalysisReportResultsResponseSuccess
|
584
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetAnalysisReportResultsResponse]
|
585
|
+
def status: () -> ::String
|
586
|
+
def start_time: () -> ::Time
|
587
|
+
def end_time: () -> ::Time
|
588
|
+
def report_time: () -> ::Time
|
589
|
+
def analysis_type: () -> ("TLS_SNI" | "HTTP_HOST")
|
590
|
+
def next_token: () -> ::String
|
591
|
+
def analysis_report_results: () -> ::Array[Types::AnalysisTypeReportResult]
|
592
|
+
end
|
593
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NetworkFirewall/Client.html#get_analysis_report_results-instance_method
|
594
|
+
def get_analysis_report_results: (
|
595
|
+
?firewall_name: ::String,
|
596
|
+
analysis_report_id: ::String,
|
597
|
+
?firewall_arn: ::String,
|
598
|
+
?next_token: ::String,
|
599
|
+
?max_results: ::Integer
|
600
|
+
) -> _GetAnalysisReportResultsResponseSuccess
|
601
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAnalysisReportResultsResponseSuccess
|
602
|
+
|
603
|
+
interface _ListAnalysisReportsResponseSuccess
|
604
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListAnalysisReportsResponse]
|
605
|
+
def analysis_reports: () -> ::Array[Types::AnalysisReport]
|
606
|
+
def next_token: () -> ::String
|
607
|
+
end
|
608
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NetworkFirewall/Client.html#list_analysis_reports-instance_method
|
609
|
+
def list_analysis_reports: (
|
610
|
+
?firewall_name: ::String,
|
611
|
+
?firewall_arn: ::String,
|
612
|
+
?next_token: ::String,
|
613
|
+
?max_results: ::Integer
|
614
|
+
) -> _ListAnalysisReportsResponseSuccess
|
615
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAnalysisReportsResponseSuccess
|
616
|
+
|
582
617
|
interface _ListFirewallPoliciesResponseSuccess
|
583
618
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListFirewallPoliciesResponse]
|
584
619
|
def next_token: () -> ::String
|
@@ -654,6 +689,18 @@ module Aws
|
|
654
689
|
) -> _PutResourcePolicyResponseSuccess
|
655
690
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutResourcePolicyResponseSuccess
|
656
691
|
|
692
|
+
interface _StartAnalysisReportResponseSuccess
|
693
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartAnalysisReportResponse]
|
694
|
+
def analysis_report_id: () -> ::String
|
695
|
+
end
|
696
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NetworkFirewall/Client.html#start_analysis_report-instance_method
|
697
|
+
def start_analysis_report: (
|
698
|
+
?firewall_name: ::String,
|
699
|
+
?firewall_arn: ::String,
|
700
|
+
analysis_type: ("TLS_SNI" | "HTTP_HOST")
|
701
|
+
) -> _StartAnalysisReportResponseSuccess
|
702
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartAnalysisReportResponseSuccess
|
703
|
+
|
657
704
|
interface _TagResourceResponseSuccess
|
658
705
|
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
659
706
|
end
|
@@ -679,6 +726,22 @@ module Aws
|
|
679
726
|
) -> _UntagResourceResponseSuccess
|
680
727
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
681
728
|
|
729
|
+
interface _UpdateFirewallAnalysisSettingsResponseSuccess
|
730
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateFirewallAnalysisSettingsResponse]
|
731
|
+
def enabled_analysis_types: () -> ::Array[("TLS_SNI" | "HTTP_HOST")]
|
732
|
+
def firewall_arn: () -> ::String
|
733
|
+
def firewall_name: () -> ::String
|
734
|
+
def update_token: () -> ::String
|
735
|
+
end
|
736
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NetworkFirewall/Client.html#update_firewall_analysis_settings-instance_method
|
737
|
+
def update_firewall_analysis_settings: (
|
738
|
+
?enabled_analysis_types: Array[("TLS_SNI" | "HTTP_HOST")],
|
739
|
+
?firewall_arn: ::String,
|
740
|
+
?firewall_name: ::String,
|
741
|
+
?update_token: ::String
|
742
|
+
) -> _UpdateFirewallAnalysisSettingsResponseSuccess
|
743
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateFirewallAnalysisSettingsResponseSuccess
|
744
|
+
|
682
745
|
interface _UpdateFirewallDeleteProtectionResponseSuccess
|
683
746
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateFirewallDeleteProtectionResponse]
|
684
747
|
def firewall_arn: () -> ::String
|