Class: AWS.NetworkFirewall
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.NetworkFirewall
- Identifier:
- networkfirewall
- API Version:
- 2020-11-12
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.
-
The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
To access Network Firewall using the REST API endpoint:
https://network-firewall.<region>.amazonaws.com
-
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
-
For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 6.0.9. For information about Suricata, see the Suricata website.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
-
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.
-
Use custom lists of known bad domains to limit the types of domain names that your applications can access.
-
Perform deep packet inspection on traffic entering or leaving your VPC.
-
Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
To start using Network Firewall, do the following:
-
(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
-
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.
-
In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
-
In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
-
In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.
-
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.
Sending a Request Using NetworkFirewall
var networkfirewall = new AWS.NetworkFirewall();
networkfirewall.associateFirewallPolicy(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the NetworkFirewall object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var networkfirewall = new AWS.NetworkFirewall({apiVersion: '2020-11-12'});
You can also set the API version globally in AWS.config.apiVersions
using
the networkfirewall service identifier:
AWS.config.apiVersions = {
networkfirewall: '2020-11-12',
// other service API versions
};
var networkfirewall = new AWS.NetworkFirewall();
Version:
-
2020-11-12
Constructor Summary collapse
-
new AWS.NetworkFirewall(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
associateFirewallPolicy(params = {}, callback) ⇒ AWS.Request
Associates a FirewallPolicy to a Firewall.
-
associateSubnets(params = {}, callback) ⇒ AWS.Request
Associates the specified subnets in the Amazon VPC to the firewall.
-
createFirewall(params = {}, callback) ⇒ AWS.Request
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
-
createFirewallPolicy(params = {}, callback) ⇒ AWS.Request
Creates the firewall policy for the firewall according to the specifications.
-
createRuleGroup(params = {}, callback) ⇒ AWS.Request
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
-
createTLSInspectionConfiguration(params = {}, callback) ⇒ AWS.Request
Creates an Network Firewall TLS inspection configuration.
-
deleteFirewall(params = {}, callback) ⇒ AWS.Request
Deletes the specified Firewall and its FirewallStatus.
-
deleteFirewallPolicy(params = {}, callback) ⇒ AWS.Request
Deletes the specified FirewallPolicy.
-
deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request
Deletes a resource policy that you created in a PutResourcePolicy request.
-
deleteRuleGroup(params = {}, callback) ⇒ AWS.Request
Deletes the specified RuleGroup.
-
deleteTLSInspectionConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes the specified TLSInspectionConfiguration.
.
-
describeFirewall(params = {}, callback) ⇒ AWS.Request
Returns the data objects for the specified firewall.
-
describeFirewallPolicy(params = {}, callback) ⇒ AWS.Request
Returns the data objects for the specified firewall policy.
-
describeLoggingConfiguration(params = {}, callback) ⇒ AWS.Request
Returns the logging configuration for the specified firewall.
-
describeResourcePolicy(params = {}, callback) ⇒ AWS.Request
Retrieves a resource policy that you created in a PutResourcePolicy request.
-
describeRuleGroup(params = {}, callback) ⇒ AWS.Request
Returns the data objects for the specified rule group.
-
describeRuleGroupMetadata(params = {}, callback) ⇒ AWS.Request
High-level information about a rule group, returned by operations like create and describe.
-
describeTLSInspectionConfiguration(params = {}, callback) ⇒ AWS.Request
Returns the data objects for the specified TLS inspection configuration.
.
-
disassociateSubnets(params = {}, callback) ⇒ AWS.Request
Removes the specified subnet associations from the firewall.
-
listFirewallPolicies(params = {}, callback) ⇒ AWS.Request
Retrieves the metadata for the firewall policies that you have defined.
-
listFirewalls(params = {}, callback) ⇒ AWS.Request
Retrieves the metadata for the firewalls that you have defined.
-
listRuleGroups(params = {}, callback) ⇒ AWS.Request
Retrieves the metadata for the rule groups that you have defined.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Retrieves the tags associated with the specified resource.
-
listTLSInspectionConfigurations(params = {}, callback) ⇒ AWS.Request
Retrieves the metadata for the TLS inspection configurations that you have defined.
-
putResourcePolicy(params = {}, callback) ⇒ AWS.Request
Creates or updates an IAM policy for your rule group or firewall policy.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Adds the specified tags to the specified resource.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes the tags with the specified keys from the specified resource.
-
updateFirewallDeleteProtection(params = {}, callback) ⇒ AWS.Request
Modifies the flag,
DeleteProtection
, which indicates whether it is possible to delete the firewall. -
updateFirewallDescription(params = {}, callback) ⇒ AWS.Request
Modifies the description for the specified firewall.
-
updateFirewallEncryptionConfiguration(params = {}, callback) ⇒ AWS.Request
A complex type that contains settings for encryption of your firewall resources.
.
-
updateFirewallPolicy(params = {}, callback) ⇒ AWS.Request
Updates the properties of the specified firewall policy.
.
-
updateFirewallPolicyChangeProtection(params = {}, callback) ⇒ AWS.Request
Modifies the flag,
ChangeProtection
, which indicates whether it is possible to change the firewall. -
updateLoggingConfiguration(params = {}, callback) ⇒ AWS.Request
Sets the logging configuration for the specified firewall.
-
updateRuleGroup(params = {}, callback) ⇒ AWS.Request
Updates the rule settings for the specified rule group.
-
updateSubnetChangeProtection(params = {}, callback) ⇒ AWS.Request
.
-
updateTLSInspectionConfiguration(params = {}, callback) ⇒ AWS.Request
Updates the TLS inspection configuration settings for the specified TLS inspection configuration.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.NetworkFirewall(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a NetworkFirewall object
var networkfirewall = new AWS.NetworkFirewall({apiVersion: '2020-11-12'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.NetworkFirewall.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.NetworkFirewall.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.NetworkFirewall.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
associateFirewallPolicy(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the associateFirewallPolicy operation
var params = {
FirewallPolicyArn: 'STRING_VALUE', /* required */
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
UpdateToken: 'STRING_VALUE'
};
networkfirewall.associateFirewallPolicy(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
FirewallPolicyArn
— (String
)The Amazon Resource Name (ARN) of the firewall policy.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallPolicyArn
— (String
)The Amazon Resource Name (ARN) of the firewall policy.
UpdateToken
— (String
)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.
-
(AWS.Response)
—
Returns:
associateSubnets(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the associateSubnets operation
var params = {
SubnetMappings: [ /* required */
{
SubnetId: 'STRING_VALUE', /* required */
IPAddressType: DUALSTACK | IPV4 | IPV6
},
/* more items */
],
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
UpdateToken: 'STRING_VALUE'
};
networkfirewall.associateSubnets(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
SubnetMappings
— (Array<map>
)The IDs of the subnets that you want to associate with the firewall.
SubnetId
— required — (String
)The unique identifier for the subnet.
IPAddressType
— (String
)The subnet's IP address type. You can't change the IP address type after you create the subnet.
Possible values include:"DUALSTACK"
"IPV4"
"IPV6"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
SubnetMappings
— (Array<map>
)The IDs of the subnets that are associated with the firewall.
SubnetId
— required — (String
)The unique identifier for the subnet.
IPAddressType
— (String
)The subnet's IP address type. You can't change the IP address type after you create the subnet.
Possible values include:"DUALSTACK"
"IPV4"
"IPV6"
UpdateToken
— (String
)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.
-
(AWS.Response)
—
Returns:
createFirewall(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the createFirewall operation
var params = {
FirewallName: 'STRING_VALUE', /* required */
FirewallPolicyArn: 'STRING_VALUE', /* required */
SubnetMappings: [ /* required */
{
SubnetId: 'STRING_VALUE', /* required */
IPAddressType: DUALSTACK | IPV4 | IPV6
},
/* more items */
],
VpcId: 'STRING_VALUE', /* required */
DeleteProtection: true || false,
Description: 'STRING_VALUE',
EncryptionConfiguration: {
Type: CUSTOMER_KMS | AWS_OWNED_KMS_KEY, /* required */
KeyId: 'STRING_VALUE'
},
FirewallPolicyChangeProtection: true || false,
SubnetChangeProtection: true || false,
Tags: [
{
Key: 'STRING_VALUE', /* required */
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
};
networkfirewall.createFirewall(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallPolicyArn
— (String
)The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
VpcId
— (String
)The unique identifier of the VPC where Network Firewall should create the firewall.
You can't change this setting after you create the firewall.
SubnetMappings
— (Array<map>
)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.
SubnetId
— required — (String
)The unique identifier for the subnet.
IPAddressType
— (String
)The subnet's IP address type. You can't change the IP address type after you create the subnet.
Possible values include:"DUALSTACK"
"IPV4"
"IPV6"
DeleteProtection
— (Boolean
)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 toTRUE
.SubnetChangeProtection
— (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
.FirewallPolicyChangeProtection
— (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
.Description
— (String
)A description of the firewall.
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration
— (map
)A complex type that contains settings for encryption of your firewall resources.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Firewall
— (map
)The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn
— required — (String
)The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId
— required — (String
)The unique identifier of the VPC where the firewall is in use.
SubnetMappings
— required — (Array<map>
)The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
SubnetId
— required — (String
)The unique identifier for the subnet.
IPAddressType
— (String
)The subnet's IP address type. You can't change the IP address type after you create the subnet.
Possible values include:"DUALSTACK"
"IPV4"
"IPV6"
DeleteProtection
— (Boolean
)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 toTRUE
.SubnetChangeProtection
— (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
.FirewallPolicyChangeProtection
— (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
.Description
— (String
)A description of the firewall.
FirewallId
— required — (String
)The unique identifier for the firewall.
Tags
— (Array<map>
)Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
FirewallStatus
— (map
)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.
Status
— required — (String
)The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it. This setting is
Possible values include:READY
only when theConfigurationSyncStateSummary
value isIN_SYNC
and theAttachment
Status
values for all of the configured subnets areREADY
."PROVISIONING"
"DELETING"
"READY"
ConfigurationSyncStateSummary
— required — (String
)The configuration sync state for the firewall. This summarizes the sync states reported in the
Config
settings for all of the Availability Zones where you have configured the firewall.When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This summary indicates whether the configuration changes have been applied everywhere.
This status must be
Possible values include:IN_SYNC
for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. TheStatus
setting indicates firewall readiness."PENDING"
"IN_SYNC"
"CAPACITY_CONSTRAINED"
SyncStates
— (map<map>
)The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you've configured a subnet. These objects provide details of the information that is summarized in the
ConfigurationSyncStateSummary
andStatus
, broken down by zone and configuration object.Attachment
— (map
)The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.
SubnetId
— (String
)The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId
— (String
)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.
Status
— (String
)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
Possible values include:Config
settings. When this value isREADY
, 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 exampleCREATING
orDELETING
."CREATING"
"DELETING"
"FAILED"
"ERROR"
"SCALING"
"READY"
StatusMessage
— (String
)If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A
FAILED
status indicates a non-recoverable state, and aERROR
status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
Config
— (map<map>
)The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.
SyncStatus
— (String
)Indicates whether this object is in sync with the version indicated in the update token.
Possible values include:"PENDING"
"IN_SYNC"
"CAPACITY_CONSTRAINED"
UpdateToken
— (String
)The current version of the object that is either in sync or pending synchronization.
CapacityUsageSummary
— (map
)Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs
— (map
)Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount
— (Integer
)The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount
— (Integer
)The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences
— (map<map>
)The list of the IP set references used by a firewall.
ResolvedCIDRCount
— (Integer
)Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call
AvailableCIDRCount
.
-
(AWS.Response)
—
Returns:
createFirewallPolicy(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the createFirewallPolicy operation
var params = {
FirewallPolicy: { /* required */
StatelessDefaultActions: [ /* required */
'STRING_VALUE',
/* more items */
],
StatelessFragmentDefaultActions: [ /* required */
'STRING_VALUE',
/* more items */
],
PolicyVariables: {
RuleVariables: {
'<RuleVariableName>': {
Definition: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* '<RuleVariableName>': ... */
}
},
StatefulDefaultActions: [
'STRING_VALUE',
/* more items */
],
StatefulEngineOptions: {
RuleOrder: DEFAULT_ACTION_ORDER | STRICT_ORDER,
StreamExceptionPolicy: DROP | CONTINUE | REJECT
},
StatefulRuleGroupReferences: [
{
ResourceArn: 'STRING_VALUE', /* required */
Override: {
Action: DROP_TO_ALERT
},
Priority: 'NUMBER_VALUE'
},
/* more items */
],
StatelessCustomActions: [
{
ActionDefinition: { /* required */
PublishMetricAction: {
Dimensions: [ /* required */
{
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
}
},
ActionName: 'STRING_VALUE' /* required */
},
/* more items */
],
StatelessRuleGroupReferences: [
{
Priority: 'NUMBER_VALUE', /* required */
ResourceArn: 'STRING_VALUE' /* required */
},
/* more items */
],
TLSInspectionConfigurationArn: 'STRING_VALUE'
},
FirewallPolicyName: 'STRING_VALUE', /* required */
Description: 'STRING_VALUE',
DryRun: true || false,
EncryptionConfiguration: {
Type: CUSTOMER_KMS | AWS_OWNED_KMS_KEY, /* required */
KeyId: 'STRING_VALUE'
},
Tags: [
{
Key: 'STRING_VALUE', /* required */
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
};
networkfirewall.createFirewallPolicy(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
FirewallPolicyName
— (String
)The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
FirewallPolicy
— (map
)The rule groups and policy actions to use in the firewall policy.
StatelessRuleGroupReferences
— (Array<map>
)References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
ResourceArn
— required — (String
)The Amazon Resource Name (ARN) of the stateless rule group.
Priority
— required — (Integer
)An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
StatelessDefaultActions
— required — (Array<String>
)The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify
aws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws:forward_to_sfe
. In addition, you can specify custom actions that are compatible with your standard section choice.For example, you could specify
["aws:pass"]
or you could specify["aws:pass", “customActionName”]
. For information about compatibility, see the custom action descriptions under CustomAction.StatelessFragmentDefaultActions
— required — (Array<String>
)The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify
aws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws:forward_to_sfe
. In addition, you can specify custom actions that are compatible with your standard section choice.For example, you could specify
["aws:pass"]
or you could specify["aws:pass", “customActionName”]
. For information about compatibility, see the custom action descriptions under CustomAction.StatelessCustomActions
— (Array<map>
)The custom action definitions that are available for use in the firewall policy's
StatelessDefaultActions
setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.ActionName
— required — (String
)The descriptive name of the custom action. You can't change the name of a custom action after you create it.
ActionDefinition
— required — (map
)The custom action associated with the action name.
PublishMetricAction
— (map
)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.
Dimensions
— required — (Array<map>
)Value
— required — (String
)The value to use in the custom metric dimension.
StatefulRuleGroupReferences
— (Array<map>
)References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
ResourceArn
— required — (String
)The Amazon Resource Name (ARN) of the stateful rule group.
Priority
— (Integer
)An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the
STRICT_ORDER
rule order in the stateful engine options settings.Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.
Override
— (map
)The action that allows the policy owner to override the behavior of the rule group within a policy.
Action
— (String
)The action that changes the rule group from
Possible values include:DROP
toALERT
. This only applies to managed rule groups."DROP_TO_ALERT"
StatefulDefaultActions
— (Array<String>
)The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
Valid values of the stateful default action:
-
aws:drop_strict
-
aws:drop_established
-
aws:alert_strict
-
aws:alert_established
For more information, see Strict evaluation order in the Network Firewall Developer Guide.
-
StatefulEngineOptions
— (map
)Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.
RuleOrder
— (String
)Indicates how to manage the order of stateful rule evaluation for the policy.
Possible values include:STRICT_ORDER
is the default and recommended option. WithSTRICT_ORDER
, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don't match any rules. ChooseSTRICT_ORDER
to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order isPASS
, followed byDROP
,REJECT
, andALERT
actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide."DEFAULT_ACTION_ORDER"
"STRICT_ORDER"
StreamExceptionPolicy
— (String
)Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
-
DROP
- Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior. -
CONTINUE
- Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule todrop http
traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using aflow:stateless
rule would still match, as would theaws:drop_strict
default action. -
REJECT
- Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
"DROP"
"CONTINUE"
"REJECT"
-
TLSInspectionConfigurationArn
— (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
PolicyVariables
— (map
)Contains variables that you can use to override default Suricata settings in your firewall policy.
RuleVariables
— (map<map>
)The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata
HOME_NET
variable. If your firewall uses an inspection VPC, you might want to override theHOME_NET
variable with the CIDRs of your home networks. If you don't overrideHOME_NET
with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.Definition
— required — (Array<String>
)The list of IP addresses and address ranges, in CIDR notation.
Description
— (String
)A description of the firewall policy.
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
DryRun
— (Boolean
)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 toFALSE
, 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.EncryptionConfiguration
— (map
)A complex type that contains settings for encryption of your firewall policy resources.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.FirewallPolicyResponse
— (map
)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.
FirewallPolicyName
— required — (String
)The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
FirewallPolicyArn
— required — (String
)The Amazon Resource Name (ARN) of the firewall policy.
Note: If this response is for a create request that hadDryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource.FirewallPolicyId
— required — (String
)The unique identifier for the firewall policy.
Description
— (String
)A description of the firewall policy.
FirewallPolicyStatus
— (String
)The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ConsumedStatelessRuleCapacity
— (Integer
)The number of capacity units currently consumed by the policy's stateless rules.
ConsumedStatefulRuleCapacity
— (Integer
)The number of capacity units currently consumed by the policy's stateful rules.
NumberOfAssociations
— (Integer
)The number of firewalls that are associated with this firewall policy.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
LastModifiedTime
— (Date
)The last time that the firewall policy was changed.
-
(AWS.Response)
—
Returns:
createRuleGroup(params = {}, callback) ⇒ AWS.Request
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
.
Service Reference:
Examples:
Calling the createRuleGroup operation
var params = {
Capacity: 'NUMBER_VALUE', /* required */
RuleGroupName: 'STRING_VALUE', /* required */
Type: STATELESS | STATEFUL, /* required */
AnalyzeRuleGroup: true || false,
Description: 'STRING_VALUE',
DryRun: true || false,
EncryptionConfiguration: {
Type: CUSTOMER_KMS | AWS_OWNED_KMS_KEY, /* required */
KeyId: 'STRING_VALUE'
},
RuleGroup: {
RulesSource: { /* required */
RulesSourceList: {
GeneratedRulesType: ALLOWLIST | DENYLIST, /* required */
TargetTypes: [ /* required */
TLS_SNI | HTTP_HOST,
/* more items */
],
Targets: [ /* required */
'STRING_VALUE',
/* more items */
]
},
RulesString: 'STRING_VALUE',
StatefulRules: [
{
Action: PASS | DROP | ALERT | REJECT, /* required */
Header: { /* required */
Destination: 'STRING_VALUE', /* required */
DestinationPort: 'STRING_VALUE', /* required */
Direction: FORWARD | ANY, /* required */
Protocol: IP | TCP | UDP | ICMP | HTTP | FTP | TLS | SMB | DNS | DCERPC | SSH | SMTP | IMAP | MSN | KRB5 | IKEV2 | TFTP | NTP | DHCP, /* required */
Source: 'STRING_VALUE', /* required */
SourcePort: 'STRING_VALUE' /* required */
},
RuleOptions: [ /* required */
{
Keyword: 'STRING_VALUE', /* required */
Settings: [
'STRING_VALUE',
/* more items */
]
},
/* more items */
]
},
/* more items */
],
StatelessRulesAndCustomActions: {
StatelessRules: [ /* required */
{
Priority: 'NUMBER_VALUE', /* required */
RuleDefinition: { /* required */
Actions: [ /* required */
'STRING_VALUE',
/* more items */
],
MatchAttributes: { /* required */
DestinationPorts: [
{
FromPort: 'NUMBER_VALUE', /* required */
ToPort: 'NUMBER_VALUE' /* required */
},
/* more items */
],
Destinations: [
{
AddressDefinition: 'STRING_VALUE' /* required */
},
/* more items */
],
Protocols: [
'NUMBER_VALUE',
/* more items */
],
SourcePorts: [
{
FromPort: 'NUMBER_VALUE', /* required */
ToPort: 'NUMBER_VALUE' /* required */
},
/* more items */
],
Sources: [
{
AddressDefinition: 'STRING_VALUE' /* required */
},
/* more items */
],
TCPFlags: [
{
Flags: [ /* required */
FIN | SYN | RST | PSH | ACK | URG | ECE | CWR,
/* more items */
],
Masks: [
FIN | SYN | RST | PSH | ACK | URG | ECE | CWR,
/* more items */
]
},
/* more items */
]
}
}
},
/* more items */
],
CustomActions: [
{
ActionDefinition: { /* required */
PublishMetricAction: {
Dimensions: [ /* required */
{
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
}
},
ActionName: 'STRING_VALUE' /* required */
},
/* more items */
]
}
},
ReferenceSets: {
IPSetReferences: {
'<IPSetReferenceName>': {
ReferenceArn: 'STRING_VALUE'
},
/* '<IPSetReferenceName>': ... */
}
},
RuleVariables: {
IPSets: {
'<RuleVariableName>': {
Definition: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* '<RuleVariableName>': ... */
},
PortSets: {
'<RuleVariableName>': {
Definition: [
'STRING_VALUE',
/* more items */
]
},
/* '<RuleVariableName>': ... */
}
},
StatefulRuleOptions: {
RuleOrder: DEFAULT_ACTION_ORDER | STRICT_ORDER
}
},
Rules: 'STRING_VALUE',
SourceMetadata: {
SourceArn: 'STRING_VALUE',
SourceUpdateToken: 'STRING_VALUE'
},
Tags: [
{
Key: 'STRING_VALUE', /* required */
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
};
networkfirewall.createRuleGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
RuleGroupName
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
RuleGroup
— (map
)An object that defines the rule group rules.
Note: You must provide either this rule group setting or aRules
setting, but not both.RuleVariables
— (map
)Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
IPSets
— (map<map>
)A list of IP addresses and address ranges, in CIDR notation.
Definition
— required — (Array<String>
)The list of IP addresses and address ranges, in CIDR notation.
PortSets
— (map<map>
)A list of port ranges.
Definition
— (Array<String>
)The set of port ranges.
ReferenceSets
— (map
)The list of a rule group's reference sets.
IPSetReferences
— (map<map>
)The list of IP set references.
ReferenceArn
— (String
)The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
RulesSource
— required — (map
)The stateful rules or stateless rules for the rule group.
RulesString
— (String
)Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.
These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.
Note: You can't use thepriority
keyword if theRuleOrder
option in StatefulRuleOptions is set toSTRICT_ORDER
.RulesSourceList
— (map
)Stateful inspection criteria for a domain list rule group.
Targets
— required — (Array<String>
)The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:
-
Explicit names. For example,
abc.example.com
matches only the domainabc.example.com
. -
Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
-
TargetTypes
— required — (Array<String>
)The protocols you want to inspect. Specify
TLS_SNI
forHTTPS
. SpecifyHTTP_HOST
forHTTP
. You can specify either or both.GeneratedRulesType
— required — (String
)Whether you want to allow or deny access to the domains in your target list.
Possible values include:"ALLOWLIST"
"DENYLIST"
StatefulRules
— (Array<map>
)An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata
Rules
format, see Rules Format.Action
— required — (String
)Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
The actions for a stateful rule are defined as follows:
-
PASS - Permits the packets to go to the intended destination.
-
DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
-
ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with
ALERT
action, verify in the logs that the rule is filtering as you want, then change the action toDROP
. -
REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
"PASS"
"DROP"
"ALERT"
"REJECT"
-
Header
— required — (map
)The stateful inspection criteria for this rule, used to inspect traffic flows.
Protocol
— required — (String
)The protocol to inspect for. To specify all, you can use
Possible values include:IP
, because all traffic on Amazon Web Services and on the internet is IP."IP"
"TCP"
"UDP"
"ICMP"
"HTTP"
"FTP"
"TLS"
"SMB"
"DNS"
"DCERPC"
"SSH"
"SMTP"
"IMAP"
"MSN"
"KRB5"
"IKEV2"
"TFTP"
"NTP"
"DHCP"
Source
— required — (String
)The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY
.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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePort
— required — (String
)The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.Direction
— required — (String
)The direction of traffic flow to inspect. If set to
Possible values include:ANY
, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set toFORWARD
, the inspection only matches traffic going from the source to the destination."FORWARD"
"ANY"
Destination
— required — (String
)The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY
.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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
DestinationPort
— required — (String
)The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
RuleOptions
— required — (Array<map>
)Additional options for the rule. These are the Suricata
RuleOptions
settings.Keyword
— required — (String
)The keyword for the Suricata compatible rule option. You must include a
sid
(signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.Settings
— (Array<String>
)The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the
Keyword
. For more information about the settings for specific options, see Rule options.
StatelessRulesAndCustomActions
— (map
)Stateless inspection criteria to be used in a stateless rule group.
StatelessRules
— required — (Array<map>
)Defines the set of stateless rules for use in a stateless rule group.
RuleDefinition
— required — (map
)Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
MatchAttributes
— required — (map
)Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.
Sources
— (Array<map>
)The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
Destinations
— (Array<map>
)The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePorts
— (Array<map>
)The source ports to inspect for. If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP).
You can specify individual ports, for example
1994
and you can specify port ranges, for example1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
DestinationPorts
— (Array<map>
)The destination ports to inspect for. If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP).
You can specify individual ports, for example
1994
and you can specify port ranges, for example1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
Protocols
— (Array<Integer>
)The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol.
TCPFlags
— (Array<map>
)The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).
Flags
— required — (Array<String>
)Used in conjunction with the
Masks
setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in theMasks
setting.For the flags that are specified in the masks setting, the following must be true for the packet to match:
-
The ones that are set in this flags setting must be set in the packet.
-
The ones that are not set in this flags setting must also not be set in the packet.
-
Masks
— (Array<String>
)The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
Actions
— required — (Array<String>
)The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
Note: Network Firewall only forwards a packet for stateful rule inspection if you specifyaws:forward_to_sfe
for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for the FirewallPolicy.For every rule, you must specify exactly one of the following standard actions.
-
aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
-
aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
-
aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this
Actions
setting. For information about the options, see CustomAction.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom
PublishMetrics
action that you've namedMyMetricsAction
, then you could specify the standard actionaws:pass
and the custom action with[“aws:pass”, “MyMetricsAction”]
.-
Priority
— required — (Integer
)Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group.
Each stateless rule group uses exactly one
StatelessRulesAndCustomActions
object, and eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
object.You can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on.
CustomActions
— (Array<map>
)Defines an array of individual custom action definitions that are available for use by the stateless rules in this
StatelessRulesAndCustomActions
specification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinitionActions
specification.ActionName
— required — (String
)The descriptive name of the custom action. You can't change the name of a custom action after you create it.
ActionDefinition
— required — (map
)The custom action associated with the action name.
PublishMetricAction
— (map
)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.
Dimensions
— required — (Array<map>
)Value
— required — (String
)The value to use in the custom metric dimension.
StatefulRuleOptions
— (map
)Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.
RuleOrder
— (String
)Indicates how to manage the order of the rule evaluation for the rule group.
Possible values include:DEFAULT_ACTION_ORDER
is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide."DEFAULT_ACTION_ORDER"
"STRICT_ORDER"
Rules
— (String
)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.
Note: You must provide either this rules setting or a populatedRuleGroup
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.
Type
— (String
)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.
Possible values include:"STATELESS"
"STATEFUL"
Description
— (String
)A description of the rule group.
Capacity
— (Integer
)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 toTRUE
.Note: 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.
-
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
DryRun
— (Boolean
)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 toFALSE
, 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.EncryptionConfiguration
— (map
)A complex type that contains settings for encryption of your rule group resources.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
SourceMetadata
— (map
)A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
SourceArn
— (String
)The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceUpdateToken
— (String
)The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.
AnalyzeRuleGroup
— (Boolean
)Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to
TRUE
, Network Firewall runs the analysis and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, setDryRun
toTRUE
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.RuleGroupResponse
— (map
)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.
RuleGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the rule group.
Note: If this response is for a create request that hadDryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource.RuleGroupName
— required — (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
RuleGroupId
— required — (String
)The unique identifier for the rule group.
Description
— (String
)A description of the rule group.
Type
— (String
)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.
Possible values include:"STATELESS"
"STATEFUL"
Capacity
— (Integer
)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 toTRUE
.RuleGroupStatus
— (String
)Detailed information about the current status of a rule group.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ConsumedCapacity
— (Integer
)The number of capacity units currently consumed by the rule group rules.
NumberOfAssociations
— (Integer
)The number of firewall policies that use this rule group.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
SourceMetadata
— (map
)A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.
SourceArn
— (String
)The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceUpdateToken
— (String
)The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.
SnsTopic
— (String
)The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..
LastModifiedTime
— (Date
)The last time that the rule group was changed.
AnalysisResults
— (Array<map>
)The list of analysis results for
AnalyzeRuleGroup
. If you setAnalyzeRuleGroup
toTRUE
in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.IdentifiedRuleIds
— (Array<String>
)The priority number of the stateless rules identified in the analysis.
IdentifiedType
— (String
)The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:
-
STATELESS_RULE_FORWARDING_ASYMMETRICALLY
Cause: One or more stateless rules with the action
pass
orforward
are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.
-
STATELESS_RULE_CONTAINS_TCP_FLAGS
Cause: At least one stateless rule with the action
pass
orforward
contains TCP flags that are inconsistent in the forward and return directions.To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:
-
Remove unnecessary TCP flag inspections from the rules.
-
If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example
SYN
andACK
flags used in a 3-way TCP handshake.
-
"STATELESS_RULE_FORWARDING_ASYMMETRICALLY"
"STATELESS_RULE_CONTAINS_TCP_FLAGS"
-
AnalysisDetail
— (String
)Provides analysis details for the identified rule.
-
(AWS.Response)
—
Returns:
createTLSInspectionConfiguration(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the createTLSInspectionConfiguration operation
var params = {
TLSInspectionConfiguration: { /* required */
ServerCertificateConfigurations: [
{
CertificateAuthorityArn: 'STRING_VALUE',
CheckCertificateRevocationStatus: {
RevokedStatusAction: PASS | DROP | REJECT,
UnknownStatusAction: PASS | DROP | REJECT
},
Scopes: [
{
DestinationPorts: [
{
FromPort: 'NUMBER_VALUE', /* required */
ToPort: 'NUMBER_VALUE' /* required */
},
/* more items */
],
Destinations: [
{
AddressDefinition: 'STRING_VALUE' /* required */
},
/* more items */
],
Protocols: [
'NUMBER_VALUE',
/* more items */
],
SourcePorts: [
{
FromPort: 'NUMBER_VALUE', /* required */
ToPort: 'NUMBER_VALUE' /* required */
},
/* more items */
],
Sources: [
{
AddressDefinition: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
],
ServerCertificates: [
{
ResourceArn: 'STRING_VALUE'
},
/* more items */
]
},
/* more items */
]
},
TLSInspectionConfigurationName: 'STRING_VALUE', /* required */
Description: 'STRING_VALUE',
EncryptionConfiguration: {
Type: CUSTOMER_KMS | AWS_OWNED_KMS_KEY, /* required */
KeyId: 'STRING_VALUE'
},
Tags: [
{
Key: 'STRING_VALUE', /* required */
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
};
networkfirewall.createTLSInspectionConfiguration(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
TLSInspectionConfigurationName
— (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfiguration
— (map
)The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
ServerCertificateConfigurations
— (Array<map>
)Lists the server certificate configurations that are associated with the TLS configuration.
ServerCertificates
— (Array<map>
)The list of server certificates to use for inbound SSL/TLS inspection.
ResourceArn
— (String
)The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection.
Scopes
— (Array<map>
)A list of scopes.
Sources
— (Array<map>
)The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
Destinations
— (Array<map>
)The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePorts
— (Array<map>
)The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.
You can specify individual ports, for example
1994
, and you can specify port ranges, such as1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
DestinationPorts
— (Array<map>
)The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.
You can specify individual ports, for example
1994
, and you can specify port ranges, such as1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
Protocols
— (Array<Integer>
)The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number (IANA). Network Firewall currently supports only TCP.
CertificateAuthorityArn
— (String
)The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
The following limitations apply:
-
You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
-
You can't use certificates issued by Private Certificate Authority.
For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
-
CheckCertificateRevocationStatus
— (map
)When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a
CertificateAuthorityArn
in ServerCertificateConfiguration.RevokedStatusAction
— (String
)Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status.
-
PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
-
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
-
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection.
REJECT
is available only for TCP traffic.
"PASS"
"DROP"
"REJECT"
-
UnknownStatusAction
— (String
)Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate.
-
PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
-
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
-
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection.
REJECT
is available only for TCP traffic.
"PASS"
"DROP"
"REJECT"
-
Description
— (String
)A description of the TLS inspection configuration.
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration
— (map
)A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException
. If this happens, retrieve the TLS inspection configuration 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.TLSInspectionConfigurationResponse
— (map
)The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
TLSInspectionConfigurationArn
— required — (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
TLSInspectionConfigurationName
— required — (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfigurationId
— required — (String
)A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
TLSInspectionConfigurationStatus
— (String
)Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Description
— (String
)A description of the TLS inspection configuration.
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
LastModifiedTime
— (Date
)The last time that the TLS inspection configuration was changed.
NumberOfAssociations
— (Integer
)The number of firewall policies that use this TLS inspection configuration.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Certificates
— (Array<map>
)A list of the certificates associated with the TLS inspection configuration.
CertificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
CertificateSerial
— (String
)The serial number of the certificate.
Status
— (String
)The status of the certificate.
StatusMessage
— (String
)Contains details about the certificate status, including information about certificate errors.
CertificateAuthority
— (map
)Contains metadata about an Certificate Manager certificate.
CertificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
CertificateSerial
— (String
)The serial number of the certificate.
Status
— (String
)The status of the certificate.
StatusMessage
— (String
)Contains details about the certificate status, including information about certificate errors.
-
(AWS.Response)
—
Returns:
deleteFirewall(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the deleteFirewall operation
var params = {
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE'
};
networkfirewall.deleteFirewall(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
FirewallName
— (String
)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.
FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Firewall
— (map
)The firewall defines the configuration settings for an Network Firewall firewall. These settings 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.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn
— required — (String
)The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId
— required — (String
)The unique identifier of the VPC where the firewall is in use.
SubnetMappings
— required — (Array<map>
)The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
SubnetId
— required — (String
)The unique identifier for the subnet.
IPAddressType
— (String
)The subnet's IP address type. You can't change the IP address type after you create the subnet.
Possible values include:"DUALSTACK"
"IPV4"
"IPV6"
DeleteProtection
— (Boolean
)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 toTRUE
.SubnetChangeProtection
— (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
.FirewallPolicyChangeProtection
— (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
.Description
— (String
)A description of the firewall.
FirewallId
— required — (String
)The unique identifier for the firewall.
Tags
— (Array<map>
)Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
FirewallStatus
— (map
)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.
Status
— required — (String
)The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it. This setting is
Possible values include:READY
only when theConfigurationSyncStateSummary
value isIN_SYNC
and theAttachment
Status
values for all of the configured subnets areREADY
."PROVISIONING"
"DELETING"
"READY"
ConfigurationSyncStateSummary
— required — (String
)The configuration sync state for the firewall. This summarizes the sync states reported in the
Config
settings for all of the Availability Zones where you have configured the firewall.When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This summary indicates whether the configuration changes have been applied everywhere.
This status must be
Possible values include:IN_SYNC
for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. TheStatus
setting indicates firewall readiness."PENDING"
"IN_SYNC"
"CAPACITY_CONSTRAINED"
SyncStates
— (map<map>
)The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you've configured a subnet. These objects provide details of the information that is summarized in the
ConfigurationSyncStateSummary
andStatus
, broken down by zone and configuration object.Attachment
— (map
)The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.
SubnetId
— (String
)The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId
— (String
)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.
Status
— (String
)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
Possible values include:Config
settings. When this value isREADY
, 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 exampleCREATING
orDELETING
."CREATING"
"DELETING"
"FAILED"
"ERROR"
"SCALING"
"READY"
StatusMessage
— (String
)If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A
FAILED
status indicates a non-recoverable state, and aERROR
status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
Config
— (map<map>
)The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.
SyncStatus
— (String
)Indicates whether this object is in sync with the version indicated in the update token.
Possible values include:"PENDING"
"IN_SYNC"
"CAPACITY_CONSTRAINED"
UpdateToken
— (String
)The current version of the object that is either in sync or pending synchronization.
CapacityUsageSummary
— (map
)Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs
— (map
)Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount
— (Integer
)The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount
— (Integer
)The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences
— (map<map>
)The list of the IP set references used by a firewall.
ResolvedCIDRCount
— (Integer
)Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call
AvailableCIDRCount
.
-
(AWS.Response)
—
Returns:
deleteFirewallPolicy(params = {}, callback) ⇒ AWS.Request
Deletes the specified FirewallPolicy.
Service Reference:
Examples:
Calling the deleteFirewallPolicy operation
var params = {
FirewallPolicyArn: 'STRING_VALUE',
FirewallPolicyName: 'STRING_VALUE'
};
networkfirewall.deleteFirewallPolicy(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
FirewallPolicyName
— (String
)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.
FirewallPolicyArn
— (String
)The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallPolicyResponse
— (map
)The object containing the definition of the FirewallPolicyResponse that you asked to delete.
FirewallPolicyName
— required — (String
)The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
FirewallPolicyArn
— required — (String
)The Amazon Resource Name (ARN) of the firewall policy.
Note: If this response is for a create request that hadDryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource.FirewallPolicyId
— required — (String
)The unique identifier for the firewall policy.
Description
— (String
)A description of the firewall policy.
FirewallPolicyStatus
— (String
)The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ConsumedStatelessRuleCapacity
— (Integer
)The number of capacity units currently consumed by the policy's stateless rules.
ConsumedStatefulRuleCapacity
— (Integer
)The number of capacity units currently consumed by the policy's stateful rules.
NumberOfAssociations
— (Integer
)The number of firewalls that are associated with this firewall policy.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
LastModifiedTime
— (Date
)The last time that the firewall policy was changed.
-
(AWS.Response)
—
Returns:
deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request
Deletes a resource policy that you created in a PutResourcePolicy request.
Service Reference:
Examples:
Calling the deleteResourcePolicy operation
var params = {
ResourceArn: 'STRING_VALUE' /* required */
};
networkfirewall.deleteResourcePolicy(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceArn
— (String
)The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteRuleGroup(params = {}, callback) ⇒ AWS.Request
Deletes the specified RuleGroup.
Service Reference:
Examples:
Calling the deleteRuleGroup operation
var params = {
RuleGroupArn: 'STRING_VALUE',
RuleGroupName: 'STRING_VALUE',
Type: STATELESS | STATEFUL
};
networkfirewall.deleteRuleGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
RuleGroupName
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
RuleGroupArn
— (String
)The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
Type
— (String
)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.
Note: This setting is required for requests that do not include thePossible values include:RuleGroupARN
."STATELESS"
"STATEFUL"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:RuleGroupResponse
— (map
)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.
RuleGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the rule group.
Note: If this response is for a create request that hadDryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource.RuleGroupName
— required — (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
RuleGroupId
— required — (String
)The unique identifier for the rule group.
Description
— (String
)A description of the rule group.
Type
— (String
)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.
Possible values include:"STATELESS"
"STATEFUL"
Capacity
— (Integer
)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 toTRUE
.RuleGroupStatus
— (String
)Detailed information about the current status of a rule group.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ConsumedCapacity
— (Integer
)The number of capacity units currently consumed by the rule group rules.
NumberOfAssociations
— (Integer
)The number of firewall policies that use this rule group.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
SourceMetadata
— (map
)A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.
SourceArn
— (String
)The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceUpdateToken
— (String
)The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.
SnsTopic
— (String
)The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..
LastModifiedTime
— (Date
)The last time that the rule group was changed.
AnalysisResults
— (Array<map>
)The list of analysis results for
AnalyzeRuleGroup
. If you setAnalyzeRuleGroup
toTRUE
in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.IdentifiedRuleIds
— (Array<String>
)The priority number of the stateless rules identified in the analysis.
IdentifiedType
— (String
)The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:
-
STATELESS_RULE_FORWARDING_ASYMMETRICALLY
Cause: One or more stateless rules with the action
pass
orforward
are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.
-
STATELESS_RULE_CONTAINS_TCP_FLAGS
Cause: At least one stateless rule with the action
pass
orforward
contains TCP flags that are inconsistent in the forward and return directions.To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:
-
Remove unnecessary TCP flag inspections from the rules.
-
If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example
SYN
andACK
flags used in a 3-way TCP handshake.
-
"STATELESS_RULE_FORWARDING_ASYMMETRICALLY"
"STATELESS_RULE_CONTAINS_TCP_FLAGS"
-
AnalysisDetail
— (String
)Provides analysis details for the identified rule.
-
(AWS.Response)
—
Returns:
deleteTLSInspectionConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes the specified TLSInspectionConfiguration.
Service Reference:
Examples:
Calling the deleteTLSInspectionConfiguration operation
var params = {
TLSInspectionConfigurationArn: 'STRING_VALUE',
TLSInspectionConfigurationName: 'STRING_VALUE'
};
networkfirewall.deleteTLSInspectionConfiguration(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
TLSInspectionConfigurationArn
— (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
You must specify the ARN or the name, and you can specify both.
TLSInspectionConfigurationName
— (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
You must specify the ARN or the name, and you can specify both.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:TLSInspectionConfigurationResponse
— (map
)The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
TLSInspectionConfigurationArn
— required — (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
TLSInspectionConfigurationName
— required — (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfigurationId
— required — (String
)A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
TLSInspectionConfigurationStatus
— (String
)Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Description
— (String
)A description of the TLS inspection configuration.
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
LastModifiedTime
— (Date
)The last time that the TLS inspection configuration was changed.
NumberOfAssociations
— (Integer
)The number of firewall policies that use this TLS inspection configuration.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Certificates
— (Array<map>
)A list of the certificates associated with the TLS inspection configuration.
CertificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
CertificateSerial
— (String
)The serial number of the certificate.
Status
— (String
)The status of the certificate.
StatusMessage
— (String
)Contains details about the certificate status, including information about certificate errors.
CertificateAuthority
— (map
)Contains metadata about an Certificate Manager certificate.
CertificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
CertificateSerial
— (String
)The serial number of the certificate.
Status
— (String
)The status of the certificate.
StatusMessage
— (String
)Contains details about the certificate status, including information about certificate errors.
-
(AWS.Response)
—
Returns:
describeFirewall(params = {}, callback) ⇒ AWS.Request
Returns the data objects for the specified firewall.
Service Reference:
Examples:
Calling the describeFirewall operation
var params = {
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE'
};
networkfirewall.describeFirewall(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
FirewallName
— (String
)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.
FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.Firewall
— (map
)The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn
— required — (String
)The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId
— required — (String
)The unique identifier of the VPC where the firewall is in use.
SubnetMappings
— required — (Array<map>
)The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
SubnetId
— required — (String
)The unique identifier for the subnet.
IPAddressType
— (String
)The subnet's IP address type. You can't change the IP address type after you create the subnet.
Possible values include:"DUALSTACK"
"IPV4"
"IPV6"
DeleteProtection
— (Boolean
)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 toTRUE
.SubnetChangeProtection
— (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
.FirewallPolicyChangeProtection
— (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
.Description
— (String
)A description of the firewall.
FirewallId
— required — (String
)The unique identifier for the firewall.
Tags
— (Array<map>
)Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
FirewallStatus
— (map
)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.
Status
— required — (String
)The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it. This setting is
Possible values include:READY
only when theConfigurationSyncStateSummary
value isIN_SYNC
and theAttachment
Status
values for all of the configured subnets areREADY
."PROVISIONING"
"DELETING"
"READY"
ConfigurationSyncStateSummary
— required — (String
)The configuration sync state for the firewall. This summarizes the sync states reported in the
Config
settings for all of the Availability Zones where you have configured the firewall.When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This summary indicates whether the configuration changes have been applied everywhere.
This status must be
Possible values include:IN_SYNC
for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. TheStatus
setting indicates firewall readiness."PENDING"
"IN_SYNC"
"CAPACITY_CONSTRAINED"
SyncStates
— (map<map>
)The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you've configured a subnet. These objects provide details of the information that is summarized in the
ConfigurationSyncStateSummary
andStatus
, broken down by zone and configuration object.Attachment
— (map
)The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.
SubnetId
— (String
)The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId
— (String
)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.
Status
— (String
)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
Possible values include:Config
settings. When this value isREADY
, 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 exampleCREATING
orDELETING
."CREATING"
"DELETING"
"FAILED"
"ERROR"
"SCALING"
"READY"
StatusMessage
— (String
)If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A
FAILED
status indicates a non-recoverable state, and aERROR
status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
Config
— (map<map>
)The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.
SyncStatus
— (String
)Indicates whether this object is in sync with the version indicated in the update token.
Possible values include:"PENDING"
"IN_SYNC"
"CAPACITY_CONSTRAINED"
UpdateToken
— (String
)The current version of the object that is either in sync or pending synchronization.
CapacityUsageSummary
— (map
)Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs
— (map
)Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount
— (Integer
)The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount
— (Integer
)The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences
— (map<map>
)The list of the IP set references used by a firewall.
ResolvedCIDRCount
— (Integer
)Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call
AvailableCIDRCount
.
-
(AWS.Response)
—
Returns:
describeFirewallPolicy(params = {}, callback) ⇒ AWS.Request
Returns the data objects for the specified firewall policy.
Service Reference:
Examples:
Calling the describeFirewallPolicy operation
var params = {
FirewallPolicyArn: 'STRING_VALUE',
FirewallPolicyName: 'STRING_VALUE'
};
networkfirewall.describeFirewallPolicy(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
FirewallPolicyName
— (String
)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.
FirewallPolicyArn
— (String
)The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.FirewallPolicyResponse
— (map
)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.
FirewallPolicyName
— required — (String
)The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
FirewallPolicyArn
— required — (String
)The Amazon Resource Name (ARN) of the firewall policy.
Note: If this response is for a create request that hadDryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource.FirewallPolicyId
— required — (String
)The unique identifier for the firewall policy.
Description
— (String
)A description of the firewall policy.
FirewallPolicyStatus
— (String
)The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ConsumedStatelessRuleCapacity
— (Integer
)The number of capacity units currently consumed by the policy's stateless rules.
ConsumedStatefulRuleCapacity
— (Integer
)The number of capacity units currently consumed by the policy's stateful rules.
NumberOfAssociations
— (Integer
)The number of firewalls that are associated with this firewall policy.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
LastModifiedTime
— (Date
)The last time that the firewall policy was changed.
FirewallPolicy
— (map
)The policy for the specified firewall policy.
StatelessRuleGroupReferences
— (Array<map>
)References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
ResourceArn
— required — (String
)The Amazon Resource Name (ARN) of the stateless rule group.
Priority
— required — (Integer
)An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
StatelessDefaultActions
— required — (Array<String>
)The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify
aws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws:forward_to_sfe
. In addition, you can specify custom actions that are compatible with your standard section choice.For example, you could specify
["aws:pass"]
or you could specify["aws:pass", “customActionName”]
. For information about compatibility, see the custom action descriptions under CustomAction.StatelessFragmentDefaultActions
— required — (Array<String>
)The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify
aws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws:forward_to_sfe
. In addition, you can specify custom actions that are compatible with your standard section choice.For example, you could specify
["aws:pass"]
or you could specify["aws:pass", “customActionName”]
. For information about compatibility, see the custom action descriptions under CustomAction.StatelessCustomActions
— (Array<map>
)The custom action definitions that are available for use in the firewall policy's
StatelessDefaultActions
setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.ActionName
— required — (String
)The descriptive name of the custom action. You can't change the name of a custom action after you create it.
ActionDefinition
— required — (map
)The custom action associated with the action name.
PublishMetricAction
— (map
)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.
Dimensions
— required — (Array<map>
)Value
— required — (String
)The value to use in the custom metric dimension.
StatefulRuleGroupReferences
— (Array<map>
)References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
ResourceArn
— required — (String
)The Amazon Resource Name (ARN) of the stateful rule group.
Priority
— (Integer
)An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the
STRICT_ORDER
rule order in the stateful engine options settings.Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.
Override
— (map
)The action that allows the policy owner to override the behavior of the rule group within a policy.
Action
— (String
)The action that changes the rule group from
Possible values include:DROP
toALERT
. This only applies to managed rule groups."DROP_TO_ALERT"
StatefulDefaultActions
— (Array<String>
)The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
Valid values of the stateful default action:
-
aws:drop_strict
-
aws:drop_established
-
aws:alert_strict
-
aws:alert_established
For more information, see Strict evaluation order in the Network Firewall Developer Guide.
-
StatefulEngineOptions
— (map
)Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.
RuleOrder
— (String
)Indicates how to manage the order of stateful rule evaluation for the policy.
Possible values include:STRICT_ORDER
is the default and recommended option. WithSTRICT_ORDER
, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don't match any rules. ChooseSTRICT_ORDER
to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order isPASS
, followed byDROP
,REJECT
, andALERT
actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide."DEFAULT_ACTION_ORDER"
"STRICT_ORDER"
StreamExceptionPolicy
— (String
)Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
-
DROP
- Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior. -
CONTINUE
- Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule todrop http
traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using aflow:stateless
rule would still match, as would theaws:drop_strict
default action. -
REJECT
- Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
"DROP"
"CONTINUE"
"REJECT"
-
TLSInspectionConfigurationArn
— (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
PolicyVariables
— (map
)Contains variables that you can use to override default Suricata settings in your firewall policy.
RuleVariables
— (map<map>
)The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata
HOME_NET
variable. If your firewall uses an inspection VPC, you might want to override theHOME_NET
variable with the CIDRs of your home networks. If you don't overrideHOME_NET
with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.Definition
— required — (Array<String>
)The list of IP addresses and address ranges, in CIDR notation.
-
(AWS.Response)
—
Returns:
describeLoggingConfiguration(params = {}, callback) ⇒ AWS.Request
Returns the logging configuration for the specified firewall.
Service Reference:
Examples:
Calling the describeLoggingConfiguration operation
var params = {
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE'
};
networkfirewall.describeLoggingConfiguration(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
LoggingConfiguration
— (map
)Defines how Network Firewall performs logging for a Firewall.
LogDestinationConfigs
— required — (Array<map>
)Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
LogType
— required — (String
)The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
-
ALERT
- Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule. -
FLOW
- Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group. -
TLS
- Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
"ALERT"
"FLOW"
"TLS"
-
LogDestinationType
— required — (String
)The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
Possible values include:"S3"
"CloudWatchLogs"
"KinesisDataFirehose"
LogDestination
— required — (map<String>
)The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
-
For an Amazon S3 bucket, provide the name of the bucket, with key
bucketName
, and optionally provide a prefix, with keyprefix
.The following example specifies an Amazon S3 bucket named
DOC-EXAMPLE-BUCKET
and the prefixalerts
:"LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }
-
For a CloudWatch log group, provide the name of the CloudWatch log group, with key
logGroup
. The following example specifies a log group namedalert-log-group
:"LogDestination": { "logGroup": "alert-log-group" }
-
For a Firehose delivery stream, provide the name of the delivery stream, with key
deliveryStream
. The following example specifies a delivery stream namedalert-delivery-stream
:"LogDestination": { "deliveryStream": "alert-delivery-stream" }
-
-
(AWS.Response)
—
Returns:
describeResourcePolicy(params = {}, callback) ⇒ AWS.Request
Retrieves a resource policy that you created in a PutResourcePolicy request.
Service Reference:
Examples:
Calling the describeResourcePolicy operation
var params = {
ResourceArn: 'STRING_VALUE' /* required */
};
networkfirewall.describeResourcePolicy(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceArn
— (String
)The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Policy
— (String
)The IAM policy for the resource.
-
(AWS.Response)
—
Returns:
describeRuleGroup(params = {}, callback) ⇒ AWS.Request
Returns the data objects for the specified rule group.
Service Reference:
Examples:
Calling the describeRuleGroup operation
var params = {
AnalyzeRuleGroup: true || false,
RuleGroupArn: 'STRING_VALUE',
RuleGroupName: 'STRING_VALUE',
Type: STATELESS | STATEFUL
};
networkfirewall.describeRuleGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
RuleGroupName
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
RuleGroupArn
— (String
)The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
Type
— (String
)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.
Note: This setting is required for requests that do not include thePossible values include:RuleGroupARN
."STATELESS"
"STATEFUL"
AnalyzeRuleGroup
— (Boolean
)Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to
TRUE
, Network Firewall runs the analysis.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.RuleGroup
— (map
)The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
RuleVariables
— (map
)Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
IPSets
— (map<map>
)A list of IP addresses and address ranges, in CIDR notation.
Definition
— required — (Array<String>
)The list of IP addresses and address ranges, in CIDR notation.
PortSets
— (map<map>
)A list of port ranges.
Definition
— (Array<String>
)The set of port ranges.
ReferenceSets
— (map
)The list of a rule group's reference sets.
IPSetReferences
— (map<map>
)The list of IP set references.
ReferenceArn
— (String
)The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
RulesSource
— required — (map
)The stateful rules or stateless rules for the rule group.
RulesString
— (String
)Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.
These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.
Note: You can't use thepriority
keyword if theRuleOrder
option in StatefulRuleOptions is set toSTRICT_ORDER
.RulesSourceList
— (map
)Stateful inspection criteria for a domain list rule group.
Targets
— required — (Array<String>
)The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:
-
Explicit names. For example,
abc.example.com
matches only the domainabc.example.com
. -
Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
-
TargetTypes
— required — (Array<String>
)The protocols you want to inspect. Specify
TLS_SNI
forHTTPS
. SpecifyHTTP_HOST
forHTTP
. You can specify either or both.GeneratedRulesType
— required — (String
)Whether you want to allow or deny access to the domains in your target list.
Possible values include:"ALLOWLIST"
"DENYLIST"
StatefulRules
— (Array<map>
)An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata
Rules
format, see Rules Format.Action
— required — (String
)Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
The actions for a stateful rule are defined as follows:
-
PASS - Permits the packets to go to the intended destination.
-
DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
-
ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with
ALERT
action, verify in the logs that the rule is filtering as you want, then change the action toDROP
. -
REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
"PASS"
"DROP"
"ALERT"
"REJECT"
-
Header
— required — (map
)The stateful inspection criteria for this rule, used to inspect traffic flows.
Protocol
— required — (String
)The protocol to inspect for. To specify all, you can use
Possible values include:IP
, because all traffic on Amazon Web Services and on the internet is IP."IP"
"TCP"
"UDP"
"ICMP"
"HTTP"
"FTP"
"TLS"
"SMB"
"DNS"
"DCERPC"
"SSH"
"SMTP"
"IMAP"
"MSN"
"KRB5"
"IKEV2"
"TFTP"
"NTP"
"DHCP"
Source
— required — (String
)The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY
.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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePort
— required — (String
)The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.Direction
— required — (String
)The direction of traffic flow to inspect. If set to
Possible values include:ANY
, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set toFORWARD
, the inspection only matches traffic going from the source to the destination."FORWARD"
"ANY"
Destination
— required — (String
)The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY
.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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
DestinationPort
— required — (String
)The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
RuleOptions
— required — (Array<map>
)Additional options for the rule. These are the Suricata
RuleOptions
settings.Keyword
— required — (String
)The keyword for the Suricata compatible rule option. You must include a
sid
(signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.Settings
— (Array<String>
)The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the
Keyword
. For more information about the settings for specific options, see Rule options.
StatelessRulesAndCustomActions
— (map
)Stateless inspection criteria to be used in a stateless rule group.
StatelessRules
— required — (Array<map>
)Defines the set of stateless rules for use in a stateless rule group.
RuleDefinition
— required — (map
)Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
MatchAttributes
— required — (map
)Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.
Sources
— (Array<map>
)The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
Destinations
— (Array<map>
)The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePorts
— (Array<map>
)The source ports to inspect for. If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP).
You can specify individual ports, for example
1994
and you can specify port ranges, for example1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
DestinationPorts
— (Array<map>
)The destination ports to inspect for. If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP).
You can specify individual ports, for example
1994
and you can specify port ranges, for example1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
Protocols
— (Array<Integer>
)The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol.
TCPFlags
— (Array<map>
)The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).
Flags
— required — (Array<String>
)Used in conjunction with the
Masks
setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in theMasks
setting.For the flags that are specified in the masks setting, the following must be true for the packet to match:
-
The ones that are set in this flags setting must be set in the packet.
-
The ones that are not set in this flags setting must also not be set in the packet.
-
Masks
— (Array<String>
)The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
Actions
— required — (Array<String>
)The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
Note: Network Firewall only forwards a packet for stateful rule inspection if you specifyaws:forward_to_sfe
for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for the FirewallPolicy.For every rule, you must specify exactly one of the following standard actions.
-
aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
-
aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
-
aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this
Actions
setting. For information about the options, see CustomAction.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom
PublishMetrics
action that you've namedMyMetricsAction
, then you could specify the standard actionaws:pass
and the custom action with[“aws:pass”, “MyMetricsAction”]
.-
Priority
— required — (Integer
)Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group.
Each stateless rule group uses exactly one
StatelessRulesAndCustomActions
object, and eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
object.You can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on.
CustomActions
— (Array<map>
)Defines an array of individual custom action definitions that are available for use by the stateless rules in this
StatelessRulesAndCustomActions
specification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinitionActions
specification.ActionName
— required — (String
)The descriptive name of the custom action. You can't change the name of a custom action after you create it.
ActionDefinition
— required — (map
)The custom action associated with the action name.
PublishMetricAction
— (map
)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.
Dimensions
— required — (Array<map>
)Value
— required — (String
)The value to use in the custom metric dimension.
StatefulRuleOptions
— (map
)Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.
RuleOrder
— (String
)Indicates how to manage the order of the rule evaluation for the rule group.
Possible values include:DEFAULT_ACTION_ORDER
is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide."DEFAULT_ACTION_ORDER"
"STRICT_ORDER"
RuleGroupResponse
— (map
)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.
RuleGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the rule group.
Note: If this response is for a create request that hadDryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource.RuleGroupName
— required — (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
RuleGroupId
— required — (String
)The unique identifier for the rule group.
Description
— (String
)A description of the rule group.
Type
— (String
)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.
Possible values include:"STATELESS"
"STATEFUL"
Capacity
— (Integer
)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 toTRUE
.RuleGroupStatus
— (String
)Detailed information about the current status of a rule group.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ConsumedCapacity
— (Integer
)The number of capacity units currently consumed by the rule group rules.
NumberOfAssociations
— (Integer
)The number of firewall policies that use this rule group.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
SourceMetadata
— (map
)A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.
SourceArn
— (String
)The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceUpdateToken
— (String
)The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.
SnsTopic
— (String
)The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..
LastModifiedTime
— (Date
)The last time that the rule group was changed.
AnalysisResults
— (Array<map>
)The list of analysis results for
AnalyzeRuleGroup
. If you setAnalyzeRuleGroup
toTRUE
in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.IdentifiedRuleIds
— (Array<String>
)The priority number of the stateless rules identified in the analysis.
IdentifiedType
— (String
)The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:
-
STATELESS_RULE_FORWARDING_ASYMMETRICALLY
Cause: One or more stateless rules with the action
pass
orforward
are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.
-
STATELESS_RULE_CONTAINS_TCP_FLAGS
Cause: At least one stateless rule with the action
pass
orforward
contains TCP flags that are inconsistent in the forward and return directions.To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:
-
Remove unnecessary TCP flag inspections from the rules.
-
If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example
SYN
andACK
flags used in a 3-way TCP handshake.
-
"STATELESS_RULE_FORWARDING_ASYMMETRICALLY"
"STATELESS_RULE_CONTAINS_TCP_FLAGS"
-
AnalysisDetail
— (String
)Provides analysis details for the identified rule.
-
(AWS.Response)
—
Returns:
describeRuleGroupMetadata(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the describeRuleGroupMetadata operation
var params = {
RuleGroupArn: 'STRING_VALUE',
RuleGroupName: 'STRING_VALUE',
Type: STATELESS | STATEFUL
};
networkfirewall.describeRuleGroupMetadata(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
RuleGroupName
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
RuleGroupArn
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
Type
— (String
)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.
Note: This setting is required for requests that do not include thePossible values include:RuleGroupARN
."STATELESS"
"STATEFUL"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:RuleGroupArn
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
RuleGroupName
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
Description
— (String
)Returns the metadata objects for the specified rule group.
Type
— (String
)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.
Note: This setting is required for requests that do not include thePossible values include:RuleGroupARN
."STATELESS"
"STATEFUL"
Capacity
— (Integer
)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 toTRUE
.StatefulRuleOptions
— (map
)Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.
RuleOrder
— (String
)Indicates how to manage the order of the rule evaluation for the rule group.
Possible values include:DEFAULT_ACTION_ORDER
is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide."DEFAULT_ACTION_ORDER"
"STRICT_ORDER"
LastModifiedTime
— (Date
)The last time that the rule group was changed.
-
(AWS.Response)
—
Returns:
describeTLSInspectionConfiguration(params = {}, callback) ⇒ AWS.Request
Returns the data objects for the specified TLS inspection configuration.
Service Reference:
Examples:
Calling the describeTLSInspectionConfiguration operation
var params = {
TLSInspectionConfigurationArn: 'STRING_VALUE',
TLSInspectionConfigurationName: 'STRING_VALUE'
};
networkfirewall.describeTLSInspectionConfiguration(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
TLSInspectionConfigurationArn
— (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
You must specify the ARN or the name, and you can specify both.
TLSInspectionConfigurationName
— (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
You must specify the ARN or the name, and you can specify both.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException
. If this happens, retrieve the TLS inspection configuration 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.TLSInspectionConfiguration
— (map
)The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
ServerCertificateConfigurations
— (Array<map>
)Lists the server certificate configurations that are associated with the TLS configuration.
ServerCertificates
— (Array<map>
)The list of server certificates to use for inbound SSL/TLS inspection.
ResourceArn
— (String
)The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection.
Scopes
— (Array<map>
)A list of scopes.
Sources
— (Array<map>
)The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
Destinations
— (Array<map>
)The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePorts
— (Array<map>
)The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.
You can specify individual ports, for example
1994
, and you can specify port ranges, such as1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
DestinationPorts
— (Array<map>
)The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.
You can specify individual ports, for example
1994
, and you can specify port ranges, such as1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
Protocols
— (Array<Integer>
)The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number (IANA). Network Firewall currently supports only TCP.
CertificateAuthorityArn
— (String
)The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
The following limitations apply:
-
You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
-
You can't use certificates issued by Private Certificate Authority.
For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
-
CheckCertificateRevocationStatus
— (map
)When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a
CertificateAuthorityArn
in ServerCertificateConfiguration.RevokedStatusAction
— (String
)Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status.
-
PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
-
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
-
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection.
REJECT
is available only for TCP traffic.
"PASS"
"DROP"
"REJECT"
-
UnknownStatusAction
— (String
)Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate.
-
PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
-
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
-
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection.
REJECT
is available only for TCP traffic.
"PASS"
"DROP"
"REJECT"
-
TLSInspectionConfigurationResponse
— (map
)The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
TLSInspectionConfigurationArn
— required — (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
TLSInspectionConfigurationName
— required — (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfigurationId
— required — (String
)A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
TLSInspectionConfigurationStatus
— (String
)Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Description
— (String
)A description of the TLS inspection configuration.
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
LastModifiedTime
— (Date
)The last time that the TLS inspection configuration was changed.
NumberOfAssociations
— (Integer
)The number of firewall policies that use this TLS inspection configuration.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Certificates
— (Array<map>
)A list of the certificates associated with the TLS inspection configuration.
CertificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
CertificateSerial
— (String
)The serial number of the certificate.
Status
— (String
)The status of the certificate.
StatusMessage
— (String
)Contains details about the certificate status, including information about certificate errors.
CertificateAuthority
— (map
)Contains metadata about an Certificate Manager certificate.
CertificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
CertificateSerial
— (String
)The serial number of the certificate.
Status
— (String
)The status of the certificate.
StatusMessage
— (String
)Contains details about the certificate status, including information about certificate errors.
-
(AWS.Response)
—
Returns:
disassociateSubnets(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the disassociateSubnets operation
var params = {
SubnetIds: [ /* required */
'STRING_VALUE',
/* more items */
],
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
UpdateToken: 'STRING_VALUE'
};
networkfirewall.disassociateSubnets(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
SubnetIds
— (Array<String>
)The unique identifiers for the subnets that you want to disassociate.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
SubnetMappings
— (Array<map>
)The IDs of the subnets that are associated with the firewall.
SubnetId
— required — (String
)The unique identifier for the subnet.
IPAddressType
— (String
)The subnet's IP address type. You can't change the IP address type after you create the subnet.
Possible values include:"DUALSTACK"
"IPV4"
"IPV6"
UpdateToken
— (String
)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.
-
(AWS.Response)
—
Returns:
listFirewallPolicies(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the listFirewallPolicies operation
var params = {
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
networkfirewall.listFirewallPolicies(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.MaxResults
— (Integer
)The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a
NextToken
value that you can use in a subsequent call to get the next batch of objects.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.FirewallPolicies
— (Array<map>
)The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.
Name
— (String
)The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
Arn
— (String
)The Amazon Resource Name (ARN) of the firewall policy.
-
(AWS.Response)
—
Returns:
listFirewalls(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the listFirewalls operation
var params = {
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE',
VpcIds: [
'STRING_VALUE',
/* more items */
]
};
networkfirewall.listFirewalls(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.VpcIds
— (Array<String>
)The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.
MaxResults
— (Integer
)The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a
NextToken
value that you can use in a subsequent call to get the next batch of objects.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.Firewalls
— (Array<map>
)The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
-
(AWS.Response)
—
Returns:
listRuleGroups(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the listRuleGroups operation
var params = {
ManagedType: AWS_MANAGED_THREAT_SIGNATURES | AWS_MANAGED_DOMAIN_LISTS,
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE',
Scope: MANAGED | ACCOUNT,
Type: STATELESS | STATEFUL
};
networkfirewall.listRuleGroups(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.MaxResults
— (Integer
)The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a
NextToken
value that you can use in a subsequent call to get the next batch of objects.Scope
— (String
)The scope of the request. The default setting of
Possible values include:ACCOUNT
or a setting ofNULL
returns all of the rule groups in your account. A setting ofMANAGED
returns all available managed rule groups."MANAGED"
"ACCOUNT"
ManagedType
— (String
)Indicates the general category of the Amazon Web Services managed rule group.
Possible values include:"AWS_MANAGED_THREAT_SIGNATURES"
"AWS_MANAGED_DOMAIN_LISTS"
Type
— (String
)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.
Possible values include:"STATELESS"
"STATEFUL"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.RuleGroups
— (Array<map>
)The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.
Name
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
Arn
— (String
)The Amazon Resource Name (ARN) of the rule group.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the listTagsForResource operation
var params = {
ResourceArn: 'STRING_VALUE', /* required */
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
networkfirewall.listTagsForResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.MaxResults
— (Integer
)The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a
NextToken
value that you can use in a subsequent call to get the next batch of objects.ResourceArn
— (String
)The Amazon Resource Name (ARN) of the resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.Tags
— (Array<map>
)The tags that are associated with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
-
(AWS.Response)
—
Returns:
listTLSInspectionConfigurations(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the listTLSInspectionConfigurations operation
var params = {
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
networkfirewall.listTLSInspectionConfigurations(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.MaxResults
— (Integer
)The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a
NextToken
value that you can use in a subsequent call to get the next batch of objects.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:NextToken
— (String
)When you request a list of objects with a
MaxResults
setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.TLSInspectionConfigurations
— (Array<map>
)The TLS inspection configuration metadata objects that you've defined. Depending on your setting for max results and the number of TLS inspection configurations, this might not be the full list.
Name
— (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
Arn
— (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
-
(AWS.Response)
—
Returns:
putResourcePolicy(params = {}, callback) ⇒ AWS.Request
Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.
When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.
-
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
-
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
Service Reference:
Examples:
Calling the putResourcePolicy operation
var params = {
Policy: 'STRING_VALUE', /* required */
ResourceArn: 'STRING_VALUE' /* required */
};
networkfirewall.putResourcePolicy(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceArn
— (String
)The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with.
Policy
— (String
)The IAM policy statement that lists the accounts that you want to share your rule group or firewall policy with and the operations that you want the accounts to be able to perform.
For a rule group resource, you can specify the following operations in the Actions section of the statement:
-
network-firewall:CreateFirewallPolicy
-
network-firewall:UpdateFirewallPolicy
-
network-firewall:ListRuleGroups
For a firewall policy resource, you can specify the following operations in the Actions section of the statement:
-
network-firewall:AssociateFirewallPolicy
-
network-firewall:ListFirewallPolicies
In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in
Arn
.-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the tagResource operation
var params = {
ResourceArn: 'STRING_VALUE', /* required */
Tags: [ /* required */
{
Key: 'STRING_VALUE', /* required */
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
};
networkfirewall.tagResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceArn
— (String
)The Amazon Resource Name (ARN) of the resource.
Tags
— (Array<map>
)Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the untagResource operation
var params = {
ResourceArn: 'STRING_VALUE', /* required */
TagKeys: [ /* required */
'STRING_VALUE',
/* more items */
]
};
networkfirewall.untagResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceArn
— (String
)The Amazon Resource Name (ARN) of the resource.
TagKeys
— (Array<String>
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateFirewallDeleteProtection(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the updateFirewallDeleteProtection operation
var params = {
DeleteProtection: true || false, /* required */
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
UpdateToken: 'STRING_VALUE'
};
networkfirewall.updateFirewallDeleteProtection(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
DeleteProtection
— (Boolean
)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 toTRUE
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
DeleteProtection
— (Boolean
)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 toTRUE
.UpdateToken
— (String
)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.
-
(AWS.Response)
—
Returns:
updateFirewallDescription(params = {}, callback) ⇒ AWS.Request
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
Service Reference:
Examples:
Calling the updateFirewallDescription operation
var params = {
Description: 'STRING_VALUE',
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
UpdateToken: 'STRING_VALUE'
};
networkfirewall.updateFirewallDescription(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
Description
— (String
)The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
Description
— (String
)A description of the firewall.
UpdateToken
— (String
)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.
-
(AWS.Response)
—
Returns:
updateFirewallEncryptionConfiguration(params = {}, callback) ⇒ AWS.Request
A complex type that contains settings for encryption of your firewall resources.
Service Reference:
Examples:
Calling the updateFirewallEncryptionConfiguration operation
var params = {
EncryptionConfiguration: {
Type: CUSTOMER_KMS | AWS_OWNED_KMS_KEY, /* required */
KeyId: 'STRING_VALUE'
},
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
UpdateToken: 'STRING_VALUE'
};
networkfirewall.updateFirewallEncryptionConfiguration(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
EncryptionConfiguration
— (map
)A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
UpdateToken
— (String
)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.EncryptionConfiguration
— (map
)A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
-
(AWS.Response)
—
Returns:
updateFirewallPolicy(params = {}, callback) ⇒ AWS.Request
Updates the properties of the specified firewall policy.
Service Reference:
Examples:
Calling the updateFirewallPolicy operation
var params = {
FirewallPolicy: { /* required */
StatelessDefaultActions: [ /* required */
'STRING_VALUE',
/* more items */
],
StatelessFragmentDefaultActions: [ /* required */
'STRING_VALUE',
/* more items */
],
PolicyVariables: {
RuleVariables: {
'<RuleVariableName>': {
Definition: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* '<RuleVariableName>': ... */
}
},
StatefulDefaultActions: [
'STRING_VALUE',
/* more items */
],
StatefulEngineOptions: {
RuleOrder: DEFAULT_ACTION_ORDER | STRICT_ORDER,
StreamExceptionPolicy: DROP | CONTINUE | REJECT
},
StatefulRuleGroupReferences: [
{
ResourceArn: 'STRING_VALUE', /* required */
Override: {
Action: DROP_TO_ALERT
},
Priority: 'NUMBER_VALUE'
},
/* more items */
],
StatelessCustomActions: [
{
ActionDefinition: { /* required */
PublishMetricAction: {
Dimensions: [ /* required */
{
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
}
},
ActionName: 'STRING_VALUE' /* required */
},
/* more items */
],
StatelessRuleGroupReferences: [
{
Priority: 'NUMBER_VALUE', /* required */
ResourceArn: 'STRING_VALUE' /* required */
},
/* more items */
],
TLSInspectionConfigurationArn: 'STRING_VALUE'
},
UpdateToken: 'STRING_VALUE', /* required */
Description: 'STRING_VALUE',
DryRun: true || false,
EncryptionConfiguration: {
Type: CUSTOMER_KMS | AWS_OWNED_KMS_KEY, /* required */
KeyId: 'STRING_VALUE'
},
FirewallPolicyArn: 'STRING_VALUE',
FirewallPolicyName: 'STRING_VALUE'
};
networkfirewall.updateFirewallPolicy(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallPolicyArn
— (String
)The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
FirewallPolicyName
— (String
)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.
FirewallPolicy
— (map
)The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another
TLSInspectionConfiguration
.StatelessRuleGroupReferences
— (Array<map>
)References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
ResourceArn
— required — (String
)The Amazon Resource Name (ARN) of the stateless rule group.
Priority
— required — (Integer
)An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
StatelessDefaultActions
— required — (Array<String>
)The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify
aws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws:forward_to_sfe
. In addition, you can specify custom actions that are compatible with your standard section choice.For example, you could specify
["aws:pass"]
or you could specify["aws:pass", “customActionName”]
. For information about compatibility, see the custom action descriptions under CustomAction.StatelessFragmentDefaultActions
— required — (Array<String>
)The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify
aws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws:forward_to_sfe
. In addition, you can specify custom actions that are compatible with your standard section choice.For example, you could specify
["aws:pass"]
or you could specify["aws:pass", “customActionName”]
. For information about compatibility, see the custom action descriptions under CustomAction.StatelessCustomActions
— (Array<map>
)The custom action definitions that are available for use in the firewall policy's
StatelessDefaultActions
setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.ActionName
— required — (String
)The descriptive name of the custom action. You can't change the name of a custom action after you create it.
ActionDefinition
— required — (map
)The custom action associated with the action name.
PublishMetricAction
— (map
)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.
Dimensions
— required — (Array<map>
)Value
— required — (String
)The value to use in the custom metric dimension.
StatefulRuleGroupReferences
— (Array<map>
)References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
ResourceArn
— required — (String
)The Amazon Resource Name (ARN) of the stateful rule group.
Priority
— (Integer
)An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the
STRICT_ORDER
rule order in the stateful engine options settings.Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.
Override
— (map
)The action that allows the policy owner to override the behavior of the rule group within a policy.
Action
— (String
)The action that changes the rule group from
Possible values include:DROP
toALERT
. This only applies to managed rule groups."DROP_TO_ALERT"
StatefulDefaultActions
— (Array<String>
)The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
Valid values of the stateful default action:
-
aws:drop_strict
-
aws:drop_established
-
aws:alert_strict
-
aws:alert_established
For more information, see Strict evaluation order in the Network Firewall Developer Guide.
-
StatefulEngineOptions
— (map
)Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.
RuleOrder
— (String
)Indicates how to manage the order of stateful rule evaluation for the policy.
Possible values include:STRICT_ORDER
is the default and recommended option. WithSTRICT_ORDER
, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don't match any rules. ChooseSTRICT_ORDER
to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order isPASS
, followed byDROP
,REJECT
, andALERT
actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide."DEFAULT_ACTION_ORDER"
"STRICT_ORDER"
StreamExceptionPolicy
— (String
)Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
-
DROP
- Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior. -
CONTINUE
- Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule todrop http
traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using aflow:stateless
rule would still match, as would theaws:drop_strict
default action. -
REJECT
- Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
"DROP"
"CONTINUE"
"REJECT"
-
TLSInspectionConfigurationArn
— (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
PolicyVariables
— (map
)Contains variables that you can use to override default Suricata settings in your firewall policy.
RuleVariables
— (map<map>
)The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata
HOME_NET
variable. If your firewall uses an inspection VPC, you might want to override theHOME_NET
variable with the CIDRs of your home networks. If you don't overrideHOME_NET
with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.Definition
— required — (Array<String>
)The list of IP addresses and address ranges, in CIDR notation.
Description
— (String
)A description of the firewall policy.
DryRun
— (Boolean
)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 toFALSE
, 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.EncryptionConfiguration
— (map
)A complex type that contains settings for encryption of your firewall policy resources.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.FirewallPolicyResponse
— (map
)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.
FirewallPolicyName
— required — (String
)The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
FirewallPolicyArn
— required — (String
)The Amazon Resource Name (ARN) of the firewall policy.
Note: If this response is for a create request that hadDryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource.FirewallPolicyId
— required — (String
)The unique identifier for the firewall policy.
Description
— (String
)A description of the firewall policy.
FirewallPolicyStatus
— (String
)The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ConsumedStatelessRuleCapacity
— (Integer
)The number of capacity units currently consumed by the policy's stateless rules.
ConsumedStatefulRuleCapacity
— (Integer
)The number of capacity units currently consumed by the policy's stateful rules.
NumberOfAssociations
— (Integer
)The number of firewalls that are associated with this firewall policy.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
LastModifiedTime
— (Date
)The last time that the firewall policy was changed.
-
(AWS.Response)
—
Returns:
updateFirewallPolicyChangeProtection(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the updateFirewallPolicyChangeProtection operation
var params = {
FirewallPolicyChangeProtection: true || false, /* required */
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
UpdateToken: 'STRING_VALUE'
};
networkfirewall.updateFirewallPolicyChangeProtection(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
FirewallPolicyChangeProtection
— (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
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallPolicyChangeProtection
— (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
.
-
(AWS.Response)
—
Returns:
updateLoggingConfiguration(params = {}, callback) ⇒ AWS.Request
Sets the logging configuration for the specified firewall.
To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.
You can perform only one of the following actions in any call to UpdateLoggingConfiguration
:
-
Create a new log destination object by adding a single
LogDestinationConfig
array element toLogDestinationConfigs
. -
Delete a log destination object by removing a single
LogDestinationConfig
array element fromLogDestinationConfigs
. -
Change the
LogDestination
setting in a singleLogDestinationConfig
array element.
You can't change the LogDestinationType
or LogType
in a LogDestinationConfig
. To change these settings, delete the existing LogDestinationConfig
object and create a new one, using two separate calls to this update operation.
Service Reference:
Examples:
Calling the updateLoggingConfiguration operation
var params = {
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
LoggingConfiguration: {
LogDestinationConfigs: [ /* required */
{
LogDestination: { /* required */
'<HashMapKey>': 'STRING_VALUE',
/* '<HashMapKey>': ... */
},
LogDestinationType: S3 | CloudWatchLogs | KinesisDataFirehose, /* required */
LogType: ALERT | FLOW | TLS /* required */
},
/* more items */
]
}
};
networkfirewall.updateLoggingConfiguration(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
LoggingConfiguration
— (map
)Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.
LogDestinationConfigs
— required — (Array<map>
)Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
LogType
— required — (String
)The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
-
ALERT
- Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule. -
FLOW
- Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group. -
TLS
- Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
"ALERT"
"FLOW"
"TLS"
-
LogDestinationType
— required — (String
)The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
Possible values include:"S3"
"CloudWatchLogs"
"KinesisDataFirehose"
LogDestination
— required — (map<String>
)The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
-
For an Amazon S3 bucket, provide the name of the bucket, with key
bucketName
, and optionally provide a prefix, with keyprefix
.The following example specifies an Amazon S3 bucket named
DOC-EXAMPLE-BUCKET
and the prefixalerts
:"LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }
-
For a CloudWatch log group, provide the name of the CloudWatch log group, with key
logGroup
. The following example specifies a log group namedalert-log-group
:"LogDestination": { "logGroup": "alert-log-group" }
-
For a Firehose delivery stream, provide the name of the delivery stream, with key
deliveryStream
. The following example specifies a delivery stream namedalert-delivery-stream
:"LogDestination": { "deliveryStream": "alert-delivery-stream" }
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
LoggingConfiguration
— (map
)Defines how Network Firewall performs logging for a Firewall.
LogDestinationConfigs
— required — (Array<map>
)Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
LogType
— required — (String
)The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
-
ALERT
- Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule. -
FLOW
- Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group. -
TLS
- Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
"ALERT"
"FLOW"
"TLS"
-
LogDestinationType
— required — (String
)The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
Possible values include:"S3"
"CloudWatchLogs"
"KinesisDataFirehose"
LogDestination
— required — (map<String>
)The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
-
For an Amazon S3 bucket, provide the name of the bucket, with key
bucketName
, and optionally provide a prefix, with keyprefix
.The following example specifies an Amazon S3 bucket named
DOC-EXAMPLE-BUCKET
and the prefixalerts
:"LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }
-
For a CloudWatch log group, provide the name of the CloudWatch log group, with key
logGroup
. The following example specifies a log group namedalert-log-group
:"LogDestination": { "logGroup": "alert-log-group" }
-
For a Firehose delivery stream, provide the name of the delivery stream, with key
deliveryStream
. The following example specifies a delivery stream namedalert-delivery-stream
:"LogDestination": { "deliveryStream": "alert-delivery-stream" }
-
-
(AWS.Response)
—
Returns:
updateRuleGroup(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the updateRuleGroup operation
var params = {
UpdateToken: 'STRING_VALUE', /* required */
AnalyzeRuleGroup: true || false,
Description: 'STRING_VALUE',
DryRun: true || false,
EncryptionConfiguration: {
Type: CUSTOMER_KMS | AWS_OWNED_KMS_KEY, /* required */
KeyId: 'STRING_VALUE'
},
RuleGroup: {
RulesSource: { /* required */
RulesSourceList: {
GeneratedRulesType: ALLOWLIST | DENYLIST, /* required */
TargetTypes: [ /* required */
TLS_SNI | HTTP_HOST,
/* more items */
],
Targets: [ /* required */
'STRING_VALUE',
/* more items */
]
},
RulesString: 'STRING_VALUE',
StatefulRules: [
{
Action: PASS | DROP | ALERT | REJECT, /* required */
Header: { /* required */
Destination: 'STRING_VALUE', /* required */
DestinationPort: 'STRING_VALUE', /* required */
Direction: FORWARD | ANY, /* required */
Protocol: IP | TCP | UDP | ICMP | HTTP | FTP | TLS | SMB | DNS | DCERPC | SSH | SMTP | IMAP | MSN | KRB5 | IKEV2 | TFTP | NTP | DHCP, /* required */
Source: 'STRING_VALUE', /* required */
SourcePort: 'STRING_VALUE' /* required */
},
RuleOptions: [ /* required */
{
Keyword: 'STRING_VALUE', /* required */
Settings: [
'STRING_VALUE',
/* more items */
]
},
/* more items */
]
},
/* more items */
],
StatelessRulesAndCustomActions: {
StatelessRules: [ /* required */
{
Priority: 'NUMBER_VALUE', /* required */
RuleDefinition: { /* required */
Actions: [ /* required */
'STRING_VALUE',
/* more items */
],
MatchAttributes: { /* required */
DestinationPorts: [
{
FromPort: 'NUMBER_VALUE', /* required */
ToPort: 'NUMBER_VALUE' /* required */
},
/* more items */
],
Destinations: [
{
AddressDefinition: 'STRING_VALUE' /* required */
},
/* more items */
],
Protocols: [
'NUMBER_VALUE',
/* more items */
],
SourcePorts: [
{
FromPort: 'NUMBER_VALUE', /* required */
ToPort: 'NUMBER_VALUE' /* required */
},
/* more items */
],
Sources: [
{
AddressDefinition: 'STRING_VALUE' /* required */
},
/* more items */
],
TCPFlags: [
{
Flags: [ /* required */
FIN | SYN | RST | PSH | ACK | URG | ECE | CWR,
/* more items */
],
Masks: [
FIN | SYN | RST | PSH | ACK | URG | ECE | CWR,
/* more items */
]
},
/* more items */
]
}
}
},
/* more items */
],
CustomActions: [
{
ActionDefinition: { /* required */
PublishMetricAction: {
Dimensions: [ /* required */
{
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
}
},
ActionName: 'STRING_VALUE' /* required */
},
/* more items */
]
}
},
ReferenceSets: {
IPSetReferences: {
'<IPSetReferenceName>': {
ReferenceArn: 'STRING_VALUE'
},
/* '<IPSetReferenceName>': ... */
}
},
RuleVariables: {
IPSets: {
'<RuleVariableName>': {
Definition: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* '<RuleVariableName>': ... */
},
PortSets: {
'<RuleVariableName>': {
Definition: [
'STRING_VALUE',
/* more items */
]
},
/* '<RuleVariableName>': ... */
}
},
StatefulRuleOptions: {
RuleOrder: DEFAULT_ACTION_ORDER | STRICT_ORDER
}
},
RuleGroupArn: 'STRING_VALUE',
RuleGroupName: 'STRING_VALUE',
Rules: 'STRING_VALUE',
SourceMetadata: {
SourceArn: 'STRING_VALUE',
SourceUpdateToken: 'STRING_VALUE'
},
Type: STATELESS | STATEFUL
};
networkfirewall.updateRuleGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.RuleGroupArn
— (String
)The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
RuleGroupName
— (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
RuleGroup
— (map
)An object that defines the rule group rules.
Note: You must provide either this rule group setting or aRules
setting, but not both.RuleVariables
— (map
)Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
IPSets
— (map<map>
)A list of IP addresses and address ranges, in CIDR notation.
Definition
— required — (Array<String>
)The list of IP addresses and address ranges, in CIDR notation.
PortSets
— (map<map>
)A list of port ranges.
Definition
— (Array<String>
)The set of port ranges.
ReferenceSets
— (map
)The list of a rule group's reference sets.
IPSetReferences
— (map<map>
)The list of IP set references.
ReferenceArn
— (String
)The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
RulesSource
— required — (map
)The stateful rules or stateless rules for the rule group.
RulesString
— (String
)Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.
These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.
Note: You can't use thepriority
keyword if theRuleOrder
option in StatefulRuleOptions is set toSTRICT_ORDER
.RulesSourceList
— (map
)Stateful inspection criteria for a domain list rule group.
Targets
— required — (Array<String>
)The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:
-
Explicit names. For example,
abc.example.com
matches only the domainabc.example.com
. -
Names that use a domain wildcard, which you indicate with an initial '
.
'. For example,.example.com
matchesexample.com
and matches all subdomains ofexample.com
, such asabc.example.com
andwww.example.com
.
-
TargetTypes
— required — (Array<String>
)The protocols you want to inspect. Specify
TLS_SNI
forHTTPS
. SpecifyHTTP_HOST
forHTTP
. You can specify either or both.GeneratedRulesType
— required — (String
)Whether you want to allow or deny access to the domains in your target list.
Possible values include:"ALLOWLIST"
"DENYLIST"
StatefulRules
— (Array<map>
)An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata
Rules
format, see Rules Format.Action
— required — (String
)Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
The actions for a stateful rule are defined as follows:
-
PASS - Permits the packets to go to the intended destination.
-
DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
-
ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with
ALERT
action, verify in the logs that the rule is filtering as you want, then change the action toDROP
. -
REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
"PASS"
"DROP"
"ALERT"
"REJECT"
-
Header
— required — (map
)The stateful inspection criteria for this rule, used to inspect traffic flows.
Protocol
— required — (String
)The protocol to inspect for. To specify all, you can use
Possible values include:IP
, because all traffic on Amazon Web Services and on the internet is IP."IP"
"TCP"
"UDP"
"ICMP"
"HTTP"
"FTP"
"TLS"
"SMB"
"DNS"
"DCERPC"
"SSH"
"SMTP"
"IMAP"
"MSN"
"KRB5"
"IKEV2"
"TFTP"
"NTP"
"DHCP"
Source
— required — (String
)The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY
.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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePort
— required — (String
)The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.Direction
— required — (String
)The direction of traffic flow to inspect. If set to
Possible values include:ANY
, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set toFORWARD
, the inspection only matches traffic going from the source to the destination."FORWARD"
"ANY"
Destination
— required — (String
)The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY
.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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
DestinationPort
— required — (String
)The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990:1994
. To match with any port, specifyANY
.
RuleOptions
— required — (Array<map>
)Additional options for the rule. These are the Suricata
RuleOptions
settings.Keyword
— required — (String
)The keyword for the Suricata compatible rule option. You must include a
sid
(signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.Settings
— (Array<String>
)The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the
Keyword
. For more information about the settings for specific options, see Rule options.
StatelessRulesAndCustomActions
— (map
)Stateless inspection criteria to be used in a stateless rule group.
StatelessRules
— required — (Array<map>
)Defines the set of stateless rules for use in a stateless rule group.
RuleDefinition
— required — (map
)Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
MatchAttributes
— required — (map
)Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.
Sources
— (Array<map>
)The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
Destinations
— (Array<map>
)The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePorts
— (Array<map>
)The source ports to inspect for. If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP).
You can specify individual ports, for example
1994
and you can specify port ranges, for example1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
DestinationPorts
— (Array<map>
)The destination ports to inspect for. If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP).
You can specify individual ports, for example
1994
and you can specify port ranges, for example1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
Protocols
— (Array<Integer>
)The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol.
TCPFlags
— (Array<map>
)The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).
Flags
— required — (Array<String>
)Used in conjunction with the
Masks
setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in theMasks
setting.For the flags that are specified in the masks setting, the following must be true for the packet to match:
-
The ones that are set in this flags setting must be set in the packet.
-
The ones that are not set in this flags setting must also not be set in the packet.
-
Masks
— (Array<String>
)The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
Actions
— required — (Array<String>
)The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
Note: Network Firewall only forwards a packet for stateful rule inspection if you specifyaws:forward_to_sfe
for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specifyaws:forward_to_sfe
for theStatelessDefaultActions
setting for the FirewallPolicy.For every rule, you must specify exactly one of the following standard actions.
-
aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
-
aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
-
aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this
Actions
setting. For information about the options, see CustomAction.To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom
PublishMetrics
action that you've namedMyMetricsAction
, then you could specify the standard actionaws:pass
and the custom action with[“aws:pass”, “MyMetricsAction”]
.-
Priority
— required — (Integer
)Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group.
Each stateless rule group uses exactly one
StatelessRulesAndCustomActions
object, and eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
object.You can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on.
CustomActions
— (Array<map>
)Defines an array of individual custom action definitions that are available for use by the stateless rules in this
StatelessRulesAndCustomActions
specification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinitionActions
specification.ActionName
— required — (String
)The descriptive name of the custom action. You can't change the name of a custom action after you create it.
ActionDefinition
— required — (map
)The custom action associated with the action name.
PublishMetricAction
— (map
)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.
Dimensions
— required — (Array<map>
)Value
— required — (String
)The value to use in the custom metric dimension.
StatefulRuleOptions
— (map
)Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.
RuleOrder
— (String
)Indicates how to manage the order of the rule evaluation for the rule group.
Possible values include:DEFAULT_ACTION_ORDER
is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide."DEFAULT_ACTION_ORDER"
"STRICT_ORDER"
Rules
— (String
)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.
Note: You must provide either this rules setting or a populatedRuleGroup
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.
Type
— (String
)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.
Note: This setting is required for requests that do not include thePossible values include:RuleGroupARN
."STATELESS"
"STATEFUL"
Description
— (String
)A description of the rule group.
DryRun
— (Boolean
)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 toFALSE
, 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.EncryptionConfiguration
— (map
)A complex type that contains settings for encryption of your rule group resources.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
SourceMetadata
— (map
)A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
SourceArn
— (String
)The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceUpdateToken
— (String
)The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.
AnalyzeRuleGroup
— (Boolean
)Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to
TRUE
, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, setDryRun
toTRUE
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.RuleGroupResponse
— (map
)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.
RuleGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the rule group.
Note: If this response is for a create request that hadDryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource.RuleGroupName
— required — (String
)The descriptive name of the rule group. You can't change the name of a rule group after you create it.
RuleGroupId
— required — (String
)The unique identifier for the rule group.
Description
— (String
)A description of the rule group.
Type
— (String
)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.
Possible values include:"STATELESS"
"STATEFUL"
Capacity
— (Integer
)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 toTRUE
.RuleGroupStatus
— (String
)Detailed information about the current status of a rule group.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
ConsumedCapacity
— (Integer
)The number of capacity units currently consumed by the rule group rules.
NumberOfAssociations
— (Integer
)The number of firewall policies that use this rule group.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
SourceMetadata
— (map
)A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.
SourceArn
— (String
)The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceUpdateToken
— (String
)The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.
SnsTopic
— (String
)The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..
LastModifiedTime
— (Date
)The last time that the rule group was changed.
AnalysisResults
— (Array<map>
)The list of analysis results for
AnalyzeRuleGroup
. If you setAnalyzeRuleGroup
toTRUE
in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.IdentifiedRuleIds
— (Array<String>
)The priority number of the stateless rules identified in the analysis.
IdentifiedType
— (String
)The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:
-
STATELESS_RULE_FORWARDING_ASYMMETRICALLY
Cause: One or more stateless rules with the action
pass
orforward
are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.
-
STATELESS_RULE_CONTAINS_TCP_FLAGS
Cause: At least one stateless rule with the action
pass
orforward
contains TCP flags that are inconsistent in the forward and return directions.To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:
-
Remove unnecessary TCP flag inspections from the rules.
-
If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example
SYN
andACK
flags used in a 3-way TCP handshake.
-
"STATELESS_RULE_FORWARDING_ASYMMETRICALLY"
"STATELESS_RULE_CONTAINS_TCP_FLAGS"
-
AnalysisDetail
— (String
)Provides analysis details for the identified rule.
-
(AWS.Response)
—
Returns:
updateSubnetChangeProtection(params = {}, callback) ⇒ AWS.Request
Service Reference:
Examples:
Calling the updateSubnetChangeProtection operation
var params = {
SubnetChangeProtection: true || false, /* required */
FirewallArn: 'STRING_VALUE',
FirewallName: 'STRING_VALUE',
UpdateToken: 'STRING_VALUE'
};
networkfirewall.updateSubnetChangeProtection(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName
— (String
)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.
SubnetChangeProtection
— (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
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)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.FirewallArn
— (String
)The Amazon Resource Name (ARN) of the firewall.
FirewallName
— (String
)The descriptive name of the firewall. You can't change the name of a firewall after you create it.
SubnetChangeProtection
— (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
.
-
(AWS.Response)
—
Returns:
updateTLSInspectionConfiguration(params = {}, callback) ⇒ AWS.Request
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.
Service Reference:
Examples:
Calling the updateTLSInspectionConfiguration operation
var params = {
TLSInspectionConfiguration: { /* required */
ServerCertificateConfigurations: [
{
CertificateAuthorityArn: 'STRING_VALUE',
CheckCertificateRevocationStatus: {
RevokedStatusAction: PASS | DROP | REJECT,
UnknownStatusAction: PASS | DROP | REJECT
},
Scopes: [
{
DestinationPorts: [
{
FromPort: 'NUMBER_VALUE', /* required */
ToPort: 'NUMBER_VALUE' /* required */
},
/* more items */
],
Destinations: [
{
AddressDefinition: 'STRING_VALUE' /* required */
},
/* more items */
],
Protocols: [
'NUMBER_VALUE',
/* more items */
],
SourcePorts: [
{
FromPort: 'NUMBER_VALUE', /* required */
ToPort: 'NUMBER_VALUE' /* required */
},
/* more items */
],
Sources: [
{
AddressDefinition: 'STRING_VALUE' /* required */
},
/* more items */
]
},
/* more items */
],
ServerCertificates: [
{
ResourceArn: 'STRING_VALUE'
},
/* more items */
]
},
/* more items */
]
},
UpdateToken: 'STRING_VALUE', /* required */
Description: 'STRING_VALUE',
EncryptionConfiguration: {
Type: CUSTOMER_KMS | AWS_OWNED_KMS_KEY, /* required */
KeyId: 'STRING_VALUE'
},
TLSInspectionConfigurationArn: 'STRING_VALUE',
TLSInspectionConfigurationName: 'STRING_VALUE'
};
networkfirewall.updateTLSInspectionConfiguration(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
TLSInspectionConfigurationArn
— (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
TLSInspectionConfigurationName
— (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfiguration
— (map
)The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
ServerCertificateConfigurations
— (Array<map>
)Lists the server certificate configurations that are associated with the TLS configuration.
ServerCertificates
— (Array<map>
)The list of server certificates to use for inbound SSL/TLS inspection.
ResourceArn
— (String
)The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection.
Scopes
— (Array<map>
)A list of scopes.
Sources
— (Array<map>
)The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
Destinations
— (Array<map>
)The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
AddressDefinition
— required — (String
)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 and IPv6.
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
. -
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
-
SourcePorts
— (Array<map>
)The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.
You can specify individual ports, for example
1994
, and you can specify port ranges, such as1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
DestinationPorts
— (Array<map>
)The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.
You can specify individual ports, for example
1994
, and you can specify port ranges, such as1990:1994
.FromPort
— required — (Integer
)The lower limit of the port range. This must be less than or equal to the
ToPort
specification.ToPort
— required — (Integer
)The upper limit of the port range. This must be greater than or equal to the
FromPort
specification.
Protocols
— (Array<Integer>
)The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number (IANA). Network Firewall currently supports only TCP.
CertificateAuthorityArn
— (String
)The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
The following limitations apply:
-
You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
-
You can't use certificates issued by Private Certificate Authority.
For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
-
CheckCertificateRevocationStatus
— (map
)When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a
CertificateAuthorityArn
in ServerCertificateConfiguration.RevokedStatusAction
— (String
)Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status.
-
PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
-
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
-
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection.
REJECT
is available only for TCP traffic.
"PASS"
"DROP"
"REJECT"
-
UnknownStatusAction
— (String
)Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate.
-
PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
-
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
-
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection.
REJECT
is available only for TCP traffic.
"PASS"
"DROP"
"REJECT"
-
Description
— (String
)A description of the TLS inspection configuration.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
UpdateToken
— (String
)A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException
. If this happens, retrieve the TLS inspection configuration 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.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpdateToken
— (String
)A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException
. If this happens, retrieve the TLS inspection configuration 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.TLSInspectionConfigurationResponse
— (map
)The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
TLSInspectionConfigurationArn
— required — (String
)The Amazon Resource Name (ARN) of the TLS inspection configuration.
TLSInspectionConfigurationName
— required — (String
)The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfigurationId
— required — (String
)A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
TLSInspectionConfigurationStatus
— (String
)Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
Possible values include:"ACTIVE"
"DELETING"
"ERROR"
Description
— (String
)A description of the TLS inspection configuration.
Tags
— (Array<map>
)The key:value pairs to associate with the resource.
Key
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value
— required — (String
)The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
LastModifiedTime
— (Date
)The last time that the TLS inspection configuration was changed.
NumberOfAssociations
— (Integer
)The number of firewall policies that use this TLS inspection configuration.
EncryptionConfiguration
— (map
)A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
KeyId
— (String
)The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type
— required — (String
)The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Possible values include:"CUSTOMER_KMS"
"AWS_OWNED_KMS_KEY"
Certificates
— (Array<map>
)A list of the certificates associated with the TLS inspection configuration.
CertificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
CertificateSerial
— (String
)The serial number of the certificate.
Status
— (String
)The status of the certificate.
StatusMessage
— (String
)Contains details about the certificate status, including information about certificate errors.
CertificateAuthority
— (map
)Contains metadata about an Certificate Manager certificate.
CertificateArn
— (String
)The Amazon Resource Name (ARN) of the certificate.
CertificateSerial
— (String
)The serial number of the certificate.
Status
— (String
)The status of the certificate.
StatusMessage
— (String
)Contains details about the certificate status, including information about certificate errors.
-
(AWS.Response)
—
Returns: