« blib/lib/Paws/Config/ConfigExportDeliveryInfo.pm
↑ Summary
blib/lib/Paws/Config/ConfigRuleComplianceFilters.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Config::ConfigRule; | ||
| 3 | use Moose; | ||
| 4 | has ConfigRuleArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has ConfigRuleId => (is => 'ro', isa => 'Str'); | ||
| 6 | has ConfigRuleName => (is => 'ro', isa => 'Str'); | ||
| 7 | has ConfigRuleState => (is => 'ro', isa => 'Str'); | ||
| 8 | has CreatedBy => (is => 'ro', isa => 'Str'); | ||
| 9 | has Description => (is => 'ro', isa => 'Str'); | ||
| 10 | has InputParameters => (is => 'ro', isa => 'Str'); | ||
| 11 | has MaximumExecutionFrequency => (is => 'ro', isa => 'Str'); | ||
| 12 | has Scope => (is => 'ro', isa => 'Paws::Config::Scope'); | ||
| 13 | has Source => (is => 'ro', isa => 'Paws::Config::Source', required => 1); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Config::ConfigRule | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Config::ConfigRule object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { ConfigRuleArn => $value, ..., Source => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Config::ConfigRule object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->ConfigRuleArn | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | An AWS Config rule represents an AWS Lambda function that you create | ||
| 46 | for a custom rule or a predefined function for an AWS managed rule. The | ||
| 47 | function evaluates configuration items to assess whether your AWS | ||
| 48 | resources comply with your desired configurations. This function can | ||
| 49 | run when AWS Config detects a configuration change to an AWS resource | ||
| 50 | and at a periodic frequency that you choose (for example, every 24 | ||
| 51 | hours). | ||
| 52 | |||
| 53 | You can use the AWS CLI and AWS SDKs if you want to create a rule that | ||
| 54 | triggers evaluations for your resources when AWS Config delivers the | ||
| 55 | configuration snapshot. For more information, see | ||
| 56 | ConfigSnapshotDeliveryProperties. | ||
| 57 | |||
| 58 | For more information about developing and using AWS Config rules, see | ||
| 59 | Evaluating AWS Resource Configurations with AWS Config | ||
| 60 | (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) | ||
| 61 | in the I<AWS Config Developer Guide>. | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ConfigRuleArn => Str | ||
| 67 | |||
| 68 | The Amazon Resource Name (ARN) of the AWS Config rule. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 ConfigRuleId => Str | ||
| 72 | |||
| 73 | The ID of the AWS Config rule. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ConfigRuleName => Str | ||
| 77 | |||
| 78 | The name that you assign to the AWS Config rule. The name is required | ||
| 79 | if you are adding a new rule. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 ConfigRuleState => Str | ||
| 83 | |||
| 84 | Indicates whether the AWS Config rule is active or is currently being | ||
| 85 | deleted by AWS Config. It can also indicate the evaluation status for | ||
| 86 | the AWS Config rule. | ||
| 87 | |||
| 88 | AWS Config sets the state of the rule to C<EVALUATING> temporarily | ||
| 89 | after you use the C<StartConfigRulesEvaluation> request to evaluate | ||
| 90 | your resources against the AWS Config rule. | ||
| 91 | |||
| 92 | AWS Config sets the state of the rule to C<DELETING_RESULTS> | ||
| 93 | temporarily after you use the C<DeleteEvaluationResults> request to | ||
| 94 | delete the current evaluation results for the AWS Config rule. | ||
| 95 | |||
| 96 | AWS Config temporarily sets the state of a rule to C<DELETING> after | ||
| 97 | you use the C<DeleteConfigRule> request to delete the rule. After AWS | ||
| 98 | Config deletes the rule, the rule and all of its evaluations are erased | ||
| 99 | and are no longer available. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 CreatedBy => Str | ||
| 103 | |||
| 104 | Service principal name of the service that created the rule. | ||
| 105 | |||
| 106 | The field is populated only if the service linked rule is created by a | ||
| 107 | service. The field is empty if you create your own rule. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Description => Str | ||
| 111 | |||
| 112 | The description that you provide for the AWS Config rule. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 InputParameters => Str | ||
| 116 | |||
| 117 | A string, in JSON format, that is passed to the AWS Config rule Lambda | ||
| 118 | function. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 MaximumExecutionFrequency => Str | ||
| 122 | |||
| 123 | The maximum frequency with which AWS Config runs evaluations for a | ||
| 124 | rule. You can specify a value for C<MaximumExecutionFrequency> when: | ||
| 125 | |||
| 126 | =over | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | You are using an AWS managed rule that is triggered at a periodic | ||
| 131 | frequency. | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | Your custom rule is triggered when AWS Config delivers the | ||
| 136 | configuration snapshot. For more information, see | ||
| 137 | ConfigSnapshotDeliveryProperties. | ||
| 138 | |||
| 139 | =back | ||
| 140 | |||
| 141 | By default, rules with a periodic trigger are evaluated every 24 hours. | ||
| 142 | To change the frequency, specify a valid value for the | ||
| 143 | C<MaximumExecutionFrequency> parameter. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 Scope => L<Paws::Config::Scope> | ||
| 147 | |||
| 148 | Defines which resources can trigger an evaluation for the rule. The | ||
| 149 | scope can include one or more resource types, a combination of one | ||
| 150 | resource type and one resource ID, or a combination of a tag key and | ||
| 151 | value. Specify a scope to constrain the resources that can trigger an | ||
| 152 | evaluation for the rule. If you do not specify a scope, evaluations are | ||
| 153 | triggered when any resource in the recording group changes. | ||
| 154 | |||
| 155 | The scope can be empty. | ||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> Source => L<Paws::Config::Source> | ||
| 159 | |||
| 160 | Provides the rule owner (AWS or customer), the rule identifier, and the | ||
| 161 | notifications that cause the function to evaluate your AWS resources. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head1 SEE ALSO | ||
| 166 | |||
| 167 | This class forms part of L<Paws>, describing an object used in L<Paws::Config> | ||
| 168 | |||
| 169 | =head1 BUGS and CONTRIBUTIONS | ||
| 170 | |||
| 171 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 172 | |||
| 173 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 174 | |||
| 175 | =cut | ||
| 176 |