prowler-sdk-poc
Version:
498 lines • 123 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class NetworkFirewall extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: NetworkFirewall.Types.ClientConfiguration)
config: Config & NetworkFirewall.Types.ClientConfiguration;
/**
* 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.
*/
associateFirewallPolicy(params: NetworkFirewall.Types.AssociateFirewallPolicyRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.AssociateFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.AssociateFirewallPolicyResponse, AWSError>;
/**
* 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.
*/
associateFirewallPolicy(callback?: (err: AWSError, data: NetworkFirewall.Types.AssociateFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.AssociateFirewallPolicyResponse, AWSError>;
/**
* 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.
*/
associateSubnets(params: NetworkFirewall.Types.AssociateSubnetsRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.AssociateSubnetsResponse) => void): Request<NetworkFirewall.Types.AssociateSubnetsResponse, AWSError>;
/**
* 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.
*/
associateSubnets(callback?: (err: AWSError, data: NetworkFirewall.Types.AssociateSubnetsResponse) => void): Request<NetworkFirewall.Types.AssociateSubnetsResponse, AWSError>;
/**
* 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.
*/
createFirewall(params: NetworkFirewall.Types.CreateFirewallRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.CreateFirewallResponse) => void): Request<NetworkFirewall.Types.CreateFirewallResponse, AWSError>;
/**
* 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.
*/
createFirewall(callback?: (err: AWSError, data: NetworkFirewall.Types.CreateFirewallResponse) => void): Request<NetworkFirewall.Types.CreateFirewallResponse, AWSError>;
/**
* 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.
*/
createFirewallPolicy(params: NetworkFirewall.Types.CreateFirewallPolicyRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.CreateFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.CreateFirewallPolicyResponse, AWSError>;
/**
* 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.
*/
createFirewallPolicy(callback?: (err: AWSError, data: NetworkFirewall.Types.CreateFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.CreateFirewallPolicyResponse, AWSError>;
/**
* 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.
*/
createRuleGroup(params: NetworkFirewall.Types.CreateRuleGroupRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.CreateRuleGroupResponse) => void): Request<NetworkFirewall.Types.CreateRuleGroupResponse, AWSError>;
/**
* 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.
*/
createRuleGroup(callback?: (err: AWSError, data: NetworkFirewall.Types.CreateRuleGroupResponse) => void): Request<NetworkFirewall.Types.CreateRuleGroupResponse, AWSError>;
/**
* 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.
*/
deleteFirewall(params: NetworkFirewall.Types.DeleteFirewallRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DeleteFirewallResponse) => void): Request<NetworkFirewall.Types.DeleteFirewallResponse, AWSError>;
/**
* 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.
*/
deleteFirewall(callback?: (err: AWSError, data: NetworkFirewall.Types.DeleteFirewallResponse) => void): Request<NetworkFirewall.Types.DeleteFirewallResponse, AWSError>;
/**
* Deletes the specified FirewallPolicy.
*/
deleteFirewallPolicy(params: NetworkFirewall.Types.DeleteFirewallPolicyRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DeleteFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.DeleteFirewallPolicyResponse, AWSError>;
/**
* Deletes the specified FirewallPolicy.
*/
deleteFirewallPolicy(callback?: (err: AWSError, data: NetworkFirewall.Types.DeleteFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.DeleteFirewallPolicyResponse, AWSError>;
/**
* Deletes a resource policy that you created in a PutResourcePolicy request.
*/
deleteResourcePolicy(params: NetworkFirewall.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DeleteResourcePolicyResponse) => void): Request<NetworkFirewall.Types.DeleteResourcePolicyResponse, AWSError>;
/**
* Deletes a resource policy that you created in a PutResourcePolicy request.
*/
deleteResourcePolicy(callback?: (err: AWSError, data: NetworkFirewall.Types.DeleteResourcePolicyResponse) => void): Request<NetworkFirewall.Types.DeleteResourcePolicyResponse, AWSError>;
/**
* Deletes the specified RuleGroup.
*/
deleteRuleGroup(params: NetworkFirewall.Types.DeleteRuleGroupRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DeleteRuleGroupResponse) => void): Request<NetworkFirewall.Types.DeleteRuleGroupResponse, AWSError>;
/**
* Deletes the specified RuleGroup.
*/
deleteRuleGroup(callback?: (err: AWSError, data: NetworkFirewall.Types.DeleteRuleGroupResponse) => void): Request<NetworkFirewall.Types.DeleteRuleGroupResponse, AWSError>;
/**
* Returns the data objects for the specified firewall.
*/
describeFirewall(params: NetworkFirewall.Types.DescribeFirewallRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeFirewallResponse) => void): Request<NetworkFirewall.Types.DescribeFirewallResponse, AWSError>;
/**
* Returns the data objects for the specified firewall.
*/
describeFirewall(callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeFirewallResponse) => void): Request<NetworkFirewall.Types.DescribeFirewallResponse, AWSError>;
/**
* Returns the data objects for the specified firewall policy.
*/
describeFirewallPolicy(params: NetworkFirewall.Types.DescribeFirewallPolicyRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.DescribeFirewallPolicyResponse, AWSError>;
/**
* Returns the data objects for the specified firewall policy.
*/
describeFirewallPolicy(callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.DescribeFirewallPolicyResponse, AWSError>;
/**
* Returns the logging configuration for the specified firewall.
*/
describeLoggingConfiguration(params: NetworkFirewall.Types.DescribeLoggingConfigurationRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeLoggingConfigurationResponse) => void): Request<NetworkFirewall.Types.DescribeLoggingConfigurationResponse, AWSError>;
/**
* Returns the logging configuration for the specified firewall.
*/
describeLoggingConfiguration(callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeLoggingConfigurationResponse) => void): Request<NetworkFirewall.Types.DescribeLoggingConfigurationResponse, AWSError>;
/**
* Retrieves a resource policy that you created in a PutResourcePolicy request.
*/
describeResourcePolicy(params: NetworkFirewall.Types.DescribeResourcePolicyRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeResourcePolicyResponse) => void): Request<NetworkFirewall.Types.DescribeResourcePolicyResponse, AWSError>;
/**
* Retrieves a resource policy that you created in a PutResourcePolicy request.
*/
describeResourcePolicy(callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeResourcePolicyResponse) => void): Request<NetworkFirewall.Types.DescribeResourcePolicyResponse, AWSError>;
/**
* Returns the data objects for the specified rule group.
*/
describeRuleGroup(params: NetworkFirewall.Types.DescribeRuleGroupRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeRuleGroupResponse) => void): Request<NetworkFirewall.Types.DescribeRuleGroupResponse, AWSError>;
/**
* Returns the data objects for the specified rule group.
*/
describeRuleGroup(callback?: (err: AWSError, data: NetworkFirewall.Types.DescribeRuleGroupResponse) => void): Request<NetworkFirewall.Types.DescribeRuleGroupResponse, AWSError>;
/**
* 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.
*/
disassociateSubnets(params: NetworkFirewall.Types.DisassociateSubnetsRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.DisassociateSubnetsResponse) => void): Request<NetworkFirewall.Types.DisassociateSubnetsResponse, AWSError>;
/**
* 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.
*/
disassociateSubnets(callback?: (err: AWSError, data: NetworkFirewall.Types.DisassociateSubnetsResponse) => void): Request<NetworkFirewall.Types.DisassociateSubnetsResponse, AWSError>;
/**
* 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.
*/
listFirewallPolicies(params: NetworkFirewall.Types.ListFirewallPoliciesRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.ListFirewallPoliciesResponse) => void): Request<NetworkFirewall.Types.ListFirewallPoliciesResponse, AWSError>;
/**
* 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.
*/
listFirewallPolicies(callback?: (err: AWSError, data: NetworkFirewall.Types.ListFirewallPoliciesResponse) => void): Request<NetworkFirewall.Types.ListFirewallPoliciesResponse, AWSError>;
/**
* 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.
*/
listFirewalls(params: NetworkFirewall.Types.ListFirewallsRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.ListFirewallsResponse) => void): Request<NetworkFirewall.Types.ListFirewallsResponse, AWSError>;
/**
* 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.
*/
listFirewalls(callback?: (err: AWSError, data: NetworkFirewall.Types.ListFirewallsResponse) => void): Request<NetworkFirewall.Types.ListFirewallsResponse, AWSError>;
/**
* 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.
*/
listRuleGroups(params: NetworkFirewall.Types.ListRuleGroupsRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.ListRuleGroupsResponse) => void): Request<NetworkFirewall.Types.ListRuleGroupsResponse, AWSError>;
/**
* 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.
*/
listRuleGroups(callback?: (err: AWSError, data: NetworkFirewall.Types.ListRuleGroupsResponse) => void): Request<NetworkFirewall.Types.ListRuleGroupsResponse, AWSError>;
/**
* 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.
*/
listTagsForResource(params: NetworkFirewall.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.ListTagsForResourceResponse) => void): Request<NetworkFirewall.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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.
*/
listTagsForResource(callback?: (err: AWSError, data: NetworkFirewall.Types.ListTagsForResourceResponse) => void): Request<NetworkFirewall.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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. 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 AWS Resource Access Manager User Guide.
*/
putResourcePolicy(params: NetworkFirewall.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.PutResourcePolicyResponse) => void): Request<NetworkFirewall.Types.PutResourcePolicyResponse, AWSError>;
/**
* 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. 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 AWS Resource Access Manager User Guide.
*/
putResourcePolicy(callback?: (err: AWSError, data: NetworkFirewall.Types.PutResourcePolicyResponse) => void): Request<NetworkFirewall.Types.PutResourcePolicyResponse, AWSError>;
/**
* 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.
*/
tagResource(params: NetworkFirewall.Types.TagResourceRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.TagResourceResponse) => void): Request<NetworkFirewall.Types.TagResourceResponse, AWSError>;
/**
* 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.
*/
tagResource(callback?: (err: AWSError, data: NetworkFirewall.Types.TagResourceResponse) => void): Request<NetworkFirewall.Types.TagResourceResponse, AWSError>;
/**
* 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.
*/
untagResource(params: NetworkFirewall.Types.UntagResourceRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.UntagResourceResponse) => void): Request<NetworkFirewall.Types.UntagResourceResponse, AWSError>;
/**
* 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.
*/
untagResource(callback?: (err: AWSError, data: NetworkFirewall.Types.UntagResourceResponse) => void): Request<NetworkFirewall.Types.UntagResourceResponse, AWSError>;
/**
* 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.
*/
updateFirewallDeleteProtection(params: NetworkFirewall.Types.UpdateFirewallDeleteProtectionRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateFirewallDeleteProtectionResponse) => void): Request<NetworkFirewall.Types.UpdateFirewallDeleteProtectionResponse, AWSError>;
/**
* 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.
*/
updateFirewallDeleteProtection(callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateFirewallDeleteProtectionResponse) => void): Request<NetworkFirewall.Types.UpdateFirewallDeleteProtectionResponse, AWSError>;
/**
* Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
*/
updateFirewallDescription(params: NetworkFirewall.Types.UpdateFirewallDescriptionRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateFirewallDescriptionResponse) => void): Request<NetworkFirewall.Types.UpdateFirewallDescriptionResponse, AWSError>;
/**
* Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
*/
updateFirewallDescription(callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateFirewallDescriptionResponse) => void): Request<NetworkFirewall.Types.UpdateFirewallDescriptionResponse, AWSError>;
/**
* Updates the properties of the specified firewall policy.
*/
updateFirewallPolicy(params: NetworkFirewall.Types.UpdateFirewallPolicyRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.UpdateFirewallPolicyResponse, AWSError>;
/**
* Updates the properties of the specified firewall policy.
*/
updateFirewallPolicy(callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateFirewallPolicyResponse) => void): Request<NetworkFirewall.Types.UpdateFirewallPolicyResponse, AWSError>;
/**
*
*/
updateFirewallPolicyChangeProtection(params: NetworkFirewall.Types.UpdateFirewallPolicyChangeProtectionRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateFirewallPolicyChangeProtectionResponse) => void): Request<NetworkFirewall.Types.UpdateFirewallPolicyChangeProtectionResponse, AWSError>;
/**
*
*/
updateFirewallPolicyChangeProtection(callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateFirewallPolicyChangeProtectionResponse) => void): Request<NetworkFirewall.Types.UpdateFirewallPolicyChangeProtectionResponse, AWSError>;
/**
* 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.
*/
updateLoggingConfiguration(params: NetworkFirewall.Types.UpdateLoggingConfigurationRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateLoggingConfigurationResponse) => void): Request<NetworkFirewall.Types.UpdateLoggingConfigurationResponse, AWSError>;
/**
* 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.
*/
updateLoggingConfiguration(callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateLoggingConfigurationResponse) => void): Request<NetworkFirewall.Types.UpdateLoggingConfigurationResponse, AWSError>;
/**
* 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.
*/
updateRuleGroup(params: NetworkFirewall.Types.UpdateRuleGroupRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateRuleGroupResponse) => void): Request<NetworkFirewall.Types.UpdateRuleGroupResponse, AWSError>;
/**
* 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.
*/
updateRuleGroup(callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateRuleGroupResponse) => void): Request<NetworkFirewall.Types.UpdateRuleGroupResponse, AWSError>;
/**
*
*/
updateSubnetChangeProtection(params: NetworkFirewall.Types.UpdateSubnetChangeProtectionRequest, callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateSubnetChangeProtectionResponse) => void): Request<NetworkFirewall.Types.UpdateSubnetChangeProtectionResponse, AWSError>;
/**
*
*/
updateSubnetChangeProtection(callback?: (err: AWSError, data: NetworkFirewall.Types.UpdateSubnetChangeProtectionResponse) => void): Request<NetworkFirewall.Types.UpdateSubnetChangeProtectionResponse, AWSError>;
}
declare namespace NetworkFirewall {
export interface ActionDefinition {
/**
* Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published. You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
*/
PublishMetricAction?: PublishMetricAction;
}
export type ActionName = string;
export interface Address {
/**
* Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4. Examples: To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32. To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
*/
AddressDefinition: AddressDefinition;
}
export type AddressDefinition = string;
export type Addresses = Address[];
export interface AssociateFirewallPolicyRequest {
/**
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*/
UpdateToken?: UpdateToken;
/**
* The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both.
*/
FirewallArn?: ResourceArn;
/**
* The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both.
*/
FirewallName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the firewall policy.
*/
FirewallPolicyArn: ResourceArn;
}
export interface AssociateFirewallPolicyResponse {
/**
* The Amazon Resource Name (ARN) of the firewall.
*/
FirewallArn?: ResourceArn;
/**
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*/
FirewallName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the firewall policy.
*/
FirewallPolicyArn?: ResourceArn;
/**
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*/
UpdateToken?: UpdateToken;
}
export interface AssociateSubnetsRequest {
/**
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*/
UpdateToken?: UpdateToken;
/**
* The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the name, and you can specify both.
*/
FirewallArn?: ResourceArn;
/**
* The descriptive name of the firewall. You can't change the name of a firewall after you create it. You must specify the ARN or the name, and you can specify both.
*/
FirewallName?: ResourceName;
/**
* The IDs of the subnets that you want to associate with the firewall.
*/
SubnetMappings: SubnetMappings;
}
export interface AssociateSubnetsResponse {
/**
* The Amazon Resource Name (ARN) of the firewall.
*/
FirewallArn?: ResourceArn;
/**
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*/
FirewallName?: ResourceName;
/**
* The IDs of the subnets that are associated with the firewall.
*/
SubnetMappings?: SubnetMappings;
/**
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it. To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*/
UpdateToken?: UpdateToken;
}
export interface Attachment {
/**
* The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
*/
SubnetId?: AzSubnet;
/**
* The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
*/
EndpointId?: EndpointId;
/**
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example CREATING, DELETING, or FAILED.
*/
Status?: AttachmentStatus;
}
export type AttachmentStatus = "CREATING"|"DELETING"|"SCALING"|"READY"|string;
export type AvailabilityZone = string;
export type AzSubnet = string;
export type AzSubnets = AzSubnet[];
export type Boolean = boolean;
export type CollectionMember_String = string;
export type ConfigurationSyncState = "PENDING"|"IN_SYNC"|string;
export interface CreateFirewallPolicyRequest {
/**
* The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
*/
FirewallPolicyName: ResourceName;
/**
* The rule groups and policy actions to use in the firewall policy.
*/
FirewallPolicy: FirewallPolicy;
/**
* A description of the firewall policy.
*/
Description?: Description;
/**
* The key:value pairs to associate with the resource.
*/
Tags?: TagList;
/**
* Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid. If set to FALSE, Network Firewall makes the requested changes to your resources.
*/
DryRun?: Boolean;
}
export interface CreateFirewallPolicyResponse {
/**
* A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
*/
UpdateToken: UpdateToken;
/**
* The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
*/
FirewallPolicyResponse: FirewallPolicyResponse;
}
export interface CreateFirewallRequest {
/**
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*/
FirewallName: ResourceName;
/**
* The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
*/
FirewallPolicyArn: ResourceArn;
/**
* The unique identifier of the VPC where Network Firewall should create the firewall. You can't change this setting after you create the firewall.
*/
VpcId: VpcId;
/**
* The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.
*/
SubnetMappings: SubnetMappings;
/**
* A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
*/
DeleteProtection?: Boolean;
/**
* A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
*/
SubnetChangeProtection?: Boolean;
/**
* A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
*/
FirewallPolicyChangeProtection?: Boolean;
/**
* A description of the firewall.
*/
Description?: Description;
/**
* The key:value pairs to associate with the resource.
*/
Tags?: TagList;
}
export interface CreateFirewallResponse {
/**
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
*/
Firewall?: Firewall;
/**
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
*/
FirewallStatus?: FirewallStatus;
}
export interface CreateRuleGroupRequest {
/**
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*/
RuleGroupName: ResourceName;
/**
* An object that defines the rule group rules. You must provide either this rule group setting or a Rules setting, but not both.
*/
RuleGroup?: RuleGroup;
/**
* A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. You must provide either this rules setting or a populated RuleGroup setting, but not both. You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.
*/
Rules?: RulesString;
/**
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
*/
Type: RuleGroupType;
/**
* A description of the rule group.
*/
Description?: Description;
/**
* The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group. You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE. You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow. Capacity for a stateless rule group For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group. To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings: A match setting with no criteria specified has a value of 1. A match setting with Any specified has a value of 1. All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3. A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6. Capacity for a stateful rule group For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
*/
Capacity: RuleCapacity;
/**
* The key:value pairs to associate with the resource.
*/
Tags?: TagList;
/**
* Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid. If set to FALSE, Network Firewall makes the requested changes to your resources.
*/
DryRun?: Boolean;
}
export interface CreateRuleGroupResponse {
/**
* A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
*/
UpdateToken: UpdateToken;
/**
* The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*/
RuleGroupResponse: RuleGroupResponse;
}
export interface CustomAction {
/**
* The descriptive name of the custom action. You can't change the name of a custom action after you create it.
*/
ActionName: ActionName;
/**
* The custom action associated with the action name.
*/
ActionDefinition: ActionDefinition;
}
export type CustomActions = CustomAction[];
export interface DeleteFirewallPolicyRequest {
/**
* The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it. You must specify the ARN or the name, and you can specify both.
*/
FirewallPolicyName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the firewall policy. You must specify the ARN or the name, and you can specify both.
*/