Class AttackDetail
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AttackDetail.Builder,
AttackDetail>
The details of a DDoS attack.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<SummarizedCounter> List of counters that describe the attack for the specified time period.final String
attackId()
The unique identifier (ID) of the attack.final List
<AttackProperty> The array of objects that provide details of the Shield event.static AttackDetail.Builder
builder()
final Instant
endTime()
The time the attack ended, in Unix time in seconds.final boolean
final boolean
equalsBySdkFields
(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 boolean
For responses, this returns true if the service returned a value for the AttackCounters property.final boolean
For responses, this returns true if the service returned a value for the AttackProperties property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Mitigations property.final boolean
For responses, this returns true if the service returned a value for the SubResources property.final List
<Mitigation> List of mitigation actions taken for the attack.final String
The ARN (Amazon Resource Name) of the resource that was attacked.static Class
<? extends AttackDetail.Builder> final Instant
The time the attack started, in Unix time in seconds.final List
<SubResourceSummary> If applicable, additional detail about the resource being attacked, for example, IP address or URL.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
-
attackId
The unique identifier (ID) of the attack.
- Returns:
- The unique identifier (ID) of the attack.
-
resourceArn
The ARN (Amazon Resource Name) of the resource that was attacked.
- Returns:
- The ARN (Amazon Resource Name) of the resource that was attacked.
-
hasSubResources
public final boolean hasSubResources()For responses, this returns true if the service returned a value for the SubResources property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
subResources
If applicable, additional detail about the resource being attacked, for example, IP address or URL.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubResources()
method.- Returns:
- If applicable, additional detail about the resource being attacked, for example, IP address or URL.
-
startTime
The time the attack started, in Unix time in seconds.
- Returns:
- The time the attack started, in Unix time in seconds.
-
endTime
The time the attack ended, in Unix time in seconds.
- Returns:
- The time the attack ended, in Unix time in seconds.
-
hasAttackCounters
public final boolean hasAttackCounters()For responses, this returns true if the service returned a value for the AttackCounters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
attackCounters
List of counters that describe the attack for the specified time period.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttackCounters()
method.- Returns:
- List of counters that describe the attack for the specified time period.
-
hasAttackProperties
public final boolean hasAttackProperties()For responses, this returns true if the service returned a value for the AttackProperties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
attackProperties
The array of objects that provide details of the Shield event.
For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttackProperties()
method.- Returns:
- The array of objects that provide details of the Shield event.
For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.
-
hasMitigations
public final boolean hasMitigations()For responses, this returns true if the service returned a value for the Mitigations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
mitigations
List of mitigation actions taken for the attack.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMitigations()
method.- Returns:
- List of mitigation actions taken for the attack.
-
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<AttackDetail.Builder,
AttackDetail> - Returns:
- a builder for type T
-
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
-