Interface AwsSecurityFinding.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsSecurityFinding.Builder,
,AwsSecurityFinding> SdkBuilder<AwsSecurityFinding.Builder,
,AwsSecurityFinding> SdkPojo
- Enclosing class:
AwsSecurityFinding
-
Method Summary
Modifier and TypeMethodDescriptiondefault AwsSecurityFinding.Builder
action
(Consumer<Action.Builder> action) Provides details about an action that affects or that was taken on a resource.Provides details about an action that affects or that was taken on a resource.awsAccountId
(String awsAccountId) The Amazon Web Services account ID that a finding is generated in.awsAccountName
(String awsAccountName) The name of the Amazon Web Services account from which a finding was generated.companyName
(String companyName) The name of the company for the product that generated the finding.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.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.confidence
(Integer confidence) A finding's confidence.Indicates when the security findings provider created the potential security issue that a finding captured.criticality
(Integer criticality) The level of importance assigned to the resources associated with the finding.description
(String description) A finding's description.default AwsSecurityFinding.Builder
detection
(Consumer<Detection.Builder> detection) Provides details about an Amazon GuardDuty Extended Threat Detection attack sequence.Provides details about an Amazon GuardDuty Extended Threat Detection attack sequence.default AwsSecurityFinding.Builder
findingProviderFields
(Consumer<FindingProviderFields.Builder> findingProviderFields) In aBatchImportFindings
request, finding providers useFindingProviderFields
to provide and update their own values for confidence, criticality, related findings, severity, and types.findingProviderFields
(FindingProviderFields findingProviderFields) In aBatchImportFindings
request, finding providers useFindingProviderFields
to provide and update their own values for confidence, criticality, related findings, severity, and types.firstObservedAt
(String firstObservedAt) Indicates when the security findings provider first observed the potential security issue that a finding captured.default AwsSecurityFinding.Builder
generatorDetails
(Consumer<GeneratorDetails.Builder> generatorDetails) Provides metadata for the Amazon CodeGuru detector associated with a finding.generatorDetails
(GeneratorDetails generatorDetails) Provides metadata for the Amazon CodeGuru detector associated with a finding.generatorId
(String generatorId) The identifier for the solution-specific component (a discrete unit of logic) that generated a finding.The security findings provider-specific identifier for a finding.lastObservedAt
(String lastObservedAt) Indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.malware
(Collection<Malware> malware) A list of malware related to a finding.malware
(Consumer<Malware.Builder>... malware) A list of malware related to a finding.A list of malware related to a finding.default AwsSecurityFinding.Builder
network
(Consumer<Network.Builder> network) The details of network-related information about a finding.The details of network-related information about a finding.networkPath
(Collection<NetworkPathComponent> networkPath) Provides information about a network path that is relevant to a finding.networkPath
(Consumer<NetworkPathComponent.Builder>... networkPath) Provides information about a network path that is relevant to a finding.networkPath
(NetworkPathComponent... networkPath) Provides information about a network path that is relevant to a finding.default AwsSecurityFinding.Builder
note
(Consumer<Note.Builder> note) A user-defined note added to a finding.A user-defined note added to a finding.default AwsSecurityFinding.Builder
patchSummary
(Consumer<PatchSummary.Builder> patchSummary) Provides an overview of the patch compliance status for an instance against a selected compliance standard.patchSummary
(PatchSummary patchSummary) Provides an overview of the patch compliance status for an instance against a selected compliance standard.default AwsSecurityFinding.Builder
process
(Consumer<ProcessDetails.Builder> process) The details of process-related information about a finding.process
(ProcessDetails process) The details of process-related information about a finding.processedAt
(String processedAt) A timestamp that indicates when Security Hub received a finding and begins to process it.productArn
(String productArn) The ARN generated by Security Hub that uniquely identifies a product that generates findings.productFields
(Map<String, String> productFields) A data type where security findings providers can include additional solution-specific details that aren't part of the definedAwsSecurityFinding
format.productName
(String productName) The name of the product that generated the finding.recordState
(String recordState) The record state of a finding.recordState
(RecordState recordState) The record state of a finding.The Region from which the finding was generated.relatedFindings
(Collection<RelatedFinding> relatedFindings) A list of related findings.relatedFindings
(Consumer<RelatedFinding.Builder>... relatedFindings) A list of related findings.relatedFindings
(RelatedFinding... relatedFindings) A list of related findings.default AwsSecurityFinding.Builder
remediation
(Consumer<Remediation.Builder> remediation) A data type that describes the remediation options for a finding.remediation
(Remediation remediation) A data type that describes the remediation options for a finding.resources
(Collection<Resource> resources) A set of resource data types that describe the resources that the finding refers to.resources
(Consumer<Resource.Builder>... resources) A set of resource data types that describe the resources that the finding refers to.A set of resource data types that describe the resources that the finding refers to.Indicates whether the finding is a sample finding.schemaVersion
(String schemaVersion) The schema version that a finding is formatted for.default AwsSecurityFinding.Builder
severity
(Consumer<Severity.Builder> severity) A finding's severity.A finding's severity.A URL that links to a page about the current finding in the security findings provider's solution.threatIntelIndicators
(Collection<ThreatIntelIndicator> threatIntelIndicators) Threat intelligence details related to a finding.threatIntelIndicators
(Consumer<ThreatIntelIndicator.Builder>... threatIntelIndicators) Threat intelligence details related to a finding.threatIntelIndicators
(ThreatIntelIndicator... threatIntelIndicators) Threat intelligence details related to a finding.threats
(Collection<Threat> threats) Details about the threat detected in a security finding and the file paths that were affected by the threat.threats
(Consumer<Threat.Builder>... threats) Details about the threat detected in a security finding and the file paths that were affected by the threat.Details about the threat detected in a security finding and the file paths that were affected by the threat.A finding's title.One or more finding types in the format ofnamespace/category/classifier
that classify a finding.types
(Collection<String> types) One or more finding types in the format ofnamespace/category/classifier
that classify a finding.Indicates when the security findings provider last updated the finding record.userDefinedFields
(Map<String, String> userDefinedFields) A list of name/value string pairs associated with the finding.verificationState
(String verificationState) Indicates the veracity of a finding.verificationState
(VerificationState verificationState) Indicates the veracity of a finding.vulnerabilities
(Collection<Vulnerability> vulnerabilities) Provides a list of vulnerabilities associated with the findings.vulnerabilities
(Consumer<Vulnerability.Builder>... vulnerabilities) Provides a list of vulnerabilities associated with the findings.vulnerabilities
(Vulnerability... vulnerabilities) Provides a list of vulnerabilities associated with the findings.default AwsSecurityFinding.Builder
workflow
(Consumer<Workflow.Builder> workflow) Provides information about the status of the investigation into a finding.Provides information about the status of the investigation into a finding.workflowState
(String workflowState) The workflow state of a finding.workflowState
(WorkflowState workflowState) The workflow state of a finding.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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 is2018-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
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
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
orBatchUpdateFindings
. 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
orBatchUpdateFindings
. 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
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
orBatchUpdateFindings
. 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
orBatchUpdateFindings
. 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
orBatchUpdateFindings
.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
orBatchUpdateFindings
.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
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
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 ofnamespace/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 ofnamespace/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
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
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
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
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 theSeverity.Builder
avoiding the need to create one manually viaSeverity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toseverity(Severity)
.- Parameters:
severity
- a consumer that will call methods onSeverity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
A data type that describes the remediation options for a finding.
This is a convenience method that creates an instance of theRemediation.Builder
avoiding the need to create one manually viaRemediation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toremediation(Remediation)
.- Parameters:
remediation
- a consumer that will call methods onRemediation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 definedAwsSecurityFinding
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
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
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 theMalware.Builder
avoiding the need to create one manually viaMalware.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomalware(List<Malware>)
.- Parameters:
malware
- a consumer that will call methods onMalware.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 theNetwork.Builder
avoiding the need to create one manually viaNetwork.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetwork(Network)
.- Parameters:
network
- a consumer that will call methods onNetwork.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 underNetworkPath
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.- Parameters:
networkPath
- Provides information about a network path that is relevant to a finding. Each entry underNetworkPath
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
This is a convenience method that creates an instance of theNetworkPath
represents a component of that path.NetworkPathComponent.Builder
avoiding the need to create one manually viaNetworkPathComponent.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetworkPath(List<NetworkPathComponent>)
.- Parameters:
networkPath
- a consumer that will call methods onNetworkPathComponent.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 theProcessDetails.Builder
avoiding the need to create one manually viaProcessDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprocess(ProcessDetails)
.- Parameters:
process
- a consumer that will call methods onProcessDetails.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
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 theThreat.Builder
avoiding the need to create one manually viaThreat.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tothreats(List<Threat>)
.- Parameters:
threats
- a consumer that will call methods onThreat.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
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 theThreatIntelIndicator.Builder
avoiding the need to create one manually viaThreatIntelIndicator.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tothreatIntelIndicators(List<ThreatIntelIndicator>)
.- Parameters:
threatIntelIndicators
- a consumer that will call methods onThreatIntelIndicator.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
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 theResource.Builder
avoiding the need to create one manually viaResource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresources(List<Resource>)
.- Parameters:
resources
- a consumer that will call methods onResource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theCompliance.Builder
avoiding the need to create one manually viaCompliance.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocompliance(Compliance)
.- Parameters:
compliance
- a consumer that will call methods onCompliance.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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 theWorkflow.Builder
avoiding the need to create one manually viaWorkflow.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkflow(Workflow)
.- Parameters:
workflow
- a consumer that will call methods onWorkflow.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-
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 theNote.Builder
avoiding the need to create one manually viaNote.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonote(Note)
.- Parameters:
note
- a consumer that will call methods onNote.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
Provides a list of vulnerabilities associated with the findings.
This is a convenience method that creates an instance of theVulnerability.Builder
avoiding the need to create one manually viaVulnerability.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovulnerabilities(List<Vulnerability>)
.- Parameters:
vulnerabilities
- a consumer that will call methods onVulnerability.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 thePatchSummary.Builder
avoiding the need to create one manually viaPatchSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topatchSummary(PatchSummary)
.- Parameters:
patchSummary
- a consumer that will call methods onPatchSummary.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 theAction.Builder
avoiding the need to create one manually viaAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaction(Action)
.- Parameters:
action
- a consumer that will call methods onAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
findingProviderFields
In a
BatchImportFindings
request, finding providers useFindingProviderFields
to provide and update their own values for confidence, criticality, related findings, severity, and types.- Parameters:
findingProviderFields
- In aBatchImportFindings
request, finding providers useFindingProviderFields
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
This is a convenience method that creates an instance of theBatchImportFindings
request, finding providers useFindingProviderFields
to provide and update their own values for confidence, criticality, related findings, severity, and types.FindingProviderFields.Builder
avoiding the need to create one manually viaFindingProviderFields.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofindingProviderFields(FindingProviderFields)
.- Parameters:
findingProviderFields
- a consumer that will call methods onFindingProviderFields.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
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 theGeneratorDetails.Builder
avoiding the need to create one manually viaGeneratorDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togeneratorDetails(GeneratorDetails)
.- Parameters:
generatorDetails
- a consumer that will call methods onGeneratorDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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 theDetection.Builder
avoiding the need to create one manually viaDetection.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todetection(Detection)
.- Parameters:
detection
- a consumer that will call methods onDetection.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-