Class AttackDetail
- java.lang.Object
-
- software.amazon.awssdk.services.shield.model.AttackDetail
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AttackDetail.Builder,AttackDetail>
@Generated("software.amazon.awssdk:codegen") public final class AttackDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AttackDetail.Builder,AttackDetail>
The details of a DDoS attack.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAttackDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<SummarizedCounter>attackCounters()List of counters that describe the attack for the specified time period.StringattackId()The unique identifier (ID) of the attack.List<AttackProperty>attackProperties()The array of objects that provide details of the Shield event.static AttackDetail.Builderbuilder()InstantendTime()The time the attack ended, in Unix time in seconds.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttackCounters()For responses, this returns true if the service returned a value for the AttackCounters property.booleanhasAttackProperties()For responses, this returns true if the service returned a value for the AttackProperties property.inthashCode()booleanhasMitigations()For responses, this returns true if the service returned a value for the Mitigations property.booleanhasSubResources()For responses, this returns true if the service returned a value for the SubResources property.List<Mitigation>mitigations()List of mitigation actions taken for the attack.StringresourceArn()The ARN (Amazon Resource Name) of the resource that was attacked.List<SdkField<?>>sdkFields()static Class<? extends AttackDetail.Builder>serializableBuilderClass()InstantstartTime()The time the attack started, in Unix time in seconds.List<SubResourceSummary>subResources()If applicable, additional detail about the resource being attacked, for example, IP address or URL.AttackDetail.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
attackId
public final String attackId()
The unique identifier (ID) of the attack.
- Returns:
- The unique identifier (ID) of the attack.
-
resourceArn
public final String 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
public final List<SubResourceSummary> 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
public final Instant startTime()
The time the attack started, in Unix time in seconds.
- Returns:
- The time the attack started, in Unix time in seconds.
-
endTime
public final Instant 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
public final List<SummarizedCounter> 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
public final List<AttackProperty> 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
public final List<Mitigation> 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
public AttackDetail.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AttackDetail.Builder,AttackDetail>
-
builder
public static AttackDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends AttackDetail.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
-