Class: Aws::FSx::Types::WindowsAuditLogCreateConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass WindowsAuditLogCreateConfiguration data as a hash:

{
  file_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
  file_share_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
  audit_log_destination: "GeneralARN",
}

The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audit_log_destinationString

The Amazon Resource Name (ARN) that specifies 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, with the following requirements:

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

  • 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.

  • If you do not provide a destination in AuditLogDestination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.

  • If AuditLogDestination is provided and the resource does not exist, the request will fail with a BadRequest error.

  • If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to DISABLED, you cannot specify a destination in AuditLogDestination.

Returns:

  • (String)


8586
8587
8588
8589
8590
8591
8592
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8586

class WindowsAuditLogCreateConfiguration < Struct.new(
  :file_access_audit_log_level,
  :file_share_access_audit_log_level,
  :audit_log_destination)
  SENSITIVE = []
  include Aws::Structure
end

#file_access_audit_log_levelString

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.

Returns:

  • (String)


8586
8587
8588
8589
8590
8591
8592
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8586

class WindowsAuditLogCreateConfiguration < Struct.new(
  :file_access_audit_log_level,
  :file_share_access_audit_log_level,
  :audit_log_destination)
  SENSITIVE = []
  include Aws::Structure
end

#file_share_access_audit_log_levelString

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.

Returns:

  • (String)


8586
8587
8588
8589
8590
8591
8592
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8586

class WindowsAuditLogCreateConfiguration < Struct.new(
  :file_access_audit_log_level,
  :file_share_access_audit_log_level,
  :audit_log_destination)
  SENSITIVE = []
  include Aws::Structure
end