aws-cdk-lib.aws_fsx.CfnFileSystem.AuditLogConfigurationProperty

interface AuditLogConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.FSx.CfnFileSystem.AuditLogConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsfsx#CfnFileSystem_AuditLogConfigurationProperty
Javasoftware.amazon.awscdk.services.fsx.CfnFileSystem.AuditLogConfigurationProperty
Pythonaws_cdk.aws_fsx.CfnFileSystem.AuditLogConfigurationProperty
TypeScript aws-cdk-lib » aws_fsx » CfnFileSystem » AuditLogConfigurationProperty

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const auditLogConfigurationProperty: fsx.CfnFileSystem.AuditLogConfigurationProperty = {
  fileAccessAuditLogLevel: 'fileAccessAuditLogLevel',
  fileShareAccessAuditLogLevel: 'fileShareAccessAuditLogLevel',

  // the properties below are optional
  auditLogDestination: 'auditLogDestination',
};

Properties

NameTypeDescription
fileAccessAuditLogLevelstringSets which attempt type is logged by Amazon FSx for file and folder accesses.
fileShareAccessAuditLogLevelstringSets which attempt type is logged by Amazon FSx for file share accesses.
auditLogDestination?stringThe Amazon Resource Name (ARN) for the destination of the audit logs.

fileAccessAuditLogLevel

Type: string

Sets which attempt type is logged by Amazon FSx for file and folder accesses.

  • SUCCESS_ONLY - only successful attempts to access files or folders are logged.
  • FAILURE_ONLY - only failed attempts to access files or folders are logged.
  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
  • DISABLED - access auditing of files and folders is turned off.

fileShareAccessAuditLogLevel

Type: string

Sets which attempt type is logged by Amazon FSx for file share accesses.

  • SUCCESS_ONLY - only successful attempts to access file shares are logged.
  • FAILURE_ONLY - only failed attempts to access file shares are logged.
  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
  • DISABLED - access auditing of file shares is turned off.

auditLogDestination?

Type: string (optional)

The Amazon Resource Name (ARN) for the destination of the audit logs.

The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix.

The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same AWS partition, AWS Region , and AWS account as your Amazon FSx file system.