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

Interface AwsSecurityFinding.Builder

    • Method Detail

      • schemaVersion

        AwsSecurityFinding.Builder schemaVersion​(String schemaVersion)

        The schema version that a finding is formatted for. The value is 2018-10-08.

        Parameters:
        schemaVersion - The schema version that a finding is formatted for. The value is 2018-10-08.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • id

        AwsSecurityFinding.Builder id​(String id)

        The security findings provider-specific identifier for a finding.

        Length Constraints: Minimum length of 1. Maximum length of 512.

        Parameters:
        id - The security findings provider-specific identifier for a finding.

        Length Constraints: Minimum length of 1. Maximum length of 512.

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

      • productArn

        AwsSecurityFinding.Builder productArn​(String productArn)

        The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.

        Length Constraints: Minimum length of 12. Maximum length of 2048.

        Parameters:
        productArn - The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.

        Length Constraints: Minimum length of 12. Maximum length of 2048.

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

      • productName

        AwsSecurityFinding.Builder productName​(String productName)

        The name of the product that generated the finding.

        Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

        When you use the Security Hub console or API to filter findings by product name, you use this attribute.

        Length Constraints: Minimum length of 1. Maximum length of 128.

        Parameters:
        productName - The name of the product that generated the finding.

        Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

        When you use the Security Hub console or API to filter findings by product name, you use this attribute.

        Length Constraints: Minimum length of 1. Maximum length of 128.

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

      • companyName

        AwsSecurityFinding.Builder companyName​(String companyName)

        The name of the company for the product that generated the finding.

        Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

        When you use the Security Hub console or API to filter findings by company name, you use this attribute.

        Length Constraints: Minimum length of 1. Maximum length of 128.

        Parameters:
        companyName - The name of the company for the product that generated the finding.

        Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

        When you use the Security Hub console or API to filter findings by company name, you use this attribute.

        Length Constraints: Minimum length of 1. Maximum length of 128.

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

      • region

        AwsSecurityFinding.Builder region​(String region)

        The Region from which the finding was generated.

        Security Hub populates this attribute automatically for each finding. You cannot update it using BatchImportFindings or BatchUpdateFindings.

        Length Constraints: Minimum length of 1. Maximum length of 16.

        Parameters:
        region - The Region from which the finding was generated.

        Security Hub populates this attribute automatically for each finding. You cannot update it using BatchImportFindings or BatchUpdateFindings.

        Length Constraints: Minimum length of 1. Maximum length of 16.

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

      • generatorId

        AwsSecurityFinding.Builder generatorId​(String generatorId)

        The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, or something else.

        Length Constraints: Minimum length of 1. Maximum length of 512.

        Parameters:
        generatorId - The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, or something else.

        Length Constraints: Minimum length of 1. Maximum length of 512.

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

      • awsAccountId

        AwsSecurityFinding.Builder awsAccountId​(String awsAccountId)

        The Amazon Web Services account ID that a finding is generated in.

        Length Constraints: 12.

        Parameters:
        awsAccountId - The Amazon Web Services account ID that a finding is generated in.

        Length Constraints: 12.

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

      • types

        AwsSecurityFinding.Builder types​(Collection<String> types)

        One or more finding types in the format of namespace/category/classifier that classify a finding.

        Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

        Array Members: Maximum number of 50 items.

        Parameters:
        types - One or more finding types in the format of namespace/category/classifier that classify a finding.

        Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

        Array Members: Maximum number of 50 items.

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

      • types

        AwsSecurityFinding.Builder types​(String... types)

        One or more finding types in the format of namespace/category/classifier that classify a finding.

        Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

        Array Members: Maximum number of 50 items.

        Parameters:
        types - One or more finding types in the format of namespace/category/classifier that classify a finding.

        Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

        Array Members: Maximum number of 50 items.

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

      • firstObservedAt

        AwsSecurityFinding.Builder firstObservedAt​(String firstObservedAt)

        Indicates when the security findings provider first observed the potential security issue that a finding captured.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Parameters:
        firstObservedAt - Indicates when the security findings provider first observed the potential security issue that a finding captured.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

      • lastObservedAt

        AwsSecurityFinding.Builder lastObservedAt​(String lastObservedAt)

        Indicates when the security findings provider most recently observed the potential security issue that a finding captured.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Parameters:
        lastObservedAt - Indicates when the security findings provider most recently observed the potential security issue that a finding captured.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

      • createdAt

        AwsSecurityFinding.Builder createdAt​(String createdAt)

        Indicates when the security findings provider created the potential security issue that a finding captured.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Parameters:
        createdAt - Indicates when the security findings provider created the potential security issue that a finding captured.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

      • updatedAt

        AwsSecurityFinding.Builder updatedAt​(String updatedAt)

        Indicates when the security findings provider last updated the finding record.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Parameters:
        updatedAt - Indicates when the security findings provider last updated the finding record.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

      • severity

        AwsSecurityFinding.Builder severity​(Severity severity)

        A finding's severity.

        Parameters:
        severity - A finding's severity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • confidence

        AwsSecurityFinding.Builder confidence​(Integer confidence)

        A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

        Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

        Parameters:
        confidence - A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

        Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

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

      • criticality

        AwsSecurityFinding.Builder criticality​(Integer criticality)

        The level of importance assigned to the resources associated with the finding.

        A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

        Parameters:
        criticality - The level of importance assigned to the resources associated with the finding.

        A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

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

      • title

        AwsSecurityFinding.Builder title​(String title)

        A finding's title. Title is a required property.

        Length Constraints: Minimum length of 1. Maximum length of 256.

        Parameters:
        title - A finding's title. Title is a required property.

        Length Constraints: Minimum length of 1. Maximum length of 256.

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

      • description

        AwsSecurityFinding.Builder description​(String description)

        A finding's description. Description is a required property.

        Length Constraints: Minimum length of 1. Maximum length of 1024.

        Parameters:
        description - A finding's description. Description is a required property.

        Length Constraints: Minimum length of 1. Maximum length of 1024.

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

      • remediation

        AwsSecurityFinding.Builder remediation​(Remediation remediation)

        A data type that describes the remediation options for a finding.

        Parameters:
        remediation - A data type that describes the remediation options for a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceUrl

        AwsSecurityFinding.Builder sourceUrl​(String sourceUrl)

        A URL that links to a page about the current finding in the security findings provider's solution.

        Parameters:
        sourceUrl - A URL that links to a page about the current finding in the security findings provider's solution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • productFields

        AwsSecurityFinding.Builder productFields​(Map<String,​String> productFields)

        A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

        Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.

        Parameters:
        productFields - A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

        Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.

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

      • userDefinedFields

        AwsSecurityFinding.Builder userDefinedFields​(Map<String,​String> userDefinedFields)

        A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

        Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 1024 characters.

        Parameters:
        userDefinedFields - A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

        Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 1024 characters.

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

      • malware

        AwsSecurityFinding.Builder malware​(Collection<Malware> malware)

        A list of malware related to a finding.

        Array Members: Maximum number of 5 items.

        Parameters:
        malware - A list of malware related to a finding.

        Array Members: Maximum number of 5 items.

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

      • malware

        AwsSecurityFinding.Builder malware​(Malware... malware)

        A list of malware related to a finding.

        Array Members: Maximum number of 5 items.

        Parameters:
        malware - A list of malware related to a finding.

        Array Members: Maximum number of 5 items.

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

      • malware

        AwsSecurityFinding.Builder malware​(Consumer<Malware.Builder>... malware)

        A list of malware related to a finding.

        Array Members: Maximum number of 5 items.

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

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

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

      • network

        AwsSecurityFinding.Builder network​(Network network)

        The details of network-related information about a finding.

        Parameters:
        network - The details of network-related information about a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • networkPath

        AwsSecurityFinding.Builder networkPath​(Collection<NetworkPathComponent> networkPath)

        Provides information about a network path that is relevant to a finding. Each entry under NetworkPath represents a component of that path.

        Parameters:
        networkPath - Provides information about a network path that is relevant to a finding. Each entry under NetworkPath represents a component of that path.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • networkPath

        AwsSecurityFinding.Builder networkPath​(NetworkPathComponent... networkPath)

        Provides information about a network path that is relevant to a finding. Each entry under NetworkPath represents a component of that path.

        Parameters:
        networkPath - Provides information about a network path that is relevant to a finding. Each entry under NetworkPath represents a component of that path.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • process

        AwsSecurityFinding.Builder process​(ProcessDetails process)

        The details of process-related information about a finding.

        Parameters:
        process - The details of process-related information about a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • threats

        AwsSecurityFinding.Builder threats​(Collection<Threat> threats)

        Details about the threat detected in a security finding and the file paths that were affected by the threat.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

        Parameters:
        threats - Details about the threat detected in a security finding and the file paths that were affected by the threat.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

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

      • threats

        AwsSecurityFinding.Builder threats​(Threat... threats)

        Details about the threat detected in a security finding and the file paths that were affected by the threat.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

        Parameters:
        threats - Details about the threat detected in a security finding and the file paths that were affected by the threat.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

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

      • threats

        AwsSecurityFinding.Builder threats​(Consumer<Threat.Builder>... threats)

        Details about the threat detected in a security finding and the file paths that were affected by the threat.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

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

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

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

      • threatIntelIndicators

        AwsSecurityFinding.Builder threatIntelIndicators​(Collection<ThreatIntelIndicator> threatIntelIndicators)

        Threat intelligence details related to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 5 items.

        Parameters:
        threatIntelIndicators - Threat intelligence details related to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 5 items.

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

      • threatIntelIndicators

        AwsSecurityFinding.Builder threatIntelIndicators​(ThreatIntelIndicator... threatIntelIndicators)

        Threat intelligence details related to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 5 items.

        Parameters:
        threatIntelIndicators - Threat intelligence details related to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 5 items.

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

      • resources

        AwsSecurityFinding.Builder resources​(Collection<Resource> resources)

        A set of resource data types that describe the resources that the finding refers to.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

        Parameters:
        resources - A set of resource data types that describe the resources that the finding refers to.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

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

      • resources

        AwsSecurityFinding.Builder resources​(Resource... resources)

        A set of resource data types that describe the resources that the finding refers to.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

        Parameters:
        resources - A set of resource data types that describe the resources that the finding refers to.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

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

      • resources

        AwsSecurityFinding.Builder resources​(Consumer<Resource.Builder>... resources)

        A set of resource data types that describe the resources that the finding refers to.

        Array Members: Minimum number of 1 item. Maximum number of 32 items.

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

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

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

      • compliance

        AwsSecurityFinding.Builder compliance​(Compliance compliance)

        This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.

        Parameters:
        compliance - This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • verificationState

        AwsSecurityFinding.Builder verificationState​(String verificationState)

        Indicates the veracity of a finding.

        Parameters:
        verificationState - Indicates the veracity of a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VerificationState, VerificationState

      • workflowState

        AwsSecurityFinding.Builder workflowState​(String workflowState)

        The workflow state of a finding.

        Parameters:
        workflowState - The workflow state of a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        WorkflowState, WorkflowState

      • workflow

        AwsSecurityFinding.Builder workflow​(Workflow workflow)

        Provides information about the status of the investigation into a finding.

        Parameters:
        workflow - Provides information about the status of the investigation into a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • recordState

        AwsSecurityFinding.Builder recordState​(String recordState)

        The record state of a finding.

        Parameters:
        recordState - The record state of a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RecordState, RecordState

      • recordState

        AwsSecurityFinding.Builder recordState​(RecordState recordState)

        The record state of a finding.

        Parameters:
        recordState - The record state of a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RecordState, RecordState

      • relatedFindings

        AwsSecurityFinding.Builder relatedFindings​(Collection<RelatedFinding> relatedFindings)

        A list of related findings.

        Array Members: Minimum number of 1 item. Maximum number of 10 items.

        Parameters:
        relatedFindings - A list of related findings.

        Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

      • relatedFindings

        AwsSecurityFinding.Builder relatedFindings​(RelatedFinding... relatedFindings)

        A list of related findings.

        Array Members: Minimum number of 1 item. Maximum number of 10 items.

        Parameters:
        relatedFindings - A list of related findings.

        Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

      • note

        AwsSecurityFinding.Builder note​(Note note)

        A user-defined note added to a finding.

        Parameters:
        note - A user-defined note added to a finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vulnerabilities

        AwsSecurityFinding.Builder vulnerabilities​(Collection<Vulnerability> vulnerabilities)

        Provides a list of vulnerabilities associated with the findings.

        Parameters:
        vulnerabilities - Provides a list of vulnerabilities associated with the findings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vulnerabilities

        AwsSecurityFinding.Builder vulnerabilities​(Vulnerability... vulnerabilities)

        Provides a list of vulnerabilities associated with the findings.

        Parameters:
        vulnerabilities - Provides a list of vulnerabilities associated with the findings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • patchSummary

        AwsSecurityFinding.Builder patchSummary​(PatchSummary patchSummary)

        Provides an overview of the patch compliance status for an instance against a selected compliance standard.

        Parameters:
        patchSummary - Provides an overview of the patch compliance status for an instance against a selected compliance standard.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • action

        AwsSecurityFinding.Builder action​(Action action)

        Provides details about an action that affects or that was taken on a resource.

        Parameters:
        action - Provides details about an action that affects or that was taken on a resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • findingProviderFields

        AwsSecurityFinding.Builder findingProviderFields​(FindingProviderFields findingProviderFields)

        In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update their own values for confidence, criticality, related findings, severity, and types.

        Parameters:
        findingProviderFields - In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update their own values for confidence, criticality, related findings, severity, and types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sample

        AwsSecurityFinding.Builder sample​(Boolean sample)

        Indicates whether the finding is a sample finding.

        Parameters:
        sample - Indicates whether the finding is a sample finding.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • generatorDetails

        AwsSecurityFinding.Builder generatorDetails​(GeneratorDetails generatorDetails)

        Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to findings that relate to Lambda functions. Amazon Inspector identifies policy violations and vulnerabilities in Lambda function code based on internal detectors developed in collaboration with Amazon CodeGuru. Security Hub receives those findings.

        Parameters:
        generatorDetails - Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to findings that relate to Lambda functions. Amazon Inspector identifies policy violations and vulnerabilities in Lambda function code based on internal detectors developed in collaboration with Amazon CodeGuru. Security Hub receives those findings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • processedAt

        AwsSecurityFinding.Builder processedAt​(String processedAt)

        A timestamp that indicates when Security Hub received a finding and begins to process it.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Parameters:
        processedAt - A timestamp that indicates when Security Hub received a finding and begins to process it.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

      • awsAccountName

        AwsSecurityFinding.Builder awsAccountName​(String awsAccountName)

        The name of the Amazon Web Services account from which a finding was generated.

        Length Constraints: Minimum length of 1. Maximum length of 50.

        Parameters:
        awsAccountName - The name of the Amazon Web Services account from which a finding was generated.

        Length Constraints: Minimum length of 1. Maximum length of 50.

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