Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration

Description

Documentation

data WindowsAuditLogCreateConfiguration Source #

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

See: newWindowsAuditLogCreateConfiguration smart constructor.

Constructors

WindowsAuditLogCreateConfiguration'

Fields

auditLogDestination :: Maybe Text
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.
fileAccessAuditLogLevel :: WindowsAccessAuditLogLevel
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 :: WindowsAccessAuditLogLevel
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.

Instances

Instances details

ToJSON WindowsAuditLogCreateConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration Methods toJSON :: WindowsAuditLogCreateConfiguration -> Value # toEncoding :: WindowsAuditLogCreateConfiguration -> Encoding # toJSONList :: [WindowsAuditLogCreateConfiguration] -> Value # toEncodingList :: [WindowsAuditLogCreateConfiguration] -> Encoding #
Generic WindowsAuditLogCreateConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration Associated Types type Rep WindowsAuditLogCreateConfiguration :: Type -> Type # Methods from :: WindowsAuditLogCreateConfiguration -> Rep WindowsAuditLogCreateConfiguration x # to :: Rep WindowsAuditLogCreateConfiguration x -> WindowsAuditLogCreateConfiguration #
Read WindowsAuditLogCreateConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration Methods readsPrec :: Int -> ReadS WindowsAuditLogCreateConfiguration # readList :: ReadS [WindowsAuditLogCreateConfiguration] # readPrec :: ReadPrec WindowsAuditLogCreateConfiguration # readListPrec :: ReadPrec [WindowsAuditLogCreateConfiguration] #
Show WindowsAuditLogCreateConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration Methods showsPrec :: Int -> WindowsAuditLogCreateConfiguration -> ShowS # show :: WindowsAuditLogCreateConfiguration -> String # showList :: [WindowsAuditLogCreateConfiguration] -> ShowS #
NFData WindowsAuditLogCreateConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration Methods rnf :: WindowsAuditLogCreateConfiguration -> () #
Eq WindowsAuditLogCreateConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration Methods (==) :: WindowsAuditLogCreateConfiguration -> WindowsAuditLogCreateConfiguration -> Bool # (/=) :: WindowsAuditLogCreateConfiguration -> WindowsAuditLogCreateConfiguration -> Bool #
Hashable WindowsAuditLogCreateConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration Methods hashWithSalt :: Int -> WindowsAuditLogCreateConfiguration -> Int # hash :: WindowsAuditLogCreateConfiguration -> Int #
type Rep WindowsAuditLogCreateConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration type Rep WindowsAuditLogCreateConfiguration = D1 ('MetaData "WindowsAuditLogCreateConfiguration" "Amazonka.FSx.Types.WindowsAuditLogCreateConfiguration" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "WindowsAuditLogCreateConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "auditLogDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fileAccessAuditLogLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WindowsAccessAuditLogLevel) :: S1 ('MetaSel ('Just "fileShareAccessAuditLogLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WindowsAccessAuditLogLevel))))

newWindowsAuditLogCreateConfiguration Source #

Arguments

:: WindowsAccessAuditLogLevel	`$sel:fileAccessAuditLogLevel:WindowsAuditLogCreateConfiguration'`
-> WindowsAccessAuditLogLevel	`$sel:fileShareAccessAuditLogLevel:WindowsAuditLogCreateConfiguration'`
-> WindowsAuditLogCreateConfiguration

Create a value of WindowsAuditLogCreateConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:auditLogDestination:WindowsAuditLogCreateConfiguration', windowsAuditLogCreateConfiguration_auditLogDestination - 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.

$sel:fileAccessAuditLogLevel:WindowsAuditLogCreateConfiguration', windowsAuditLogCreateConfiguration_fileAccessAuditLogLevel - 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.

$sel:fileShareAccessAuditLogLevel:WindowsAuditLogCreateConfiguration', windowsAuditLogCreateConfiguration_fileShareAccessAuditLogLevel - 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.

windowsAuditLogCreateConfiguration_auditLogDestination :: Lens' WindowsAuditLogCreateConfiguration (Maybe Text) Source #

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.

windowsAuditLogCreateConfiguration_fileAccessAuditLogLevel :: Lens' WindowsAuditLogCreateConfiguration WindowsAccessAuditLogLevel Source #

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.

windowsAuditLogCreateConfiguration_fileShareAccessAuditLogLevel :: Lens' WindowsAuditLogCreateConfiguration WindowsAccessAuditLogLevel Source #

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.