Class AnalyticsConfig
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AnalyticsConfig.Builder,AnalyticsConfig>
Specifies the security analytics configuration for the web ACL. Security analytics shows the web ACL's request log data from multiple Amazon Web Services Regions in a single dashboard in the WAF console.
When you enable security analytics, you authorize Amazon Web Services to transfer and store full request logs outside the Amazon Web Services Region where the web ACL is hosted. For regional web ACLs, security analytics is disabled by default when you omit this configuration. For web ACLs that protect CloudFront distributions (global web ACLs), security analytics is enabled by default. For more information, see Enabling security analytics for a protection pack (web ACL) in the WAF Developer Guide.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic AnalyticsConfig.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final AnalyticsModemode()The security analytics mode for the web ACL.final StringThe security analytics mode for the web ACL.static Class<? extends AnalyticsConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
mode
The security analytics mode for the web ACL. Valid values:
-
CROSS_REGION- Enables security analytics. WAF transfers and stores the web ACL's request logs outside the Amazon Web Services Region where the web ACL is hosted, for aggregation and processing. -
DISABLED- Disables security analytics. WAF stops transferring the web ACL's request logs.
If the service returns an enum value that is not available in the current SDK version,
modewill returnAnalyticsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommodeAsString().- Returns:
- The security analytics mode for the web ACL. Valid values:
-
CROSS_REGION- Enables security analytics. WAF transfers and stores the web ACL's request logs outside the Amazon Web Services Region where the web ACL is hosted, for aggregation and processing. -
DISABLED- Disables security analytics. WAF stops transferring the web ACL's request logs.
-
- See Also:
-
-
modeAsString
The security analytics mode for the web ACL. Valid values:
-
CROSS_REGION- Enables security analytics. WAF transfers and stores the web ACL's request logs outside the Amazon Web Services Region where the web ACL is hosted, for aggregation and processing. -
DISABLED- Disables security analytics. WAF stops transferring the web ACL's request logs.
If the service returns an enum value that is not available in the current SDK version,
modewill returnAnalyticsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommodeAsString().- Returns:
- The security analytics mode for the web ACL. Valid values:
-
CROSS_REGION- Enables security analytics. WAF transfers and stores the web ACL's request logs outside the Amazon Web Services Region where the web ACL is hosted, for aggregation and processing. -
DISABLED- Disables security analytics. WAF stops transferring the web ACL's request logs.
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<AnalyticsConfig.Builder,AnalyticsConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-