class CfnRuleGroupPropsMixin

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

Implements IMixin

Extends Mixin

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

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 } from '@aws-cdk/mixins-preview';
import { mixins as networkfirewall_mixins } from '@aws-cdk/mixins-preview/aws-networkfirewall';
const cfnRuleGroupPropsMixin = new networkfirewall_mixins.CfnRuleGroupPropsMixin({
  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',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnRuleGroupPropsMixin(props: CfnRuleGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnRuleGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::NetworkFirewall::RuleGroup.

Properties

Name	Type	Description
props	CfnRuleGroupMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnRuleGroupMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.