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