Package software.amazon.awssdk.services.securityhub.model

Interface Signal.Builder

    • Method Detail

      • type

        Signal.Builder type​(String type)

        The type of the signal used to identify an attack sequence.

        Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see GuardDuty foundational data sources in the Amazon GuardDuty User Guide.

        A signal type can be one of the following values. Here are the related descriptions:

        • FINDING - Individually generated GuardDuty finding.

        • CLOUD_TRAIL - Activity observed from CloudTrail logs

        • S3_DATA_EVENTS - Activity observed from CloudTrail data events for Amazon Simple Storage Service (S3). Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and the steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.

        Parameters:
        type - The type of the signal used to identify an attack sequence.

        Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see GuardDuty foundational data sources in the Amazon GuardDuty User Guide.

        A signal type can be one of the following values. Here are the related descriptions:

        • FINDING - Individually generated GuardDuty finding.

        • CLOUD_TRAIL - Activity observed from CloudTrail logs

        • S3_DATA_EVENTS - Activity observed from CloudTrail data events for Amazon Simple Storage Service (S3). Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and the steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • id

        Signal.Builder id​(String id)

        The identifier of the signal.

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

      • title

        Signal.Builder title​(String title)

        The description of the GuardDuty finding.

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

      • productArn

        Signal.Builder productArn​(String productArn)

        The Amazon Resource Name (ARN) of the product that generated the signal.

        Parameters:
        productArn - The Amazon Resource Name (ARN) of the product that generated the signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceIds

        Signal.Builder resourceIds​(Collection<String> resourceIds)

        The ARN or ID of the Amazon Web Services resource associated with the signal.

        Parameters:
        resourceIds - The ARN or ID of the Amazon Web Services resource associated with the signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceIds

        Signal.Builder resourceIds​(String... resourceIds)

        The ARN or ID of the Amazon Web Services resource associated with the signal.

        Parameters:
        resourceIds - The ARN or ID of the Amazon Web Services resource associated with the signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalIndicators

        Signal.Builder signalIndicators​(Collection<Indicator> signalIndicators)

        Contains information about the indicators associated with the signals in this attack sequence finding. The values for SignalIndicators are a subset of the values for SequenceIndicators, but the values for these fields don't always match 1:1.

        Parameters:
        signalIndicators - Contains information about the indicators associated with the signals in this attack sequence finding. The values for SignalIndicators are a subset of the values for SequenceIndicators, but the values for these fields don't always match 1:1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalIndicators

        Signal.Builder signalIndicators​(Indicator... signalIndicators)

        Contains information about the indicators associated with the signals in this attack sequence finding. The values for SignalIndicators are a subset of the values for SequenceIndicators, but the values for these fields don't always match 1:1.

        Parameters:
        signalIndicators - Contains information about the indicators associated with the signals in this attack sequence finding. The values for SignalIndicators are a subset of the values for SequenceIndicators, but the values for these fields don't always match 1:1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalIndicators

        Signal.Builder signalIndicators​(Consumer<Indicator.Builder>... signalIndicators)

        Contains information about the indicators associated with the signals in this attack sequence finding. The values for SignalIndicators are a subset of the values for SequenceIndicators, but the values for these fields don't always match 1:1.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #signalIndicators(List).

        Parameters:
        signalIndicators - a consumer that will call methods on Indicator.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #signalIndicators(java.util.Collection)

      • name

        Signal.Builder name​(String name)

        The name of the GuardDuty signal. For example, when signal type is FINDING, the signal name is the name of the finding.

        Parameters:
        name - The name of the GuardDuty signal. For example, when signal type is FINDING, the signal name is the name of the finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        Signal.Builder createdAt​(Long createdAt)

        The timestamp when the first finding or activity related to this signal was observed.

        Parameters:
        createdAt - The timestamp when the first finding or activity related to this signal was observed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • updatedAt

        Signal.Builder updatedAt​(Long updatedAt)

        The timestamp when this signal was last observed.

        Parameters:
        updatedAt - The timestamp when this signal was last observed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • firstSeenAt

        Signal.Builder firstSeenAt​(Long firstSeenAt)

        The timestamp when the first finding or activity related to this signal was observed.

        Parameters:
        firstSeenAt - The timestamp when the first finding or activity related to this signal was observed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastSeenAt

        Signal.Builder lastSeenAt​(Long lastSeenAt)

        The timestamp when the last finding or activity related to this signal was observed.

        Parameters:
        lastSeenAt - The timestamp when the last finding or activity related to this signal was observed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • severity

        Signal.Builder severity​(Double severity)

        The severity associated with the signal. For more information about severity, see Severity levels for GuardDuty findings in the Amazon GuardDuty User Guide.

        Parameters:
        severity - The severity associated with the signal. For more information about severity, see Severity levels for GuardDuty findings in the Amazon GuardDuty User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • count

        Signal.Builder count​(Integer count)

        The number of times this signal was observed.

        Parameters:
        count - The number of times this signal was observed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actorIds

        Signal.Builder actorIds​(Collection<String> actorIds)

        The IDs of the threat actors involved in the signal.

        Parameters:
        actorIds - The IDs of the threat actors involved in the signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actorIds

        Signal.Builder actorIds​(String... actorIds)

        The IDs of the threat actors involved in the signal.

        Parameters:
        actorIds - The IDs of the threat actors involved in the signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpointIds

        Signal.Builder endpointIds​(Collection<String> endpointIds)

        Information about the endpoint IDs associated with this signal.

        Parameters:
        endpointIds - Information about the endpoint IDs associated with this signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpointIds

        Signal.Builder endpointIds​(String... endpointIds)

        Information about the endpoint IDs associated with this signal.

        Parameters:
        endpointIds - Information about the endpoint IDs associated with this signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.