« blib/lib/Paws/Config/RetentionConfiguration.pm
↑ Summary
blib/lib/Paws/Config/SelectAggregateResourceConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Config::Scope; | ||
| 3 | use Moose; | ||
| 4 | has ComplianceResourceId => (is => 'ro', isa => 'Str'); | ||
| 5 | has ComplianceResourceTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has TagKey => (is => 'ro', isa => 'Str'); | ||
| 7 | has TagValue => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Config::Scope | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Config::Scope object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { ComplianceResourceId => $value, ..., TagValue => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Config::Scope object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->ComplianceResourceId | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Defines which resources trigger an evaluation for an AWS Config rule. | ||
| 40 | The scope can include one or more resource types, a combination of a | ||
| 41 | tag key and value, or a combination of one resource type and one | ||
| 42 | resource ID. Specify a scope to constrain which resources trigger an | ||
| 43 | evaluation for a rule. Otherwise, evaluations for the rule are | ||
| 44 | triggered when any resource in your recording group changes in | ||
| 45 | configuration. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 ComplianceResourceId => Str | ||
| 51 | |||
| 52 | The ID of the only AWS resource that you want to trigger an evaluation | ||
| 53 | for the rule. If you specify a resource ID, you must specify one | ||
| 54 | resource type for C<ComplianceResourceTypes>. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ComplianceResourceTypes => ArrayRef[Str|Undef] | ||
| 58 | |||
| 59 | The resource types of only those AWS resources that you want to trigger | ||
| 60 | an evaluation for the rule. You can only specify one type if you also | ||
| 61 | specify a resource ID for C<ComplianceResourceId>. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 TagKey => Str | ||
| 65 | |||
| 66 | The tag key that is applied to only those AWS resources that you want | ||
| 67 | to trigger an evaluation for the rule. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 TagValue => Str | ||
| 71 | |||
| 72 | The tag value applied to only those AWS resources that you want to | ||
| 73 | trigger an evaluation for the rule. If you specify a value for | ||
| 74 | C<TagValue>, you must also specify a value for C<TagKey>. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, describing an object used in L<Paws::Config> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |