blib/lib/Paws/CloudWatchEvents/Target.pm untested

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 20 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::CloudWatchEvents::Target;
3 use Moose;
4 has Arn => (is => 'ro', isa => 'Str', required => 1);
5 has BatchParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::BatchParameters');
6 has DeadLetterConfig => (is => 'ro', isa => 'Paws::CloudWatchEvents::DeadLetterConfig');
7 has EcsParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::EcsParameters');
8 has HttpParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::HttpParameters');
9 has Id => (is => 'ro', isa => 'Str', required => 1);
10 has Input => (is => 'ro', isa => 'Str');
11 has InputPath => (is => 'ro', isa => 'Str');
12 has InputTransformer => (is => 'ro', isa => 'Paws::CloudWatchEvents::InputTransformer');
13 has KinesisParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::KinesisParameters');
14 has RedshiftDataParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::RedshiftDataParameters');
15 has RetryPolicy => (is => 'ro', isa => 'Paws::CloudWatchEvents::RetryPolicy');
16 has RoleArn => (is => 'ro', isa => 'Str');
17 has RunCommandParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::RunCommandParameters');
18 has SageMakerPipelineParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::SageMakerPipelineParameters');
19 has SqsParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::SqsParameters');
20  
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::CloudWatchEvents::Target
28  
29 =head1 USAGE
30  
31 This class represents one of two things:
32  
33 =head3 Arguments in a call to a service
34  
35 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
36 Each attribute should be used as a named argument in the calls that expect this type of object.
37  
38 As an example, if Att1 is expected to be a Paws::CloudWatchEvents::Target object:
39  
40 $service_obj->Method(Att1 => { Arn => $value, ..., SqsParameters => $value });
41  
42 =head3 Results returned from an API call
43  
44 Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::Target object:
45  
46 $result = $service_obj->Method(...);
47 $result->Att1->Arn
48  
49 =head1 DESCRIPTION
50  
51 Targets are the resources to be invoked when a rule is triggered. For a
52 complete list of services and resources that can be set as a target,
53 see PutTargets.
54  
55 If you are setting the event bus of another account as the target, and
56 that account granted permission to your account through an organization
57 instead of directly by the account ID, then you must specify a
58 C<RoleArn> with proper permissions in the C<Target> structure. For more
59 information, see Sending and Receiving Events Between AWS Accounts
60 (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html)
61 in the I<Amazon EventBridge User Guide>.
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 B<REQUIRED> Arn => Str
67  
68 The Amazon Resource Name (ARN) of the target.
69  
70  
71 =head2 BatchParameters => L<Paws::CloudWatchEvents::BatchParameters>
72  
73 If the event target is an AWS Batch job, this contains the job
74 definition, job name, and other parameters. For more information, see
75 Jobs (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in
76 the I<AWS Batch User Guide>.
77  
78  
79 =head2 DeadLetterConfig => L<Paws::CloudWatchEvents::DeadLetterConfig>
80  
81 The C<DeadLetterConfig> that defines the target queue to send
82 dead-letter queue events to.
83  
84  
85 =head2 EcsParameters => L<Paws::CloudWatchEvents::EcsParameters>
86  
87 Contains the Amazon ECS task definition and task count to be used, if
88 the event target is an Amazon ECS task. For more information about
89 Amazon ECS tasks, see Task Definitions
90 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html)
91 in the I<Amazon EC2 Container Service Developer Guide>.
92  
93  
94 =head2 HttpParameters => L<Paws::CloudWatchEvents::HttpParameters>
95  
96 Contains the HTTP parameters to use when the target is a API Gateway
97 REST endpoint or EventBridge ApiDestination.
98  
99 If you specify an API Gateway REST API or EventBridge ApiDestination as
100 a target, you can use this parameter to specify headers, path
101 parameters, and query string keys/values as part of your target
102 invoking request. If you're using ApiDestinations, the corresponding
103 Connection can also have these values configured. In case of any
104 conflicting keys, values from the Connection take precedence.
105  
106  
107 =head2 B<REQUIRED> Id => Str
108  
109 The ID of the target.
110  
111  
112 =head2 Input => Str
113  
114 Valid JSON text passed to the target. In this case, nothing from the
115 event itself is passed to the target. For more information, see The
116 JavaScript Object Notation (JSON) Data Interchange Format
117 (http://www.rfc-editor.org/rfc/rfc7159.txt).
118  
119  
120 =head2 InputPath => Str
121  
122 The value of the JSONPath that is used for extracting part of the
123 matched event when passing it to the target. You must use JSON dot
124 notation, not bracket notation. For more information about JSON paths,
125 see JSONPath (http://goessner.net/articles/JsonPath/).
126  
127  
128 =head2 InputTransformer => L<Paws::CloudWatchEvents::InputTransformer>
129  
130 Settings to enable you to provide custom input to a target based on
131 certain event data. You can extract one or more key-value pairs from
132 the event and then use that data to send customized input to the
133 target.
134  
135  
136 =head2 KinesisParameters => L<Paws::CloudWatchEvents::KinesisParameters>
137  
138 The custom parameter you can use to control the shard assignment, when
139 the target is a Kinesis data stream. If you do not include this
140 parameter, the default is to use the C<eventId> as the partition key.
141  
142  
143 =head2 RedshiftDataParameters => L<Paws::CloudWatchEvents::RedshiftDataParameters>
144  
145 Contains the Redshift Data API parameters to use when the target is a
146 Redshift cluster.
147  
148 If you specify a Redshift Cluster as a Target, you can use this to
149 specify parameters to invoke the Redshift Data API ExecuteStatement
150 based on EventBridge events.
151  
152  
153 =head2 RetryPolicy => L<Paws::CloudWatchEvents::RetryPolicy>
154  
155 The C<RetryPolicy> object that contains the retry policy configuration
156 to use for the dead-letter queue.
157  
158  
159 =head2 RoleArn => Str
160  
161 The Amazon Resource Name (ARN) of the IAM role to be used for this
162 target when the rule is triggered. If one rule triggers multiple
163 targets, you can use a different IAM role for each target.
164  
165  
166 =head2 RunCommandParameters => L<Paws::CloudWatchEvents::RunCommandParameters>
167  
168 Parameters used when you are using the rule to invoke Amazon EC2 Run
169 Command.
170  
171  
172 =head2 SageMakerPipelineParameters => L<Paws::CloudWatchEvents::SageMakerPipelineParameters>
173  
174 Contains the SageMaker Model Building Pipeline parameters to start
175 execution of a SageMaker Model Building Pipeline.
176  
177 If you specify a SageMaker Model Building Pipeline as a target, you can
178 use this to specify parameters to start a pipeline execution based on
179 EventBridge events.
180  
181  
182 =head2 SqsParameters => L<Paws::CloudWatchEvents::SqsParameters>
183  
184 Contains the message group ID to use when the target is a FIFO queue.
185  
186 If you specify an SQS FIFO queue as a target, the queue must have
187 content-based deduplication enabled.
188  
189  
190  
191 =head1 SEE ALSO
192  
193 This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents>
194  
195 =head1 BUGS and CONTRIBUTIONS
196  
197 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
198  
199 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
200  
201 =cut
202