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