Class: AWSCDK::FSX::CfnFileSystem::AuditLogConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fsx/cfn_file_system.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_access_audit_log_level:, file_share_access_audit_log_level:, audit_log_destination: nil) ⇒ AuditLogConfigurationProperty

Returns a new instance of AuditLogConfigurationProperty.

Parameters:

  • file_access_audit_log_level (String) —

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

  • file_share_access_audit_log_level (String) —

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

  • audit_log_destination (String, nil) (defaults to: nil) —

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



732
733
734
735
736
737
738
739
 
# File 'fsx/cfn_file_system.rb', line 732

def initialize(file_access_audit_log_level:, file_share_access_audit_log_level:, audit_log_destination: nil)
  @file_access_audit_log_level = file_access_audit_log_level
  Jsii::Type.check_type(@file_access_audit_log_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileAccessAuditLogLevel")
  @file_share_access_audit_log_level = file_share_access_audit_log_level
  Jsii::Type.check_type(@file_share_access_audit_log_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileShareAccessAuditLogLevel")
  @audit_log_destination = audit_log_destination
  Jsii::Type.check_type(@audit_log_destination, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "auditLogDestination") unless @audit_log_destination.nil?
end

Instance Attribute Details

#audit_log_destination ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



771
772
773
 
# File 'fsx/cfn_file_system.rb', line 771

def audit_log_destination
  @audit_log_destination
end

#file_access_audit_log_level ⇒ String (readonly)

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)

See Also:



750
751
752
 
# File 'fsx/cfn_file_system.rb', line 750

def file_access_audit_log_level
  @file_access_audit_log_level
end

#file_share_access_audit_log_level ⇒ String (readonly)

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)

See Also:



760
761
762
 
# File 'fsx/cfn_file_system.rb', line 760

def file_share_access_audit_log_level
  @file_share_access_audit_log_level
end

Class Method Details

.jsii_properties ⇒ Object 



773
774
775
776
777
778
779
 
# File 'fsx/cfn_file_system.rb', line 773

def self.jsii_properties
  {
    :file_access_audit_log_level => "fileAccessAuditLogLevel",
    :file_share_access_audit_log_level => "fileShareAccessAuditLogLevel",
    :audit_log_destination => "auditLogDestination",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



781
782
783
784
785
786
787
788
789
 
# File 'fsx/cfn_file_system.rb', line 781

def to_jsii
  result = {}
  result.merge!({
    "fileAccessAuditLogLevel" => @file_access_audit_log_level,
    "fileShareAccessAuditLogLevel" => @file_share_access_audit_log_level,
    "auditLogDestination" => @audit_log_destination,
  })
  result.compact
end