Class: Aws::NetworkFirewall::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::NetworkFirewall::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb
Overview
An API client for NetworkFirewall. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::NetworkFirewall::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_firewall_policy(params = {}) ⇒ Types::AssociateFirewallPolicyResponse
Associates a FirewallPolicy to a Firewall.
-
#associate_subnets(params = {}) ⇒ Types::AssociateSubnetsResponse
Associates the specified subnets in the Amazon VPC to the firewall.
-
#create_firewall(params = {}) ⇒ Types::CreateFirewallResponse
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
-
#create_firewall_policy(params = {}) ⇒ Types::CreateFirewallPolicyResponse
Creates the firewall policy for the firewall according to the specifications.
-
#create_rule_group(params = {}) ⇒ Types::CreateRuleGroupResponse
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
-
#create_tls_inspection_configuration(params = {}) ⇒ Types::CreateTLSInspectionConfigurationResponse
Creates an Network Firewall TLS inspection configuration.
-
#delete_firewall(params = {}) ⇒ Types::DeleteFirewallResponse
Deletes the specified Firewall and its FirewallStatus.
-
#delete_firewall_policy(params = {}) ⇒ Types::DeleteFirewallPolicyResponse
Deletes the specified FirewallPolicy.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource policy that you created in a PutResourcePolicy request.
-
#delete_rule_group(params = {}) ⇒ Types::DeleteRuleGroupResponse
Deletes the specified RuleGroup.
-
#delete_tls_inspection_configuration(params = {}) ⇒ Types::DeleteTLSInspectionConfigurationResponse
Deletes the specified TLSInspectionConfiguration.
-
#describe_firewall(params = {}) ⇒ Types::DescribeFirewallResponse
Returns the data objects for the specified firewall.
-
#describe_firewall_policy(params = {}) ⇒ Types::DescribeFirewallPolicyResponse
Returns the data objects for the specified firewall policy.
-
#describe_flow_operation(params = {}) ⇒ Types::DescribeFlowOperationResponse
Returns key information about a specific flow operation.
-
#describe_logging_configuration(params = {}) ⇒ Types::DescribeLoggingConfigurationResponse
Returns the logging configuration for the specified firewall.
-
#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse
Retrieves a resource policy that you created in a PutResourcePolicy request.
-
#describe_rule_group(params = {}) ⇒ Types::DescribeRuleGroupResponse
Returns the data objects for the specified rule group.
-
#describe_rule_group_metadata(params = {}) ⇒ Types::DescribeRuleGroupMetadataResponse
High-level information about a rule group, returned by operations like create and describe.
-
#describe_tls_inspection_configuration(params = {}) ⇒ Types::DescribeTLSInspectionConfigurationResponse
Returns the data objects for the specified TLS inspection configuration.
-
#disassociate_subnets(params = {}) ⇒ Types::DisassociateSubnetsResponse
Removes the specified subnet associations from the firewall.
-
#get_analysis_report_results(params = {}) ⇒ Types::GetAnalysisReportResultsResponse
The results of a
COMPLETED
analysis report generated with StartAnalysisReport. -
#list_analysis_reports(params = {}) ⇒ Types::ListAnalysisReportsResponse
Returns a list of all traffic analysis reports generated within the last 30 days.
-
#list_firewall_policies(params = {}) ⇒ Types::ListFirewallPoliciesResponse
Retrieves the metadata for the firewall policies that you have defined.
-
#list_firewalls(params = {}) ⇒ Types::ListFirewallsResponse
Retrieves the metadata for the firewalls that you have defined.
-
#list_flow_operation_results(params = {}) ⇒ Types::ListFlowOperationResultsResponse
Returns the results of a specific flow operation.
-
#list_flow_operations(params = {}) ⇒ Types::ListFlowOperationsResponse
Returns a list of all flow operations ran in a specific firewall.
-
#list_rule_groups(params = {}) ⇒ Types::ListRuleGroupsResponse
Retrieves the metadata for the rule groups that you have defined.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the tags associated with the specified resource.
-
#list_tls_inspection_configurations(params = {}) ⇒ Types::ListTLSInspectionConfigurationsResponse
Retrieves the metadata for the TLS inspection configurations that you have defined.
-
#put_resource_policy(params = {}) ⇒ Struct
Creates or updates an IAM policy for your rule group or firewall policy.
-
#start_analysis_report(params = {}) ⇒ Types::StartAnalysisReportResponse
Generates a traffic analysis report for the timeframe and traffic type you specify.
-
#start_flow_capture(params = {}) ⇒ Types::StartFlowCaptureResponse
Begins capturing the flows in a firewall, according to the filters you define.
-
#start_flow_flush(params = {}) ⇒ Types::StartFlowFlushResponse
Begins the flushing of traffic from the firewall, according to the filters you define.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the tags with the specified keys from the specified resource.
-
#update_firewall_analysis_settings(params = {}) ⇒ Types::UpdateFirewallAnalysisSettingsResponse
Enables specific types of firewall analysis on a specific firewall you define.
-
#update_firewall_delete_protection(params = {}) ⇒ Types::UpdateFirewallDeleteProtectionResponse
Modifies the flag,
DeleteProtection
, which indicates whether it is possible to delete the firewall. -
#update_firewall_description(params = {}) ⇒ Types::UpdateFirewallDescriptionResponse
Modifies the description for the specified firewall.
-
#update_firewall_encryption_configuration(params = {}) ⇒ Types::UpdateFirewallEncryptionConfigurationResponse
A complex type that contains settings for encryption of your firewall resources.
-
#update_firewall_policy(params = {}) ⇒ Types::UpdateFirewallPolicyResponse
Updates the properties of the specified firewall policy.
-
#update_firewall_policy_change_protection(params = {}) ⇒ Types::UpdateFirewallPolicyChangeProtectionResponse
Modifies the flag,
ChangeProtection
, which indicates whether it is possible to change the firewall. -
#update_logging_configuration(params = {}) ⇒ Types::UpdateLoggingConfigurationResponse
Sets the logging configuration for the specified firewall.
-
#update_rule_group(params = {}) ⇒ Types::UpdateRuleGroupResponse
Updates the rule settings for the specified rule group.
-
#update_subnet_change_protection(params = {}) ⇒ Types::UpdateSubnetChangeProtectionResponse
Returns a response object which responds to the following methods:.
-
#update_tls_inspection_configuration(params = {}) ⇒ Types::UpdateTLSInspectionConfigurationResponse
Updates the TLS inspection configuration settings for the specified TLS inspection configuration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#associate_firewall_policy(params = {}) ⇒ Types::AssociateFirewallPolicyResponse
Associates a FirewallPolicy to a Firewall.
A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
546 547 548 549 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 546 def associate_firewall_policy(params = {}, = {}) req = build_request(:associate_firewall_policy, params) req.send_request() end |
#associate_subnets(params = {}) ⇒ Types::AssociateSubnetsResponse
Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.
This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.
628 629 630 631 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 628 def associate_subnets(params = {}, = {}) req = build_request(:associate_subnets, params) req.send_request() end |
#create_firewall(params = {}) ⇒ Types::CreateFirewallResponse
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation 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.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
To generate a report on the last 30 days of traffic monitored by a firewall, use StartAnalysisReport.
788 789 790 791 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 788 def create_firewall(params = {}, = {}) req = build_request(:create_firewall, params) req.send_request() end |
#create_firewall_policy(params = {}) ⇒ Types::CreateFirewallPolicyResponse
Creates the firewall policy for the firewall according to the specifications.
An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
927 928 929 930 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 927 def create_firewall_policy(params = {}, = {}) req = build_request(:create_firewall_policy, params) req.send_request() end |
#create_rule_group(params = {}) ⇒ Types::CreateRuleGroupResponse
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
You provide your rule group specification in your request using either
RuleGroup
or Rules
.
1224 1225 1226 1227 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1224 def create_rule_group(params = {}, = {}) req = build_request(:create_rule_group, params) req.send_request() end |
#create_tls_inspection_configuration(params = {}) ⇒ Types::CreateTLSInspectionConfigurationResponse
Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.
To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.
To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.
For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1402 def create_tls_inspection_configuration(params = {}, = {}) req = build_request(:create_tls_inspection_configuration, params) req.send_request() end |
#delete_firewall(params = {}) ⇒ Types::DeleteFirewallResponse
Deletes the specified Firewall and its FirewallStatus. This operation
requires the firewall's DeleteProtection
flag to be FALSE
. You
can't revert this operation.
You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.
To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.
1486 1487 1488 1489 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1486 def delete_firewall(params = {}, = {}) req = build_request(:delete_firewall, params) req.send_request() end |
#delete_firewall_policy(params = {}) ⇒ Types::DeleteFirewallPolicyResponse
Deletes the specified FirewallPolicy.
1536 1537 1538 1539 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1536 def delete_firewall_policy(params = {}, = {}) req = build_request(:delete_firewall_policy, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource policy that you created in a PutResourcePolicy request.
1560 1561 1562 1563 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1560 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#delete_rule_group(params = {}) ⇒ Types::DeleteRuleGroupResponse
Deletes the specified RuleGroup.
1630 1631 1632 1633 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1630 def delete_rule_group(params = {}, = {}) req = build_request(:delete_rule_group, params) req.send_request() end |
#delete_tls_inspection_configuration(params = {}) ⇒ Types::DeleteTLSInspectionConfigurationResponse
Deletes the specified TLSInspectionConfiguration.
1687 1688 1689 1690 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1687 def delete_tls_inspection_configuration(params = {}, = {}) req = build_request(:delete_tls_inspection_configuration, params) req.send_request() end |
#describe_firewall(params = {}) ⇒ Types::DescribeFirewallResponse
Returns the data objects for the specified firewall.
1759 1760 1761 1762 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1759 def describe_firewall(params = {}, = {}) req = build_request(:describe_firewall, params) req.send_request() end |
#describe_firewall_policy(params = {}) ⇒ Types::DescribeFirewallPolicyResponse
Returns the data objects for the specified firewall policy.
1836 1837 1838 1839 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1836 def describe_firewall_policy(params = {}, = {}) req = build_request(:describe_firewall_policy, params) req.send_request() end |
#describe_flow_operation(params = {}) ⇒ Types::DescribeFlowOperationResponse
Returns key information about a specific flow operation.
1899 1900 1901 1902 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1899 def describe_flow_operation(params = {}, = {}) req = build_request(:describe_flow_operation, params) req.send_request() end |
#describe_logging_configuration(params = {}) ⇒ Types::DescribeLoggingConfigurationResponse
Returns the logging configuration for the specified firewall.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1942 def describe_logging_configuration(params = {}, = {}) req = build_request(:describe_logging_configuration, params) req.send_request() end |
#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse
Retrieves a resource policy that you created in a PutResourcePolicy request.
1972 1973 1974 1975 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1972 def describe_resource_policy(params = {}, = {}) req = build_request(:describe_resource_policy, params) req.send_request() end |
#describe_rule_group(params = {}) ⇒ Types::DescribeRuleGroupResponse
Returns the data objects for the specified rule group.
2103 2104 2105 2106 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2103 def describe_rule_group(params = {}, = {}) req = build_request(:describe_rule_group, params) req.send_request() end |
#describe_rule_group_metadata(params = {}) ⇒ Types::DescribeRuleGroupMetadataResponse
High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
2167 2168 2169 2170 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2167 def (params = {}, = {}) req = build_request(:describe_rule_group_metadata, params) req.send_request() end |
#describe_tls_inspection_configuration(params = {}) ⇒ Types::DescribeTLSInspectionConfigurationResponse
Returns the data objects for the specified TLS inspection configuration.
2247 2248 2249 2250 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2247 def describe_tls_inspection_configuration(params = {}, = {}) req = build_request(:describe_tls_inspection_configuration, params) req.send_request() end |
#disassociate_subnets(params = {}) ⇒ Types::DisassociateSubnetsResponse
Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.
2318 2319 2320 2321 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2318 def disassociate_subnets(params = {}, = {}) req = build_request(:disassociate_subnets, params) req.send_request() end |
#get_analysis_report_results(params = {}) ⇒ Types::GetAnalysisReportResultsResponse
The results of a COMPLETED
analysis report generated with
StartAnalysisReport.
For more information, see AnalysisTypeReportResult.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2398 def get_analysis_report_results(params = {}, = {}) req = build_request(:get_analysis_report_results, params) req.send_request() end |
#list_analysis_reports(params = {}) ⇒ Types::ListAnalysisReportsResponse
Returns a list of all traffic analysis reports generated within the last 30 days.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2459 2460 2461 2462 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2459 def list_analysis_reports(params = {}, = {}) req = build_request(:list_analysis_reports, params) req.send_request() end |
#list_firewall_policies(params = {}) ⇒ Types::ListFirewallPoliciesResponse
Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2506 2507 2508 2509 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2506 def list_firewall_policies(params = {}, = {}) req = build_request(:list_firewall_policies, params) req.send_request() end |
#list_firewalls(params = {}) ⇒ Types::ListFirewallsResponse
Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.
Depending on your setting for max results and the number of firewalls, a single call might not return the full list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2562 2563 2564 2565 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2562 def list_firewalls(params = {}, = {}) req = build_request(:list_firewalls, params) req.send_request() end |
#list_flow_operation_results(params = {}) ⇒ Types::ListFlowOperationResultsResponse
Returns the results of a specific flow operation.
Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2651 2652 2653 2654 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2651 def list_flow_operation_results(params = {}, = {}) req = build_request(:list_flow_operation_results, params) req.send_request() end |
#list_flow_operations(params = {}) ⇒ Types::ListFlowOperationsResponse
Returns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations.
Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2726 2727 2728 2729 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2726 def list_flow_operations(params = {}, = {}) req = build_request(:list_flow_operations, params) req.send_request() end |
#list_rule_groups(params = {}) ⇒ Types::ListRuleGroupsResponse
Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2790 2791 2792 2793 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2790 def list_rule_groups(params = {}, = {}) req = build_request(:list_rule_groups, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2895 2896 2897 2898 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2895 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_tls_inspection_configurations(params = {}) ⇒ Types::ListTLSInspectionConfigurationsResponse
Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2838 2839 2840 2841 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2838 def list_tls_inspection_configurations(params = {}, = {}) req = build_request(:list_tls_inspection_configurations, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Struct
Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.
When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
2972 2973 2974 2975 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2972 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#start_analysis_report(params = {}) ⇒ Types::StartAnalysisReportResponse
Generates a traffic analysis report for the timeframe and traffic type you specify.
For information on the contents of a traffic analysis report, see AnalysisReport.
3017 3018 3019 3020 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3017 def start_analysis_report(params = {}, = {}) req = build_request(:start_analysis_report, params) req.send_request() end |
#start_flow_capture(params = {}) ⇒ Types::StartFlowCaptureResponse
Begins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
FlowFilters
, like
narrow IP ranges, ports, or protocols.
3101 3102 3103 3104 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3101 def start_flow_capture(params = {}, = {}) req = build_request(:start_flow_capture, params) req.send_request() end |
#start_flow_flush(params = {}) ⇒ Types::StartFlowFlushResponse
Begins the flushing of traffic from the firewall, according to the filters you define. When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes, or flushes, the flows from the firewall table.
While the flush completes, impacted flows are processed as midstream traffic. This may result in a temporary increase in midstream traffic metrics. We recommend that you double check your stream exception policy before you perform a flush operation.
3172 3173 3174 3175 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3172 def start_flow_flush(params = {}, = {}) req = build_request(:start_flow_flush, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
3210 3211 3212 3213 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3210 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
3244 3245 3246 3247 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3244 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_firewall_analysis_settings(params = {}) ⇒ Types::UpdateFirewallAnalysisSettingsResponse
Enables specific types of firewall analysis on a specific firewall you define.
3314 3315 3316 3317 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3314 def update_firewall_analysis_settings(params = {}, = {}) req = build_request(:update_firewall_analysis_settings, params) req.send_request() end |
#update_firewall_delete_protection(params = {}) ⇒ Types::UpdateFirewallDeleteProtectionResponse
Modifies the flag, DeleteProtection
, which indicates whether it is
possible to delete the firewall. If the flag is set to TRUE
, the
firewall is protected against deletion. This setting helps protect
against accidentally deleting a firewall that's in use.
3388 3389 3390 3391 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3388 def update_firewall_delete_protection(params = {}, = {}) req = build_request(:update_firewall_delete_protection, params) req.send_request() end |
#update_firewall_description(params = {}) ⇒ Types::UpdateFirewallDescriptionResponse
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
3458 3459 3460 3461 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3458 def update_firewall_description(params = {}, = {}) req = build_request(:update_firewall_description, params) req.send_request() end |
#update_firewall_encryption_configuration(params = {}) ⇒ Types::UpdateFirewallEncryptionConfigurationResponse
A complex type that contains settings for encryption of your firewall resources.
3538 3539 3540 3541 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3538 def update_firewall_encryption_configuration(params = {}, = {}) req = build_request(:update_firewall_encryption_configuration, params) req.send_request() end |
#update_firewall_policy(params = {}) ⇒ Types::UpdateFirewallPolicyResponse
Updates the properties of the specified firewall policy.
3687 3688 3689 3690 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3687 def update_firewall_policy(params = {}, = {}) req = build_request(:update_firewall_policy, params) req.send_request() end |
#update_firewall_policy_change_protection(params = {}) ⇒ Types::UpdateFirewallPolicyChangeProtectionResponse
Modifies the flag, ChangeProtection
, which indicates whether it is
possible to change the firewall. If the flag is set to TRUE
, the
firewall is protected from changes. This setting helps protect against
accidentally changing a firewall that's in use.
3761 3762 3763 3764 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3761 def update_firewall_policy_change_protection(params = {}, = {}) req = build_request(:update_firewall_policy_change_protection, params) req.send_request() end |
#update_logging_configuration(params = {}) ⇒ Types::UpdateLoggingConfigurationResponse
Sets the logging configuration for the specified firewall.
To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.
You can perform only one of the following actions in any call to
UpdateLoggingConfiguration
:
Create a new log destination object by adding a single
LogDestinationConfig
array element toLogDestinationConfigs
.Delete a log destination object by removing a single
LogDestinationConfig
array element fromLogDestinationConfigs
.Change the
LogDestination
setting in a singleLogDestinationConfig
array element.
You can't change the LogDestinationType
or LogType
in a
LogDestinationConfig
. To change these settings, delete the existing
LogDestinationConfig
object and create a new one, using two separate
calls to this update operation.
3844 3845 3846 3847 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3844 def update_logging_configuration(params = {}, = {}) req = build_request(:update_logging_configuration, params) req.send_request() end |
#update_rule_group(params = {}) ⇒ Types::UpdateRuleGroupResponse
Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.
To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.
4111 4112 4113 4114 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4111 def update_rule_group(params = {}, = {}) req = build_request(:update_rule_group, params) req.send_request() end |
#update_subnet_change_protection(params = {}) ⇒ Types::UpdateSubnetChangeProtectionResponse
Returns a response object which responds to the following methods:
- #update_token => String
- #firewall_arn => String
- #firewall_name => String
- #subnet_change_protection => Boolean
4180 4181 4182 4183 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4180 def update_subnet_change_protection(params = {}, = {}) req = build_request(:update_subnet_change_protection, params) req.send_request() end |
#update_tls_inspection_configuration(params = {}) ⇒ Types::UpdateTLSInspectionConfigurationResponse
Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.
To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then provide the updated object to this call.
4339 4340 4341 4342 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4339 def update_tls_inspection_configuration(params = {}, = {}) req = build_request(:update_tls_inspection_configuration, params) req.send_request() end |