/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::WAFV2::GetRuleGroup

NAME

Paws::WAFV2::GetRuleGroup - Arguments for method GetRuleGroup on Paws::WAFV2

DESCRIPTION

This class represents the parameters used for calling the method GetRuleGroup on the AWS WAFV2 service. Use the attributes of this class as arguments to method GetRuleGroup.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRuleGroup.

SYNOPSIS

my $wafv2 = Paws->service('WAFV2');
my $GetRuleGroupResponse = $wafv2->GetRuleGroup(
  ARN   => 'MyResourceArn',    # OPTIONAL
  Id    => 'MyEntityId',       # OPTIONAL
  Name  => 'MyEntityName',     # OPTIONAL
  Scope => 'CLOUDFRONT',       # OPTIONAL
);

# Results:
my $LockToken = $GetRuleGroupResponse->LockToken;
my $RuleGroup = $GetRuleGroupResponse->RuleGroup;

# Returns a L<Paws::WAFV2::GetRuleGroupResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/wafv2/GetRuleGroup

ATTRIBUTES

ARN => Str

The Amazon Resource Name (ARN) of the entity.

Id => Str

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Name => Str

The name of the rule group. You cannot change the name of a rule group after you create it.

Scope => Str

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Valid values are: "CLOUDFRONT", "REGIONAL"

SEE ALSO

This class forms part of Paws, documenting arguments for method GetRuleGroup in Paws::WAFV2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues