From ab0e00ecd3230b4b7ca8dd7eb1e2014972348c64 Mon Sep 17 00:00:00 2001
From: awstools Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains Certificate Manager certificate associations between and the scope configurations that Network Firewall uses to decrypt and re-encrypt traffic traveling through your firewall. After you create a TLS inspection configuration, you can associate it with a new firewall policy. 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. Stateful inspection criteria for a domain list rule group. For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake. By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET
rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.HOME_NET
rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and
+ * Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.ALERT
action, verify in the logs that the rule
* is filtering as you want, then change the action to DROP
.
+ * 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.
+ ** Capacity for a stateful rule group *
- *For - * a stateful rule group, the minimum capacity required is the number of individual rules that + *
For a stateful rule group, the minimum capacity required is the number of individual rules that * you expect to have in the rule group.
* @public */ @@ -3081,6 +3085,7 @@ export type LogDestinationType = (typeof LogDestinationType)[keyof typeof LogDes export const LogType = { ALERT: "ALERT", FLOW: "FLOW", + TLS: "TLS", } as const; /** @@ -3090,24 +3095,37 @@ export type LogType = (typeof LogType)[keyof typeof LogType]; /** *Defines where Network Firewall sends logs for the firewall for one log type. This is used - * in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
- *Network Firewall generates logs for stateful rule groups. You can save alert and flow log
- * types. The stateful rules engine records flow logs for all network traffic that it receives.
- * It records alert logs for traffic that matches stateful rules that have the rule
- * action set to DROP
or ALERT
.
Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log + * types.
* @public */ export interface LogDestinationConfig { /** - *The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are - * standard network traffic flow logs.
+ *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.
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 Kinesis Data Firehose delivery stream.
+ * a CloudWatch log group, or a Firehose delivery stream. * @public */ LogDestinationType: LogDestinationType | undefined; @@ -3118,9 +3136,8 @@ export interface LogDestinationConfig { *For an Amazon S3 bucket, provide the name of the bucket, with key bucketName
,
- * and optionally provide a prefix, with key prefix
. The following example
- * specifies an Amazon S3 bucket named
- * DOC-EXAMPLE-BUCKET
and the prefix alerts
:
prefix
.
+ * The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET
and the prefix alerts
:
* "LogDestination": \{ "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts"
* \}
@@ -3135,7 +3152,7 @@ export interface LogDestinationConfig {
*
For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key + *
For a Firehose delivery stream, provide the name of the delivery stream, with key
* deliveryStream
. The following example specifies a delivery stream
* named alert-delivery-stream
:
diff --git a/codegen/sdk-codegen/aws-models/network-firewall.json b/codegen/sdk-codegen/aws-models/network-firewall.json index 0bcf6825a7f1..2343b42bc6de 100644 --- a/codegen/sdk-codegen/aws-models/network-firewall.json +++ b/codegen/sdk-codegen/aws-models/network-firewall.json @@ -804,7 +804,7 @@ "Capacity": { "target": "com.amazonaws.networkfirewall#RuleCapacity", "traits": { - "smithy.api#documentation": "
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.\n When you update a rule group, you are limited to this capacity. When you reference a rule group\n from a firewall policy, Network Firewall reserves this capacity for the rule group.
\nYou can retrieve the capacity that would be required for a rule group before you create the rule group by calling\n CreateRuleGroup with DryRun
set to TRUE
.
You can't change or exceed this capacity when you update the rule group, so leave\n room for your rule group to grow.
\n\n Capacity for a stateless rule group\n
\nFor a stateless rule group, the capacity required is the sum of the capacity\n requirements of the individual rules that you expect to have in the rule group.
\nTo calculate the capacity requirement of a single rule, multiply the capacity\n requirement values of each of the rule's match settings:
\nA match setting with no criteria specified has a value of 1.
\nA 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\n the setting. For example, a protocol setting [\"UDP\"] and a source setting\n [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value\n 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.\n
\nA rule with no criteria specified in any of its match settings has a capacity\n requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting\n [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification\n for each of the other match settings has a capacity requirement of 6.
\n\n Capacity for a stateful rule group\n
\nFor\n a stateful rule group, the minimum capacity required is the number of individual rules that\n you expect to have in the rule group.
", + "smithy.api#documentation": "The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.\n When you update a rule group, you are limited to this capacity. When you reference a rule group\n from a firewall policy, Network Firewall reserves this capacity for the rule group.
\nYou can retrieve the capacity that would be required for a rule group before you create the rule group by calling\n CreateRuleGroup with DryRun
set to TRUE
.
You can't change or exceed this capacity when you update the rule group, so leave\n room for your rule group to grow.
\n\n Capacity for a stateless rule group\n
\nFor a stateless rule group, the capacity required is the sum of the capacity\n requirements of the individual rules that you expect to have in the rule group.
\nTo calculate the capacity requirement of a single rule, multiply the capacity\n requirement values of each of the rule's match settings:
\nA match setting with no criteria specified has a value of 1.
\nA 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\n the setting. For example, a protocol setting [\"UDP\"] and a source setting\n [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value\n 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.\n
\nA rule with no criteria specified in any of its match settings has a capacity\n requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting\n [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification\n for each of the other match settings has a capacity requirement of 6.
\n\n Capacity for a stateful rule group\n
\nFor a stateful rule group, the minimum capacity required is the number of individual rules that\n you expect to have in the rule group.
", "smithy.api#required": {} } }, @@ -893,7 +893,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains Certificate Manager certificate associations between and the scope configurations that Network Firewall uses to decrypt and re-encrypt traffic traveling through your firewall.
\nAfter you create a TLS inspection configuration, you can associate it with a new firewall policy.
\nTo update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.
\nTo manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
\nTo retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.
\n\n For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.\n
" + "smithy.api#documentation": "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.
\nTo update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.
\nTo manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
\nTo retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.
\n\n For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.\n
" } }, "com.amazonaws.networkfirewall#CreateTLSInspectionConfigurationRequest": { @@ -3073,27 +3073,27 @@ "LogType": { "target": "com.amazonaws.networkfirewall#LogType", "traits": { - "smithy.api#documentation": "The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are\n standard network traffic flow logs.
", + "smithy.api#documentation": "The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
\n\n 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.
\n 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.
\n TLS
- Logs for events that are related to TLS inspection. For more information, see \n Inspecting SSL/TLS traffic with TLS inspection configurations \n in the Network Firewall Developer Guide.
The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket,\n a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
", + "smithy.api#documentation": "The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket,\n a CloudWatch log group, or a Firehose delivery stream.
", "smithy.api#required": {} } }, "LogDestination": { "target": "com.amazonaws.networkfirewall#LogDestinationMap", "traits": { - "smithy.api#documentation": "The named location for the logs, provided in a key:value mapping that is specific to the\n chosen destination type.
\nFor an Amazon S3 bucket, provide the name of the bucket, with key bucketName
,\n and optionally provide a prefix, with key prefix
. The following example\n specifies an Amazon S3 bucket named\n DOC-EXAMPLE-BUCKET
and the prefix alerts
:
\n \"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\"\n }
\n
For a CloudWatch log group, provide the name of the CloudWatch log group, with key\n logGroup
. The following example specifies a log group named\n alert-log-group
:
\n \"LogDestination\": { \"logGroup\": \"alert-log-group\" }
\n
For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key\n deliveryStream
. The following example specifies a delivery stream\n named alert-delivery-stream
:
\n \"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\"\n }
\n
The named location for the logs, provided in a key:value mapping that is specific to the\n chosen destination type.
\nFor an Amazon S3 bucket, provide the name of the bucket, with key bucketName
,\n and optionally provide a prefix, with key prefix
.
The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET
and the prefix alerts
:
\n \"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\"\n }
\n
For a CloudWatch log group, provide the name of the CloudWatch log group, with key\n logGroup
. The following example specifies a log group named\n alert-log-group
:
\n \"LogDestination\": { \"logGroup\": \"alert-log-group\" }
\n
For a Firehose delivery stream, provide the name of the delivery stream, with key\n deliveryStream
. The following example specifies a delivery stream\n named alert-delivery-stream
:
\n \"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\"\n }
\n
Defines where Network Firewall sends logs for the firewall for one log type. This is used\n in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
\nNetwork Firewall generates logs for stateful rule groups. You can save alert and flow log\n types. The stateful rules engine records flow logs for all network traffic that it receives.\n It records alert logs for traffic that matches stateful rules that have the rule\n action set to DROP
or ALERT
.
Defines where Network Firewall sends logs for the firewall for one log type. This is used\n in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
\nNetwork Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log\n types.
" } }, "com.amazonaws.networkfirewall#LogDestinationConfigs": { @@ -3167,6 +3167,12 @@ "traits": { "smithy.api#enumValue": "FLOW" } + }, + "TLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TLS" + } } } }, @@ -5089,7 +5095,7 @@ } }, "traits": { - "smithy.api#documentation": "Stateful inspection criteria for a domain list rule group.
\nFor HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
\nBy default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET
rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.
Stateful inspection criteria for a domain list rule group.
\nFor HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
\nBy default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET
rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and \n Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.
Defines what Network Firewall should do with the packets in a traffic flow when the flow\n matches the stateful rule criteria. For all actions, Network Firewall performs the specified\n action and discontinues stateful inspection of the traffic flow.
\nThe actions for a stateful rule are defined as follows:
\n\n PASS - Permits the packets to go to the\n intended destination.
\n\n DROP - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\n\n ALERT - Sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\nYou can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with ALERT
action, verify in the logs that the rule\n is filtering as you want, then change the action to DROP
.
Defines what Network Firewall should do with the packets in a traffic flow when the flow\n matches the stateful rule criteria. For all actions, Network Firewall performs the specified\n action and discontinues stateful inspection of the traffic flow.
\nThe actions for a stateful rule are defined as follows:
\n\n PASS - Permits the packets to go to the\n intended destination.
\n\n DROP - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\n\n ALERT - Sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\nYou can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with ALERT
action, verify in the logs that the rule\n is filtering as you want, then change the action to DROP
.
\n 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.
\n