« blib/lib/Paws/NetworkFirewall/CreateRuleGroupResponse.pm
↑ Summary
blib/lib/Paws/NetworkFirewall/DeleteFirewall.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::NetworkFirewall::CustomAction; | ||
| 3 | use Moose; | ||
| 4 | has ActionDefinition => (is => 'ro', isa => 'Paws::NetworkFirewall::ActionDefinition', required => 1); | ||
| 5 | has ActionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::NetworkFirewall::CustomAction | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::NetworkFirewall::CustomAction object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { ActionDefinition => $value, ..., ActionName => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::NetworkFirewall::CustomAction object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->ActionDefinition | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | An optional, non-standard action to use for stateless packet handling. | ||
| 38 | You can define this in addition to the standard action that you must | ||
| 39 | specify. | ||
| 40 | |||
| 41 | You define and name the custom actions that you want to be able to use, | ||
| 42 | and then you reference them by name in your actions settings. | ||
| 43 | |||
| 44 | You can use custom actions in the following places: | ||
| 45 | |||
| 46 | =over | ||
| 47 | |||
| 48 | =item * | ||
| 49 | |||
| 50 | In a rule group's StatelessRulesAndCustomActions specification. The | ||
| 51 | custom actions are available for use by name inside the | ||
| 52 | C<StatelessRulesAndCustomActions> where you define them. You can use | ||
| 53 | them for your stateless rule actions to specify what to do with a | ||
| 54 | packet that matches the rule's match attributes. | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | In a FirewallPolicy specification, in C<StatelessCustomActions>. The | ||
| 59 | custom actions are available for use inside the policy where you define | ||
| 60 | them. You can use them for the policy's default stateless actions | ||
| 61 | settings to specify what to do with packets that don't match any of the | ||
| 62 | policy's stateless rules. | ||
| 63 | |||
| 64 | =back | ||
| 65 | |||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> ActionDefinition => L<Paws::NetworkFirewall::ActionDefinition> | ||
| 71 | |||
| 72 | The custom action associated with the action name. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> ActionName => Str | ||
| 76 | |||
| 77 | The descriptive name of the custom action. You can't change the name of | ||
| 78 | a custom action after you create it. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, describing an object used in L<Paws::NetworkFirewall> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |