Package software.amazon.awssdk.services.guardduty.model

Interface Signal.Builder

    • Method Detail

      • uid

        Signal.Builder uid​(String uid)

        The unique identifier of the signal.

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

      • 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 Foundational data sources in the GuardDuty User Guide.

        A signal type can be one of the valid values listed in this API. 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 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 steps to enable it, see S3 Protection in the 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 Foundational data sources in the GuardDuty User Guide.

        A signal type can be one of the valid values listed in this API. 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 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 steps to enable it, see S3 Protection in the GuardDuty User Guide.

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

      • type

        Signal.Builder type​(SignalType 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 Foundational data sources in the GuardDuty User Guide.

        A signal type can be one of the valid values listed in this API. 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 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 steps to enable it, see S3 Protection in the 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 Foundational data sources in the GuardDuty User Guide.

        A signal type can be one of the valid values listed in this API. 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 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 steps to enable it, see S3 Protection in the GuardDuty User Guide.

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

      • description

        Signal.Builder description​(String description)

        The description of the signal.

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

      • name

        Signal.Builder name​(String name)

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

        Parameters:
        name - The name of the 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​(Instant 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​(Instant 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​(Instant 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​(Instant 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 Findings severity levels in the GuardDuty User Guide.

        Parameters:
        severity - The severity associated with the signal. For more information about severity, see Findings severity levels in the 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.

      • resourceUids

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

        Information about the unique identifiers of the resources involved in the signal.

        Parameters:
        resourceUids - Information about the unique identifiers of the resources involved in the signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceUids

        Signal.Builder resourceUids​(String... resourceUids)

        Information about the unique identifiers of the resources involved in the signal.

        Parameters:
        resourceUids - Information about the unique identifiers of the resources involved in the signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • actorIds

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

        Information about the IDs of the threat actors involved in the signal.

        Parameters:
        actorIds - Information about 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)

        Information about the IDs of the threat actors involved in the signal.

        Parameters:
        actorIds - Information about 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.

      • signalIndicators

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

        Contains information about the indicators associated with the signals.

        Parameters:
        signalIndicators - Contains information about the indicators associated with the signals.
        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.

        Parameters:
        signalIndicators - Contains information about the indicators associated with the signals.
        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.

        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)