Interface Threat.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Threat.Builder,Threat>, SdkBuilder<Threat.Builder,Threat>, SdkPojo
Enclosing class:
Threat
@Mutable @NotThreadSafe public static interface Threat.Builder extends SdkPojo, CopyableBuilder<Threat.Builder,Threat>

  • Method Details

    • threatId

      Threat.Builder threatId(String threatId)

      The unique identifier of the threat.

      Parameters:
      threatId - The unique identifier of the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • threatJobId

      Threat.Builder threatJobId(String threatJobId)

      The unique identifier of the threat model job that produced the threat.

      Parameters:
      threatJobId - The unique identifier of the threat model job that produced the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      Threat.Builder title(String title)

      A short title summarizing the threat.

      Parameters:
      title - A short title summarizing the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statement

      Threat.Builder statement(String statement)

      The natural-language threat statement.

      Parameters:
      statement - The natural-language threat statement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • severity

      Threat.Builder severity(String severity)

      The severity level of the threat.

      Parameters:
      severity - The severity level of the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • severity

      Threat.Builder severity(ThreatSeverity severity)

      The severity level of the threat.

      Parameters:
      severity - The severity level of the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Threat.Builder status(String status)

      The current status of the threat.

      Parameters:
      status - The current status of the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Threat.Builder status(ThreatStatus status)

      The current status of the threat.

      Parameters:
      status - The current status of the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • comments

      Threat.Builder comments(String comments)

      Optional customer comment on the threat.

      Parameters:
      comments - Optional customer comment on the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • threatSource

      Threat.Builder threatSource(String threatSource)

      The actor or origin of the threat.

      Parameters:
      threatSource - The actor or origin of the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • prerequisites

      Threat.Builder prerequisites(String prerequisites)

      The conditions required for the threat to be exploitable.

      Parameters:
      prerequisites - The conditions required for the threat to be exploitable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • threatAction

      Threat.Builder threatAction(String threatAction)

      What the threat source can do.

      Parameters:
      threatAction - What the threat source can do.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • threatImpact

      Threat.Builder threatImpact(String threatImpact)

      The direct consequence of the threat action.

      Parameters:
      threatImpact - The direct consequence of the threat action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • impactedGoal

      Threat.Builder impactedGoal(Collection<String> impactedGoal)

      The security goals affected by the threat.

      Parameters:
      impactedGoal - The security goals affected by the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • impactedGoal

      Threat.Builder impactedGoal(String... impactedGoal)

      The security goals affected by the threat.

      Parameters:
      impactedGoal - The security goals affected by the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • impactedAssets

      Threat.Builder impactedAssets(Collection<String> impactedAssets)

      The specific assets affected by the threat.

      Parameters:
      impactedAssets - The specific assets affected by the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • impactedAssets

      Threat.Builder impactedAssets(String... impactedAssets)

      The specific assets affected by the threat.

      Parameters:
      impactedAssets - The specific assets affected by the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • anchor

      Threat.Builder anchor(ThreatAnchorShape anchor)

      The DFD element this threat is anchored to.

      Parameters:
      anchor - The DFD element this threat is anchored to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • anchor

      default Threat.Builder anchor(Consumer<ThreatAnchorShape.Builder> anchor)

      The DFD element this threat is anchored to.

      This is a convenience method that creates an instance of the ThreatAnchorShape.Builder avoiding the need to create one manually via ThreatAnchorShape.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to anchor(ThreatAnchorShape).

      Parameters:
      anchor - a consumer that will call methods on ThreatAnchorShape.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • evidence

      Threat.Builder evidence(Collection<ThreatEvidenceShape> evidence)

      The source code files supporting the threat.

      Parameters:
      evidence - The source code files supporting the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evidence

      Threat.Builder evidence(ThreatEvidenceShape... evidence)

      The source code files supporting the threat.

      Parameters:
      evidence - The source code files supporting the threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evidence

      Threat.Builder evidence(Consumer<ThreatEvidenceShape.Builder>... evidence)

      The source code files supporting the threat.

      This is a convenience method that creates an instance of the ThreatEvidenceShape.Builder avoiding the need to create one manually via ThreatEvidenceShape.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to evidence(List<ThreatEvidenceShape>).

      Parameters:
      evidence - a consumer that will call methods on ThreatEvidenceShape.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • strideWithStrings

      Threat.Builder strideWithStrings(Collection<String> stride)

      The STRIDE categories applicable to this threat.

      Parameters:
      stride - The STRIDE categories applicable to this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • strideWithStrings

      Threat.Builder strideWithStrings(String... stride)

      The STRIDE categories applicable to this threat.

      Parameters:
      stride - The STRIDE categories applicable to this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stride

      Threat.Builder stride(Collection<StrideCategory> stride)

      The STRIDE categories applicable to this threat.

      Parameters:
      stride - The STRIDE categories applicable to this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stride

      Threat.Builder stride(StrideCategory... stride)

      The STRIDE categories applicable to this threat.

      Parameters:
      stride - The STRIDE categories applicable to this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recommendation

      Threat.Builder recommendation(String recommendation)

      The recommended mitigation guidance for this threat.

      Parameters:
      recommendation - The recommended mitigation guidance for this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      Threat.Builder createdBy(String createdBy)

      Who created this threat.

      Parameters:
      createdBy - Who created this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdBy

      Threat.Builder createdBy(ThreatActor createdBy)

      Who created this threat.

      Parameters:
      createdBy - Who created this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • updatedBy

      Threat.Builder updatedBy(String updatedBy)

      Who last updated this threat.

      Parameters:
      updatedBy - Who last updated this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • updatedBy

      Threat.Builder updatedBy(ThreatActor updatedBy)

      Who last updated this threat.

      Parameters:
      updatedBy - Who last updated this threat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      Threat.Builder createdAt(Instant createdAt)

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

      Parameters:
      createdAt - The date and time the threat was created, in UTC format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Threat.Builder updatedAt(Instant updatedAt)

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

      Parameters:
      updatedAt - The date and time the threat was last updated, in UTC format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.