Class ThreatModel

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

Represents a threat model configuration that defines the parameters for automated threat analysis, including target assets and logging configuration.

See Also:

  • Method Details

    • threatModelId

      public final String threatModelId()

      The unique identifier of the threat model.

      Returns:
      The unique identifier of the threat model.

    • agentSpaceId

      public final String agentSpaceId()

      The unique identifier of the agent space that contains the threat model.

      Returns:
      The unique identifier of the agent space that contains the threat model.

    • title

      public final String title()

      The title of the threat model.

      Returns:
      The title of the threat model.

    • description

      public final String description()

      A description of the application or system being threat modeled.

      Returns:
      A description of the application or system being threat modeled.

    • assets

      public final Assets assets()

      The assets included in the threat model.

      Returns:
      The assets included in the threat model.

    • hasScopeDocs

      public final boolean hasScopeDocs()
      For responses, this returns true if the service returned a value for the ScopeDocs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • scopeDocs

      public final List<DocumentInfo> scopeDocs()

      The scoped documents for the agent to focus on during threat modeling.

      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 hasScopeDocs() method.

      Returns:
      The scoped documents for the agent to focus on during threat modeling.

    • serviceRole

      public final String serviceRole()

      The IAM service role used for the threat model.

      Returns:
      The IAM service role used for the threat model.

    • logConfig

      public final CloudWatchLog logConfig()

      The CloudWatch Logs configuration for the threat model.

      Returns:
      The CloudWatch Logs configuration for the threat model.

    • createdAt

      public final Instant createdAt()

      The date and time the threat model was created, in UTC format.

      Returns:
      The date and time the threat model was created, in UTC format.

    • updatedAt

      public final Instant updatedAt()

      The date and time the threat model was last updated, in UTC format.

      Returns:
      The date and time the threat model was last updated, in UTC format.

    • toBuilder

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

    • builder

      public static ThreatModel.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ThreatModel.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.