File Coverage

blib/lib/Paws/CloudTrail/Trail.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	sub	time	code
1				package Paws::CloudTrail::Trail;
2	1	1	317	use Moose;
	1		2
	1		6
3				has CloudWatchLogsLogGroupArn => (is => 'ro', isa => 'Str');
4				has CloudWatchLogsRoleArn => (is => 'ro', isa => 'Str');
5				has HasCustomEventSelectors => (is => 'ro', isa => 'Bool');
6				has HomeRegion => (is => 'ro', isa => 'Str');
7				has IncludeGlobalServiceEvents => (is => 'ro', isa => 'Bool');
8				has IsMultiRegionTrail => (is => 'ro', isa => 'Bool');
9				has KmsKeyId => (is => 'ro', isa => 'Str');
10				has LogFileValidationEnabled => (is => 'ro', isa => 'Bool');
11				has Name => (is => 'ro', isa => 'Str');
12				has S3BucketName => (is => 'ro', isa => 'Str');
13				has S3KeyPrefix => (is => 'ro', isa => 'Str');
14				has SnsTopicARN => (is => 'ro', isa => 'Str');
15				has SnsTopicName => (is => 'ro', isa => 'Str');
16				has TrailARN => (is => 'ro', isa => 'Str');
17				1;
18
19				### main pod documentation begin ###
20
21				=head1 NAME
22
23				Paws::CloudTrail::Trail
24
25				=head1 USAGE
26
27				This class represents one of two things:
28
29				=head3 Arguments in a call to a service
30
31				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
32				Each attribute should be used as a named argument in the calls that expect this type of object.
33
34				As an example, if Att1 is expected to be a Paws::CloudTrail::Trail object:
35
36				$service_obj->Method(Att1 => { CloudWatchLogsLogGroupArn => $value, ..., TrailARN => $value });
37
38				=head3 Results returned from an API call
39
40				Use accessors for each attribute. If Att1 is expected to be an Paws::CloudTrail::Trail object:
41
42				$result = $service_obj->Method(...);
43				$result->Att1->CloudWatchLogsLogGroupArn
44
45				=head1 DESCRIPTION
46
47				The settings for a trail.
48
49				=head1 ATTRIBUTES
50
51
52				=head2 CloudWatchLogsLogGroupArn => Str
53
54				Specifies an Amazon Resource Name (ARN), a unique identifier that
55				represents the log group to which CloudTrail logs will be delivered.
56
57
58				=head2 CloudWatchLogsRoleArn => Str
59
60				Specifies the role for the CloudWatch Logs endpoint to assume to write
61				to a user's log group.
62
63
64				=head2 HasCustomEventSelectors => Bool
65
66				Specifies if the trail has custom event selectors.
67
68
69				=head2 HomeRegion => Str
70
71				The region in which the trail was created.
72
73
74				=head2 IncludeGlobalServiceEvents => Bool
75
76				Set to B<True> to include AWS API calls from AWS global services such
77				as IAM. Otherwise, B<False>.
78
79
80				=head2 IsMultiRegionTrail => Bool
81
82				Specifies whether the trail belongs only to one region or exists in all
83				regions.
84
85
86				=head2 KmsKeyId => Str
87
88				Specifies the KMS key ID that encrypts the logs delivered by
89				CloudTrail. The value is a fully specified ARN to a KMS key in the
90				format:
91
92				C<arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012>
93
94
95				=head2 LogFileValidationEnabled => Bool
96
97				Specifies whether log file validation is enabled.
98
99
100				=head2 Name => Str
101
102				Name of the trail set by calling CreateTrail. The maximum length is 128
103				characters.
104
105
106				=head2 S3BucketName => Str
107
108				Name of the Amazon S3 bucket into which CloudTrail delivers your trail
109				files. See Amazon S3 Bucket Naming Requirements.
110
111
112				=head2 S3KeyPrefix => Str
113
114				Specifies the Amazon S3 key prefix that comes after the name of the
115				bucket you have designated for log file delivery. For more information,
116				see Finding Your CloudTrail Log Files.The maximum length is 200
117				characters.
118
119
120				=head2 SnsTopicARN => Str
121
122				Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
123				notifications when log files are delivered. The format of a topic ARN
124				is:
125
126				C<arn:aws:sns:us-east-1:123456789012:MyTopic>
127
128
129				=head2 SnsTopicName => Str
130
131				This field is deprecated. Use SnsTopicARN.
132
133
134				=head2 TrailARN => Str
135
136				Specifies the ARN of the trail. The format of a trail ARN is:
137
138				C<arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail>
139
140
141
142				=head1 SEE ALSO
143
144				This class forms part of L<Paws>, describing an object used in L<Paws::CloudTrail>
145
146				=head1 BUGS and CONTRIBUTIONS
147
148				The source code is located here: https://github.com/pplu/aws-sdk-perl
149
150				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
151
152				=cut
153