CfnFirewallPolicyProps

class aws_cdk.aws_networkfirewall.CfnFirewallPolicyProps(*, firewall_policy, firewall_policy_name, description=None, tags=None)

Bases: object

Properties for defining a CfnFirewallPolicy.

Parameters
  • firewall_policy (Union[IResolvable, FirewallPolicyProperty, Dict[str, Any]]) – The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.

  • firewall_policy_name (str) – The descriptive name of the firewall policy. You can’t change the name of a firewall policy after you create it.

  • description (Optional[str]) – A description of the firewall policy.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_networkfirewall as networkfirewall

cfn_firewall_policy_props = networkfirewall.CfnFirewallPolicyProps(
    firewall_policy=networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty(
        stateless_default_actions=["statelessDefaultActions"],
        stateless_fragment_default_actions=["statelessFragmentDefaultActions"],

        # the properties below are optional
        stateful_default_actions=["statefulDefaultActions"],
        stateful_engine_options=networkfirewall.CfnFirewallPolicy.StatefulEngineOptionsProperty(
            rule_order="ruleOrder"
        ),
        stateful_rule_group_references=[networkfirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty(
            resource_arn="resourceArn",

            # the properties below are optional
            priority=123
        )],
        stateless_custom_actions=[networkfirewall.CfnFirewallPolicy.CustomActionProperty(
            action_definition=networkfirewall.CfnFirewallPolicy.ActionDefinitionProperty(
                publish_metric_action=networkfirewall.CfnFirewallPolicy.PublishMetricActionProperty(
                    dimensions=[networkfirewall.CfnFirewallPolicy.DimensionProperty(
                        value="value"
                    )]
                )
            ),
            action_name="actionName"
        )],
        stateless_rule_group_references=[networkfirewall.CfnFirewallPolicy.StatelessRuleGroupReferenceProperty(
            priority=123,
            resource_arn="resourceArn"
        )]
    ),
    firewall_policy_name="firewallPolicyName",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of the firewall policy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-description

Return type

Optional[str]

firewall_policy

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy

Return type

Union[IResolvable, FirewallPolicyProperty]

firewall_policy_name

The descriptive name of the firewall policy.

You can’t change the name of a firewall policy after you create it.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicyname

Return type

str

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-tags

Return type

Optional[List[CfnTag]]