File Coverage

blib/lib/Paws/CloudWatchEvents/Target.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudWatchEvents::Target;
2 1     1   392 use Moose;
  1         2  
  1         7  
3             has Arn => (is => 'ro', isa => 'Str', required => 1);
4             has EcsParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::EcsParameters');
5             has Id => (is => 'ro', isa => 'Str', required => 1);
6             has Input => (is => 'ro', isa => 'Str');
7             has InputPath => (is => 'ro', isa => 'Str');
8             has InputTransformer => (is => 'ro', isa => 'Paws::CloudWatchEvents::InputTransformer');
9             has KinesisParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::KinesisParameters');
10             has RoleArn => (is => 'ro', isa => 'Str');
11             has RunCommandParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::RunCommandParameters');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::CloudWatchEvents::Target
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::CloudWatchEvents::Target object:
30              
31             $service_obj->Method(Att1 => { Arn => $value, ..., RunCommandParameters => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::Target object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->Arn
39              
40             =head1 DESCRIPTION
41              
42             Targets are the resources to be invoked when a rule is triggered.
43             Target types include EC2 instances, AWS Lambda functions, Amazon
44             Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines,
45             Run Command, and built-in targets.
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 B<REQUIRED> Arn => Str
51              
52             The Amazon Resource Name (ARN) of the target.
53              
54              
55             =head2 EcsParameters => L<Paws::CloudWatchEvents::EcsParameters>
56              
57             Contains the Amazon ECS task definition and task count to be used, if
58             the event target is an Amazon ECS task. For more information about
59             Amazon ECS tasks, see Task Definitions in the I<Amazon EC2 Container
60             Service Developer Guide>.
61              
62              
63             =head2 B<REQUIRED> Id => Str
64              
65             The ID of the target.
66              
67              
68             =head2 Input => Str
69              
70             Valid JSON text passed to the target. In this case, nothing from the
71             event itself is passed to the target. You must use JSON dot notation,
72             not bracket notation. For more information, see The JavaScript Object
73             Notation (JSON) Data Interchange Format.
74              
75              
76             =head2 InputPath => Str
77              
78             The value of the JSONPath that is used for extracting part of the
79             matched event when passing it to the target. You must use JSON dot
80             notation, not bracket notation. For more information about JSON paths,
81             see JSONPath.
82              
83              
84             =head2 InputTransformer => L<Paws::CloudWatchEvents::InputTransformer>
85              
86             Settings to enable you to provide custom input to a target based on
87             certain event data. You can extract one or more key-value pairs from
88             the event and then use that data to send customized input to the
89             target.
90              
91              
92             =head2 KinesisParameters => L<Paws::CloudWatchEvents::KinesisParameters>
93              
94             The custom parameter you can use to control shard assignment, when the
95             target is an Amazon Kinesis stream. If you do not include this
96             parameter, the default is to use the C<eventId> as the partition key.
97              
98              
99             =head2 RoleArn => Str
100              
101             The Amazon Resource Name (ARN) of the IAM role to be used for this
102             target when the rule is triggered. If one rule triggers multiple
103             targets, you can use a different IAM role for each target.
104              
105              
106             =head2 RunCommandParameters => L<Paws::CloudWatchEvents::RunCommandParameters>
107              
108             Parameters used when you are using the rule to invoke Amazon EC2 Run
109             Command.
110              
111              
112              
113             =head1 SEE ALSO
114              
115             This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents>
116              
117             =head1 BUGS and CONTRIBUTIONS
118              
119             The source code is located here: https://github.com/pplu/aws-sdk-perl
120              
121             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
122              
123             =cut
124