Struct aws_sdk_securityhub::model::aws_security_finding::Builder

pub struct Builder { /* private fields */ }

A builder for AwsSecurityFinding.

Implementations

impl Builder

pub fn schema_version(self, input: impl Into<String>) -> Self

The schema version that a finding is formatted for.

pub fn set_schema_version(self, input: Option<String>) -> Self

The schema version that a finding is formatted for.

pub fn id(self, input: impl Into<String>) -> Self

The security findings provider-specific identifier for a finding.

pub fn set_id(self, input: Option<String>) -> Self

The security findings provider-specific identifier for a finding.

pub fn product_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_product_arn(self, input: Option<String>) -> Self

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.

pub fn product_name(self, input: impl Into<String>) -> Self

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.

pub fn set_product_name(self, input: Option<String>) -> Self

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.

pub fn company_name(self, input: impl Into<String>) -> Self

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.

pub fn set_company_name(self, input: Option<String>) -> Self

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.

pub fn region(self, input: impl Into<String>) -> Self

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.

pub fn set_region(self, input: Option<String>) -> Self

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.

pub fn generator_id(self, input: impl Into<String>) -> Self

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, etc.

pub fn set_generator_id(self, input: Option<String>) -> Self

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, etc.

pub fn aws_account_id(self, input: impl Into<String>) -> Self

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

pub fn set_aws_account_id(self, input: Option<String>) -> Self

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

pub fn types(self, input: impl Into<String>) -> Self

Appends an item to types.

To override the contents of this collection use set_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

pub fn set_types(self, input: Option<Vec<String>>) -> Self

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

pub fn first_observed_at(self, input: impl Into<String>) -> Self

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

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

pub fn set_first_observed_at(self, input: Option<String>) -> Self

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

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

pub fn last_observed_at(self, input: impl Into<String>) -> Self

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

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

pub fn set_last_observed_at(self, input: Option<String>) -> Self

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

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

pub fn created_at(self, input: impl Into<String>) -> Self

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

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

pub fn set_created_at(self, input: Option<String>) -> Self

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

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

pub fn updated_at(self, input: impl Into<String>) -> Self

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

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

pub fn set_updated_at(self, input: Option<String>) -> Self

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

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

pub fn severity(self, input: Severity) -> Self

A finding's severity.

pub fn set_severity(self, input: Option<Severity>) -> Self

A finding's severity.

pub fn confidence(self, input: i32) -> Self

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.

pub fn set_confidence(self, input: Option<i32>) -> Self

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.

pub fn criticality(self, input: i32) -> Self

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.

pub fn set_criticality(self, input: Option<i32>) -> Self

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.

pub fn title(self, input: impl Into<String>) -> Self

A finding's title.

In this release, Title is a required property.

pub fn set_title(self, input: Option<String>) -> Self

A finding's title.

In this release, Title is a required property.

pub fn description(self, input: impl Into<String>) -> Self

A finding's description.

In this release, Description is a required property.

pub fn set_description(self, input: Option<String>) -> Self

A finding's description.

In this release, Description is a required property.

pub fn remediation(self, input: Remediation) -> Self

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

pub fn set_remediation(self, input: Option<Remediation>) -> Self

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

pub fn source_url(self, input: impl Into<String>) -> Self

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

pub fn set_source_url(self, input: Option<String>) -> Self

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

pub fn product_fields(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to product_fields.

To override the contents of this collection use set_product_fields.

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.

pub fn set_product_fields(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn user_defined_fields(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to user_defined_fields.

To override the contents of this collection use set_user_defined_fields.

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

pub fn set_user_defined_fields(
    self,
    input: Option<HashMap<String, String>>
) -> Self

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

pub fn malware(self, input: Malware) -> Self

Appends an item to malware.

To override the contents of this collection use set_malware.

A list of malware related to a finding.

pub fn set_malware(self, input: Option<Vec<Malware>>) -> Self

A list of malware related to a finding.

pub fn network(self, input: Network) -> Self

The details of network-related information about a finding.

pub fn set_network(self, input: Option<Network>) -> Self

The details of network-related information about a finding.

pub fn network_path(self, input: NetworkPathComponent) -> Self

Appends an item to network_path.

To override the contents of this collection use set_network_path.

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

pub fn set_network_path(self, input: Option<Vec<NetworkPathComponent>>) -> Self

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

pub fn process(self, input: ProcessDetails) -> Self

The details of process-related information about a finding.

pub fn set_process(self, input: Option<ProcessDetails>) -> Self

The details of process-related information about a finding.

pub fn threats(self, input: Threat) -> Self

Appends an item to threats.

To override the contents of this collection use set_threats.

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

pub fn set_threats(self, input: Option<Vec<Threat>>) -> Self

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

pub fn threat_intel_indicators(self, input: ThreatIntelIndicator) -> Self

Appends an item to threat_intel_indicators.

To override the contents of this collection use set_threat_intel_indicators.

Threat intelligence details related to a finding.

pub fn set_threat_intel_indicators(
    self,
    input: Option<Vec<ThreatIntelIndicator>>
) -> Self

Threat intelligence details related to a finding.

pub fn resources(self, input: Resource) -> Self

Appends an item to resources.

To override the contents of this collection use set_resources.

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

pub fn set_resources(self, input: Option<Vec<Resource>>) -> Self

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

pub fn compliance(self, input: Compliance) -> Self

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.

pub fn set_compliance(self, input: Option<Compliance>) -> Self

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.

pub fn verification_state(self, input: VerificationState) -> Self

Indicates the veracity of a finding.

pub fn set_verification_state(self, input: Option<VerificationState>) -> Self

Indicates the veracity of a finding.

pub fn workflow_state(self, input: WorkflowState) -> Self

The workflow state of a finding.

pub fn set_workflow_state(self, input: Option<WorkflowState>) -> Self

The workflow state of a finding.

pub fn workflow(self, input: Workflow) -> Self

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

pub fn set_workflow(self, input: Option<Workflow>) -> Self

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

pub fn record_state(self, input: RecordState) -> Self

The record state of a finding.

pub fn set_record_state(self, input: Option<RecordState>) -> Self

The record state of a finding.

pub fn related_findings(self, input: RelatedFinding) -> Self

Appends an item to related_findings.

To override the contents of this collection use set_related_findings.

A list of related findings.

pub fn set_related_findings(self, input: Option<Vec<RelatedFinding>>) -> Self

A list of related findings.

pub fn note(self, input: Note) -> Self

A user-defined note added to a finding.

pub fn set_note(self, input: Option<Note>) -> Self

A user-defined note added to a finding.

pub fn vulnerabilities(self, input: Vulnerability) -> Self

Appends an item to vulnerabilities.

To override the contents of this collection use set_vulnerabilities.

Provides a list of vulnerabilities associated with the findings.

pub fn set_vulnerabilities(self, input: Option<Vec<Vulnerability>>) -> Self

Provides a list of vulnerabilities associated with the findings.

pub fn patch_summary(self, input: PatchSummary) -> Self

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

pub fn set_patch_summary(self, input: Option<PatchSummary>) -> Self

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

pub fn action(self, input: Action) -> Self

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

pub fn set_action(self, input: Option<Action>) -> Self

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

pub fn finding_provider_fields(self, input: FindingProviderFields) -> Self

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

pub fn set_finding_provider_fields(
    self,
    input: Option<FindingProviderFields>
) -> Self

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

pub fn sample(self, input: bool) -> Self

Indicates whether the finding is a sample finding.

pub fn set_sample(self, input: Option<bool>) -> Self

Indicates whether the finding is a sample finding.

pub fn build(self) -> AwsSecurityFinding

Consumes the builder and constructs a AwsSecurityFinding.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder