« blib/lib/Paws/CloudWatch/PutDashboardOutput.pm
↑ Summary
blib/lib/Paws/CloudWatch/PutInsightRuleOutput.pm »
| 1 | |||
| 2 | package Paws::CloudWatch::PutInsightRule; | ||
| 3 | use Moose; | ||
| 4 | has RuleDefinition => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has RuleName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has RuleState => (is => 'ro', isa => 'Str'); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::Tag]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutInsightRule'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::PutInsightRuleOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'PutInsightRuleResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudWatch::PutInsightRule - Arguments for method PutInsightRule on L<Paws::CloudWatch> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutInsightRule on the | ||
| 25 | L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class | ||
| 26 | as arguments to method PutInsightRule. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutInsightRule. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $monitoring = Paws->service('CloudWatch'); | ||
| 33 | my $PutInsightRuleOutput = $monitoring->PutInsightRule( | ||
| 34 | RuleDefinition => 'MyInsightRuleDefinition', | ||
| 35 | RuleName => 'MyInsightRuleName', | ||
| 36 | RuleState => 'MyInsightRuleState', # OPTIONAL | ||
| 37 | Tags => [ | ||
| 38 | { | ||
| 39 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 40 | Value => 'MyTagValue', # max: 256 | ||
| 41 | |||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/PutInsightRule> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> RuleDefinition => Str | ||
| 54 | |||
| 55 | The definition of the rule, as a JSON object. For details on the valid | ||
| 56 | syntax, see Contributor Insights Rule Syntax | ||
| 57 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html). | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> RuleName => Str | ||
| 62 | |||
| 63 | A unique name for the rule. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 RuleState => Str | ||
| 68 | |||
| 69 | The state of the rule. Valid values are ENABLED and DISABLED. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 Tags => ArrayRef[L<Paws::CloudWatch::Tag>] | ||
| 74 | |||
| 75 | A list of key-value pairs to associate with the Contributor Insights | ||
| 76 | rule. You can associate as many as 50 tags with a rule. | ||
| 77 | |||
| 78 | Tags can help you organize and categorize your resources. You can also | ||
| 79 | use them to scope user permissions, by granting a user permission to | ||
| 80 | access or change only the resources that have certain tag values. | ||
| 81 | |||
| 82 | To be able to associate tags with a rule, you must have the | ||
| 83 | C<cloudwatch:TagResource> permission in addition to the | ||
| 84 | C<cloudwatch:PutInsightRule> permission. | ||
| 85 | |||
| 86 | If you are using this operation to update an existing Contributor | ||
| 87 | Insights rule, any tags you specify in this parameter are ignored. To | ||
| 88 | change the tags of an existing rule, use TagResource | ||
| 89 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html). | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method PutInsightRule in L<Paws::CloudWatch> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |