| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Config::RemediationConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has Automatic => (is => 'ro', isa => 'Bool'); | ||
| 6 | has ConfigRuleName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has CreatedByService => (is => 'ro', isa => 'Str'); | ||
| 8 | has ExecutionControls => (is => 'ro', isa => 'Paws::Config::ExecutionControls'); | ||
| 9 | has MaximumAutomaticAttempts => (is => 'ro', isa => 'Int'); | ||
| 10 | has Parameters => (is => 'ro', isa => 'Paws::Config::RemediationParameters'); | ||
| 11 | has ResourceType => (is => 'ro', isa => 'Str'); | ||
| 12 | has RetryAttemptSeconds => (is => 'ro', isa => 'Int'); | ||
| 13 | has TargetId => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has TargetType => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | has TargetVersion => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Config::RemediationConfiguration | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::Config::RemediationConfiguration object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { Arn => $value, ..., TargetVersion => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::Config::RemediationConfiguration object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->Arn | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | An object that represents the details about the remediation | ||
| 48 | configuration that includes the remediation action, parameters, and | ||
| 49 | data to execute the action. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Arn => Str | ||
| 55 | |||
| 56 | Amazon Resource Name (ARN) of remediation configuration. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Automatic => Bool | ||
| 60 | |||
| 61 | The remediation is triggered automatically. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> ConfigRuleName => Str | ||
| 65 | |||
| 66 | The name of the AWS Config rule. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 CreatedByService => Str | ||
| 70 | |||
| 71 | Name of the service that owns the service linked rule, if applicable. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 ExecutionControls => L<Paws::Config::ExecutionControls> | ||
| 75 | |||
| 76 | An ExecutionControls object. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 MaximumAutomaticAttempts => Int | ||
| 80 | |||
| 81 | The maximum number of failed attempts for auto-remediation. If you do | ||
| 82 | not select a number, the default is 5. | ||
| 83 | |||
| 84 | For example, if you specify MaximumAutomaticAttempts as 5 with | ||
| 85 | RetryAttemptSeconds as 50 seconds, AWS Config will put a | ||
| 86 | RemediationException on your behalf for the failing resource after the | ||
| 87 | 5th failed attempt within 50 seconds. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 Parameters => L<Paws::Config::RemediationParameters> | ||
| 91 | |||
| 92 | An object of the RemediationParameterValue. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 ResourceType => Str | ||
| 96 | |||
| 97 | The type of a resource. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 RetryAttemptSeconds => Int | ||
| 101 | |||
| 102 | Maximum time in seconds that AWS Config runs auto-remediation. If you | ||
| 103 | do not select a number, the default is 60 seconds. | ||
| 104 | |||
| 105 | For example, if you specify RetryAttemptSeconds as 50 seconds and | ||
| 106 | MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 | ||
| 107 | times within 50 seconds before throwing an exception. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> TargetId => Str | ||
| 111 | |||
| 112 | Target ID is the name of the public document. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> TargetType => Str | ||
| 116 | |||
| 117 | The type of the target. Target executes remediation. For example, SSM | ||
| 118 | document. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 TargetVersion => Str | ||
| 122 | |||
| 123 | Version of the target. For example, version of the SSM document. | ||
| 124 | |||
| 125 | If you make backward incompatible changes to the SSM document, you must | ||
| 126 | call PutRemediationConfiguration API again to ensure the remediations | ||
| 127 | can run. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, describing an object used in L<Paws::Config> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |