@propulsionworks/cloudformation 0.0.2 → 0.1.1

package/out/exports/resources.generated/aws-networkfirewall-firewallpolicy.d.ts

@@ -0,0 +1,302 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Use the `FirewallPolicy` to define the stateless and stateful network traffic filtering behavior for your `Firewall` . You can use one firewall policy for multiple firewalls.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html}
+ */
+export type NetworkFirewallFirewallPolicy = ResourceDefinitionWithAttributes<"AWS::NetworkFirewall::FirewallPolicy", NetworkFirewallFirewallPolicyProps, NetworkFirewallFirewallPolicyAttribs>;
+/**
+ * Use the `FirewallPolicy` to define the stateless and stateful network traffic filtering behavior for your `Firewall` . You can use one firewall policy for multiple firewalls.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html}
+ */
+export type NetworkFirewallFirewallPolicyProps = {
+    /**
+     * A description of the firewall policy.
+     * @minLength 1
+     * @maxLength 512
+     * @pattern ^.*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-description}
+     */
+    Description?: string | undefined;
+    /**
+     * The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy}
+     */
+    FirewallPolicy: FirewallPolicy;
+    /**
+     * The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicyname}
+     */
+    FirewallPolicyName: string;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-tags}
+     */
+    Tags?: Tag[] | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#aws-resource-networkfirewall-firewallpolicy-return-values}
+ */
+export type NetworkFirewallFirewallPolicyAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the `FirewallPolicy` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicyarn}
+     */
+    FirewallPolicyArn: string;
+    /**
+     * The unique ID of the `FirewallPolicy` resource.
+     * @minLength 36
+     * @maxLength 36
+     * @pattern ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicyid}
+     */
+    FirewallPolicyId: string;
+};
+/**
+ * A custom action to use in stateless rule actions settings.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-actiondefinition.html}
+ */
+export type ActionDefinition = {
+    /**
+     * Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.
+     *
+     * You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-actiondefinition.html#cfn-networkfirewall-firewallpolicy-actiondefinition-publishmetricaction}
+     */
+    PublishMetricAction?: PublishMetricAction | undefined;
+};
+/**
+ * An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify.
+ *
+ * You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.
+ *
+ * You can use custom actions in the following places:
+ *
+ * - In an `RuleGroup.StatelessRulesAndCustomActions` . The custom actions are available for use by name inside the `StatelessRulesAndCustomActions` where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes.
+ * - In an `FirewallPolicy` specification, in `StatelessCustomActions` . The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html}
+ */
+export type CustomAction = {
+    /**
+     * The custom action associated with the action name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html#cfn-networkfirewall-firewallpolicy-customaction-actiondefinition}
+     */
+    ActionDefinition: ActionDefinition;
+    /**
+     * The descriptive name of the custom action. You can't change the name of a custom action after you create it.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html#cfn-networkfirewall-firewallpolicy-customaction-actionname}
+     */
+    ActionName: string;
+};
+/**
+ * The value to use in an Amazon CloudWatch custom metric dimension. This is used in the `PublishMetrics` custom action. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
+ *
+ * AWS Network Firewall sets the dimension name to `CustomAction` and you provide the dimension value.
+ *
+ * For more information about CloudWatch custom metric dimensions, see [Publishing Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-dimension.html}
+ */
+export type Dimension = {
+    /**
+     * The value to use in the custom metric dimension.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9-_ ]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-dimension.html#cfn-networkfirewall-firewallpolicy-dimension-value}
+     */
+    Value: string;
+};
+/**
+ * The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html}
+ */
+export type FirewallPolicy = {
+    /**
+     * Contains variables that you can use to override default Suricata settings in your firewall policy.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-policyvariables}
+     */
+    PolicyVariables?: {
+        RuleVariables?: Record<string, IPSet> | undefined;
+    } | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefuldefaultactions}
+     */
+    StatefulDefaultActions?: string[] | undefined;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulengineoptions}
+     */
+    StatefulEngineOptions?: StatefulEngineOptions | undefined;
+    /**
+     * References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulrulegroupreferences}
+     */
+    StatefulRuleGroupReferences?: StatefulRuleGroupReference[] | undefined;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelesscustomactions}
+     */
+    StatelessCustomActions?: CustomAction[] | undefined;
+    /**
+     * 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` , or `aws: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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessdefaultactions}
+     */
+    StatelessDefaultActions: string[];
+    /**
+     * The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy. If you want non-matching fragmented packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe` .
+     *
+     * You must specify one of the standard actions: `aws:pass` , `aws:drop` , or `aws: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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessfragmentdefaultactions}
+     */
+    StatelessFragmentDefaultActions: string[];
+    /**
+     * References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessrulegroupreferences}
+     */
+    StatelessRuleGroupReferences?: StatelessRuleGroupReference[] | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the TLS inspection configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-tlsinspectionconfigurationarn}
+     */
+    TLSInspectionConfigurationArn?: string | undefined;
+};
+/**
+ * A list of IP addresses and address ranges, in CIDR notation. This is part of a `RuleVariables` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-ipset.html}
+ */
+export type IPSet = {
+    /**
+     * The list of IP addresses and address ranges, in CIDR notation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-ipset.html#cfn-networkfirewall-firewallpolicy-ipset-definition}
+     */
+    Definition?: string[] | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-overrideaction.html}
+ */
+export type OverrideAction = "DROP_TO_ALERT";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-publishmetricaction.html}
+ */
+export type PublishMetricAction = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-publishmetricaction.html#cfn-networkfirewall-firewallpolicy-publishmetricaction-dimensions}
+     */
+    Dimensions: Dimension[];
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-ruleorder.html}
+ */
+export type RuleOrder = "DEFAULT_ACTION_ORDER" | "STRICT_ORDER";
+/**
+ * Configuration settings for the handling of the stateful rule groups in a firewall policy.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html}
+ */
+export type StatefulEngineOptions = {
+    /**
+     * Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-flowtimeouts}
+     */
+    FlowTimeouts?: {
+        /**
+         * @min 60
+         * @max 6000
+         */
+        TcpIdleTimeoutSeconds?: number | undefined;
+    } | undefined;
+    /**
+     * Indicates how to manage the order of stateful rule evaluation for the policy. `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](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-ruleorder}
+     */
+    RuleOrder?: RuleOrder | undefined;
+    /**
+     * 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 to `drop 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 a `flow:stateless` rule would still match, as would the `aws: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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-streamexceptionpolicy}
+     */
+    StreamExceptionPolicy?: StreamExceptionPolicy | undefined;
+};
+/**
+ * The setting that allows the policy owner to change the behavior of the rule group within a policy.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html}
+ */
+export type StatefulRuleGroupOverride = {
+    /**
+     * The action that changes the rule group from `DROP` to `ALERT` . This only applies to managed rule groups.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupoverride-action}
+     */
+    Action?: OverrideAction | undefined;
+};
+/**
+ * Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html}
+ */
+export type StatefulRuleGroupReference = {
+    /**
+     * The action that allows the policy owner to override the behavior of the rule group within a policy.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-override}
+     */
+    Override?: StatefulRuleGroupOverride | undefined;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-priority}
+     */
+    Priority?: number | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the stateful rule group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-resourcearn}
+     */
+    ResourceArn: string;
+};
+/**
+ * Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html}
+ */
+export type StatelessRuleGroupReference = {
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-priority}
+     */
+    Priority: number;
+    /**
+     * The Amazon Resource Name (ARN) of the stateless rule group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-resourcearn}
+     */
+    ResourceArn: string;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-streamexceptionpolicy.html}
+ */
+export type StreamExceptionPolicy = "DROP" | "CONTINUE" | "REJECT";
+//# sourceMappingURL=aws-networkfirewall-firewallpolicy.d.ts.map

package/out/exports/resources.generated/aws-networkfirewall-loggingconfiguration.d.ts

@@ -0,0 +1,101 @@
+import type { ResourceDefinition } from "../main.ts";
+/**
+ * Use the `LoggingConfiguration` to define the destinations and logging options for an `Firewall` .
+ *
+ * You must change the logging configuration by changing one `LogDestinationConfig` setting at a time in your `LogDestinationConfigs` .
+ *
+ * You can make only one of the following changes to your `LoggingConfiguration` resource:
+ *
+ * - Create a new log destination object by adding a single `LogDestinationConfig` array element to `LogDestinationConfigs` .
+ * - Delete a log destination object by removing a single `LogDestinationConfig` array element from `LogDestinationConfigs` .
+ * - Change the `LogDestination` setting in a single `LogDestinationConfig` array element.
+ *
+ * You can't change the `LogDestinationType` or `LogType` in a `LogDestinationConfig` . To change these settings, delete the existing `LogDestinationConfig` object and create a new one, in two separate modifications.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html}
+ */
+export type NetworkFirewallLoggingConfiguration = ResourceDefinition<"AWS::NetworkFirewall::LoggingConfiguration", NetworkFirewallLoggingConfigurationProps>;
+/**
+ * Use the `LoggingConfiguration` to define the destinations and logging options for an `Firewall` .
+ *
+ * You must change the logging configuration by changing one `LogDestinationConfig` setting at a time in your `LogDestinationConfigs` .
+ *
+ * You can make only one of the following changes to your `LoggingConfiguration` resource:
+ *
+ * - Create a new log destination object by adding a single `LogDestinationConfig` array element to `LogDestinationConfigs` .
+ * - Delete a log destination object by removing a single `LogDestinationConfig` array element from `LogDestinationConfigs` .
+ * - Change the `LogDestination` setting in a single `LogDestinationConfig` array element.
+ *
+ * You can't change the `LogDestinationType` or `LogType` in a `LogDestinationConfig` . To change these settings, delete the existing `LogDestinationConfig` object and create a new one, in two separate modifications.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html}
+ */
+export type NetworkFirewallLoggingConfigurationProps = {
+    /**
+     * The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with. You can't change the firewall specification after you create the logging configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallarn}
+     */
+    FirewallArn: string;
+    /**
+     * The name of the firewall that the logging configuration is associated with. You can't change the firewall specification after you create the logging configuration.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallname}
+     */
+    FirewallName?: string | undefined;
+    /**
+     * Defines how AWS Network Firewall performs logging for a `Firewall` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration}
+     */
+    LoggingConfiguration: LoggingConfiguration;
+};
+/**
+ * Defines where AWS 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` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html}
+ */
+export type LogDestinationConfig = {
+    /**
+     * 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 key `prefix` .
+     *
+     * The following example specifies an Amazon S3 bucket named `DOC-EXAMPLE-BUCKET` and the prefix `alerts` :
+     *
+     * `"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 named `alert-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 named `alert-delivery-stream` :
+     *
+     * `"LogDestination": { "deliveryStream": "alert-delivery-stream" }`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logdestination}
+     */
+    LogDestination: Record<string, 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logdestinationtype}
+     */
+    LogDestinationType: "S3" | "CloudWatchLogs" | "KinesisDataFirehose";
+    /**
+     * 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 the `StatefulRule` property.
+     * - `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](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-configurations.html) in the *Network Firewall Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logtype}
+     */
+    LogType: "ALERT" | "FLOW" | "TLS";
+};
+/**
+ * Defines how AWS Network Firewall performs logging for a `Firewall` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-loggingconfiguration.html}
+ */
+export type LoggingConfiguration = {
+    /**
+     * Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration-logdestinationconfigs}
+     */
+    LogDestinationConfigs: LogDestinationConfig[];
+};
+//# sourceMappingURL=aws-networkfirewall-loggingconfiguration.d.ts.map