NAME
Paws::NetworkFirewall::CreateRuleGroup - Arguments for method CreateRuleGroup on Paws::NetworkFirewall
DESCRIPTION
This class represents the parameters used for calling the method CreateRuleGroup on the AWS Network Firewall service. Use the attributes of this class as arguments to method CreateRuleGroup.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateRuleGroup.
SYNOPSIS
my $network-firewall = Paws->service('NetworkFirewall');
my $CreateRuleGroupResponse = $network -firewall->CreateRuleGroup(
Capacity => 1,
RuleGroupName => 'MyResourceName',
Type => 'STATELESS',
Description => 'MyDescription', # OPTIONAL
DryRun => 1, # OPTIONAL
RuleGroup => {
RulesSource => {
RulesSourceList => {
GeneratedRulesType => 'ALLOWLIST', # values: ALLOWLIST, DENYLIST
TargetTypes => [
'TLS_SNI', ... # values: TLS_SNI, HTTP_HOST
],
Targets => [ 'MyCollectionMember_String', ... ],
}, # OPTIONAL
RulesString => 'MyRulesString', # max: 1000000; OPTIONAL
StatefulRules => [
{
Action => 'PASS', # values: PASS, DROP, ALERT
Header => {
Destination => 'MyDestination', # min: 1, max: 1024
DestinationPort => 'MyPort', # min: 1, max: 1024
Direction => 'FORWARD', # values: FORWARD, ANY
Protocol => 'IP'
, # values: IP, TCP, UDP, ICMP, HTTP, FTP, TLS, SMB, DNS, DCERPC, SSH, SMTP, IMAP, MSN, KRB5, IKEV2, TFTP, NTP, DHCP
Source => 'MySource', # min: 1, max: 1024
SourcePort => 'MyPort', # min: 1, max: 1024
},
RuleOptions => [
{
Keyword => 'MyKeyword', # min: 1, max: 128
Settings => [
'MySetting', ... # min: 1, max: 8192
], # OPTIONAL
},
...
],
},
...
], # OPTIONAL
StatelessRulesAndCustomActions => {
StatelessRules => [
{
Priority => 1, # min: 1, max: 65535
RuleDefinition => {
Actions => [ 'MyCollectionMember_String', ... ],
MatchAttributes => {
DestinationPorts => [
{
FromPort => 1, # max: 65535
ToPort => 1, # max: 65535
},
...
], # OPTIONAL
Destinations => [
{
AddressDefinition =>
'MyAddressDefinition', # min: 1, max: 255
},
...
], # OPTIONAL
Protocols => [
1, ... # max: 255
], # OPTIONAL
SourcePorts => [
{
FromPort => 1, # max: 65535
ToPort => 1, # max: 65535
},
...
], # OPTIONAL
Sources => [
{
AddressDefinition =>
'MyAddressDefinition', # min: 1, max: 255
},
...
], # OPTIONAL
TCPFlags => [
{
Flags => [
'FIN',
... # values: FIN, SYN, RST, PSH, ACK, URG, ECE, CWR
],
Masks => [
'FIN',
... # values: FIN, SYN, RST, PSH, ACK, URG, ECE, CWR
],
},
...
], # OPTIONAL
},
},
},
...
],
CustomActions => [
{
ActionDefinition => {
PublishMetricAction => {
Dimensions => [
{
Value => 'MyDimensionValue', # min: 1, max: 128
},
...
], # min: 1, max: 1
}, # OPTIONAL
},
ActionName => 'MyActionName', # min: 1, max: 128
},
...
], # OPTIONAL
}, # OPTIONAL
},
RuleVariables => {
IPSets => {
'MyRuleVariableName' => {
Definition => [
'MyVariableDefinition', ... # min: 1
],
}, # key: min: 1, max: 32
}, # OPTIONAL
PortSets => {
'MyRuleVariableName' => {
Definition => [
'MyVariableDefinition', ... # min: 1
],
}, # key: min: 1, max: 32
}, # OPTIONAL
}, # OPTIONAL
}, # OPTIONAL
Rules => 'MyRulesString', # OPTIONAL
Tags => [
{
Key => 'MyTagKey', # min: 1, max: 128
Value => 'MyTagValue', # max: 256
},
...
], # OPTIONAL
);
# Results:
my $RuleGroupResponse = $CreateRuleGroupResponse->RuleGroupResponse;
my $UpdateToken = $CreateRuleGroupResponse->UpdateToken;
# Returns a L<Paws::NetworkFirewall::CreateRuleGroupResponse> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/network-firewall/CreateRuleGroup
ATTRIBUTES
REQUIRED Capacity => Int
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. 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.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with
Anyspecified has a value of 1.All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
Description => Str
A description of the rule group.
DryRun => Bool
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
RuleGroup => Paws::NetworkFirewall::RuleGroup
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
REQUIRED RuleGroupName => Str
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
Rules => Str
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.
Tags => ArrayRef[Paws::NetworkFirewall::Tag]
The key:value pairs to associate with the resource.
REQUIRED Type => Str
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.
Valid values are: "STATELESS", "STATEFUL"
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateRuleGroup in Paws::NetworkFirewall
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues