« blib/lib/Paws/FSX/WindowsAuditLogConfiguration.pm
↑ Summary
blib/lib/Paws/FSX/WindowsFileSystemConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::WindowsAuditLogCreateConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AuditLogDestination => (is => 'ro', isa => 'Str'); | ||
| 5 | has FileAccessAuditLogLevel => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has FileShareAccessAuditLogLevel => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::FSX::WindowsAuditLogCreateConfiguration | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::FSX::WindowsAuditLogCreateConfiguration object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { AuditLogDestination => $value, ..., FileShareAccessAuditLogLevel => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::FSX::WindowsAuditLogCreateConfiguration object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->AuditLogDestination | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The Windows file access auditing configuration used when creating or | ||
| 39 | updating an Amazon FSx for Windows File Server file system. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 AuditLogDestination => Str | ||
| 45 | |||
| 46 | The Amazon Resource Name (ARN) that specifies the destination of the | ||
| 47 | audit logs. | ||
| 48 | |||
| 49 | The destination can be any Amazon CloudWatch Logs log group ARN or | ||
| 50 | Amazon Kinesis Data Firehose delivery stream ARN, with the following | ||
| 51 | requirements: | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | The destination ARN that you provide (either CloudWatch Logs log group | ||
| 58 | or Kinesis Data Firehose delivery stream) must be in the same AWS | ||
| 59 | partition, AWS region, and AWS account as your Amazon FSx file system. | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | The name of the Amazon CloudWatch Logs log group must begin with the | ||
| 64 | C</aws/fsx> prefix. The name of the Amazon Kinesis Data Firehouse | ||
| 65 | delivery stream must begin with the C<aws-fsx> prefix. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | If you do not provide a destination in C<AuditLogDestination>, Amazon | ||
| 70 | FSx will create and use a log stream in the CloudWatch Logs | ||
| 71 | C</aws/fsx/windows> log group. | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | If C<AuditLogDestination> is provided and the resource does not exist, | ||
| 76 | the request will fail with a C<BadRequest> error. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | If C<FileAccessAuditLogLevel> and C<FileShareAccessAuditLogLevel> are | ||
| 81 | both set to C<DISABLED>, you cannot specify a destination in | ||
| 82 | C<AuditLogDestination>. | ||
| 83 | |||
| 84 | =back | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> FileAccessAuditLogLevel => Str | ||
| 89 | |||
| 90 | Sets which attempt type is logged by Amazon FSx for file and folder | ||
| 91 | accesses. | ||
| 92 | |||
| 93 | =over | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<SUCCESS_ONLY> - only successful attempts to access files or folders | ||
| 98 | are logged. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<FAILURE_ONLY> - only failed attempts to access files or folders are | ||
| 103 | logged. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<SUCCESS_AND_FAILURE> - both successful attempts and failed attempts | ||
| 108 | to access files or folders are logged. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<DISABLED> - access auditing of files and folders is turned off. | ||
| 113 | |||
| 114 | =back | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 B<REQUIRED> FileShareAccessAuditLogLevel => Str | ||
| 119 | |||
| 120 | Sets which attempt type is logged by Amazon FSx for file share | ||
| 121 | accesses. | ||
| 122 | |||
| 123 | =over | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | C<SUCCESS_ONLY> - only successful attempts to access file shares are | ||
| 128 | logged. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | C<FAILURE_ONLY> - only failed attempts to access file shares are | ||
| 133 | logged. | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | C<SUCCESS_AND_FAILURE> - both successful attempts and failed attempts | ||
| 138 | to access file shares are logged. | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | C<DISABLED> - access auditing of file shares is turned off. | ||
| 143 | |||
| 144 | =back | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head1 SEE ALSO | ||
| 150 | |||
| 151 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 152 | |||
| 153 | =head1 BUGS and CONTRIBUTIONS | ||
| 154 | |||
| 155 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 156 | |||
| 157 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 158 | |||
| 159 | =cut | ||
| 160 |