software.amazon.awscdk.services.fsx

Interface CfnFileSystem.AuditLogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystem.AuditLogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

@Stability(value=Stable)
public static interface CfnFileSystem.AuditLogConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.fsx.*;
 AuditLogConfigurationProperty auditLogConfigurationProperty = AuditLogConfigurationProperty.builder()
         .fileAccessAuditLogLevel("fileAccessAuditLogLevel")
         .fileShareAccessAuditLogLevel("fileShareAccessAuditLogLevel")
         // the properties below are optional
         .auditLogDestination("auditLogDestination")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFileSystem.AuditLogConfigurationProperty.Builder A builder for CfnFileSystem.AuditLogConfigurationProperty
static class	CfnFileSystem.AuditLogConfigurationProperty.Jsii$Proxy An implementation for CfnFileSystem.AuditLogConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnFileSystem.AuditLogConfigurationProperty.Builder	builder()
default String	getAuditLogDestination() The Amazon Resource Name (ARN) for the destination of the audit logs.
String	getFileAccessAuditLogLevel() Sets which attempt type is logged by Amazon FSx for file and folder accesses.
String	getFileShareAccessAuditLogLevel() Sets which attempt type is logged by Amazon FSx for file share accesses.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFileAccessAuditLogLevel

@Stability(value=Stable)
 @NotNull
String getFileAccessAuditLogLevel()

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.

getFileShareAccessAuditLogLevel

@Stability(value=Stable)
 @NotNull
String getFileShareAccessAuditLogLevel()

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.

getAuditLogDestination

@Stability(value=Stable)
 @Nullable
default String getAuditLogDestination()

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.

builder

@Stability(value=Stable)
static CfnFileSystem.AuditLogConfigurationProperty.Builder builder()

Returns:

a CfnFileSystem.AuditLogConfigurationProperty.Builder of CfnFileSystem.AuditLogConfigurationProperty