Interface ThreatModel.Builder

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

  • Method Details

    • threatModelId

      ThreatModel.Builder threatModelId(String threatModelId)

      The unique identifier of the threat model.

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

    • agentSpaceId

      ThreatModel.Builder agentSpaceId(String agentSpaceId)

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

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

    • title

      ThreatModel.Builder title(String title)

      The title of the threat model.

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

    • description

      ThreatModel.Builder description(String description)

      A description of the application or system being threat modeled.

      Parameters:
      description - A description of the application or system being threat modeled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assets

      ThreatModel.Builder assets(Assets assets)

      The assets included in the threat model.

      Parameters:
      assets - The assets included in the threat model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assets

      default ThreatModel.Builder assets(Consumer<Assets.Builder> assets)

      The assets included in the threat model.

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

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

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

    • scopeDocs

      ThreatModel.Builder scopeDocs(Collection<DocumentInfo> scopeDocs)

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

      Parameters:
      scopeDocs - The scoped documents for the agent to focus on during threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeDocs

      ThreatModel.Builder scopeDocs(DocumentInfo... scopeDocs)

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

      Parameters:
      scopeDocs - The scoped documents for the agent to focus on during threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeDocs

      ThreatModel.Builder scopeDocs(Consumer<DocumentInfo.Builder>... scopeDocs)

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

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

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

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

    • serviceRole

      ThreatModel.Builder serviceRole(String serviceRole)

      The IAM service role used for the threat model.

      Parameters:
      serviceRole - The IAM service role used for the threat model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfig

      ThreatModel.Builder logConfig(CloudWatchLog logConfig)

      The CloudWatch Logs configuration for the threat model.

      Parameters:
      logConfig - The CloudWatch Logs configuration for the threat model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfig

      default ThreatModel.Builder logConfig(Consumer<CloudWatchLog.Builder> logConfig)

      The CloudWatch Logs configuration for the threat model.

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

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

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

    • createdAt

      ThreatModel.Builder createdAt(Instant createdAt)

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

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

    • updatedAt

      ThreatModel.Builder updatedAt(Instant updatedAt)

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

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