« blib/lib/Paws/CloudWatchEvents/RetryPolicy.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/RunCommandParameters.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatchEvents::Rule; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has EventBusName => (is => 'ro', isa => 'Str'); | ||
| 7 | has EventPattern => (is => 'ro', isa => 'Str'); | ||
| 8 | has ManagedBy => (is => 'ro', isa => 'Str'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str'); | ||
| 10 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 11 | has ScheduleExpression => (is => 'ro', isa => 'Str'); | ||
| 12 | has State => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudWatchEvents::Rule | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::CloudWatchEvents::Rule object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Arn => $value, ..., State => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::Rule object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Arn | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Contains information about a rule in Amazon EventBridge. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Arn => Str | ||
| 50 | |||
| 51 | The Amazon Resource Name (ARN) of the rule. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Description => Str | ||
| 55 | |||
| 56 | The description of the rule. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 EventBusName => Str | ||
| 60 | |||
| 61 | The name or ARN of the event bus associated with the rule. If you omit | ||
| 62 | this, the default event bus is used. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 EventPattern => Str | ||
| 66 | |||
| 67 | The event pattern of the rule. For more information, see Events and | ||
| 68 | Event Patterns | ||
| 69 | (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) | ||
| 70 | in the I<Amazon EventBridge User Guide>. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 ManagedBy => Str | ||
| 74 | |||
| 75 | If the rule was created on behalf of your account by an AWS service, | ||
| 76 | this field displays the principal name of the service that created the | ||
| 77 | rule. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Name => Str | ||
| 81 | |||
| 82 | The name of the rule. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 RoleArn => Str | ||
| 86 | |||
| 87 | The Amazon Resource Name (ARN) of the role that is used for target | ||
| 88 | invocation. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ScheduleExpression => Str | ||
| 92 | |||
| 93 | The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 | ||
| 94 | minutes)". | ||
| 95 | |||
| 96 | |||
| 97 | =head2 State => Str | ||
| 98 | |||
| 99 | The state of the rule. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |