| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudTrail::Trail; | ||
| 3 | use Moose; | ||
| 4 | has CloudWatchLogsLogGroupArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has CloudWatchLogsRoleArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has HasCustomEventSelectors => (is => 'ro', isa => 'Bool'); | ||
| 7 | has HasInsightSelectors => (is => 'ro', isa => 'Bool'); | ||
| 8 | has HomeRegion => (is => 'ro', isa => 'Str'); | ||
| 9 | has IncludeGlobalServiceEvents => (is => 'ro', isa => 'Bool'); | ||
| 10 | has IsMultiRegionTrail => (is => 'ro', isa => 'Bool'); | ||
| 11 | has IsOrganizationTrail => (is => 'ro', isa => 'Bool'); | ||
| 12 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 13 | has LogFileValidationEnabled => (is => 'ro', isa => 'Bool'); | ||
| 14 | has Name => (is => 'ro', isa => 'Str'); | ||
| 15 | has S3BucketName => (is => 'ro', isa => 'Str'); | ||
| 16 | has S3KeyPrefix => (is => 'ro', isa => 'Str'); | ||
| 17 | has SnsTopicARN => (is => 'ro', isa => 'Str'); | ||
| 18 | has SnsTopicName => (is => 'ro', isa => 'Str'); | ||
| 19 | has TrailARN => (is => 'ro', isa => 'Str'); | ||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::CloudTrail::Trail | ||
| 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::CloudTrail::Trail object: | ||
| 39 | |||
| 40 | $service_obj->Method(Att1 => { CloudWatchLogsLogGroupArn => $value, ..., TrailARN => $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::CloudTrail::Trail object: | ||
| 45 | |||
| 46 | $result = $service_obj->Method(...); | ||
| 47 | $result->Att1->CloudWatchLogsLogGroupArn | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | The settings for a trail. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CloudWatchLogsLogGroupArn => Str | ||
| 57 | |||
| 58 | Specifies an Amazon Resource Name (ARN), a unique identifier that | ||
| 59 | represents the log group to which CloudTrail logs will be delivered. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 CloudWatchLogsRoleArn => Str | ||
| 63 | |||
| 64 | Specifies the role for the CloudWatch Logs endpoint to assume to write | ||
| 65 | to a user's log group. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 HasCustomEventSelectors => Bool | ||
| 69 | |||
| 70 | Specifies if the trail has custom event selectors. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 HasInsightSelectors => Bool | ||
| 74 | |||
| 75 | Specifies whether a trail has insight types specified in an | ||
| 76 | C<InsightSelector> list. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 HomeRegion => Str | ||
| 80 | |||
| 81 | The region in which the trail was created. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 IncludeGlobalServiceEvents => Bool | ||
| 85 | |||
| 86 | Set to B<True> to include AWS API calls from AWS global services such | ||
| 87 | as IAM. Otherwise, B<False>. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 IsMultiRegionTrail => Bool | ||
| 91 | |||
| 92 | Specifies whether the trail exists only in one region or exists in all | ||
| 93 | regions. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 IsOrganizationTrail => Bool | ||
| 97 | |||
| 98 | Specifies whether the trail is an organization trail. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 KmsKeyId => Str | ||
| 102 | |||
| 103 | Specifies the KMS key ID that encrypts the logs delivered by | ||
| 104 | CloudTrail. The value is a fully specified ARN to a KMS key in the | ||
| 105 | format: | ||
| 106 | |||
| 107 | C<arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012> | ||
| 108 | |||
| 109 | |||
| 110 | =head2 LogFileValidationEnabled => Bool | ||
| 111 | |||
| 112 | Specifies whether log file validation is enabled. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 Name => Str | ||
| 116 | |||
| 117 | Name of the trail set by calling CreateTrail. The maximum length is 128 | ||
| 118 | characters. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 S3BucketName => Str | ||
| 122 | |||
| 123 | Name of the Amazon S3 bucket into which CloudTrail delivers your trail | ||
| 124 | files. See Amazon S3 Bucket Naming Requirements | ||
| 125 | (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). | ||
| 126 | |||
| 127 | |||
| 128 | =head2 S3KeyPrefix => Str | ||
| 129 | |||
| 130 | Specifies the Amazon S3 key prefix that comes after the name of the | ||
| 131 | bucket you have designated for log file delivery. For more information, | ||
| 132 | see Finding Your CloudTrail Log Files | ||
| 133 | (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).The | ||
| 134 | maximum length is 200 characters. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 SnsTopicARN => Str | ||
| 138 | |||
| 139 | Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send | ||
| 140 | notifications when log files are delivered. The format of a topic ARN | ||
| 141 | is: | ||
| 142 | |||
| 143 | C<arn:aws:sns:us-east-2:123456789012:MyTopic> | ||
| 144 | |||
| 145 | |||
| 146 | =head2 SnsTopicName => Str | ||
| 147 | |||
| 148 | This field is no longer in use. Use SnsTopicARN. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 TrailARN => Str | ||
| 152 | |||
| 153 | Specifies the ARN of the trail. The format of a trail ARN is: | ||
| 154 | |||
| 155 | C<arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail> | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head1 SEE ALSO | ||
| 160 | |||
| 161 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudTrail> | ||
| 162 | |||
| 163 | =head1 BUGS and CONTRIBUTIONS | ||
| 164 | |||
| 165 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 166 | |||
| 167 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 168 | |||
| 169 | =cut | ||
| 170 |