Skip to content
v2.274.0

CfnFirewallPolicyProps Struct ​

Properties for defining a CfnFirewallPolicy.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_networkfirewall as networkfirewall } from 'aws-cdk-lib';
const cfnFirewallPolicyProps: networkfirewall.CfnFirewallPolicyProps = {
  firewallPolicy: {
    statelessDefaultActions: ['statelessDefaultActions'],
    statelessFragmentDefaultActions: ['statelessFragmentDefaultActions'],

    // the properties below are optional
    enableTlsSessionHolding: false,
    policyVariables: {
      ruleVariables: {
        ruleVariablesKey: {
          definition: ['definition'],
        },
      },
    },
    statefulDefaultActions: ['statefulDefaultActions'],
    statefulEngineOptions: {
      flowTimeouts: {
        tcpIdleTimeoutSeconds: 123,
      },
      ruleOrder: 'ruleOrder',
      streamExceptionPolicy: 'streamExceptionPolicy',
    },
    statefulRuleGroupReferences: [{
      resourceArn: 'resourceArn',

      // the properties below are optional
      deepThreatInspection: false,
      override: {
        action: 'action',
      },
      priority: 123,
    }],
    statelessCustomActions: [{
      actionDefinition: {
        publishMetricAction: {
          dimensions: [{
            value: 'value',
          }],
        },
      },
      actionName: 'actionName',
    }],
    statelessRuleGroupReferences: [{
      priority: 123,
      resourceArn: 'resourceArn',
    }],
    tlsInspectionConfigurationArn: 'tlsInspectionConfigurationArn',
  },
  firewallPolicyName: 'firewallPolicyName',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the firewall policy.
firewallPolicyIResolvable | CfnFirewallPolicy.FirewallPolicyPropertyfirewall_policytyping.Union[IResolvable, FirewallPolicyProperty]firewallPolicyIResolvableFirewallPolicyIResolvableFirewallPolicyinterface{}required#
The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
firewallPolicyNamestringfirewall_policy_namestrfirewallPolicyNameStringFirewallPolicyNamestringFirewallPolicyName*stringrequired#
The descriptive name of the firewall policy.

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

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.

For more information, see Tag .