Interface AwsSecurityFinding.Builder

  • Method Details

    • 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

      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

      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

      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

      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.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

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

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      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 a change in the resource that is involved in the finding.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      Parameters:
      lastObservedAt - Indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      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.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

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

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      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.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

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

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • severity

      A finding's severity.

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

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

      Parameters:
      severity - a consumer that will call methods on Severity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      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.
    • remediation

      default AwsSecurityFinding.Builder remediation(Consumer<Remediation.Builder> remediation)

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

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

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

      Parameters:
      remediation - a consumer that will call methods on Remediation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      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

      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<Malware>).

      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:
    • 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.
    • network

      The details of network-related information about a finding.

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

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

      Parameters:
      network - a consumer that will call methods on Network.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • networkPath

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

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

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

      Parameters:
      networkPath - a consumer that will call methods on NetworkPathComponent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • process

      The details of process-related information about a finding.

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

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

      Parameters:
      process - a consumer that will call methods on ProcessDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      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<Threat>).

      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:
    • 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.
    • threatIntelIndicators

      AwsSecurityFinding.Builder threatIntelIndicators(Consumer<ThreatIntelIndicator.Builder>... threatIntelIndicators)

      Threat intelligence details related to a finding.

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

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

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

      Parameters:
      threatIntelIndicators - a consumer that will call methods on ThreatIntelIndicator.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      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<Resource>).

      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:
    • 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.
    • compliance

      default AwsSecurityFinding.Builder compliance(Consumer<Compliance.Builder> 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.

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

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

      Parameters:
      compliance - a consumer that will call methods on Compliance.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      AwsSecurityFinding.Builder verificationState(VerificationState 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:
    • 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

      AwsSecurityFinding.Builder workflowState(WorkflowState 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:
    • 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.
    • workflow

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

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

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

      Parameters:
      workflow - a consumer that will call methods on Workflow.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

      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:
    • 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.
    • relatedFindings

      AwsSecurityFinding.Builder relatedFindings(Consumer<RelatedFinding.Builder>... relatedFindings)

      A list of related findings.

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

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

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

      Parameters:
      relatedFindings - a consumer that will call methods on RelatedFinding.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • note

      A user-defined note added to a finding.

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

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

      Parameters:
      note - a consumer that will call methods on Note.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • vulnerabilities

      AwsSecurityFinding.Builder vulnerabilities(Consumer<Vulnerability.Builder>... vulnerabilities)

      Provides a list of vulnerabilities associated with the findings.

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

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

      Parameters:
      vulnerabilities - a consumer that will call methods on Vulnerability.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • patchSummary

      default AwsSecurityFinding.Builder patchSummary(Consumer<PatchSummary.Builder> patchSummary)

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

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

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

      Parameters:
      patchSummary - a consumer that will call methods on PatchSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • action

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

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

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

      Parameters:
      action - a consumer that will call methods on Action.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • findingProviderFields

      default AwsSecurityFinding.Builder findingProviderFields(Consumer<FindingProviderFields.Builder> findingProviderFields)

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

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

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

      Parameters:
      findingProviderFields - a consumer that will call methods on FindingProviderFields.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • generatorDetails

      default AwsSecurityFinding.Builder generatorDetails(Consumer<GeneratorDetails.Builder> 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.

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

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

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

      AwsSecurityFinding.Builder processedAt(String processedAt)

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

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

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

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      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.
    • detection

      AwsSecurityFinding.Builder detection(Detection detection)

      Provides details about an Amazon GuardDuty Extended Threat Detection attack sequence. GuardDuty generates an attack sequence finding when multiple events align to a potentially suspicious activity. To receive GuardDuty attack sequence findings in Security Hub, you must have GuardDuty enabled. For more information, see GuardDuty Extended Threat Detection in the Amazon GuardDuty User Guide.

      Parameters:
      detection - Provides details about an Amazon GuardDuty Extended Threat Detection attack sequence. GuardDuty generates an attack sequence finding when multiple events align to a potentially suspicious activity. To receive GuardDuty attack sequence findings in Security Hub, you must have GuardDuty enabled. For more information, see GuardDuty Extended Threat Detection in the Amazon GuardDuty User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • detection

      default AwsSecurityFinding.Builder detection(Consumer<Detection.Builder> detection)

      Provides details about an Amazon GuardDuty Extended Threat Detection attack sequence. GuardDuty generates an attack sequence finding when multiple events align to a potentially suspicious activity. To receive GuardDuty attack sequence findings in Security Hub, you must have GuardDuty enabled. For more information, see GuardDuty Extended Threat Detection in the Amazon GuardDuty User Guide.

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

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

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