blib/lib/Paws/CloudTrail/UpdateTrail.pm untested

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 22 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CloudTrail::UpdateTrail;
3 use Moose;
4 has CloudWatchLogsLogGroupArn => (is => 'ro', isa => 'Str');
5 has CloudWatchLogsRoleArn => (is => 'ro', isa => 'Str');
6 has EnableLogFileValidation => (is => 'ro', isa => 'Bool');
7 has IncludeGlobalServiceEvents => (is => 'ro', isa => 'Bool');
8 has IsMultiRegionTrail => (is => 'ro', isa => 'Bool');
9 has IsOrganizationTrail => (is => 'ro', isa => 'Bool');
10 has KmsKeyId => (is => 'ro', isa => 'Str');
11 has Name => (is => 'ro', isa => 'Str', required => 1);
12 has S3BucketName => (is => 'ro', isa => 'Str');
13 has S3KeyPrefix => (is => 'ro', isa => 'Str');
14 has SnsTopicName => (is => 'ro', isa => 'Str');
15  
16 use MooseX::ClassAttribute;
17  
18 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateTrail');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudTrail::UpdateTrailResponse');
20 class_has _result_key => (isa => 'Str', is => 'ro');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::CloudTrail::UpdateTrail - Arguments for method UpdateTrail on L<Paws::CloudTrail>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method UpdateTrail on the
32 L<AWS CloudTrail|Paws::CloudTrail> service. Use the attributes of this class
33 as arguments to method UpdateTrail.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateTrail.
36  
37 =head1 SYNOPSIS
38  
39 my $cloudtrail = Paws->service('CloudTrail');
40 my $UpdateTrailResponse = $cloudtrail->UpdateTrail(
41 Name => 'MyString',
42 CloudWatchLogsLogGroupArn => 'MyString', # OPTIONAL
43 CloudWatchLogsRoleArn => 'MyString', # OPTIONAL
44 EnableLogFileValidation => 1, # OPTIONAL
45 IncludeGlobalServiceEvents => 1, # OPTIONAL
46 IsMultiRegionTrail => 1, # OPTIONAL
47 IsOrganizationTrail => 1, # OPTIONAL
48 KmsKeyId => 'MyString', # OPTIONAL
49 S3BucketName => 'MyString', # OPTIONAL
50 S3KeyPrefix => 'MyString', # OPTIONAL
51 SnsTopicName => 'MyString', # OPTIONAL
52 );
53  
54 # Results:
55 my $CloudWatchLogsLogGroupArn =
56 $UpdateTrailResponse->CloudWatchLogsLogGroupArn;
57 my $CloudWatchLogsRoleArn = $UpdateTrailResponse->CloudWatchLogsRoleArn;
58 my $IncludeGlobalServiceEvents =
59 $UpdateTrailResponse->IncludeGlobalServiceEvents;
60 my $IsMultiRegionTrail = $UpdateTrailResponse->IsMultiRegionTrail;
61 my $IsOrganizationTrail = $UpdateTrailResponse->IsOrganizationTrail;
62 my $KmsKeyId = $UpdateTrailResponse->KmsKeyId;
63 my $LogFileValidationEnabled =
64 $UpdateTrailResponse->LogFileValidationEnabled;
65 my $Name = $UpdateTrailResponse->Name;
66 my $S3BucketName = $UpdateTrailResponse->S3BucketName;
67 my $S3KeyPrefix = $UpdateTrailResponse->S3KeyPrefix;
68 my $SnsTopicARN = $UpdateTrailResponse->SnsTopicARN;
69 my $SnsTopicName = $UpdateTrailResponse->SnsTopicName;
70 my $TrailARN = $UpdateTrailResponse->TrailARN;
71  
72 # Returns a L<Paws::CloudTrail::UpdateTrailResponse> object.
73  
74 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
75 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudtrail/UpdateTrail>
76  
77 =head1 ATTRIBUTES
78  
79  
80 =head2 CloudWatchLogsLogGroupArn => Str
81  
82 Specifies a log group name using an Amazon Resource Name (ARN), a
83 unique identifier that represents the log group to which CloudTrail
84 logs will be delivered. Not required unless you specify
85 CloudWatchLogsRoleArn.
86  
87  
88  
89 =head2 CloudWatchLogsRoleArn => Str
90  
91 Specifies the role for the CloudWatch Logs endpoint to assume to write
92 to a user's log group.
93  
94  
95  
96 =head2 EnableLogFileValidation => Bool
97  
98 Specifies whether log file validation is enabled. The default is false.
99  
100 When you disable log file integrity validation, the chain of digest
101 files is broken after one hour. CloudTrail will not create digest files
102 for log files that were delivered during a period in which log file
103 integrity validation was disabled. For example, if you enable log file
104 integrity validation at noon on January 1, disable it at noon on
105 January 2, and re-enable it at noon on January 10, digest files will
106 not be created for the log files delivered from noon on January 2 to
107 noon on January 10. The same applies whenever you stop CloudTrail
108 logging or delete a trail.
109  
110  
111  
112 =head2 IncludeGlobalServiceEvents => Bool
113  
114 Specifies whether the trail is publishing events from global services
115 such as IAM to the log files.
116  
117  
118  
119 =head2 IsMultiRegionTrail => Bool
120  
121 Specifies whether the trail applies only to the current region or to
122 all regions. The default is false. If the trail exists only in the
123 current region and this value is set to true, shadow trails
124 (replications of the trail) will be created in the other regions. If
125 the trail exists in all regions and this value is set to false, the
126 trail will remain in the region where it was created, and its shadow
127 trails in other regions will be deleted. As a best practice, consider
128 using trails that log events in all regions.
129  
130  
131  
132 =head2 IsOrganizationTrail => Bool
133  
134 Specifies whether the trail is applied to all accounts in an
135 organization in AWS Organizations, or only for the current AWS account.
136 The default is false, and cannot be true unless the call is made on
137 behalf of an AWS account that is the master account for an organization
138 in AWS Organizations. If the trail is not an organization trail and
139 this is set to true, the trail will be created in all AWS accounts that
140 belong to the organization. If the trail is an organization trail and
141 this is set to false, the trail will remain in the current AWS account
142 but be deleted from all member accounts in the organization.
143  
144  
145  
146 =head2 KmsKeyId => Str
147  
148 Specifies the KMS key ID to use to encrypt the logs delivered by
149 CloudTrail. The value can be an alias name prefixed by "alias/", a
150 fully specified ARN to an alias, a fully specified ARN to a key, or a
151 globally unique identifier.
152  
153 Examples:
154  
155 =over
156  
157 =item *
158  
159 alias/MyAliasName
160  
161 =item *
162  
163 arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
164  
165 =item *
166  
167 arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
168  
169 =item *
170  
171 12345678-1234-1234-1234-123456789012
172  
173 =back
174  
175  
176  
177  
178 =head2 B<REQUIRED> Name => Str
179  
180 Specifies the name of the trail or trail ARN. If C<Name> is a trail
181 name, the string must meet the following requirements:
182  
183 =over
184  
185 =item *
186  
187 Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.),
188 underscores (_), or dashes (-)
189  
190 =item *
191  
192 Start with a letter or number, and end with a letter or number
193  
194 =item *
195  
196 Be between 3 and 128 characters
197  
198 =item *
199  
200 Have no adjacent periods, underscores or dashes. Names like
201 C<my-_namespace> and C<my--namespace> are invalid.
202  
203 =item *
204  
205 Not be in IP address format (for example, 192.168.5.4)
206  
207 =back
208  
209 If C<Name> is a trail ARN, it must be in the format:
210  
211 C<arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail>
212  
213  
214  
215 =head2 S3BucketName => Str
216  
217 Specifies the name of the Amazon S3 bucket designated for publishing
218 log files. See Amazon S3 Bucket Naming Requirements
219 (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html).
220  
221  
222  
223 =head2 S3KeyPrefix => Str
224  
225 Specifies the Amazon S3 key prefix that comes after the name of the
226 bucket you have designated for log file delivery. For more information,
227 see Finding Your CloudTrail Log Files
228 (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).
229 The maximum length is 200 characters.
230  
231  
232  
233 =head2 SnsTopicName => Str
234  
235 Specifies the name of the Amazon SNS topic defined for notification of
236 log file delivery. The maximum length is 256 characters.
237  
238  
239  
240  
241 =head1 SEE ALSO
242  
243 This class forms part of L<Paws>, documenting arguments for method UpdateTrail in L<Paws::CloudTrail>
244  
245 =head1 BUGS and CONTRIBUTIONS
246  
247 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
248  
249 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
250  
251 =cut
252