« blib/lib/Paws/WAFV2/DeleteWebACLResponse.pm
↑ Summary
blib/lib/Paws/WAFV2/DescribeManagedRuleGroupResponse.pm »
| 1 | |||
| 2 | package Paws::WAFV2::DescribeManagedRuleGroup; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Scope => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has VendorName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeManagedRuleGroup'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WAFV2::DescribeManagedRuleGroupResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::WAFV2::DescribeManagedRuleGroup - Arguments for method DescribeManagedRuleGroup on L<Paws::WAFV2> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeManagedRuleGroup on the | ||
| 24 | L<AWS WAFV2|Paws::WAFV2> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeManagedRuleGroup. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeManagedRuleGroup. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $wafv2 = Paws->service('WAFV2'); | ||
| 32 | my $DescribeManagedRuleGroupResponse = $wafv2->DescribeManagedRuleGroup( | ||
| 33 | Name => 'MyEntityName', | ||
| 34 | Scope => 'CLOUDFRONT', | ||
| 35 | VendorName => 'MyVendorName', | ||
| 36 | |||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $AvailableLabels = $DescribeManagedRuleGroupResponse->AvailableLabels; | ||
| 41 | my $Capacity = $DescribeManagedRuleGroupResponse->Capacity; | ||
| 42 | my $ConsumedLabels = $DescribeManagedRuleGroupResponse->ConsumedLabels; | ||
| 43 | my $LabelNamespace = $DescribeManagedRuleGroupResponse->LabelNamespace; | ||
| 44 | my $Rules = $DescribeManagedRuleGroupResponse->Rules; | ||
| 45 | |||
| 46 | # Returns a L<Paws::WAFV2::DescribeManagedRuleGroupResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/wafv2/DescribeManagedRuleGroup> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> Name => Str | ||
| 55 | |||
| 56 | The name of the managed rule group. You use this, along with the vendor | ||
| 57 | name, to identify the rule group. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Scope => Str | ||
| 62 | |||
| 63 | Specifies whether this is for an Amazon CloudFront distribution or for | ||
| 64 | a regional application. A regional application can be an Application | ||
| 65 | Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync | ||
| 66 | GraphQL API. | ||
| 67 | |||
| 68 | To work with CloudFront, you must also specify the Region US East (N. | ||
| 69 | Virginia) as follows: | ||
| 70 | |||
| 71 | =over | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | CLI - Specify the Region when you use the CloudFront scope: | ||
| 76 | C<--scope=CLOUDFRONT --region=us-east-1>. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | API and SDKs - For all calls, use the Region endpoint us-east-1. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | |||
| 85 | Valid values are: C<"CLOUDFRONT">, C<"REGIONAL"> | ||
| 86 | |||
| 87 | =head2 B<REQUIRED> VendorName => Str | ||
| 88 | |||
| 89 | The name of the managed rule group vendor. You use this, along with the | ||
| 90 | rule group name, to identify the rule group. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method DescribeManagedRuleGroup in L<Paws::WAFV2> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |