blib/lib/Paws/Synthetics/Canary.pm untested

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Synthetics::Canary;
3 use Moose;
4 has ArtifactS3Location => (is => 'ro', isa => 'Str');
5 has Code => (is => 'ro', isa => 'Paws::Synthetics::CanaryCodeOutput');
6 has EngineArn => (is => 'ro', isa => 'Str');
7 has ExecutionRoleArn => (is => 'ro', isa => 'Str');
8 has FailureRetentionPeriodInDays => (is => 'ro', isa => 'Int');
9 has Id => (is => 'ro', isa => 'Str');
10 has Name => (is => 'ro', isa => 'Str');
11 has RunConfig => (is => 'ro', isa => 'Paws::Synthetics::CanaryRunConfigOutput');
12 has RuntimeVersion => (is => 'ro', isa => 'Str');
13 has Schedule => (is => 'ro', isa => 'Paws::Synthetics::CanaryScheduleOutput');
14 has Status => (is => 'ro', isa => 'Paws::Synthetics::CanaryStatus');
15 has SuccessRetentionPeriodInDays => (is => 'ro', isa => 'Int');
16 has Tags => (is => 'ro', isa => 'Paws::Synthetics::TagMap');
17 has Timeline => (is => 'ro', isa => 'Paws::Synthetics::CanaryTimeline');
18 has VpcConfig => (is => 'ro', isa => 'Paws::Synthetics::VpcConfigOutput');
19  
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::Synthetics::Canary
27  
28 =head1 USAGE
29  
30 This class represents one of two things:
31  
32 =head3 Arguments in a call to a service
33  
34 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
35 Each attribute should be used as a named argument in the calls that expect this type of object.
36  
37 As an example, if Att1 is expected to be a Paws::Synthetics::Canary object:
38  
39 $service_obj->Method(Att1 => { ArtifactS3Location => $value, ..., VpcConfig => $value });
40  
41 =head3 Results returned from an API call
42  
43 Use accessors for each attribute. If Att1 is expected to be an Paws::Synthetics::Canary object:
44  
45 $result = $service_obj->Method(...);
46 $result->Att1->ArtifactS3Location
47  
48 =head1 DESCRIPTION
49  
50 This structure contains all information about one canary in your
51 account.
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 ArtifactS3Location => Str
57  
58 The location in Amazon S3 where Synthetics stores artifacts from the
59 runs of this canary. Artifacts include the log file, screenshots, and
60 HAR files.
61  
62  
63 =head2 Code => L<Paws::Synthetics::CanaryCodeOutput>
64  
65  
66  
67  
68 =head2 EngineArn => Str
69  
70 The ARN of the Lambda function that is used as your canary's engine.
71 For more information about Lambda ARN format, see Resources and
72 Conditions for Lambda Actions
73 (https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html).
74  
75  
76 =head2 ExecutionRoleArn => Str
77  
78 The ARN of the IAM role used to run the canary. This role must include
79 C<lambda.amazonaws.com> as a principal in the trust policy.
80  
81  
82 =head2 FailureRetentionPeriodInDays => Int
83  
84 The number of days to retain data about failed runs of this canary.
85  
86  
87 =head2 Id => Str
88  
89 The unique ID of this canary.
90  
91  
92 =head2 Name => Str
93  
94 The name of the canary.
95  
96  
97 =head2 RunConfig => L<Paws::Synthetics::CanaryRunConfigOutput>
98  
99  
100  
101  
102 =head2 RuntimeVersion => Str
103  
104 Specifies the runtime version to use for the canary. For more
105 information about runtime versions, see Canary Runtime Versions
106 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).
107  
108  
109 =head2 Schedule => L<Paws::Synthetics::CanaryScheduleOutput>
110  
111 A structure that contains information about how often the canary is to
112 run, and when these runs are to stop.
113  
114  
115 =head2 Status => L<Paws::Synthetics::CanaryStatus>
116  
117 A structure that contains information about the canary's status.
118  
119  
120 =head2 SuccessRetentionPeriodInDays => Int
121  
122 The number of days to retain data about successful runs of this canary.
123  
124  
125 =head2 Tags => L<Paws::Synthetics::TagMap>
126  
127 The list of key-value pairs that are associated with the canary.
128  
129  
130 =head2 Timeline => L<Paws::Synthetics::CanaryTimeline>
131  
132 A structure that contains information about when the canary was
133 created, modified, and most recently run.
134  
135  
136 =head2 VpcConfig => L<Paws::Synthetics::VpcConfigOutput>
137  
138  
139  
140  
141  
142 =head1 SEE ALSO
143  
144 This class forms part of L<Paws>, describing an object used in L<Paws::Synthetics>
145  
146 =head1 BUGS and CONTRIBUTIONS
147  
148 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
149  
150 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
151  
152 =cut
153