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
-
#accept_network_firewall_transit_gateway_attachment(params = {}) ⇒ Types::AcceptNetworkFirewallTransitGatewayAttachmentResponse
Accepts a transit gateway attachment request for Network Firewall.
-
#associate_availability_zones(params = {}) ⇒ Types::AssociateAvailabilityZonesResponse
Associates the specified Availability Zones with a transit gateway-attached firewall.
-
#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_container_association(params = {}) ⇒ Types::CreateContainerAssociationResponse
Creates a Network Firewall container association.
-
#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_firewall_policy_v2(params = {}) ⇒ Types::CreateFirewallPolicyV2Response
Creates a Next Generation policy 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.
-
#create_vpc_endpoint_association(params = {}) ⇒ Types::CreateVpcEndpointAssociationResponse
Creates a firewall endpoint for an Network Firewall firewall.
-
#delete_container_association(params = {}) ⇒ Types::DeleteContainerAssociationResponse
Deletes a container association.
-
#delete_firewall(params = {}) ⇒ Types::DeleteFirewallResponse
Deletes the specified Firewall and its FirewallStatus.
-
#delete_firewall_policy(params = {}) ⇒ Types::DeleteFirewallPolicyResponse
Deletes the specified FirewallPolicy.
-
#delete_firewall_policy_v2(params = {}) ⇒ Types::DeleteFirewallPolicyV2Response
Deletes the specified FirewallPolicyV2.
-
#delete_network_firewall_transit_gateway_attachment(params = {}) ⇒ Types::DeleteNetworkFirewallTransitGatewayAttachmentResponse
Deletes a transit gateway attachment from a Network Firewall.
-
#delete_proxy(params = {}) ⇒ Types::DeleteProxyResponse
Deletes the specified proxy.
-
#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.
-
#delete_vpc_endpoint_association(params = {}) ⇒ Types::DeleteVpcEndpointAssociationResponse
Deletes the specified VpcEndpointAssociation.
-
#describe_container_association(params = {}) ⇒ Types::DescribeContainerAssociationResponse
Retrieves the configuration and status of a container association.
-
#describe_firewall(params = {}) ⇒ Types::DescribeFirewallResponse
Returns the data objects for the specified firewall.
-
#describe_firewall_metadata(params = {}) ⇒ Types::DescribeFirewallMetadataResponse
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
-
#describe_firewall_policy(params = {}) ⇒ Types::DescribeFirewallPolicyResponse
Returns the data objects for the specified firewall policy.
-
#describe_firewall_policy_v2(params = {}) ⇒ Types::DescribeFirewallPolicyV2Response
Returns the data objects for the specified Next Generation 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_proxy(params = {}) ⇒ Types::DescribeProxyResponse
Returns the data objects for the specified proxy.
-
#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_rule_group_summary(params = {}) ⇒ Types::DescribeRuleGroupSummaryResponse
Returns detailed information for a stateful rule group.
-
#describe_tls_inspection_configuration(params = {}) ⇒ Types::DescribeTLSInspectionConfigurationResponse
Returns the data objects for the specified TLS inspection configuration.
-
#describe_vpc_endpoint_association(params = {}) ⇒ Types::DescribeVpcEndpointAssociationResponse
Returns the data object for the specified VPC endpoint association.
-
#disassociate_availability_zones(params = {}) ⇒ Types::DisassociateAvailabilityZonesResponse
Removes the specified Availability Zone associations from a transit gateway-attached firewall.
-
#disassociate_subnets(params = {}) ⇒ Types::DisassociateSubnetsResponse
Removes the specified subnet associations from the firewall.
-
#get_analysis_report_results(params = {}) ⇒ Types::GetAnalysisReportResultsResponse
The results of a
COMPLETEDanalysis 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_container_associations(params = {}) ⇒ Types::ListContainerAssociationsResponse
Lists the container associations in your account and Region.
-
#list_context_stores(params = {}) ⇒ Types::ListContextStoresResponse
Lists the active context stores that are associated with your firewalls.
-
#list_firewall_policies(params = {}) ⇒ Types::ListFirewallPoliciesResponse
Retrieves the metadata for the firewall policies that you have defined.
-
#list_firewall_policies_v2(params = {}) ⇒ Types::ListFirewallPoliciesV2Response
Retrieves the metadata for the Next Generation 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_resources_in_context_store(params = {}) ⇒ Types::ListResourcesInContextStoreResponse
Lists the resources that a context store records.
-
#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.
-
#list_vpc_endpoint_associations(params = {}) ⇒ Types::ListVpcEndpointAssociationsResponse
Retrieves the metadata for the VPC endpoint associations that you have defined.
-
#put_resource_policy(params = {}) ⇒ Struct
Creates or updates an IAM policy for your rule group, firewall policy, or firewall.
-
#reject_network_firewall_transit_gateway_attachment(params = {}) ⇒ Types::RejectNetworkFirewallTransitGatewayAttachmentResponse
Rejects a transit gateway attachment request for Network Firewall.
-
#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_availability_zone_change_protection(params = {}) ⇒ Types::UpdateAvailabilityZoneChangeProtectionResponse
Modifies the
AvailabilityZoneChangeProtectionsetting for a transit gateway-attached firewall. -
#update_container_association(params = {}) ⇒ Types::UpdateContainerAssociationResponse
Updates the monitoring configurations and description of a container association.
-
#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_firewall_policy_v2(params = {}) ⇒ Types::UpdateFirewallPolicyV2Response
Updates the properties of the specified Next Generation policy.
-
#update_logging_configuration(params = {}) ⇒ Types::UpdateLoggingConfigurationResponse
Sets the logging configuration for the specified firewall.
-
#update_proxy_settings(params = {}) ⇒ Types::UpdateProxySettingsResponse
Modifies the proxy settings of a proxy mode 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.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
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.
486 487 488 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#accept_network_firewall_transit_gateway_attachment(params = {}) ⇒ Types::AcceptNetworkFirewallTransitGatewayAttachmentResponse
Accepts a transit gateway attachment request for Network Firewall. When you accept the attachment request, Network Firewall creates the necessary routing components to enable traffic flow between the transit gateway and firewall endpoints.
You must accept a transit gateway attachment to complete the creation of a transit gateway-attached firewall, unless auto-accept is enabled on the transit gateway. After acceptance, use DescribeFirewall to verify the firewall status.
To reject an attachment instead of accepting it, use RejectNetworkFirewallTransitGatewayAttachment.
535 536 537 538 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 535 def (params = {}, = {}) req = build_request(:accept_network_firewall_transit_gateway_attachment, params) req.send_request() end |
#associate_availability_zones(params = {}) ⇒ Types::AssociateAvailabilityZonesResponse
Associates the specified Availability Zones with a transit gateway-attached firewall. For each Availability Zone, Network Firewall creates a firewall endpoint to process traffic. You can specify one or more Availability Zones where you want to deploy the firewall.
After adding Availability Zones, you must update your transit gateway route tables to direct traffic through the new firewall endpoints. Use DescribeFirewall to monitor the status of the new endpoints.
616 617 618 619 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 616 def associate_availability_zones(params = {}, = {}) req = build_request(:associate_availability_zones, params) req.send_request() end |
#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.
688 689 690 691 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 688 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.
For a proxy mode firewall, use this operation to add Availability
Zones to the firewall. For each subnet, specify a NAT gateway in
NatGatewayCreateMappings in the same Availability Zone. You can't
add an Availability Zone that the firewall already uses. The firewall
keeps working in its other Availability Zones while Network Firewall
sets up the new one. If Network Firewall can't set up the new
Availability Zone, it removes the Availability Zone from the firewall.
It also deletes the NAT gateway that it created there. The
Availability Zone's Attachment status shows the reason. You can
then add the Availability Zone again.
799 800 801 802 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 799 def associate_subnets(params = {}, = {}) req = build_request(:associate_subnets, params) req.send_request() end |
#create_container_association(params = {}) ⇒ Types::CreateContainerAssociationResponse
Creates a Network Firewall container association. The association monitors container lifecycle events in your Amazon ECS or Amazon EKS clusters and resolves running container addresses for use in firewall rules.
889 890 891 892 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 889 def create_container_association(params = {}, = {}) req = build_request(:create_container_association, 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.
To create a proxy mode firewall, specify VpcEndpoint and
NatGatewayCreateMappings instead of VpcId and SubnetMappings. A
proxy mode firewall is an explicit forward proxy. Your clients send
HTTP and HTTPS proxy requests to the firewall's proxy DNS name, which
DescribeFirewall returns in each Availability Zone's Attachment.
The firewall evaluates proxy traffic with the stateful rules in its
firewall policy, and sends allowed traffic out through the NAT gateway
in the same Availability Zone. Your clients don't need route table
changes. In each Availability Zone, the firewall has one endpoint and
one NAT gateway, which Network Firewall creates for you.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1223 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.
1385 1386 1387 1388 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1385 def create_firewall_policy(params = {}, = {}) req = build_request(:create_firewall_policy, params) req.send_request() end |
#create_firewall_policy_v2(params = {}) ⇒ Types::CreateFirewallPolicyV2Response
Creates a Next Generation policy according to the specifications.
A Next Generation policy defines the behavior of a firewall in a collection of firewall engine and IPS engine rule groups and other settings. You can use one firewall policy for multiple firewalls. For more information, see Next Generation policies in the Network Firewall Developer Guide.
1621 1622 1623 1624 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1621 def create_firewall_policy_v2(params = {}, = {}) req = build_request(:create_firewall_policy_v2, 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.
2044 2045 2046 2047 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2044 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.
2228 2229 2230 2231 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2228 def create_tls_inspection_configuration(params = {}, = {}) req = build_request(:create_tls_inspection_configuration, params) req.send_request() end |
#create_vpc_endpoint_association(params = {}) ⇒ Types::CreateVpcEndpointAssociationResponse
Creates a firewall endpoint for an Network Firewall firewall. This
type of firewall endpoint is independent of the firewall endpoints
that you specify in the Firewall itself, and you define it in
addition to those endpoints after the firewall has been created. You
can define a VPC endpoint association using a different VPC than the
one you used in the firewall specifications.
2307 2308 2309 2310 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2307 def create_vpc_endpoint_association(params = {}, = {}) req = build_request(:create_vpc_endpoint_association, params) req.send_request() end |
#delete_container_association(params = {}) ⇒ Types::DeleteContainerAssociationResponse
Deletes a container association. The resource transitions to a
DELETING state. Deletion is asynchronous - Network Firewall returns
immediately while cleanup proceeds in the background. You can't
delete a container association while a rule group references it.
2350 2351 2352 2353 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2350 def delete_container_association(params = {}, = {}) req = build_request(:delete_container_association, 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.
Deleting a proxy mode firewall detaches its NAT gateways. To also
delete the NAT gateways that Network Firewall created for the
firewall, specify DeleteAssociatedNatGateways.
2489 2490 2491 2492 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2489 def delete_firewall(params = {}, = {}) req = build_request(:delete_firewall, params) req.send_request() end |
#delete_firewall_policy(params = {}) ⇒ Types::DeleteFirewallPolicyResponse
Deletes the specified FirewallPolicy.
2545 2546 2547 2548 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2545 def delete_firewall_policy(params = {}, = {}) req = build_request(:delete_firewall_policy, params) req.send_request() end |
#delete_firewall_policy_v2(params = {}) ⇒ Types::DeleteFirewallPolicyV2Response
Deletes the specified FirewallPolicyV2.
2601 2602 2603 2604 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2601 def delete_firewall_policy_v2(params = {}, = {}) req = build_request(:delete_firewall_policy_v2, params) req.send_request() end |
#delete_network_firewall_transit_gateway_attachment(params = {}) ⇒ Types::DeleteNetworkFirewallTransitGatewayAttachmentResponse
Deletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment.
After you delete a transit gateway attachment, traffic will no longer flow through the firewall endpoints.
After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.
2640 2641 2642 2643 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2640 def (params = {}, = {}) req = build_request(:delete_network_firewall_transit_gateway_attachment, params) req.send_request() end |
#delete_proxy(params = {}) ⇒ Types::DeleteProxyResponse
Deletes the specified proxy.
Detaches a Proxy configuration from a NAT Gateway.
2687 2688 2689 2690 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2687 def delete_proxy(params = {}, = {}) req = build_request(:delete_proxy, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource policy that you created in a PutResourcePolicy request.
2711 2712 2713 2714 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2711 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.
2792 2793 2794 2795 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2792 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.
2849 2850 2851 2852 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2849 def delete_tls_inspection_configuration(params = {}, = {}) req = build_request(:delete_tls_inspection_configuration, params) req.send_request() end |
#delete_vpc_endpoint_association(params = {}) ⇒ Types::DeleteVpcEndpointAssociationResponse
Deletes the specified VpcEndpointAssociation.
You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation. You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewall endpoint, you can remove the endpoint association safely.
2903 2904 2905 2906 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2903 def delete_vpc_endpoint_association(params = {}, = {}) req = build_request(:delete_vpc_endpoint_association, params) req.send_request() end |
#describe_container_association(params = {}) ⇒ Types::DescribeContainerAssociationResponse
Retrieves the configuration and status of a container association.
2963 2964 2965 2966 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2963 def describe_container_association(params = {}, = {}) req = build_request(:describe_container_association, params) req.send_request() end |
#describe_firewall(params = {}) ⇒ Types::DescribeFirewallResponse
Returns the data objects for the specified firewall.
3070 3071 3072 3073 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3070 def describe_firewall(params = {}, = {}) req = build_request(:describe_firewall, params) req.send_request() end |
#describe_firewall_metadata(params = {}) ⇒ Types::DescribeFirewallMetadataResponse
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
3110 3111 3112 3113 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3110 def (params = {}, = {}) req = build_request(:describe_firewall_metadata, params) req.send_request() end |
#describe_firewall_policy(params = {}) ⇒ Types::DescribeFirewallPolicyResponse
Returns the data objects for the specified firewall policy.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- firewall_policy_active
3207 3208 3209 3210 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3207 def describe_firewall_policy(params = {}, = {}) req = build_request(:describe_firewall_policy, params) req.send_request() end |
#describe_firewall_policy_v2(params = {}) ⇒ Types::DescribeFirewallPolicyV2Response
Returns the data objects for the specified Next Generation policy.
3343 3344 3345 3346 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3343 def describe_firewall_policy_v2(params = {}, = {}) req = build_request(:describe_firewall_policy_v2, params) req.send_request() end |
#describe_flow_operation(params = {}) ⇒ Types::DescribeFlowOperationResponse
Returns key information about a specific flow operation.
3430 3431 3432 3433 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3430 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.
3475 3476 3477 3478 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3475 def describe_logging_configuration(params = {}, = {}) req = build_request(:describe_logging_configuration, params) req.send_request() end |
#describe_proxy(params = {}) ⇒ Types::DescribeProxyResponse
Returns the data objects for the specified proxy.
3535 3536 3537 3538 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3535 def describe_proxy(params = {}, = {}) req = build_request(:describe_proxy, params) req.send_request() end |
#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse
Retrieves a resource policy that you created in a PutResourcePolicy request.
3565 3566 3567 3568 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3565 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.
3775 3776 3777 3778 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3775 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.
3854 3855 3856 3857 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3854 def (params = {}, = {}) req = build_request(:describe_rule_group_metadata, params) req.send_request() end |
#describe_rule_group_summary(params = {}) ⇒ Types::DescribeRuleGroupSummaryResponse
Returns detailed information for a stateful rule group.
For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.
To modify how threat information appears in summaries, use the
SummaryConfiguration parameter in UpdateRuleGroup.
3917 3918 3919 3920 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3917 def describe_rule_group_summary(params = {}, = {}) req = build_request(:describe_rule_group_summary, params) req.send_request() end |
#describe_tls_inspection_configuration(params = {}) ⇒ Types::DescribeTLSInspectionConfigurationResponse
Returns the data objects for the specified TLS inspection configuration.
4002 4003 4004 4005 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4002 def describe_tls_inspection_configuration(params = {}, = {}) req = build_request(:describe_tls_inspection_configuration, params) req.send_request() end |
#describe_vpc_endpoint_association(params = {}) ⇒ Types::DescribeVpcEndpointAssociationResponse
Returns the data object for the specified VPC endpoint association.
4047 4048 4049 4050 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4047 def describe_vpc_endpoint_association(params = {}, = {}) req = build_request(:describe_vpc_endpoint_association, params) req.send_request() end |
#disassociate_availability_zones(params = {}) ⇒ Types::DisassociateAvailabilityZonesResponse
Removes the specified Availability Zone associations from a transit gateway-attached firewall. This removes the firewall endpoints from these Availability Zones and stops traffic filtering in those zones. Before removing an Availability Zone, ensure you've updated your transit gateway route tables to redirect traffic appropriately.
AvailabilityZoneChangeProtection is enabled, you must first
disable it using UpdateAvailabilityZoneChangeProtection.
To verify the status of your Availability Zone changes, use DescribeFirewall.
4132 4133 4134 4135 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4132 def disassociate_availability_zones(params = {}, = {}) req = build_request(:disassociate_availability_zones, 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.
For a proxy mode firewall, this also removes the firewall's proxy DNS record in the Availability Zone and detaches the Availability Zone's NAT gateway from the firewall. Network Firewall keeps the NAT gateway. You can't remove the firewall's last Availability Zone. To do that, delete the firewall. If a VPC endpoint association exists in the Availability Zone, delete it first.
4210 4211 4212 4213 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4210 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.
4290 4291 4292 4293 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4290 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.
4351 4352 4353 4354 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4351 def list_analysis_reports(params = {}, = {}) req = build_request(:list_analysis_reports, params) req.send_request() end |
#list_container_associations(params = {}) ⇒ Types::ListContainerAssociationsResponse
Lists the container associations in your account and Region. Use the
NextToken parameter in subsequent requests to retrieve additional
results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4398 4399 4400 4401 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4398 def list_container_associations(params = {}, = {}) req = build_request(:list_container_associations, params) req.send_request() end |
#list_context_stores(params = {}) ⇒ Types::ListContextStoresResponse
Lists the active context stores that are associated with your firewalls. A context store records network resources that can be used to evaluate context-aware rules. You can list the following resource types: VPCs, subnets, security groups, and transit gateway attachments.
When using a small page size, a single call might not return the full
list. A response can contain fewer than MaxResults results, or none,
and still include a NextToken. Keep making requests until the
response does not include a NextToken.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4452 4453 4454 4455 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4452 def list_context_stores(params = {}, = {}) req = build_request(:list_context_stores, 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.
4499 4500 4501 4502 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4499 def list_firewall_policies(params = {}, = {}) req = build_request(:list_firewall_policies, params) req.send_request() end |
#list_firewall_policies_v2(params = {}) ⇒ Types::ListFirewallPoliciesV2Response
Retrieves the metadata for the Next Generation 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.
4546 4547 4548 4549 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4546 def list_firewall_policies_v2(params = {}, = {}) req = build_request(:list_firewall_policies_v2, 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.
4603 4604 4605 4606 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4603 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.
4716 4717 4718 4719 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4716 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.
4809 4810 4811 4812 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4809 def list_flow_operations(params = {}, = {}) req = build_request(:list_flow_operations, params) req.send_request() end |
#list_resources_in_context_store(params = {}) ⇒ Types::ListResourcesInContextStoreResponse
Lists the resources that a context store records. The context store must be associated with a transit gateway that your firewall is attached to. You can filter the results by Region, resource type, or both.
When using a small page size, a single call might not return the full
list. A response can contain fewer than MaxResults results, or none,
and still include a NextToken. Keep making requests until the
response does not include a NextToken.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4883 4884 4885 4886 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4883 def list_resources_in_context_store(params = {}, = {}) req = build_request(:list_resources_in_context_store, 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.
4954 4955 4956 4957 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4954 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.
5059 5060 5061 5062 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5059 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.
5002 5003 5004 5005 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5002 def list_tls_inspection_configurations(params = {}, = {}) req = build_request(:list_tls_inspection_configurations, params) req.send_request() end |
#list_vpc_endpoint_associations(params = {}) ⇒ Types::ListVpcEndpointAssociationsResponse
Retrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for that firewall.
Depending on your setting for max results and the number of associations, 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.
5115 5116 5117 5118 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5115 def list_vpc_endpoint_associations(params = {}, = {}) req = build_request(:list_vpc_endpoint_associations, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Struct
Creates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
For information about using sharing with Network Firewall resources, see Sharing Network Firewall resources in the Network Firewall Developer Guide.
Use this operation to create or update a resource policy for your Network Firewall rule group, firewall policy, or firewall. In the resource policy, you specify the accounts that you want to share the Network Firewall 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 resource.
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.
5207 5208 5209 5210 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5207 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#reject_network_firewall_transit_gateway_attachment(params = {}) ⇒ Types::RejectNetworkFirewallTransitGatewayAttachmentResponse
Rejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.
Only the transit gateway owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.
Use DescribeFirewall to monitor the rejection status. To accept the attachment instead of rejecting it, use AcceptNetworkFirewallTransitGatewayAttachment.
5255 5256 5257 5258 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5255 def (params = {}, = {}) req = build_request(:reject_network_firewall_transit_gateway_attachment, 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.
5300 5301 5302 5303 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5300 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.
5402 5403 5404 5405 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5402 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.
5491 5492 5493 5494 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5491 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.
5529 5530 5531 5532 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5529 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.
5563 5564 5565 5566 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5563 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_availability_zone_change_protection(params = {}) ⇒ Types::UpdateAvailabilityZoneChangeProtectionResponse
Modifies the AvailabilityZoneChangeProtection setting for a transit
gateway-attached firewall. When enabled, this setting prevents
accidental changes to the firewall's Availability Zone configuration.
This helps protect against disrupting traffic flow in production
environments.
When enabled, you must disable this protection before using AssociateAvailabilityZones or DisassociateAvailabilityZones to modify the firewall's Availability Zone configuration.
5642 5643 5644 5645 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5642 def update_availability_zone_change_protection(params = {}, = {}) req = build_request(:update_availability_zone_change_protection, params) req.send_request() end |
#update_container_association(params = {}) ⇒ Types::UpdateContainerAssociationResponse
Updates the monitoring configurations and description of a container association. You can't change the container type after creation. Provide an update token to enable optimistic concurrency control.
5755 5756 5757 5758 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5755 def update_container_association(params = {}, = {}) req = build_request(:update_container_association, params) req.send_request() end |
#update_firewall_analysis_settings(params = {}) ⇒ Types::UpdateFirewallAnalysisSettingsResponse
Enables specific types of firewall analysis on a specific firewall you define.
5825 5826 5827 5828 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5825 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.
5899 5900 5901 5902 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5899 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.
5969 5970 5971 5972 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 5969 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.
6049 6050 6051 6052 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 6049 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.
6221 6222 6223 6224 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 6221 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.
6295 6296 6297 6298 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 6295 def update_firewall_policy_change_protection(params = {}, = {}) req = build_request(:update_firewall_policy_change_protection, params) req.send_request() end |
#update_firewall_policy_v2(params = {}) ⇒ Types::UpdateFirewallPolicyV2Response
Updates the properties of the specified Next Generation policy.
6534 6535 6536 6537 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 6534 def update_firewall_policy_v2(params = {}, = {}) req = build_request(:update_firewall_policy_v2, 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
LogDestinationConfigarray element toLogDestinationConfigs.Delete a log destination object by removing a single
LogDestinationConfigarray element fromLogDestinationConfigs.Change the
LogDestinationsetting in a singleLogDestinationConfigarray 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.
6633 6634 6635 6636 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 6633 def update_logging_configuration(params = {}, = {}) req = build_request(:update_logging_configuration, params) req.send_request() end |
#update_proxy_settings(params = {}) ⇒ Types::UpdateProxySettingsResponse
Modifies the proxy settings of a proxy mode firewall. Use this operation to change the ports and protocols on which the firewall's proxy listens for traffic. The new listeners take effect without recreating the firewall.
The ProxySettings that you provide replace the firewall's current
proxy settings. If you created the firewall with your own
CertificateArn and DomainName, you must specify the same values in
every request. You can't change or remove them.
6725 6726 6727 6728 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 6725 def update_proxy_settings(params = {}, = {}) req = build_request(:update_proxy_settings, 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.
7112 7113 7114 7115 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 7112 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
7181 7182 7183 7184 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 7181 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.
7346 7347 7348 7349 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 7346 def update_tls_inspection_configuration(params = {}, = {}) req = build_request(:update_tls_inspection_configuration, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.
| waiter_name | params | :delay | :max_attempts |
|---|---|---|---|
| firewall_policy_active | #describe_firewall_policy | 15 | 40 |
7461 7462 7463 7464 7465 |
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 7461 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |