awsnetworkfirewall

package
v2.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 25, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnFirewallPolicy_CFN_RESOURCE_TYPE_NAME 

func CfnFirewallPolicy_CFN_RESOURCE_TYPE_NAME() *string

func CfnFirewallPolicy_IsCfnElement 

func CfnFirewallPolicy_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnFirewallPolicy_IsCfnResource 

func CfnFirewallPolicy_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFirewallPolicy_IsConstruct 

func CfnFirewallPolicy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnFirewall_CFN_RESOURCE_TYPE_NAME 

func CfnFirewall_CFN_RESOURCE_TYPE_NAME() *string

func CfnFirewall_IsCfnElement 

func CfnFirewall_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnFirewall_IsCfnResource 

func CfnFirewall_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFirewall_IsConstruct 

func CfnFirewall_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnLoggingConfiguration_CFN_RESOURCE_TYPE_NAME 

func CfnLoggingConfiguration_CFN_RESOURCE_TYPE_NAME() *string

func CfnLoggingConfiguration_IsCfnElement 

func CfnLoggingConfiguration_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnLoggingConfiguration_IsCfnResource 

func CfnLoggingConfiguration_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnLoggingConfiguration_IsConstruct 

func CfnLoggingConfiguration_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnRuleGroup_CFN_RESOURCE_TYPE_NAME 

func CfnRuleGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnRuleGroup_IsCfnElement 

func CfnRuleGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnRuleGroup_IsCfnResource 

func CfnRuleGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnRuleGroup_IsConstruct 

func CfnRuleGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnFirewallPolicy_Override 

func NewCfnFirewallPolicy_Override(c CfnFirewallPolicy, scope constructs.Construct, id *string, props *CfnFirewallPolicyProps)

Create a new `AWS::NetworkFirewall::FirewallPolicy`.

func NewCfnFirewall_Override 

func NewCfnFirewall_Override(c CfnFirewall, scope constructs.Construct, id *string, props *CfnFirewallProps)

Create a new `AWS::NetworkFirewall::Firewall`.

func NewCfnLoggingConfiguration_Override 

func NewCfnLoggingConfiguration_Override(c CfnLoggingConfiguration, scope constructs.Construct, id *string, props *CfnLoggingConfigurationProps)

Create a new `AWS::NetworkFirewall::LoggingConfiguration`.

func NewCfnRuleGroup_Override 

func NewCfnRuleGroup_Override(c CfnRuleGroup, scope constructs.Construct, id *string, props *CfnRuleGroupProps)

Create a new `AWS::NetworkFirewall::RuleGroup`.

Types

type CfnFirewall 

type CfnFirewall interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrEndpointIds() *[]*string
	AttrFirewallArn() *string
	AttrFirewallId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DeleteProtection() interface{}
	SetDeleteProtection(val interface{})
	Description() *string
	SetDescription(val *string)
	FirewallName() *string
	SetFirewallName(val *string)
	FirewallPolicyArn() *string
	SetFirewallPolicyArn(val *string)
	FirewallPolicyChangeProtection() interface{}
	SetFirewallPolicyChangeProtection(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	SubnetChangeProtection() interface{}
	SetSubnetChangeProtection(val interface{})
	SubnetMappings() interface{}
	SetSubnetMappings(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	VpcId() *string
	SetVpcId(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::NetworkFirewall::Firewall`.

Use the `Firewall` to provide stateful, managed, network firewall and intrusion detection and prevention filtering for your VPCs in Amazon VPC .

The firewall defines the configuration settings for an AWS Network Firewall firewall. The 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 AWS resource.

TODO: EXAMPLE

func NewCfnFirewall 

func NewCfnFirewall(scope constructs.Construct, id *string, props *CfnFirewallProps) CfnFirewall

Create a new `AWS::NetworkFirewall::Firewall`.

type CfnFirewallPolicy 

type CfnFirewallPolicy interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrFirewallPolicyArn() *string
	AttrFirewallPolicyId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	FirewallPolicy() interface{}
	SetFirewallPolicy(val interface{})
	FirewallPolicyName() *string
	SetFirewallPolicyName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::NetworkFirewall::FirewallPolicy`.

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.

TODO: EXAMPLE

func NewCfnFirewallPolicy 

func NewCfnFirewallPolicy(scope constructs.Construct, id *string, props *CfnFirewallPolicyProps) CfnFirewallPolicy

Create a new `AWS::NetworkFirewall::FirewallPolicy`.

type CfnFirewallPolicyProps 

type CfnFirewallPolicyProps struct {
	// The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
	FirewallPolicy interface{} `json:"firewallPolicy" yaml:"firewallPolicy"`
	// The descriptive name of the firewall policy.
	//
	// You can't change the name of a firewall policy after you create it.
	FirewallPolicyName *string `json:"firewallPolicyName" yaml:"firewallPolicyName"`
	// A description of the firewall policy.
	Description *string `json:"description" yaml:"description"`
	// 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) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnFirewallPolicy`.

TODO: EXAMPLE

type CfnFirewallPolicy_ActionDefinitionProperty 

type CfnFirewallPolicy_ActionDefinitionProperty struct {
	// Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet.
	//
	// This setting defines a CloudWatch dimension value to be published.
	//
	// You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
	PublishMetricAction interface{} `json:"publishMetricAction" yaml:"publishMetricAction"`
}

A custom action to use in stateless rule actions settings.

TODO: EXAMPLE

type CfnFirewallPolicy_CustomActionProperty 

type CfnFirewallPolicy_CustomActionProperty struct {
	// The custom action associated with the action name.
	ActionDefinition interface{} `json:"actionDefinition" yaml:"actionDefinition"`
	// The descriptive name of the custom action.
	//
	// You can't change the name of a custom action after you create it.
	ActionName *string `json:"actionName" yaml:"actionName"`
}

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.

TODO: EXAMPLE

type CfnFirewallPolicy_DimensionProperty 

type CfnFirewallPolicy_DimensionProperty struct {
	// The value to use in the custom metric dimension.
	Value *string `json:"value" yaml:"value"`
}

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

TODO: EXAMPLE

type CfnFirewallPolicy_FirewallPolicyProperty 

type CfnFirewallPolicy_FirewallPolicyProperty struct {
	// 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.
	StatelessDefaultActions *[]*string `json:"statelessDefaultActions" yaml:"statelessDefaultActions"`
	// 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.
	StatelessFragmentDefaultActions *[]*string `json:"statelessFragmentDefaultActions" yaml:"statelessFragmentDefaultActions"`
	// 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* .
	StatefulDefaultActions *[]*string `json:"statefulDefaultActions" yaml:"statefulDefaultActions"`
	// 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.
	StatefulEngineOptions interface{} `json:"statefulEngineOptions" yaml:"statefulEngineOptions"`
	// References to the stateful rule groups that are used in the policy.
	//
	// These define the inspection criteria in stateful rules.
	StatefulRuleGroupReferences interface{} `json:"statefulRuleGroupReferences" yaml:"statefulRuleGroupReferences"`
	// 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.
	StatelessCustomActions interface{} `json:"statelessCustomActions" yaml:"statelessCustomActions"`
	// References to the stateless rule groups that are used in the policy.
	//
	// These define the matching criteria in stateless rules.
	StatelessRuleGroupReferences interface{} `json:"statelessRuleGroupReferences" yaml:"statelessRuleGroupReferences"`
}

The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.

TODO: EXAMPLE

type CfnFirewallPolicy_PublishMetricActionProperty 

type CfnFirewallPolicy_PublishMetricActionProperty struct {
	// `CfnFirewallPolicy.PublishMetricActionProperty.Dimensions`.
	Dimensions interface{} `json:"dimensions" yaml:"dimensions"`
}

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.

TODO: EXAMPLE

type CfnFirewallPolicy_StatefulEngineOptionsProperty 

type CfnFirewallPolicy_StatefulEngineOptionsProperty struct {
	// 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* .
	RuleOrder *string `json:"ruleOrder" yaml:"ruleOrder"`
}

Configuration settings for the handling of the stateful rule groups in a firewall policy.

TODO: EXAMPLE

type CfnFirewallPolicy_StatefulRuleGroupReferenceProperty 

type CfnFirewallPolicy_StatefulRuleGroupReferenceProperty struct {
	// The Amazon Resource Name (ARN) of the stateful rule group.
	ResourceArn *string `json:"resourceArn" yaml:"resourceArn"`
	// 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.
	Priority *float64 `json:"priority" yaml:"priority"`
}

Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

TODO: EXAMPLE

type CfnFirewallPolicy_StatelessRuleGroupReferenceProperty 

type CfnFirewallPolicy_StatelessRuleGroupReferenceProperty struct {
	// 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.
	Priority *float64 `json:"priority" yaml:"priority"`
	// The Amazon Resource Name (ARN) of the stateless rule group.
	ResourceArn *string `json:"resourceArn" yaml:"resourceArn"`
}

Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

TODO: EXAMPLE

type CfnFirewallProps 

type CfnFirewallProps struct {
	// The descriptive name of the firewall.
	//
	// You can't change the name of a firewall after you create it.
	FirewallName *string `json:"firewallName" yaml:"firewallName"`
	// 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.
	FirewallPolicyArn *string `json:"firewallPolicyArn" yaml:"firewallPolicyArn"`
	// The public subnets that Network Firewall is using for the firewall.
	//
	// Each subnet must belong to a different Availability Zone.
	SubnetMappings interface{} `json:"subnetMappings" yaml:"subnetMappings"`
	// The unique identifier of the VPC where the firewall is in use.
	//
	// You can't change the VPC of a firewall after you create the firewall.
	VpcId *string `json:"vpcId" yaml:"vpcId"`
	// A flag indicating whether it is possible to delete the firewall.
	//
	// A setting of `TRUE` indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to `TRUE` .
	DeleteProtection interface{} `json:"deleteProtection" yaml:"deleteProtection"`
	// A description of the firewall.
	Description *string `json:"description" yaml:"description"`
	// A setting indicating whether the firewall is protected against a change to the firewall policy association.
	//
	// Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE` .
	FirewallPolicyChangeProtection interface{} `json:"firewallPolicyChangeProtection" yaml:"firewallPolicyChangeProtection"`
	// A setting indicating whether the firewall is protected against changes to the subnet associations.
	//
	// Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE` .
	SubnetChangeProtection interface{} `json:"subnetChangeProtection" yaml:"subnetChangeProtection"`
	// 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) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnFirewall`.

TODO: EXAMPLE

type CfnFirewall_SubnetMappingProperty 

type CfnFirewall_SubnetMappingProperty struct {
	// The unique identifier for the subnet.
	SubnetId *string `json:"subnetId" yaml:"subnetId"`
}

The ID for a subnet that you want to associate with the firewall.

AWS Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.

TODO: EXAMPLE

type CfnLoggingConfiguration 

type CfnLoggingConfiguration interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	FirewallArn() *string
	SetFirewallArn(val *string)
	FirewallName() *string
	SetFirewallName(val *string)
	LoggingConfiguration() interface{}
	SetLoggingConfiguration(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::NetworkFirewall::LoggingConfiguration`.

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.

TODO: EXAMPLE

func NewCfnLoggingConfiguration 

func NewCfnLoggingConfiguration(scope constructs.Construct, id *string, props *CfnLoggingConfigurationProps) CfnLoggingConfiguration

Create a new `AWS::NetworkFirewall::LoggingConfiguration`.

type CfnLoggingConfigurationProps 

type CfnLoggingConfigurationProps struct {
	// 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.
	FirewallArn *string `json:"firewallArn" yaml:"firewallArn"`
	// Defines how AWS Network Firewall performs logging for a `Firewall` .
	LoggingConfiguration interface{} `json:"loggingConfiguration" yaml:"loggingConfiguration"`
	// 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.
	FirewallName *string `json:"firewallName" yaml:"firewallName"`
}

Properties for defining a `CfnLoggingConfiguration`.

TODO: EXAMPLE

type CfnLoggingConfiguration_LogDestinationConfigProperty 

type CfnLoggingConfiguration_LogDestinationConfigProperty struct {
	// 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 Kinesis Data 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" }`
	LogDestination interface{} `json:"logDestination" yaml:"logDestination"`
	// 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.
	LogDestinationType *string `json:"logDestinationType" yaml:"logDestinationType"`
	// The type of log to send.
	//
	// Alert logs report traffic that matches a stateful rule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
	LogType *string `json:"logType" yaml:"logType"`
}

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

TODO: EXAMPLE

type CfnLoggingConfiguration_LoggingConfigurationProperty 

type CfnLoggingConfiguration_LoggingConfigurationProperty struct {
	// Defines the logging destinations for the logs for a firewall.
	//
	// Network Firewall generates logs for stateful rule groups.
	LogDestinationConfigs interface{} `json:"logDestinationConfigs" yaml:"logDestinationConfigs"`
}

Defines how AWS Network Firewall performs logging for a `Firewall` .

TODO: EXAMPLE

type CfnRuleGroup 

type CfnRuleGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrRuleGroupArn() *string
	AttrRuleGroupId() *string
	Capacity() *float64
	SetCapacity(val *float64)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RuleGroup() interface{}
	SetRuleGroup(val interface{})
	RuleGroupName() *string
	SetRuleGroupName(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::NetworkFirewall::RuleGroup`.

Use the `RuleGroup` to define a reusable collection of stateless or stateful network traffic filtering rules. You use rule groups in an `FirewallPolicy` to specify the filtering behavior of an `Firewall` .

TODO: EXAMPLE

func NewCfnRuleGroup 

func NewCfnRuleGroup(scope constructs.Construct, id *string, props *CfnRuleGroupProps) CfnRuleGroup

Create a new `AWS::NetworkFirewall::RuleGroup`.

type CfnRuleGroupProps 

type CfnRuleGroupProps struct {
	// The maximum operating resources that this rule group can use.
	//
	// You can't change a rule group's capacity setting after you create the rule group. 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.
	Capacity *float64 `json:"capacity" yaml:"capacity"`
	// The descriptive name of the rule group.
	//
	// You can't change the name of a rule group after you create it.
	RuleGroupName *string `json:"ruleGroupName" yaml:"ruleGroupName"`
	// Indicates whether the rule group is stateless or stateful.
	//
	// If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
	Type *string `json:"type" yaml:"type"`
	// A description of the rule group.
	Description *string `json:"description" yaml:"description"`
	// An object that defines the rule group rules.
	RuleGroup interface{} `json:"ruleGroup" yaml:"ruleGroup"`
	// 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) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnRuleGroup`.

TODO: EXAMPLE

type CfnRuleGroup_ActionDefinitionProperty 

type CfnRuleGroup_ActionDefinitionProperty struct {
	// Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet.
	//
	// This setting defines a CloudWatch dimension value to be published.
	//
	// You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
	PublishMetricAction interface{} `json:"publishMetricAction" yaml:"publishMetricAction"`
}

A custom action to use in stateless rule actions settings.

TODO: EXAMPLE

type CfnRuleGroup_AddressProperty 

type CfnRuleGroup_AddressProperty struct {
	// Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
	//
	// Network Firewall supports all address ranges for IPv4.
	//
	// Examples:
	//
	// - To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .
	// - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .
	//
	// For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) .
	AddressDefinition *string `json:"addressDefinition" yaml:"addressDefinition"`
}

A single IP address specification.

This is used in the `RuleGroup.MatchAttributes` source and destination specifications.

TODO: EXAMPLE

type CfnRuleGroup_CustomActionProperty 

type CfnRuleGroup_CustomActionProperty struct {
	// The custom action associated with the action name.
	ActionDefinition interface{} `json:"actionDefinition" yaml:"actionDefinition"`
	// The descriptive name of the custom action.
	//
	// You can't change the name of a custom action after you create it.
	ActionName *string `json:"actionName" yaml:"actionName"`
}

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.

TODO: EXAMPLE

type CfnRuleGroup_DimensionProperty 

type CfnRuleGroup_DimensionProperty struct {
	// The value to use in the custom metric dimension.
	Value *string `json:"value" yaml:"value"`
}

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

TODO: EXAMPLE

type CfnRuleGroup_HeaderProperty 

type CfnRuleGroup_HeaderProperty struct {
	// 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.
	//
	// Examples:
	//
	// - To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .
	// - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .
	//
	// For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) .
	Destination *string `json:"destination" yaml:"destination"`
	// The destination port to inspect for.
	//
	// You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` .
	DestinationPort *string `json:"destinationPort" yaml:"destinationPort"`
	// The direction of traffic flow to inspect.
	//
	// If set to `ANY` , the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to `FORWARD` , the inspection only matches traffic going from the source to the destination.
	Direction *string `json:"direction" yaml:"direction"`
	// The protocol to inspect for.
	//
	// To specify all, you can use `IP` , because all traffic on AWS and on the internet is IP.
	Protocol *string `json:"protocol" yaml:"protocol"`
	// 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.
	//
	// Examples:
	//
	// - To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .
	// - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .
	//
	// For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) .
	Source *string `json:"source" yaml:"source"`
	// The source port to inspect for.
	//
	// You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` .
	SourcePort *string `json:"sourcePort" yaml:"sourcePort"`
}

The 5-tuple criteria for AWS Network Firewall to use to inspect packet headers in stateful traffic flow inspection.

Traffic flows that match the criteria are a match for the corresponding stateful rule.

TODO: EXAMPLE

type CfnRuleGroup_IPSetProperty 

type CfnRuleGroup_IPSetProperty struct {
	// The list of IP addresses and address ranges, in CIDR notation.
	Definition *[]*string `json:"definition" yaml:"definition"`
}

A list of IP addresses and address ranges, in CIDR notation.

This is part of a `RuleGroup.RuleVariables` .

TODO: EXAMPLE

type CfnRuleGroup_MatchAttributesProperty 

type CfnRuleGroup_MatchAttributesProperty struct {
	// 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 example `1990:1994` .
	DestinationPorts interface{} `json:"destinationPorts" yaml:"destinationPorts"`
	// The destination IP addresses and address ranges to inspect for, in CIDR notation.
	//
	// If not specified, this matches with any destination address.
	Destinations interface{} `json:"destinations" yaml:"destinations"`
	// The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA).
	//
	// If not specified, this matches with any protocol.
	Protocols interface{} `json:"protocols" yaml:"protocols"`
	// 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 example `1990:1994` .
	SourcePorts interface{} `json:"sourcePorts" yaml:"sourcePorts"`
	// The source IP addresses and address ranges to inspect for, in CIDR notation.
	//
	// If not specified, this matches with any source address.
	Sources interface{} `json:"sources" yaml:"sources"`
	// 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).
	TcpFlags interface{} `json:"tcpFlags" yaml:"tcpFlags"`
}

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.

TODO: EXAMPLE

type CfnRuleGroup_PortRangeProperty 

type CfnRuleGroup_PortRangeProperty struct {
	// The lower limit of the port range.
	//
	// This must be less than or equal to the `ToPort` specification.
	FromPort *float64 `json:"fromPort" yaml:"fromPort"`
	// The upper limit of the port range.
	//
	// This must be greater than or equal to the `FromPort` specification.
	ToPort *float64 `json:"toPort" yaml:"toPort"`
}

A single port range specification.

This is used for source and destination port ranges in the stateless `RuleGroup.MatchAttributes` .

TODO: EXAMPLE

type CfnRuleGroup_PortSetProperty 

type CfnRuleGroup_PortSetProperty struct {
	// The set of port ranges.
	Definition *[]*string `json:"definition" yaml:"definition"`
}

A set of port ranges for use in the rules in a rule group.

TODO: EXAMPLE

type CfnRuleGroup_PublishMetricActionProperty 

type CfnRuleGroup_PublishMetricActionProperty struct {
	// `CfnRuleGroup.PublishMetricActionProperty.Dimensions`.
	Dimensions interface{} `json:"dimensions" yaml:"dimensions"`
}

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.

TODO: EXAMPLE

type CfnRuleGroup_RuleDefinitionProperty 

type CfnRuleGroup_RuleDefinitionProperty struct {
	// 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.
	//
	// > Network Firewall only forwards a packet for stateful rule inspection if you specify `aws:forward_to_sfe` for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify `aws:forward_to_sfe` for the `StatelessDefaultActions` 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.
	//
	// To provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named `MyMetricsAction` , then you could specify the standard action `aws:pass` combined with the custom action using `[“aws:pass”, “MyMetricsAction”]` .
	Actions *[]*string `json:"actions" yaml:"actions"`
	// 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.
	MatchAttributes interface{} `json:"matchAttributes" yaml:"matchAttributes"`
}

The inspection criteria and action for a single stateless rule.

AWS Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.

TODO: EXAMPLE

type CfnRuleGroup_RuleGroupProperty 

type CfnRuleGroup_RuleGroupProperty struct {
	// The stateful rules or stateless rules for the rule group.
	RulesSource interface{} `json:"rulesSource" yaml:"rulesSource"`
	// Settings that are available for use in the rules in the rule group.
	//
	// You can only use these for stateful rule groups.
	RuleVariables interface{} `json:"ruleVariables" yaml:"ruleVariables"`
	// 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.
	StatefulRuleOptions interface{} `json:"statefulRuleOptions" yaml:"statefulRuleOptions"`
}

The object that defines the rules in a rule group.

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

TODO: EXAMPLE

type CfnRuleGroup_RuleOptionProperty 

type CfnRuleGroup_RuleOptionProperty struct {
	// `CfnRuleGroup.RuleOptionProperty.Keyword`.
	Keyword *string `json:"keyword" yaml:"keyword"`
	// `CfnRuleGroup.RuleOptionProperty.Settings`.
	Settings *[]*string `json:"settings" yaml:"settings"`
}

Additional settings for a stateful rule.

TODO: EXAMPLE

type CfnRuleGroup_RuleVariablesProperty 

type CfnRuleGroup_RuleVariablesProperty struct {
	// A list of IP addresses and address ranges, in CIDR notation.
	IpSets interface{} `json:"ipSets" yaml:"ipSets"`
	// A list of port ranges.
	PortSets interface{} `json:"portSets" yaml:"portSets"`
}

Settings that are available for use in the rules in the `RuleGroup` where this is defined.

TODO: EXAMPLE

type CfnRuleGroup_RulesSourceListProperty 

type CfnRuleGroup_RulesSourceListProperty struct {
	// Whether you want to allow or deny access to the domains in your target list.
	GeneratedRulesType *string `json:"generatedRulesType" yaml:"generatedRulesType"`
	// 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 domain `abc.example.com` .
	// - Names that use a domain wildcard, which you indicate with an initial ' `.` '. For example, `.example.com` matches `example.com` and matches all subdomains of `example.com` , such as `abc.example.com` and `www.example.com` .
	Targets *[]*string `json:"targets" yaml:"targets"`
	// The types of targets to inspect for.
	//
	// Valid values are `TLS_SNI` and `HTTP_HOST` .
	TargetTypes *[]*string `json:"targetTypes" yaml:"targetTypes"`
}

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 `HOME_NET` rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see `RuleGroup.RuleVariables` in this guide and [Stateful domain list rule groups in AWS Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) in the *Network Firewall Developer Guide*

TODO: EXAMPLE

type CfnRuleGroup_RulesSourceProperty 

type CfnRuleGroup_RulesSourceProperty struct {
	// Stateful inspection criteria for a domain list rule group.
	RulesSourceList interface{} `json:"rulesSourceList" yaml:"rulesSourceList"`
	// Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.
	//
	// Suricata is an open-source network IPS 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.
	RulesString *string `json:"rulesString" yaml:"rulesString"`
	// 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](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#) .
	StatefulRules interface{} `json:"statefulRules" yaml:"statefulRules"`
	// Stateless inspection criteria to be used in a stateless rule group.
	StatelessRulesAndCustomActions interface{} `json:"statelessRulesAndCustomActions" yaml:"statelessRulesAndCustomActions"`
}

The stateless or stateful rules definitions for use in a single rule group.

Each rule group requires a single `RulesSource` . You can use an instance of this for either stateless rules or stateful rules.

TODO: EXAMPLE

type CfnRuleGroup_StatefulRuleOptionsProperty 

type CfnRuleGroup_StatefulRuleOptionsProperty struct {
	// Indicates how to manage the order of the rule evaluation for the rule group.
	//
	// `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* .
	RuleOrder *string `json:"ruleOrder" yaml:"ruleOrder"`
}

Additional options governing how Network Firewall handles the rule group.

You can only use these for stateful rule groups.

TODO: EXAMPLE

type CfnRuleGroup_StatefulRuleProperty 

type CfnRuleGroup_StatefulRuleProperty struct {
	// 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's `LoggingConfiguration` .
	// - *ALERT* - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the firewall's `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 to `DROP` .
	Action *string `json:"action" yaml:"action"`
	// The stateful inspection criteria for this rule, used to inspect traffic flows.
	Header interface{} `json:"header" yaml:"header"`
	// Additional settings for a stateful rule, provided as keywords and settings.
	RuleOptions interface{} `json:"ruleOptions" yaml:"ruleOptions"`
}

A single Suricata rules specification, for use in a stateful rule group.

Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata `Rules` format, see [Rules Format](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#) .

TODO: EXAMPLE

type CfnRuleGroup_StatelessRuleProperty 

type CfnRuleGroup_StatelessRuleProperty struct {
	// 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 each `StatelessRulesAndCustomActions` contains exactly one `StatelessRules` object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single `StatelessRules` 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.
	Priority *float64 `json:"priority" yaml:"priority"`
	// Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
	RuleDefinition interface{} `json:"ruleDefinition" yaml:"ruleDefinition"`
}

A single stateless rule.

This is used in `RuleGroup.StatelessRulesAndCustomActions` .

TODO: EXAMPLE

type CfnRuleGroup_StatelessRulesAndCustomActionsProperty 

type CfnRuleGroup_StatelessRulesAndCustomActionsProperty struct {
	// Defines the set of stateless rules for use in a stateless rule group.
	StatelessRules interface{} `json:"statelessRules" yaml:"statelessRules"`
	// 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 stateless rule `RuleGroup.RuleDefinition` `Actions` specification.
	CustomActions interface{} `json:"customActions" yaml:"customActions"`
}

Stateless inspection criteria.

Each stateless rule group uses exactly one of these data types to define its stateless rules.

TODO: EXAMPLE

type CfnRuleGroup_TCPFlagFieldProperty 

type CfnRuleGroup_TCPFlagFieldProperty struct {
	// 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 the `Masks` 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.
	Flags *[]*string `json:"flags" yaml:"flags"`
	// The set of flags to consider in the inspection.
	//
	// To inspect all flags in the valid values list, leave this with no setting.
	Masks *[]*string `json:"masks" yaml:"masks"`
}

TCP flags and masks to inspect packets for. This is used in the `RuleGroup.MatchAttributes` specification.

For example:

`"TCPFlags": [ { "Flags": [ "ECE", "SYN" ], "Masks": [ "SYN", "ECE" ] } ]`

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.