interface CfnRuleGroupMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.NetworkFirewall.Mixins.CfnRuleGroupMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsnetworkfirewall/mixins#CfnRuleGroupMixinProps
Java	software.amazon.awscdk.mixins.preview.services.networkfirewall.mixins.CfnRuleGroupMixinProps
Python	aws_cdk.mixins_preview.aws_networkfirewall.mixins.CfnRuleGroupMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_networkfirewall » mixins » CfnRuleGroupMixinProps

Properties for CfnRuleGroupPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as networkfirewall_mixins } from '@aws-cdk/mixins-preview/aws-networkfirewall';
const cfnRuleGroupMixinProps: networkfirewall_mixins.CfnRuleGroupMixinProps = {
  capacity: 123,
  description: 'description',
  ruleGroup: {
    referenceSets: {
      ipSetReferences: {
        ipSetReferencesKey: {
          referenceArn: 'referenceArn',
        },
      },
    },
    rulesSource: {
      rulesSourceList: {
        generatedRulesType: 'generatedRulesType',
        targets: ['targets'],
        targetTypes: ['targetTypes'],
      },
      rulesString: 'rulesString',
      statefulRules: [{
        action: 'action',
        header: {
          destination: 'destination',
          destinationPort: 'destinationPort',
          direction: 'direction',
          protocol: 'protocol',
          source: 'source',
          sourcePort: 'sourcePort',
        },
        ruleOptions: [{
          keyword: 'keyword',
          settings: ['settings'],
        }],
      }],
      statelessRulesAndCustomActions: {
        customActions: [{
          actionDefinition: {
            publishMetricAction: {
              dimensions: [{
                value: 'value',
              }],
            },
          },
          actionName: 'actionName',
        }],
        statelessRules: [{
          priority: 123,
          ruleDefinition: {
            actions: ['actions'],
            matchAttributes: {
              destinationPorts: [{
                fromPort: 123,
                toPort: 123,
              }],
              destinations: [{
                addressDefinition: 'addressDefinition',
              }],
              protocols: [123],
              sourcePorts: [{
                fromPort: 123,
                toPort: 123,
              }],
              sources: [{
                addressDefinition: 'addressDefinition',
              }],
              tcpFlags: [{
                flags: ['flags'],
                masks: ['masks'],
              }],
            },
          },
        }],
      },
    },
    ruleVariables: {
      ipSets: {
        ipSetsKey: {
          definition: ['definition'],
        },
      },
      portSets: {
        portSetsKey: {
          definition: ['definition'],
        },
      },
    },
    statefulRuleOptions: {
      ruleOrder: 'ruleOrder',
    },
  },
  ruleGroupName: 'ruleGroupName',
  summaryConfiguration: {
    ruleOptions: ['ruleOptions'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties

Name	Type	Description
capacity?	number	The maximum operating resources that this rule group can use.
description?	string	A description of the rule group.
ruleGroup?	IResolvable | RuleGroupProperty	An object that defines the rule group rules.
ruleGroupName?	string	The descriptive name of the rule group.
summaryConfiguration?	IResolvable | SummaryConfigurationProperty	A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary .
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.
type?	string	Indicates whether the rule group is stateless or stateful.

---

capacity?

Type: number (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-capacity

---

description?

Type: string (optional)

A description of the rule group.

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

---

ruleGroup?

Type: IResolvable | RuleGroupProperty (optional)

An object that defines the rule group rules.

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

---

ruleGroupName?

Type: string (optional)

The descriptive name of the rule group.

You can't change the name of a rule group after you create it.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroupname

---

summaryConfiguration?

Type: IResolvable | SummaryConfigurationProperty (optional)

A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary .

• The RuleOptions specified in SummaryConfiguration
• Rule metadata organization preferences

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-summaryconfiguration

---

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

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

---

type?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-type