Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

NetworkFirewall

import { NetworkFirewall } from "https://aws-api.deno.dev/v0.3/services/networkfirewall.ts?docs=full";
class NetworkFirewall {
constructor(apiFactory: client.ApiFactory);
async associateFirewallPolicy(params: AssociateFirewallPolicyRequest, opts?: client.RequestOptions): Promise<AssociateFirewallPolicyResponse>;
async associateSubnets(params: AssociateSubnetsRequest, opts?: client.RequestOptions): Promise<AssociateSubnetsResponse>;
async createFirewall(params: CreateFirewallRequest, opts?: client.RequestOptions): Promise<CreateFirewallResponse>;
async createFirewallPolicy(params: CreateFirewallPolicyRequest, opts?: client.RequestOptions): Promise<CreateFirewallPolicyResponse>;
async createRuleGroup(params: CreateRuleGroupRequest, opts?: client.RequestOptions): Promise<CreateRuleGroupResponse>;
async deleteFirewall(params?: DeleteFirewallRequest, opts?: client.RequestOptions): Promise<DeleteFirewallResponse>;
async deleteFirewallPolicy(params?: DeleteFirewallPolicyRequest, opts?: client.RequestOptions): Promise<DeleteFirewallPolicyResponse>;
async deleteResourcePolicy(params: DeleteResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>;
async deleteRuleGroup(params?: DeleteRuleGroupRequest, opts?: client.RequestOptions): Promise<DeleteRuleGroupResponse>;
async describeFirewall(params?: DescribeFirewallRequest, opts?: client.RequestOptions): Promise<DescribeFirewallResponse>;
async describeFirewallPolicy(params?: DescribeFirewallPolicyRequest, opts?: client.RequestOptions): Promise<DescribeFirewallPolicyResponse>;
async describeLoggingConfiguration(params?: DescribeLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeLoggingConfigurationResponse>;
async describeResourcePolicy(params: DescribeResourcePolicyRequest, opts?: client.RequestOptions): Promise<DescribeResourcePolicyResponse>;
async describeRuleGroup(params?: DescribeRuleGroupRequest, opts?: client.RequestOptions): Promise<DescribeRuleGroupResponse>;
async describeRuleGroupMetadata(params?: DescribeRuleGroupMetadataRequest, opts?: client.RequestOptions): Promise<DescribeRuleGroupMetadataResponse>;
async disassociateSubnets(params: DisassociateSubnetsRequest, opts?: client.RequestOptions): Promise<DisassociateSubnetsResponse>;
async listFirewallPolicies(params?: ListFirewallPoliciesRequest, opts?: client.RequestOptions): Promise<ListFirewallPoliciesResponse>;
async listFirewalls(params?: ListFirewallsRequest, opts?: client.RequestOptions): Promise<ListFirewallsResponse>;
async listRuleGroups(params?: ListRuleGroupsRequest, opts?: client.RequestOptions): Promise<ListRuleGroupsResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async putResourcePolicy(params: PutResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateFirewallDeleteProtection(params: UpdateFirewallDeleteProtectionRequest, opts?: client.RequestOptions): Promise<UpdateFirewallDeleteProtectionResponse>;
async updateFirewallDescription(params?: UpdateFirewallDescriptionRequest, opts?: client.RequestOptions): Promise<UpdateFirewallDescriptionResponse>;
async updateFirewallPolicy(params: UpdateFirewallPolicyRequest, opts?: client.RequestOptions): Promise<UpdateFirewallPolicyResponse>;
async updateFirewallPolicyChangeProtection(params: UpdateFirewallPolicyChangeProtectionRequest, opts?: client.RequestOptions): Promise<UpdateFirewallPolicyChangeProtectionResponse>;
async updateLoggingConfiguration(params?: UpdateLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateLoggingConfigurationResponse>;
async updateRuleGroup(params: UpdateRuleGroupRequest, opts?: client.RequestOptions): Promise<UpdateRuleGroupResponse>;
async updateSubnetChangeProtection(params: UpdateSubnetChangeProtectionRequest, opts?: client.RequestOptions): Promise<UpdateSubnetChangeProtectionResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new NetworkFirewall(apiFactory: client.ApiFactory)
[src]

§Methods

§

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.

§

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 AWS 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.

§

Creates an AWS Network Firewall "Firewall" and accompanying "FirewallStatus" for a VPC.

The firewall defines the configuration settings for an AWS 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 AWS 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 AWS resource tagging operations, "ListTagsForResource", "TagResource", and "UntagResource".

To retrieve information about firewalls, use "ListFirewalls" and "DescribeFirewall".

§

Creates the firewall policy for the firewall according to the specifications.

An AWS 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.

§

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.

§

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".

§

Deletes the specified "FirewallPolicy".

§
deleteResourcePolicy(params: DeleteResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a resource policy that you created in a "PutResourcePolicy" request.

§

Deletes the specified "RuleGroup".

§

Returns the data objects for the specified firewall.

§

Returns the data objects for the specified firewall policy.

§

Returns the logging configuration for the specified firewall.

§

Retrieves a resource policy that you created in a "PutResourcePolicy" request.

§

Returns the data objects for the specified rule group.

§

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".

§

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.

§

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.

§

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.

§

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.

§

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 AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.

§
putResourcePolicy(params: PutResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>
[src]

Creates or updates an AWS Identity and Access Management 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 AWS 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.

For additional information about resource sharing using RAM, see AWS Resource Access Manager User Guide.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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 AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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 AWS resource, up to 50 tags for a resource.

You can manage tags for the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.

§

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.

§

Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.

§

Updates the properties of the specified firewall policy.

§

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.

§

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 to LogDestinationConfigs.
  • Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs.
  • Change the LogDestination setting in a single LogDestinationConfig 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.

§

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.

§Static Properties