« blib/lib/Paws/NetworkFirewall/DescribeResourcePolicyResponse.pm
↑ Summary
blib/lib/Paws/NetworkFirewall/DescribeRuleGroupResponse.pm »
| 1 | |||
| 2 | package Paws::NetworkFirewall::DescribeRuleGroup; | ||
| 3 | use Moose; | ||
| 4 | has RuleGroupArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has RuleGroupName => (is => 'ro', isa => 'Str'); | ||
| 6 | has Type => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeRuleGroup'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::NetworkFirewall::DescribeRuleGroupResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::NetworkFirewall::DescribeRuleGroup - Arguments for method DescribeRuleGroup on L<Paws::NetworkFirewall> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeRuleGroup on the | ||
| 24 | L<AWS Network Firewall|Paws::NetworkFirewall> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeRuleGroup. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeRuleGroup. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $network-firewall = Paws->service('NetworkFirewall'); | ||
| 32 | my $DescribeRuleGroupResponse = $network -firewall->DescribeRuleGroup( | ||
| 33 | RuleGroupArn => 'MyResourceArn', # OPTIONAL | ||
| 34 | RuleGroupName => 'MyResourceName', # OPTIONAL | ||
| 35 | Type => 'STATELESS', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $RuleGroup = $DescribeRuleGroupResponse->RuleGroup; | ||
| 40 | my $RuleGroupResponse = $DescribeRuleGroupResponse->RuleGroupResponse; | ||
| 41 | my $UpdateToken = $DescribeRuleGroupResponse->UpdateToken; | ||
| 42 | |||
| 43 | # Returns a L<Paws::NetworkFirewall::DescribeRuleGroupResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/network-firewall/DescribeRuleGroup> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 RuleGroupArn => Str | ||
| 52 | |||
| 53 | The Amazon Resource Name (ARN) of the rule group. | ||
| 54 | |||
| 55 | You must specify the ARN or the name, and you can specify both. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 RuleGroupName => Str | ||
| 60 | |||
| 61 | The descriptive name of the rule group. You can't change the name of a | ||
| 62 | rule group after you create it. | ||
| 63 | |||
| 64 | You must specify the ARN or the name, and you can specify both. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Type => Str | ||
| 69 | |||
| 70 | Indicates whether the rule group is stateless or stateful. If the rule | ||
| 71 | group is stateless, it contains stateless rules. If it is stateful, it | ||
| 72 | contains stateful rules. | ||
| 73 | |||
| 74 | This setting is required for requests that do not include the | ||
| 75 | C<RuleGroupARN>. | ||
| 76 | |||
| 77 | Valid values are: C<"STATELESS">, C<"STATEFUL"> | ||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method DescribeRuleGroup in L<Paws::NetworkFirewall> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |