« blib/lib/Paws/NetworkFirewall/FirewallMetadata.pm
↑ Summary
blib/lib/Paws/NetworkFirewall/FirewallPolicyMetadata.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::NetworkFirewall::FirewallPolicy; | ||
| 3 | use Moose; | ||
| 4 | has StatefulRuleGroupReferences => (is => 'ro', isa => 'ArrayRef[Paws::NetworkFirewall::StatefulRuleGroupReference]'); | ||
| 5 | has StatelessCustomActions => (is => 'ro', isa => 'ArrayRef[Paws::NetworkFirewall::CustomAction]'); | ||
| 6 | has StatelessDefaultActions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 7 | has StatelessFragmentDefaultActions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 8 | has StatelessRuleGroupReferences => (is => 'ro', isa => 'ArrayRef[Paws::NetworkFirewall::StatelessRuleGroupReference]'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::NetworkFirewall::FirewallPolicy | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::NetworkFirewall::FirewallPolicy object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { StatefulRuleGroupReferences => $value, ..., StatelessRuleGroupReferences => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::NetworkFirewall::FirewallPolicy object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->StatefulRuleGroupReferences | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | The firewall policy defines the behavior of a firewall using a | ||
| 41 | collection of stateless and stateful rule groups and other settings. | ||
| 42 | You can use one firewall policy for multiple firewalls. | ||
| 43 | |||
| 44 | This, along with FirewallPolicyResponse, define the policy. You can | ||
| 45 | retrieve all objects for a firewall policy by calling | ||
| 46 | DescribeFirewallPolicy. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 StatefulRuleGroupReferences => ArrayRef[L<Paws::NetworkFirewall::StatefulRuleGroupReference>] | ||
| 52 | |||
| 53 | References to the stateless rule groups that are used in the policy. | ||
| 54 | These define the inspection criteria in stateful rules. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 StatelessCustomActions => ArrayRef[L<Paws::NetworkFirewall::CustomAction>] | ||
| 58 | |||
| 59 | The custom action definitions that are available for use in the | ||
| 60 | firewall policy's C<StatelessDefaultActions> setting. You name each | ||
| 61 | custom action that you define, and then you can use it by name in your | ||
| 62 | default actions specifications. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> StatelessDefaultActions => ArrayRef[Str|Undef] | ||
| 66 | |||
| 67 | The actions to take on a packet if it doesn't match any of the | ||
| 68 | stateless rules in the policy. If you want non-matching packets to be | ||
| 69 | forwarded for stateful inspection, specify C<aws:forward_to_sfe>. | ||
| 70 | |||
| 71 | You must specify one of the standard actions: C<aws:pass>, C<aws:drop>, | ||
| 72 | or C<aws:forward_to_sfe>. In addition, you can specify custom actions | ||
| 73 | that are compatible with your standard section choice. | ||
| 74 | |||
| 75 | For example, you could specify C<["aws:pass"]> or you could specify | ||
| 76 | C<["aws:pass", E<ldquo>customActionNameE<rdquo>]>. For information | ||
| 77 | about compatibility, see the custom action descriptions under | ||
| 78 | CustomAction. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> StatelessFragmentDefaultActions => ArrayRef[Str|Undef] | ||
| 82 | |||
| 83 | The actions to take on a fragmented UDP packet if it doesn't match any | ||
| 84 | of the stateless rules in the policy. Network Firewall only manages UDP | ||
| 85 | packet fragments and silently drops packet fragments for other | ||
| 86 | protocols. If you want non-matching fragmented UDP packets to be | ||
| 87 | forwarded for stateful inspection, specify C<aws:forward_to_sfe>. | ||
| 88 | |||
| 89 | You must specify one of the standard actions: C<aws:pass>, C<aws:drop>, | ||
| 90 | or C<aws:forward_to_sfe>. In addition, you can specify custom actions | ||
| 91 | that are compatible with your standard section choice. | ||
| 92 | |||
| 93 | For example, you could specify C<["aws:pass"]> or you could specify | ||
| 94 | C<["aws:pass", E<ldquo>customActionNameE<rdquo>]>. For information | ||
| 95 | about compatibility, see the custom action descriptions under | ||
| 96 | CustomAction. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 StatelessRuleGroupReferences => ArrayRef[L<Paws::NetworkFirewall::StatelessRuleGroupReference>] | ||
| 100 | |||
| 101 | References to the stateless rule groups that are used in the policy. | ||
| 102 | These define the matching criteria in stateless rules. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::NetworkFirewall> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |