AwsSecurityFinding

public struct AwsSecurityFinding : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The AWS account ID that a finding is generated in.

    Declaration

    Swift

    public let awsAccountId: String

  • 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 AWS Foundations. Contains security standard-related finding details.

    Declaration

    Swift

    public let compliance: Compliance?

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

    Declaration

    Swift

    public let confidence: Int?

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

    Declaration

    Swift

    public let createdAt: String

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

    Declaration

    Swift

    public let criticality: Int?

  • A finding’s description. In this release, Description is a required property.

    Declaration

    Swift

    public let description: String

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

    Declaration

    Swift

    public let firstObservedAt: String?

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

    Declaration

    Swift

    public let generatorId: String
  • id

    The security findings provider-specific identifier for a finding.

    Declaration

    Swift

    public let id: String

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

    Declaration

    Swift

    public let lastObservedAt: String?

  • A list of malware related to a finding.

    Declaration

    Swift

    public let malware: [Malware]?

  • The details of network-related information about a finding.

    Declaration

    Swift

    public let network: Network?

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

    Declaration

    Swift

    public let networkPath: [NetworkPathComponent]?

  • A user-defined note added to a finding.

    Declaration

    Swift

    public let note: Note?

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

    Declaration

    Swift

    public let patchSummary: PatchSummary?

  • The details of process-related information about a finding.

    Declaration

    Swift

    public let process: ProcessDetails?

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

    Declaration

    Swift

    public let productArn: String

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

    Declaration

    Swift

    public let productFields: [String : String]?

  • The record state of a finding.

    Declaration

    Swift

    public let recordState: RecordState?

  • A list of related findings.

    Declaration

    Swift

    public let relatedFindings: [RelatedFinding]?

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

    Declaration

    Swift

    public let remediation: Remediation?

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

    Declaration

    Swift

    public let resources: [Resource]

  • The schema version that a finding is formatted for.

    Declaration

    Swift

    public let schemaVersion: String

  • A finding’s severity.

    Declaration

    Swift

    public let severity: Severity

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

    Declaration

    Swift

    public let sourceUrl: String?

  • Threat intelligence details related to a finding.

    Declaration

    Swift

    public let threatIntelIndicators: [ThreatIntelIndicator]?

  • A finding’s title. In this release, Title is a required property.

    Declaration

    Swift

    public let title: String

  • 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

    Declaration

    Swift

    public let types: [String]

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

    Declaration

    Swift

    public let updatedAt: String

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

    Declaration

    Swift

    public let userDefinedFields: [String : String]?

  • Indicates the veracity of a finding.

    Declaration

    Swift

    public let verificationState: VerificationState?

  • Provides a list of vulnerabilities associated with the findings.

    Declaration

    Swift

    public let vulnerabilities: [Vulnerability]?

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

    Declaration

    Swift

    public let workflow: Workflow?

  • The workflow state of a finding.

    Declaration

    Swift

    public let workflowState: WorkflowState?

  • Undocumented

    Declaration

    Swift

    public init(awsAccountId: String, compliance: Compliance? = nil, confidence: Int? = nil, createdAt: String, criticality: Int? = nil, description: String, firstObservedAt: String? = nil, generatorId: String, id: String, lastObservedAt: String? = nil, malware: [Malware]? = nil, network: Network? = nil, networkPath: [NetworkPathComponent]? = nil, note: Note? = nil, patchSummary: PatchSummary? = nil, process: ProcessDetails? = nil, productArn: String, productFields: [String : String]? = nil, recordState: RecordState? = nil, relatedFindings: [RelatedFinding]? = nil, remediation: Remediation? = nil, resources: [Resource], schemaVersion: String, severity: Severity, sourceUrl: String? = nil, threatIntelIndicators: [ThreatIntelIndicator]? = nil, title: String, types: [String], updatedAt: String, userDefinedFields: [String : String]? = nil, verificationState: VerificationState? = nil, vulnerabilities: [Vulnerability]? = nil, workflow: Workflow? = nil, workflowState: WorkflowState? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws