Class S3Analysis

java.lang.Object
software.amazon.awssdk.services.guardduty.model.S3Analysis
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3Analysis.Builder,S3Analysis>
@Generated("software.amazon.awssdk:codegen") public final class S3Analysis extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3Analysis.Builder,S3Analysis>

Contains an analysis of Amazon S3 activity or exposure. The members that can be set depend on AnalysisType: S3_EXPOSURE (FindingSubtype, EffectivePermission, BlockPublicAccessSettings, and Exposure), S3_ACTOR_CONTEXT ( UserAgent, UserAgentClassification, SourceIp, IpReputation, and ActorAssessment), and S3_PEN_TEST (UserAgent, S3ApiActivity, SourceContext, and AuthorizationAssessment).

See Also:

  • Method Details

    • findingSubtype

      public final String findingSubtype()

      The subtype of the finding.

      Returns:
      The subtype of the finding.

    • effectivePermission

      public final String effectivePermission()

      The effective permission of the Amazon S3 resource.

      Returns:
      The effective permission of the Amazon S3 resource.

    • blockPublicAccessSettings

      public final String blockPublicAccessSettings()

      A description of the Amazon S3 Block Public Access settings.

      Returns:
      A description of the Amazon S3 Block Public Access settings.

    • exposure

      public final String exposure()

      An assessment of the exposure of the Amazon S3 resource.

      Returns:
      An assessment of the exposure of the Amazon S3 resource.

    • userAgent

      public final String userAgent()

      The user agent of the caller.

      Returns:
      The user agent of the caller.

    • userAgentClassification

      public final String userAgentClassification()

      The classification of the user agent.

      Returns:
      The classification of the user agent.

    • sourceIp

      public final String sourceIp()

      The source address of the activity, or a description of the source.

      Returns:
      The source address of the activity, or a description of the source.

    • ipReputation

      public final String ipReputation()

      The reputation of the source IP address.

      Returns:
      The reputation of the source IP address.

    • actorAssessment

      public final String actorAssessment()

      An assessment of the identity that performed the activity.

      Returns:
      An assessment of the identity that performed the activity.

    • s3ApiActivity

      public final String s3ApiActivity()

      A description of the Amazon S3 API activity.

      Returns:
      A description of the Amazon S3 API activity.

    • sourceContext

      public final String sourceContext()

      Context about the source of the activity.

      Returns:
      Context about the source of the activity.

    • authorizationAssessment

      public final String authorizationAssessment()

      An assessment of whether the activity was authorized.

      Returns:
      An assessment of whether the activity was authorized.

    • toBuilder

      public S3Analysis.Builder 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 interface ToCopyableBuilder<S3Analysis.Builder,S3Analysis>
      Returns:
      a builder for type T

    • builder

      public static S3Analysis.Builder builder()

    • serializableBuilderClass

      public static Class<? extends S3Analysis.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.