Class WindowsAuditLogCreateConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WindowsAuditLogCreateConfiguration.Builder,
WindowsAuditLogCreateConfiguration>
The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Resource Name (ARN) that specifies the destination of the audit logs.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Sets which attempt type is logged by Amazon FSx for file and folder accesses.final String
Sets which attempt type is logged by Amazon FSx for file and folder accesses.Sets which attempt type is logged by Amazon FSx for file share accesses.final String
Sets which attempt type is logged by Amazon FSx for file share accesses.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends WindowsAuditLogCreateConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
If the service returns an enum value that is not available in the current SDK version,
fileAccessAuditLogLevel
will returnWindowsAccessAuditLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileAccessAuditLogLevelAsString()
.- Returns:
- 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.
-
- See Also:
-
-
fileAccessAuditLogLevelAsString
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.
If the service returns an enum value that is not available in the current SDK version,
fileAccessAuditLogLevel
will returnWindowsAccessAuditLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileAccessAuditLogLevelAsString()
.- Returns:
- 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.
-
- See Also:
-
-
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 Firehose delivery stream must begin with theaws-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 aBadRequest
error. -
If
FileAccessAuditLogLevel
andFileShareAccessAuditLogLevel
are both set toDISABLED
, you cannot specify a destination inAuditLogDestination
.
- Returns:
- 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 Firehose delivery stream must begin with theaws-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 aBadRequest
error. -
If
FileAccessAuditLogLevel
andFileShareAccessAuditLogLevel
are both set toDISABLED
, you cannot specify a destination inAuditLogDestination
.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<WindowsAuditLogCreateConfiguration.Builder,
WindowsAuditLogCreateConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends WindowsAuditLogCreateConfiguration.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-