CfnRuleGroup

class aws_cdk.aws_networkfirewall.CfnRuleGroup(scope, id, *, capacity, rule_group_name, type, description=None, rule_group=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::NetworkFirewall::RuleGroup.

CloudformationResource

AWS::NetworkFirewall::RuleGroup

Link

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

Create a new AWS::NetworkFirewall::RuleGroup.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • capacity (Union[int, float]) – AWS::NetworkFirewall::RuleGroup.Capacity.

  • rule_group_name (str) – AWS::NetworkFirewall::RuleGroup.RuleGroupName.

  • type (str) – AWS::NetworkFirewall::RuleGroup.Type.

  • description (Optional[str]) – AWS::NetworkFirewall::RuleGroup.Description.

  • rule_group (Union[IResolvable, RuleGroupProperty, None]) – AWS::NetworkFirewall::RuleGroup.RuleGroup.

  • tags (Optional[Sequence[CfnTag]]) – AWS::NetworkFirewall::RuleGroup.Tags.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::NetworkFirewall::RuleGroup'
attr_rule_group_arn

RuleGroupArn

Type

cloudformationAttribute

Return type

str

attr_rule_group_id

RuleGroupId

Type

cloudformationAttribute

Return type

str

capacity

AWS::NetworkFirewall::RuleGroup.Capacity.

Link

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

Return type

Union[int, float]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

AWS::NetworkFirewall::RuleGroup.Description.

Link

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

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

rule_group

AWS::NetworkFirewall::RuleGroup.RuleGroup.

Link

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

Return type

Union[IResolvable, RuleGroupProperty, None]

rule_group_name

AWS::NetworkFirewall::RuleGroup.RuleGroupName.

Link

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

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::NetworkFirewall::RuleGroup.Tags.

Link

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

Return type

TagManager

type

AWS::NetworkFirewall::RuleGroup.Type.

Link

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

Return type

str

Static Methods

classmethod is_cfn_element(x)

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.

Parameters

x (Any) –

Return type

bool

Returns

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

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ActionDefinitionProperty

class CfnRuleGroup.ActionDefinitionProperty(*, publish_metric_action=None)

Bases: object

Parameters

publish_metric_action (Union[IResolvable, PublishMetricActionProperty, None]) – CfnRuleGroup.ActionDefinitionProperty.PublishMetricAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-actiondefinition.html

Attributes

publish_metric_action

CfnRuleGroup.ActionDefinitionProperty.PublishMetricAction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-actiondefinition.html#cfn-networkfirewall-rulegroup-actiondefinition-publishmetricaction

Return type

Union[IResolvable, PublishMetricActionProperty, None]

AddressProperty

class CfnRuleGroup.AddressProperty(*, address_definition)

Bases: object

Parameters

address_definition (str) – CfnRuleGroup.AddressProperty.AddressDefinition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-address.html

Attributes

address_definition

CfnRuleGroup.AddressProperty.AddressDefinition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-address.html#cfn-networkfirewall-rulegroup-address-addressdefinition

Return type

str

CustomActionProperty

class CfnRuleGroup.CustomActionProperty(*, action_definition, action_name)

Bases: object

Parameters
  • action_definition (Union[IResolvable, ActionDefinitionProperty]) – CfnRuleGroup.CustomActionProperty.ActionDefinition.

  • action_name (str) – CfnRuleGroup.CustomActionProperty.ActionName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html

Attributes

action_definition

CfnRuleGroup.CustomActionProperty.ActionDefinition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html#cfn-networkfirewall-rulegroup-customaction-actiondefinition

Return type

Union[IResolvable, ActionDefinitionProperty]

action_name

CfnRuleGroup.CustomActionProperty.ActionName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html#cfn-networkfirewall-rulegroup-customaction-actionname

Return type

str

DimensionProperty

class CfnRuleGroup.DimensionProperty(*, value)

Bases: object

Parameters

value (str) – CfnRuleGroup.DimensionProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-dimension.html

Attributes

value

CfnRuleGroup.DimensionProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-dimension.html#cfn-networkfirewall-rulegroup-dimension-value

Return type

str

HeaderProperty

class CfnRuleGroup.HeaderProperty(*, destination, destination_port, direction, protocol, source, source_port)

Bases: object

Parameters
  • destination (str) – CfnRuleGroup.HeaderProperty.Destination.

  • destination_port (str) – CfnRuleGroup.HeaderProperty.DestinationPort.

  • direction (str) – CfnRuleGroup.HeaderProperty.Direction.

  • protocol (str) – CfnRuleGroup.HeaderProperty.Protocol.

  • source (str) – CfnRuleGroup.HeaderProperty.Source.

  • source_port (str) – CfnRuleGroup.HeaderProperty.SourcePort.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html

Attributes

destination

CfnRuleGroup.HeaderProperty.Destination.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-destination

Return type

str

destination_port

CfnRuleGroup.HeaderProperty.DestinationPort.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-destinationport

Return type

str

direction

CfnRuleGroup.HeaderProperty.Direction.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-direction

Return type

str

protocol

CfnRuleGroup.HeaderProperty.Protocol.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-protocol

Return type

str

source

CfnRuleGroup.HeaderProperty.Source.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-source

Return type

str

source_port

CfnRuleGroup.HeaderProperty.SourcePort.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-sourceport

Return type

str

MatchAttributesProperty

class CfnRuleGroup.MatchAttributesProperty(*, destination_ports=None, destinations=None, protocols=None, source_ports=None, sources=None, tcp_flags=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html

Attributes

destination_ports

CfnRuleGroup.MatchAttributesProperty.DestinationPorts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-destinationports

Return type

Union[IResolvable, List[Union[IResolvable, PortRangeProperty]], None]

destinations

CfnRuleGroup.MatchAttributesProperty.Destinations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-destinations

Return type

Union[IResolvable, List[Union[IResolvable, AddressProperty]], None]

protocols

CfnRuleGroup.MatchAttributesProperty.Protocols.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-protocols

Return type

Union[IResolvable, List[Union[int, float]], None]

source_ports

CfnRuleGroup.MatchAttributesProperty.SourcePorts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-sourceports

Return type

Union[IResolvable, List[Union[IResolvable, PortRangeProperty]], None]

sources

CfnRuleGroup.MatchAttributesProperty.Sources.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-sources

Return type

Union[IResolvable, List[Union[IResolvable, AddressProperty]], None]

tcp_flags

CfnRuleGroup.MatchAttributesProperty.TCPFlags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-tcpflags

Return type

Union[IResolvable, List[Union[IResolvable, TCPFlagFieldProperty]], None]

PortRangeProperty

class CfnRuleGroup.PortRangeProperty(*, from_port, to_port)

Bases: object

Parameters
  • from_port (Union[int, float]) – CfnRuleGroup.PortRangeProperty.FromPort.

  • to_port (Union[int, float]) – CfnRuleGroup.PortRangeProperty.ToPort.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html

Attributes

from_port

CfnRuleGroup.PortRangeProperty.FromPort.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html#cfn-networkfirewall-rulegroup-portrange-fromport

Return type

Union[int, float]

to_port

CfnRuleGroup.PortRangeProperty.ToPort.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html#cfn-networkfirewall-rulegroup-portrange-toport

Return type

Union[int, float]

PortSetProperty

class CfnRuleGroup.PortSetProperty(*, definition=None)

Bases: object

Parameters

definition (Optional[Sequence[str]]) – CfnRuleGroup.PortSetProperty.Definition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portset.html

Attributes

definition

CfnRuleGroup.PortSetProperty.Definition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portset.html#cfn-networkfirewall-rulegroup-portset-definition

Return type

Optional[List[str]]

PublishMetricActionProperty

class CfnRuleGroup.PublishMetricActionProperty(*, dimensions)

Bases: object

Parameters

dimensions (Union[IResolvable, Sequence[Union[IResolvable, DimensionProperty]]]) – CfnRuleGroup.PublishMetricActionProperty.Dimensions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-publishmetricaction.html

Attributes

dimensions

CfnRuleGroup.PublishMetricActionProperty.Dimensions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-publishmetricaction.html#cfn-networkfirewall-rulegroup-publishmetricaction-dimensions

Return type

Union[IResolvable, List[Union[IResolvable, DimensionProperty]]]

RuleDefinitionProperty

class CfnRuleGroup.RuleDefinitionProperty(*, actions, match_attributes)

Bases: object

Parameters
  • actions (Sequence[str]) – CfnRuleGroup.RuleDefinitionProperty.Actions.

  • match_attributes (Union[IResolvable, MatchAttributesProperty]) – CfnRuleGroup.RuleDefinitionProperty.MatchAttributes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html

Attributes

actions

CfnRuleGroup.RuleDefinitionProperty.Actions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html#cfn-networkfirewall-rulegroup-ruledefinition-actions

Return type

List[str]

match_attributes

CfnRuleGroup.RuleDefinitionProperty.MatchAttributes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html#cfn-networkfirewall-rulegroup-ruledefinition-matchattributes

Return type

Union[IResolvable, MatchAttributesProperty]

RuleGroupProperty

class CfnRuleGroup.RuleGroupProperty(*, rules_source, rule_variables=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html

Attributes

rule_variables

CfnRuleGroup.RuleGroupProperty.RuleVariables.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-rulevariables

Return type

Union[IResolvable, RuleVariablesProperty, None]

rules_source

CfnRuleGroup.RuleGroupProperty.RulesSource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-rulessource

Return type

Union[IResolvable, RulesSourceProperty]

RuleOptionProperty

class CfnRuleGroup.RuleOptionProperty(*, keyword, settings=None)

Bases: object

Parameters
  • keyword (str) – CfnRuleGroup.RuleOptionProperty.Keyword.

  • settings (Optional[Sequence[str]]) – CfnRuleGroup.RuleOptionProperty.Settings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html

Attributes

keyword

CfnRuleGroup.RuleOptionProperty.Keyword.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html#cfn-networkfirewall-rulegroup-ruleoption-keyword

Return type

str

settings

CfnRuleGroup.RuleOptionProperty.Settings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html#cfn-networkfirewall-rulegroup-ruleoption-settings

Return type

Optional[List[str]]

RuleVariablesProperty

class CfnRuleGroup.RuleVariablesProperty(*, ip_sets=None, port_sets=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html

Attributes

ip_sets

CfnRuleGroup.RuleVariablesProperty.IPSets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html#cfn-networkfirewall-rulegroup-rulevariables-ipsets

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, IPSetProperty]], None]

port_sets

CfnRuleGroup.RuleVariablesProperty.PortSets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html#cfn-networkfirewall-rulegroup-rulevariables-portsets

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, PortSetProperty]], None]

RulesSourceListProperty

class CfnRuleGroup.RulesSourceListProperty(*, generated_rules_type, targets, target_types)

Bases: object

Parameters
  • generated_rules_type (str) – CfnRuleGroup.RulesSourceListProperty.GeneratedRulesType.

  • targets (Sequence[str]) – CfnRuleGroup.RulesSourceListProperty.Targets.

  • target_types (Sequence[str]) – CfnRuleGroup.RulesSourceListProperty.TargetTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html

Attributes

generated_rules_type

CfnRuleGroup.RulesSourceListProperty.GeneratedRulesType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-generatedrulestype

Return type

str

target_types

CfnRuleGroup.RulesSourceListProperty.TargetTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-targettypes

Return type

List[str]

targets

CfnRuleGroup.RulesSourceListProperty.Targets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-targets

Return type

List[str]

RulesSourceProperty

class CfnRuleGroup.RulesSourceProperty(*, rules_source_list=None, rules_string=None, stateful_rules=None, stateless_rules_and_custom_actions=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html

Attributes

rules_source_list

CfnRuleGroup.RulesSourceProperty.RulesSourceList.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-rulessourcelist

Return type

Union[IResolvable, RulesSourceListProperty, None]

rules_string

CfnRuleGroup.RulesSourceProperty.RulesString.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-rulesstring

Return type

Optional[str]

stateful_rules

CfnRuleGroup.RulesSourceProperty.StatefulRules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-statefulrules

Return type

Union[IResolvable, List[Union[IResolvable, StatefulRuleProperty]], None]

stateless_rules_and_custom_actions

CfnRuleGroup.RulesSourceProperty.StatelessRulesAndCustomActions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-statelessrulesandcustomactions

Return type

Union[IResolvable, StatelessRulesAndCustomActionsProperty, None]

StatefulRuleProperty

class CfnRuleGroup.StatefulRuleProperty(*, action, header, rule_options)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html

Attributes

action

CfnRuleGroup.StatefulRuleProperty.Action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-action

Return type

str

header

CfnRuleGroup.StatefulRuleProperty.Header.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-header

Return type

Union[IResolvable, HeaderProperty]

rule_options

CfnRuleGroup.StatefulRuleProperty.RuleOptions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-ruleoptions

Return type

Union[IResolvable, List[Union[IResolvable, RuleOptionProperty]]]

StatelessRuleProperty

class CfnRuleGroup.StatelessRuleProperty(*, priority, rule_definition)

Bases: object

Parameters
  • priority (Union[int, float]) – CfnRuleGroup.StatelessRuleProperty.Priority.

  • rule_definition (Union[IResolvable, RuleDefinitionProperty]) – CfnRuleGroup.StatelessRuleProperty.RuleDefinition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html

Attributes

priority

CfnRuleGroup.StatelessRuleProperty.Priority.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html#cfn-networkfirewall-rulegroup-statelessrule-priority

Return type

Union[int, float]

rule_definition

CfnRuleGroup.StatelessRuleProperty.RuleDefinition.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html#cfn-networkfirewall-rulegroup-statelessrule-ruledefinition

Return type

Union[IResolvable, RuleDefinitionProperty]

StatelessRulesAndCustomActionsProperty

class CfnRuleGroup.StatelessRulesAndCustomActionsProperty(*, stateless_rules, custom_actions=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html

Attributes

custom_actions

CfnRuleGroup.StatelessRulesAndCustomActionsProperty.CustomActions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html#cfn-networkfirewall-rulegroup-statelessrulesandcustomactions-customactions

Return type

Union[IResolvable, List[Union[IResolvable, CustomActionProperty]], None]

stateless_rules

CfnRuleGroup.StatelessRulesAndCustomActionsProperty.StatelessRules.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html#cfn-networkfirewall-rulegroup-statelessrulesandcustomactions-statelessrules

Return type

Union[IResolvable, List[Union[IResolvable, StatelessRuleProperty]]]

TCPFlagFieldProperty

class CfnRuleGroup.TCPFlagFieldProperty(*, flags, masks=None)

Bases: object

Parameters
  • flags (Sequence[str]) – CfnRuleGroup.TCPFlagFieldProperty.Flags.

  • masks (Optional[Sequence[str]]) – CfnRuleGroup.TCPFlagFieldProperty.Masks.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html

Attributes

flags

CfnRuleGroup.TCPFlagFieldProperty.Flags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-flags

Return type

List[str]

masks

CfnRuleGroup.TCPFlagFieldProperty.Masks.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-masks

Return type

Optional[List[str]]