Security Hub

16 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

SecurityHubAccount # GA

SecurityHubAccount is the Schema for managing the Security Hub account subscription in a region.

kubectl get securityhubaccounts · example on GitHub

Example

# SecurityHubAccount — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubaccount
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubAccount
metadata:
  name: example-securityhubaccount
  namespace: default
spec:
  controlFindingGenerator: SECURITY_CONTROL
  enableDefaultStandards: true
  providerRef:
    name: example-securityhubaccount
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
controlFindingGeneratorenum—ControlFindingGenerator specifies whether a control check generates a single consolidated finding (SECURITY_CONTROL) or per-standard findings (STANDARD_CONTROL). Allowed: SECURITY_CONTROL, STANDARD_CONTROL
enableDefaultStandardsboolean—EnableDefaultStandards enables the standards Security Hub designates as automatically enabled.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—Tags to add to the hub resource when enabling Security Hub.

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
hubArnstring—HubARN is the ARN of the Hub resource.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
subscribedAtstring—SubscribedAt is when Security Hub was enabled in the account.

SecurityHubAggregatorV2 # CLOUD CONTROL · AWS::SecurityHub::AggregatorV2 ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: account-wide finding aggregation. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. SecurityHubAggregatorV2 manages AWS::SecurityHub::AggregatorV2 through the AWS Cloud Control API.

kubectl get securityhubaggregatorv2s · example on GitHub

Example

# SecurityHubAggregatorV2 — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubaggregatorv2
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubAggregatorV2
metadata:
  name: example-securityhubaggregatorv2
  namespace: default
spec:
  linkedRegions:
  - example
  providerRef:
    name: example-securityhubaggregatorv2
    region: us-east-1
  regionLinkingMode: SPECIFIED_REGIONS
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
linkedRegionsarray<string>yesThe list of included Regions
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
regionLinkingModeenumyesIndicates to link a list of included Regions Allowed: SPECIFIED_REGIONS
tagsmap<string>—

Status

FieldTypeRequiredDescription
aggregationRegionstring—The aggregation Region of the AggregatorV2 Read-only: reported by AWS after creation.
aggregatorV2Arnstring—The ARN of the AggregatorV2 being created and assigned as the unique identifier Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

SecurityHubAutomationRule # CLOUD CONTROL · AWS::SecurityHub::AutomationRule

SecurityHubAutomationRule manages AWS::SecurityHub::AutomationRule through the AWS Cloud Control API.

kubectl get securityhubautomationrules · example on GitHub

Example

# SecurityHubAutomationRule — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubautomationrule
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubAutomationRule
metadata:
  name: example-securityhubautomationrule
  namespace: default
spec:
  actions:
  - findingFieldsUpdate:
      confidence: 1
      criticality: 1
      relatedFindings:
      - productArn: arn:aws:iam::123456789012:role/example-role
      types:
      - example
      verificationState: UNKNOWN
    type: FINDING_FIELDS_UPDATE
  criteria:
    awsAccountId:
    - comparison: EQUALS
      value: example
    companyName:
    - comparison: EQUALS
      value: example
    complianceAssociatedStandardsId:
    - comparison: EQUALS
      value: example
    complianceSecurityControlId:
    - comparison: EQUALS
      value: example
    complianceStatus:
    - comparison: EQUALS
      value: example
    confidence:
    - eq: 1
      gte: 1
      lte: 1
    createdAt:
    - end: example
      start: example
    criticality:
    - eq: 1
      gte: 1
      lte: 1
    description:
    - comparison: EQUALS
      value: example
    firstObservedAt:
    - end: example
      start: example
    generatorId:
    - comparison: EQUALS
      value: example
    id:
    - comparison: EQUALS
      value: example
    lastObservedAt:
    - end: example
      start: example
    noteText:
    - comparison: EQUALS
      value: example
    noteUpdatedAt:
    - end: example
      start: example
    noteUpdatedBy:
    - comparison: EQUALS
      value: example
    productArn:
    - comparison: EQUALS
      value: example
    productName:
    - comparison: EQUALS
      value: example
    recordState:
    - comparison: EQUALS
      value: example
    relatedFindingsId:
    - comparison: EQUALS
      value: example
    relatedFindingsProductArn:
    - comparison: EQUALS
      value: example
    resourceDetailsOther:
    - comparison: EQUALS
      key: example
      value: example
    resourceId:
    - comparison: EQUALS
      value: example
    resourcePartition:
    - comparison: EQUALS
      value: example
    resourceRegion:
    - comparison: EQUALS
      value: example
    resourceTags:
    - comparison: EQUALS
      key: example
      value: example
    resourceType:
    - comparison: EQUALS
      value: example
    severityLabel:
    - comparison: EQUALS
      value: example
    sourceUrl:
    - comparison: EQUALS
      value: example
    title:
    - comparison: EQUALS
      value: example
    type:
    - comparison: EQUALS
      value: example
    updatedAt:
    - end: example
      start: example
    userDefinedFields:
    - comparison: EQUALS
      key: example
      value: example
    verificationState:
    - comparison: EQUALS
      value: example
    workflowStatus:
    - comparison: EQUALS
      value: example
  description: Managed by konfig-konector
  isTerminal: false
  providerRef:
    name: example-securityhubautomationrule
    region: us-east-1
  ruleName: example-securityhubautomationrule
  ruleOrder: 1
  ruleStatus: ENABLED
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
actionsarray<object>yesOne or more actions to update finding fields if a finding matches the conditions specified in ``Criteria``.
actions[].findingFieldsUpdateobjectyesSpecifies that the automation rule action is an update to a finding field.
actions[].findingFieldsUpdate.confidenceinteger—The rule action updates the ``Confidence`` field of a finding.
actions[].findingFieldsUpdate.criticalityinteger—The rule action updates the ``Criticality`` field of a finding.
actions[].findingFieldsUpdate.noteobject—The rule action will update the ``Note`` field of a finding.
actions[].findingFieldsUpdate.note.textstringyesThe updated note text.
actions[].findingFieldsUpdate.note.updatedByobjectyesThe principal that updated the note.
actions[].findingFieldsUpdate.relatedFindingsarray<object>—The rule action will update the ``RelatedFindings`` field of a finding.
actions[].findingFieldsUpdate.relatedFindings[].idobjectyesThe product-generated identifier for a related finding.
actions[].findingFieldsUpdate.relatedFindings[].productArnstringyesThe Amazon Resource Name (ARN) for the product that generated a related finding.
actions[].findingFieldsUpdate.severityobject—The rule action will update the ``Severity`` field of a finding.
actions[].findingFieldsUpdate.severity.labelenum—The severity value of the finding. Allowed: INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL
actions[].findingFieldsUpdate.severity.normalizedinteger—The normalized severity for the finding.
actions[].findingFieldsUpdate.severity.productnumber—The native severity as defined by the AWS service or integrated partner product that generated the finding.
actions[].findingFieldsUpdate.typesarray<string>—The rule action updates the ``Types`` field of a finding.
actions[].findingFieldsUpdate.userDefinedFieldsmap<string>—The rule action updates the ``UserDefinedFields`` field of a finding.
actions[].findingFieldsUpdate.verificationStateenum—The rule action updates the ``VerificationState`` field of a finding. Allowed: UNKNOWN, TRUE_POSITIVE, FALSE_POSITIVE, BENIGN_POSITIVE
actions[].findingFieldsUpdate.workflowobject—The rule action will update the ``Workflow`` field of a finding.
actions[].findingFieldsUpdate.workflow.statusenumyesThe status of the investigation into the finding. Allowed: NEW, NOTIFIED, RESOLVED, SUPPRESSED
actions[].typeenumyesSpecifies the type of action that Security Hub CSPM takes when a finding matches the defined criteria of a rule. Allowed: FINDING_FIELDS_UPDATE
criteriaobjectyesA set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings.
criteria.awsAccountIdarray<object>—The AWS-account ID in which a finding was generated.
criteria.awsAccountId[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.awsAccountId[].valuestringyesThe string filter value.
criteria.companyNamearray<object>—The name of the company for the product that generated the finding.
criteria.companyName[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.companyName[].valuestringyesThe string filter value.
criteria.complianceAssociatedStandardsIdarray<object>—The unique identifier of a standard in which a control is enabled.
criteria.complianceAssociatedStandardsId[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.complianceAssociatedStandardsId[].valuestringyesThe string filter value.
criteria.complianceSecurityControlIdarray<object>—The security control ID for which a finding was generated.
criteria.complianceSecurityControlId[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.complianceSecurityControlId[].valuestringyesThe string filter value.
criteria.complianceStatusarray<object>—The result of a security check.
criteria.complianceStatus[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.complianceStatus[].valuestringyesThe string filter value.
criteria.confidencearray<object>—The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.
criteria.confidence[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
criteria.confidence[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
criteria.confidence[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
criteria.createdAtarray<object>—A timestamp that indicates when this finding record was created.
criteria.createdAt[].dateRangeobject—A date range for the date filter.
criteria.createdAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
criteria.createdAt[].dateRange.valuenumberyesA date range value for the date filter.
criteria.createdAt[].endstring—A timestamp that provides the end date for the date filter.
criteria.createdAt[].startstring—A timestamp that provides the start date for the date filter.
criteria.criticalityarray<object>—The level of importance that is assigned to the resources that are associated with a finding.
criteria.criticality[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
criteria.criticality[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
criteria.criticality[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
criteria.descriptionarray<object>—A finding's description.
criteria.description[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.description[].valuestringyesThe string filter value.
criteria.firstObservedAtarray<object>—A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product.
criteria.firstObservedAt[].dateRangeobject—A date range for the date filter.
criteria.firstObservedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
criteria.firstObservedAt[].dateRange.valuenumberyesA date range value for the date filter.
criteria.firstObservedAt[].endstring—A timestamp that provides the end date for the date filter.
criteria.firstObservedAt[].startstring—A timestamp that provides the start date for the date filter.
criteria.generatorIdarray<object>—The identifier for the solution-specific component that generated a finding.
criteria.generatorId[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.generatorId[].valuestringyesThe string filter value.
criteria.idarray<object>—The product-specific identifier for a finding.
criteria.id[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.id[].valuestringyesThe string filter value.
criteria.lastObservedAtarray<object>—A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.
criteria.lastObservedAt[].dateRangeobject—A date range for the date filter.
criteria.lastObservedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
criteria.lastObservedAt[].dateRange.valuenumberyesA date range value for the date filter.
criteria.lastObservedAt[].endstring—A timestamp that provides the end date for the date filter.
criteria.lastObservedAt[].startstring—A timestamp that provides the start date for the date filter.
criteria.noteTextarray<object>—The text of a user-defined note that's added to a finding.
criteria.noteText[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.noteText[].valuestringyesThe string filter value.
criteria.noteUpdatedAtarray<object>—The timestamp of when the note was updated.
criteria.noteUpdatedAt[].dateRangeobject—A date range for the date filter.
criteria.noteUpdatedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
criteria.noteUpdatedAt[].dateRange.valuenumberyesA date range value for the date filter.
criteria.noteUpdatedAt[].endstring—A timestamp that provides the end date for the date filter.
criteria.noteUpdatedAt[].startstring—A timestamp that provides the start date for the date filter.
criteria.noteUpdatedByarray<object>—The principal that created a note.
criteria.noteUpdatedBy[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.noteUpdatedBy[].valuestringyesThe string filter value.
criteria.productArnarray<object>—The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub CSPM.
criteria.productArn[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.productArn[].valuestringyesThe string filter value.
criteria.productNamearray<object>—Provides the name of the product that generated the finding.
criteria.productName[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.productName[].valuestringyesThe string filter value.
criteria.recordStatearray<object>—Provides the current state of a finding.
criteria.recordState[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.recordState[].valuestringyesThe string filter value.
criteria.relatedFindingsIdarray<object>—The product-generated identifier for a related finding.
criteria.relatedFindingsId[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.relatedFindingsId[].valuestringyesThe string filter value.
criteria.relatedFindingsProductArnarray<object>—The ARN for the product that generated a related finding.
criteria.relatedFindingsProductArn[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.relatedFindingsProductArn[].valuestringyesThe string filter value.
criteria.resourceDetailsOtherarray<object>—Custom fields and values about the resource that a finding pertains to.
criteria.resourceDetailsOther[].comparisonenumyesThe condition to apply to the key value when filtering Security Hub CSPM findings with a map filter. Allowed: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.resourceDetailsOther[].keystringyesThe key of the map filter.
criteria.resourceDetailsOther[].valuestringyesThe value for the key in the map filter.
criteria.resourceIdarray<object>—The identifier for the given resource type.
criteria.resourceId[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.resourceId[].valuestringyesThe string filter value.
criteria.resourcePartitionarray<object>—The partition in which the resource that the finding pertains to is located.
criteria.resourcePartition[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.resourcePartition[].valuestringyesThe string filter value.
criteria.resourceRegionarray<object>—The AWS-Region where the resource that a finding pertains to is located.
criteria.resourceRegion[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.resourceRegion[].valuestringyesThe string filter value.
criteria.resourceTagsarray<object>—A list of AWS tags associated with a resource at the time the finding was processed.
criteria.resourceTags[].comparisonenumyesThe condition to apply to the key value when filtering Security Hub CSPM findings with a map filter. Allowed: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.resourceTags[].keystringyesThe key of the map filter.
criteria.resourceTags[].valuestringyesThe value for the key in the map filter.
criteria.resourceTypearray<object>—A finding's title.
criteria.resourceType[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.resourceType[].valuestringyesThe string filter value.
criteria.severityLabelarray<object>—The severity value of the finding.
criteria.severityLabel[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.severityLabel[].valuestringyesThe string filter value.
criteria.sourceUrlarray<object>—Provides a URL that links to a page about the current finding in the finding product.
criteria.sourceUrl[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.sourceUrl[].valuestringyesThe string filter value.
criteria.titlearray<object>—A finding's title.
criteria.title[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.title[].valuestringyesThe string filter value.
criteria.typearray<object>—One or more finding types in the format of namespace/category/classifier that classify a finding.
criteria.type[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.type[].valuestringyesThe string filter value.
criteria.updatedAtarray<object>—A timestamp that indicates when the finding record was most recently updated.
criteria.updatedAt[].dateRangeobject—A date range for the date filter.
criteria.updatedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
criteria.updatedAt[].dateRange.valuenumberyesA date range value for the date filter.
criteria.updatedAt[].endstring—A timestamp that provides the end date for the date filter.
criteria.updatedAt[].startstring—A timestamp that provides the start date for the date filter.
criteria.userDefinedFieldsarray<object>—A list of user-defined name and value string pairs added to a finding.
criteria.userDefinedFields[].comparisonenumyesThe condition to apply to the key value when filtering Security Hub CSPM findings with a map filter. Allowed: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.userDefinedFields[].keystringyesThe key of the map filter.
criteria.userDefinedFields[].valuestringyesThe value for the key in the map filter.
criteria.verificationStatearray<object>—Provides the veracity of a finding.
criteria.verificationState[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.verificationState[].valuestringyesThe string filter value.
criteria.workflowStatusarray<object>—Provides information about the status of the investigation into a finding.
criteria.workflowStatus[].comparisonenumyesThe condition to apply to a string value when filtering Security Hub CSPM findings. Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS, NOT_CONTAINS
criteria.workflowStatus[].valuestringyesThe string filter value.
descriptionstringyesA description of the rule.
isTerminalboolean—Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
ruleNamestringyesThe name of the rule.
ruleOrderintegeryesAn integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
ruleStatusenum—Whether the rule is active after it is created. Allowed: ENABLED, DISABLED
tagsmap<string>—User-defined tags associated with an automation rule.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
createdAtstring—Read-only: reported by AWS after creation.
createdBystring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
ruleArnstring—Read-only: reported by AWS after creation.
updatedAtstring—Read-only: reported by AWS after creation.

SecurityHubAutomationRuleV2 # CLOUD CONTROL · AWS::SecurityHub::AutomationRuleV2

SecurityHubAutomationRuleV2 manages AWS::SecurityHub::AutomationRuleV2 through the AWS Cloud Control API.

kubectl get securityhubautomationrulev2s · example on GitHub

Example

# SecurityHubAutomationRuleV2 — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubautomationrulev2
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubAutomationRuleV2
metadata:
  name: example-securityhubautomationrulev2
  namespace: default
spec:
  actions:
  - externalIntegrationConfiguration:
      connectorArn: arn:aws:iam::123456789012:role/example-role
    findingFieldsUpdate:
      comment: Managed by konfig-konector
      severityId: 1
      statusId: 1
    type: FINDING_FIELDS_UPDATE
  criteria:
    ocsfFindingCriteria:
      compositeFilters:
      - booleanFilters:
        - fieldName: compliance.assessments.meets_criteria
          filter:
            value: false
        dateFilters:
        - fieldName: finding_info.created_time_dt
          filter:
            end: example
            start: example
        mapFilters:
        - fieldName: resources.tags
          filter:
            comparison: EQUALS
            key: example
            value: example
        numberFilters:
        - fieldName: activity_id
          filter:
            eq: 1
            gte: 1
            lte: 1
        operator: AND
        stringFilters:
        - fieldName: activity_name
          filter:
            comparison: EQUALS
            value: example
      compositeOperator: AND
  description: Managed by konfig-konector
  providerRef:
    name: example-securityhubautomationrulev2
    region: us-east-1
  ruleName: example-securityhubautomationrulev2
  ruleOrder: 1
  ruleStatus: ENABLED
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
actionsarray<object>yesA list of actions to be performed when the rule criteria is met
actions[].externalIntegrationConfigurationobject—SecurityHubAutomationRuleV2ExternalIntegrationConfiguration is a nested property type of AWS::SecurityHub::AutomationRuleV2.
actions[].externalIntegrationConfiguration.connectorArnstring—The ARN of the connector that establishes the integration
actions[].findingFieldsUpdateobject—SecurityHubAutomationRuleV2AutomationRulesFindingFieldsUpdateV2 is a nested property type of AWS::SecurityHub::AutomationRuleV2.
actions[].findingFieldsUpdate.commentstring—Notes or contextual information for findings that are modified by the automation rule
actions[].findingFieldsUpdate.severityIdinteger—The severity level to be assigned to findings that match the automation rule criteria
actions[].findingFieldsUpdate.statusIdinteger—The status to be applied to findings that match automation rule criteria
actions[].typeenumyesThe category of action to be executed by the automation rule Allowed: FINDING_FIELDS_UPDATE, EXTERNAL_INTEGRATION
criteriaobjectyesSecurityHubAutomationRuleV2Criteria is a nested property type of AWS::SecurityHub::AutomationRuleV2.
criteria.ocsfFindingCriteriaobject—SecurityHubAutomationRuleV2OcsfFindingFilters is a nested property type of AWS::SecurityHub::AutomationRuleV2.
criteria.ocsfFindingCriteria.compositeFiltersarray<object>—Enables the creation of complex filtering conditions by combining filter
criteria.ocsfFindingCriteria.compositeFilters[].booleanFiltersarray<object>—Enables filtering based on boolean field values
criteria.ocsfFindingCriteria.compositeFilters[].booleanFilters[].fieldNameenumyesThe name of the field Allowed: compliance.assessments.meets_criteria, vulnerabilities.is_exploit_available, vulnerabilities.is_fix_available
criteria.ocsfFindingCriteria.compositeFilters[].booleanFilters[].filterobjectyesSecurityHubAutomationRuleV2BooleanFilter is a nested property type of AWS::SecurityHub::AutomationRuleV2.
criteria.ocsfFindingCriteria.compositeFilters[].booleanFilters[].filter.valuebooleanyesThe value of the boolean
criteria.ocsfFindingCriteria.compositeFilters[].dateFiltersarray<object>—Enables filtering based on date and timestamp fields
criteria.ocsfFindingCriteria.compositeFilters[].dateFilters[].fieldNameenumyesThe name of the field Allowed: finding_info.created_time_dt, finding_info.first_seen_time_dt, finding_info.last_seen_time_dt, finding_info.modified_time_dt
criteria.ocsfFindingCriteria.compositeFilters[].dateFilters[].filterobjectyesSecurityHubAutomationRuleV2DateFilter is a nested property type of AWS::SecurityHub::AutomationRuleV2.
criteria.ocsfFindingCriteria.compositeFilters[].dateFilters[].filter.dateRangeobject—SecurityHubAutomationRuleV2DateRange is a nested property type of AWS::SecurityHub::AutomationRuleV2.
criteria.ocsfFindingCriteria.compositeFilters[].dateFilters[].filter.endstring—
criteria.ocsfFindingCriteria.compositeFilters[].dateFilters[].filter.startstring—
criteria.ocsfFindingCriteria.compositeFilters[].mapFiltersarray<object>—Enables filtering based on map field value
criteria.ocsfFindingCriteria.compositeFilters[].mapFilters[].fieldNameenumyesThe name of the field Allowed: resources.tags
criteria.ocsfFindingCriteria.compositeFilters[].mapFilters[].filterobjectyesSecurityHubAutomationRuleV2MapFilter is a nested property type of AWS::SecurityHub::AutomationRuleV2.
criteria.ocsfFindingCriteria.compositeFilters[].mapFilters[].filter.comparisonenumyesThe condition to apply to the key value when filtering findings with a map filter Allowed: EQUALS, NOT_EQUALS
criteria.ocsfFindingCriteria.compositeFilters[].mapFilters[].filter.keystringyesThe key of the map filter
criteria.ocsfFindingCriteria.compositeFilters[].mapFilters[].filter.valuestringyesThe value for the key in the map filter
criteria.ocsfFindingCriteria.compositeFilters[].numberFiltersarray<object>—Enables filtering based on numerical field values
criteria.ocsfFindingCriteria.compositeFilters[].numberFilters[].fieldNameenumyesThe name of the field Allowed: activity_id, compliance.status_id, confidence_score, finding_info.related_events_count, vendor_attributes.severity_id
criteria.ocsfFindingCriteria.compositeFilters[].numberFilters[].filterobjectyesSecurityHubAutomationRuleV2NumberFilter is a nested property type of AWS::SecurityHub::AutomationRuleV2.
criteria.ocsfFindingCriteria.compositeFilters[].numberFilters[].filter.eqnumber—The equal-to condition to be applied to a single field when querying for findings
criteria.ocsfFindingCriteria.compositeFilters[].numberFilters[].filter.gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings
criteria.ocsfFindingCriteria.compositeFilters[].numberFilters[].filter.ltenumber—The less-than-equal condition to be applied to a single field when querying for findings
criteria.ocsfFindingCriteria.compositeFilters[].operatorenum—Allowed: AND, OR
criteria.ocsfFindingCriteria.compositeFilters[].stringFiltersarray<object>—Enables filtering based on string field values
criteria.ocsfFindingCriteria.compositeFilters[].stringFilters[].fieldNameenumyesAllowed: activity_name, cloud.account.name, cloud.account.uid, cloud.provider, cloud.region, compliance.assessments.category, compliance.assessments.name, compliance.control…
criteria.ocsfFindingCriteria.compositeFilters[].stringFilters[].filterobjectyesSecurityHubAutomationRuleV2StringFilter is a nested property type of AWS::SecurityHub::AutomationRuleV2.
criteria.ocsfFindingCriteria.compositeFilters[].stringFilters[].filter.comparisonenumyesThe condition to apply to a string value when filtering findings Allowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS, CONTAINS
criteria.ocsfFindingCriteria.compositeFilters[].stringFilters[].filter.valuestringyesThe string filter value
criteria.ocsfFindingCriteria.compositeOperatorenum—Allowed: AND, OR
descriptionstringyesA description of the automation rule
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
ruleNamestringyesThe name of the automation rule
ruleOrdernumberyesThe value for the rule priority
ruleStatusenum—The status of the automation rule Allowed: ENABLED, DISABLED
tagsmap<string>—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
createdAtstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
ruleArnstring—The ARN of the automation rule Read-only: reported by AWS after creation.
ruleIdstring—The ID of the automation rule Read-only: reported by AWS after creation.
updatedAtstring—Read-only: reported by AWS after creation.

SecurityHubConfigurationPolicy # CLOUD CONTROL · AWS::SecurityHub::ConfigurationPolicy

SecurityHubConfigurationPolicy manages AWS::SecurityHub::ConfigurationPolicy through the AWS Cloud Control API.

kubectl get securityhubconfigurationpolicies · example on GitHub

Example

# SecurityHubConfigurationPolicy — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubconfigurationpolicy
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubConfigurationPolicy
metadata:
  name: example-securityhubconfigurationpolicy
  namespace: default
spec:
  configurationPolicy:
    securityHub:
      enabledStandardIdentifiers:
      - example
      securityControlsConfiguration:
        disabledSecurityControlIdentifiers:
        - example
        enabledSecurityControlIdentifiers:
        - example
      serviceEnabled: true
  description: Managed by konfig-konector
  name: example-securityhubconfigurationpolicy
  providerRef:
    name: example-securityhubconfigurationpolicy
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
configurationPolicyobjectyesSecurityHubConfigurationPolicyPolicy is a nested property type of AWS::SecurityHub::ConfigurationPolicy.
configurationPolicy.securityHubobject—SecurityHubConfigurationPolicySecurityHubPolicy is a nested property type of AWS::SecurityHub::ConfigurationPolicy.
configurationPolicy.securityHub.enabledStandardIdentifiersarray<string>—A list that defines which security standards are enabled in the configuration policy.
configurationPolicy.securityHub.securityControlsConfigurationobject—SecurityHubConfigurationPolicySecurityControlsConfiguration is a nested property type of AWS::SecurityHub::ConfigurationPolicy.
configurationPolicy.securityHub.securityControlsConfiguration.disabledSecurityControlIdentifiersarray<string>—A list of security controls that are disabled in the configuration policy
configurationPolicy.securityHub.securityControlsConfiguration.enabledSecurityControlIdentifiersarray<string>—A list of security controls that are enabled in the configuration policy.
configurationPolicy.securityHub.securityControlsConfiguration.securityControlCustomParametersarray<object>—A list of security controls and control parameter values that are included in a configuration policy.
configurationPolicy.securityHub.securityControlsConfiguration.securityControlCustomParameters[].parametersmap<string>—An object that specifies parameter values for a control in a configuration policy.
configurationPolicy.securityHub.securityControlsConfiguration.securityControlCustomParameters[].securityControlIdstring—The ID of the security control.
configurationPolicy.securityHub.serviceEnabledboolean—Indicates whether Security Hub is enabled in the policy.
descriptionstring—The description of the configuration policy.
namestringyesThe name of the configuration policy.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—

Status

FieldTypeRequiredDescription
arnstring—The Amazon Resource Name (ARN) of the configuration policy.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
createdAtstring—The date and time, in UTC and ISO 8601 format.
idstring—The universally unique identifier (UUID) of the configuration policy.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
serviceEnabledboolean—Indicates whether the service that the configuration policy applies to is enabled in the policy.
updatedAtstring—The date and time, in UTC and ISO 8601 format.

SecurityHubConnector # CLOUD CONTROL · AWS::SecurityHub::Connector

SecurityHubConnector manages AWS::SecurityHub::Connector through the AWS Cloud Control API.

kubectl get securityhubconnectors · example on GitHub

Example

# SecurityHubConnector — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubconnector
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubConnector
metadata:
  name: example-securityhubconnector
  namespace: default
spec:
  description: Managed by konfig-konector
  name: example-securityhubconnector
  provider:
    azure:
      awsConfigConnectorArn: arn:aws:iam::123456789012:role/example-role
      azureRegions:
      - example
      scopeConfiguration:
        scopeType: TENANT
        scopeValues:
        - example
  providerRef:
    name: example-securityhubconnector
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
descriptionstring—The description of the connector.
namestringyesThe name of the connector.
providerobjectyesSecurityHubConnectorProvider is a nested property type of AWS::SecurityHub::Connector.
provider.azureobjectyesSecurityHubConnectorAzureProviderConfiguration is a nested property type of AWS::SecurityHub::Connector.
provider.azure.awsConfigConnectorArnstringyesThe ARN of the multi-cloud configuration connector used to establish the connection to Azure.
provider.azure.azureRegionsarray<string>yesThe list of Azure regions to monitor.
provider.azure.scopeConfigurationobjectyesThe scope configuration that defines which Azure resources are monitored.
provider.azure.scopeConfiguration.scopeTypeenumyesThe type of scope. Allowed: TENANT, SUBSCRIPTION
provider.azure.scopeConfiguration.scopeValuesarray<string>—The list of scope values, such as subscription IDs, when the scope type is ``subscription``.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
connectorArnstring—Read-only: reported by AWS after creation.
connectorIdstring—Read-only: reported by AWS after creation.
connectorStatusstring—Read-only: reported by AWS after creation.
createdAtstring—Read-only: reported by AWS after creation.
createdBystring—Read-only: reported by AWS after creation.
enablementStatusstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
issuesarray<object>—Read-only: reported by AWS after creation.
issues[].codestringyesThe error code that identifies the type of health issue.
issues[].messagestringyesA human-readable message that describes the health issue.
lastCheckedAtstring—Read-only: reported by AWS after creation.
lastSyncTimestring—
lastUpdatedAtstring—Read-only: reported by AWS after creation.
messagestring—Read-only: reported by AWS after creation.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

SecurityHubConnectorV2 # CLOUD CONTROL · AWS::SecurityHub::ConnectorV2

SecurityHubConnectorV2 manages AWS::SecurityHub::ConnectorV2 through the AWS Cloud Control API.

kubectl get securityhubconnectorv2s · example on GitHub

Example

# SecurityHubConnectorV2 — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubconnectorv2
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubConnectorV2
metadata:
  name: example-securityhubconnectorv2
  namespace: default
spec:
  description: Managed by konfig-konector
  kmsKeyArn: arn:aws:iam::123456789012:role/example-role
  name: example-securityhubconnectorv2
  providerRef:
    name: example-securityhubconnectorv2
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
descriptionstring—A description of the connector
kmsKeyArnstring—The ARN of KMS key used for the connector Create-only in AWS: changing it requires replacing the resource.
namestringyesThe name of the connector Create-only in AWS: changing it requires replacing the resource.
providerobjectyes
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
connectorArnstring—The ARN of the connector Read-only: reported by AWS after creation.
connectorIdstring—The ID of the connector Read-only: reported by AWS after creation.
connectorStatusstring—The status of the connector Read-only: reported by AWS after creation.
createdAtstring—Read-only: reported by AWS after creation.
enablementStatusstring—The enablement status of the connector Read-only: reported by AWS after creation.
enablementStatusReasonstring—The reason for the enablement status of the connector Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
issuesarray<object>—The list of health issues associated with the connector Read-only: reported by AWS after creation.
issues[].codestringyesThe code identifying the type of health issue
issues[].messagestringyesThe message describing the health issue
lastCheckedAtstring—Read-only: reported by AWS after creation.
lastSyncTimestring—
lastUpdatedAtstring—Read-only: reported by AWS after creation.
messagestring—The message of the connector status change Read-only: reported by AWS after creation.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

SecurityHubDelegatedAdmin # CLOUD CONTROL · AWS::SecurityHub::DelegatedAdmin ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: organization-wide delegated administrator. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. SecurityHubDelegatedAdmin manages AWS::SecurityHub::DelegatedAdmin through the AWS Cloud Control API.

kubectl get securityhubdelegatedadmins · example on GitHub

Example

# SecurityHubDelegatedAdmin — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubdelegatedadmin
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubDelegatedAdmin
metadata:
  name: example-securityhubdelegatedadmin
  namespace: default
spec:
  adminAccountId: '123456789012'
  providerRef:
    name: example-securityhubdelegatedadmin
    region: us-east-1

Spec

FieldTypeRequiredDescription
adminAccountIdstringyesThe AWS-account identifier of the account to designate as the Security Hub CSPM administrator account.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
delegatedAdminIdentifierstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
statusenum—Read-only: reported by AWS after creation. Allowed: ENABLED, DISABLE_IN_PROGRESS

SecurityHubFindingAggregator # CLOUD CONTROL · AWS::SecurityHub::FindingAggregator ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: account-wide finding aggregation. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. SecurityHubFindingAggregator manages AWS::SecurityHub::FindingAggregator through the AWS Cloud Control API.

kubectl get securityhubfindingaggregators · example on GitHub

Example

# SecurityHubFindingAggregator — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubfindingaggregator
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubFindingAggregator
metadata:
  name: example-securityhubfindingaggregator
  namespace: default
spec:
  providerRef:
    name: example-securityhubfindingaggregator
    region: us-east-1
  regionLinkingMode: ALL_REGIONS
  regions:
  - example

Spec

FieldTypeRequiredDescription
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
regionLinkingModeenumyesIndicates whether to aggregate findings from all of the available Regions in the current partition. Allowed: ALL_REGIONS, ALL_REGIONS_EXCEPT_SPECIFIED, SPECIFIED_REGIONS
regionsarray<string>—If ``RegionLinkingMode`` is ``ALL_REGIONS_EXCEPT_SPECIFIED``, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
findingAggregationRegionstring—Read-only: reported by AWS after creation.
findingAggregatorArnstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

SecurityHubHubV2 # CLOUD CONTROL · AWS::SecurityHub::HubV2 ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: account-wide Security Hub enablement. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. SecurityHubHubV2 manages AWS::SecurityHub::HubV2 through the AWS Cloud Control API.

kubectl get securityhubhubv2s · example on GitHub

Example

# SecurityHubHubV2 — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubhubv2
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubHubV2
metadata:
  name: example-securityhubhubv2
  namespace: default
spec:
  providerRef:
    name: example-securityhubhubv2
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
hubV2Arnstring—The Amazon Resource Name of the Security Hub V2 resource.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
subscribedAtstring—Read-only: reported by AWS after creation.

SecurityHubInsight # CLOUD CONTROL · AWS::SecurityHub::Insight

SecurityHubInsight manages AWS::SecurityHub::Insight through the AWS Cloud Control API.

kubectl get securityhubinsights · example on GitHub

Example

# SecurityHubInsight — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubinsight
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubInsight
metadata:
  name: example-securityhubinsight
  namespace: default
spec:
  filters:
    awsAccountId:
    - comparison: EQUALS
      value: example
    awsAccountName:
    - comparison: EQUALS
      value: example
    companyName:
    - comparison: EQUALS
      value: example
    complianceAssociatedStandardsId:
    - comparison: EQUALS
      value: example
    complianceSecurityControlId:
    - comparison: EQUALS
      value: example
    complianceSecurityControlParametersName:
    - comparison: EQUALS
      value: example
    complianceSecurityControlParametersValue:
    - comparison: EQUALS
      value: example
    complianceStatus:
    - comparison: EQUALS
      value: example
    confidence:
    - eq: 1
      gte: 1
      lte: 1
    createdAt:
    - end: example
      start: example
    criticality:
    - eq: 1
      gte: 1
      lte: 1
    description:
    - comparison: EQUALS
      value: example
    findingProviderFieldsConfidence:
    - eq: 1
      gte: 1
      lte: 1
    findingProviderFieldsCriticality:
    - eq: 1
      gte: 1
      lte: 1
    findingProviderFieldsRelatedFindingsId:
    - comparison: EQUALS
      value: example
    findingProviderFieldsRelatedFindingsProductArn:
    - comparison: EQUALS
      value: example
    findingProviderFieldsSeverityLabel:
    - comparison: EQUALS
      value: example
    findingProviderFieldsSeverityOriginal:
    - comparison: EQUALS
      value: example
    findingProviderFieldsTypes:
    - comparison: EQUALS
      value: example
    firstObservedAt:
    - end: example
      start: example
    generatorId:
    - comparison: EQUALS
      value: example
    id:
    - comparison: EQUALS
      value: example
    keyword:
    - value: example
    lastObservedAt:
    - end: example
      start: example
    malwareName:
    - comparison: EQUALS
      value: example
    malwarePath:
    - comparison: EQUALS
      value: example
    malwareState:
    - comparison: EQUALS
      value: example
    malwareType:
    - comparison: EQUALS
      value: example
    networkDestinationDomain:
    - comparison: EQUALS
      value: example
    networkDestinationIpV4:
    - cidr: 10.0.0.0/16
    networkDestinationIpV6:
    - cidr: 10.0.0.0/16
    networkDestinationPort:
    - eq: 1
      gte: 1
      lte: 1
    networkDirection:
    - comparison: EQUALS
      value: example
    networkProtocol:
    - comparison: EQUALS
      value: example
    networkSourceDomain:
    - comparison: EQUALS
      value: example
    networkSourceIpV4:
    - cidr: 10.0.0.0/16
    networkSourceIpV6:
    - cidr: 10.0.0.0/16
    networkSourceMac:
    - comparison: EQUALS
      value: example
    networkSourcePort:
    - eq: 1
      gte: 1
      lte: 1
    noteText:
    - comparison: EQUALS
      value: example
    noteUpdatedAt:
    - end: example
      start: example
    noteUpdatedBy:
    - comparison: EQUALS
      value: example
    processLaunchedAt:
    - end: example
      start: example
    processName:
    - comparison: EQUALS
      value: example
    processParentPid:
    - eq: 1
      gte: 1
      lte: 1
    processPath:
    - comparison: EQUALS
      value: example
    processPid:
    - eq: 1
      gte: 1
      lte: 1
    processTerminatedAt:
    - end: example
      start: example
    productArn:
    - comparison: EQUALS
      value: example
    productFields:
    - comparison: EQUALS
      key: example
      value: example
    productName:
    - comparison: EQUALS
      value: example
    recommendationText:
    - comparison: EQUALS
      value: example
    recordState:
    - comparison: EQUALS
      value: example
    region:
    - comparison: EQUALS
      value: example
    relatedFindingsId:
    - comparison: EQUALS
      value: example
    relatedFindingsProductArn:
    - comparison: EQUALS
      value: example
    resourceApplicationArn:
    - comparison: EQUALS
      value: example
    resourceApplicationName:
    - comparison: EQUALS
      value: example
    resourceAwsEc2InstanceIamInstanceProfileArn:
    - comparison: EQUALS
      value: example
    resourceAwsEc2InstanceImageId:
    - comparison: EQUALS
      value: example
    resourceAwsEc2InstanceIpV4Addresses:
    - cidr: 10.0.0.0/16
    resourceAwsEc2InstanceIpV6Addresses:
    - cidr: 10.0.0.0/16
    resourceAwsEc2InstanceKeyName:
    - comparison: EQUALS
      value: example
    resourceAwsEc2InstanceLaunchedAt:
    - end: example
      start: example
    resourceAwsEc2InstanceSubnetId:
    - comparison: EQUALS
      value: example
    resourceAwsEc2InstanceType:
    - comparison: EQUALS
      value: example
    resourceAwsEc2InstanceVpcId:
    - comparison: EQUALS
      value: example
    resourceAwsIamAccessKeyCreatedAt:
    - end: example
      start: example
    resourceAwsIamAccessKeyPrincipalName:
    - comparison: EQUALS
      value: example
    resourceAwsIamAccessKeyStatus:
    - comparison: EQUALS
      value: example
    resourceAwsIamAccessKeyUserName:
    - comparison: EQUALS
      value: example
    resourceAwsIamUserUserName:
    - comparison: EQUALS
      value: example
    resourceAwsS3BucketOwnerId:
    - comparison: EQUALS
      value: example
    resourceAwsS3BucketOwnerName:
    - comparison: EQUALS
      value: example
    resourceContainerImageId:
    - comparison: EQUALS
      value: example
    resourceContainerImageName:
    - comparison: EQUALS
      value: example
    resourceContainerLaunchedAt:
    - end: example
      start: example
    resourceContainerName:
    - comparison: EQUALS
      value: example
    resourceDetailsOther:
    - comparison: EQUALS
      key: example
      value: example
    resourceId:
    - comparison: EQUALS
      value: example
    resourcePartition:
    - comparison: EQUALS
      value: example
    resourceRegion:
    - comparison: EQUALS
      value: example
    resourceTags:
    - comparison: EQUALS
      key: example
      value: example
    resourceType:
    - comparison: EQUALS
      value: example
    sample:
    - value: false
    severityLabel:
    - comparison: EQUALS
      value: example
    severityNormalized:
    - eq: 1
      gte: 1
      lte: 1
    severityProduct:
    - eq: 1
      gte: 1
      lte: 1
    sourceUrl:
    - comparison: EQUALS
      value: example
    threatIntelIndicatorCategory:
    - comparison: EQUALS
      value: example
    threatIntelIndicatorLastObservedAt:
    - end: example
      start: example
    threatIntelIndicatorSource:
    - comparison: EQUALS
      value: example
    threatIntelIndicatorSourceUrl:
    - comparison: EQUALS
      value: example
    threatIntelIndicatorType:
    - comparison: EQUALS
      value: example
    threatIntelIndicatorValue:
    - comparison: EQUALS
      value: example
    title:
    - comparison: EQUALS
      value: example
    type:
    - comparison: EQUALS
      value: example
    updatedAt:
    - end: example
      start: example
    userDefinedFields:
    - comparison: EQUALS
      key: example
      value: example
    verificationState:
    - comparison: EQUALS
      value: example
    vulnerabilitiesExploitAvailable:
    - comparison: EQUALS
      value: example
    vulnerabilitiesFixAvailable:
    - comparison: EQUALS
      value: example
    workflowState:
    - comparison: EQUALS
      value: example
    workflowStatus:
    - comparison: EQUALS
      value: example
  groupByAttribute: example
  name: example-securityhubinsight
  providerRef:
    name: example-securityhubinsight
    region: us-east-1

Spec

FieldTypeRequiredDescription
filtersobjectyesOne or more attributes used to filter the findings included in the insight
filters.awsAccountIdarray<object>—The AWS account ID in which a finding is generated.
filters.awsAccountId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.awsAccountId[].valuestringyes
filters.awsAccountNamearray<object>—The name of the AWS account in which a finding is generated.
filters.awsAccountName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.awsAccountName[].valuestringyes
filters.companyNamearray<object>—The name of the findings provider (company) that owns the solution (product) that generates findings.
filters.companyName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.companyName[].valuestringyes
filters.complianceAssociatedStandardsIdarray<object>—The unique identifier of a standard in which a control is enabled.
filters.complianceAssociatedStandardsId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.complianceAssociatedStandardsId[].valuestringyes
filters.complianceSecurityControlIdarray<object>—The unique identifier of a control across standards.
filters.complianceSecurityControlId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.complianceSecurityControlId[].valuestringyes
filters.complianceSecurityControlParametersNamearray<object>—The name of a security control parameter.
filters.complianceSecurityControlParametersName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.complianceSecurityControlParametersName[].valuestringyes
filters.complianceSecurityControlParametersValuearray<object>—The current value of a security control parameter.
filters.complianceSecurityControlParametersValue[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.complianceSecurityControlParametersValue[].valuestringyes
filters.complianceStatusarray<object>—Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard.
filters.complianceStatus[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.complianceStatus[].valuestringyes
filters.confidencearray<object>—A finding's confidence.
filters.confidence[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.confidence[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.confidence[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.createdAtarray<object>—An ISO8601-formatted timestamp that indicates when the security findings provider captured the potential security issue that a finding captured.
filters.createdAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.createdAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.createdAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.createdAt[].endstring—
filters.createdAt[].startstring—
filters.criticalityarray<object>—The level of importance assigned to the resources associated with the finding.
filters.criticality[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.criticality[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.criticality[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.descriptionarray<object>—A finding's description.
filters.description[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.description[].valuestringyes
filters.findingProviderFieldsConfidencearray<object>—The finding provider value for the finding confidence.
filters.findingProviderFieldsConfidence[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.findingProviderFieldsConfidence[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.findingProviderFieldsConfidence[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.findingProviderFieldsCriticalityarray<object>—The finding provider value for the level of importance assigned to the resources associated with the findings.
filters.findingProviderFieldsCriticality[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.findingProviderFieldsCriticality[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.findingProviderFieldsCriticality[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.findingProviderFieldsRelatedFindingsIdarray<object>—The finding identifier of a related finding that is identified by the finding provider.
filters.findingProviderFieldsRelatedFindingsId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.findingProviderFieldsRelatedFindingsId[].valuestringyes
filters.findingProviderFieldsRelatedFindingsProductArnarray<object>—The ARN of the solution that generated a related finding that is identified by the finding provider.
filters.findingProviderFieldsRelatedFindingsProductArn[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.findingProviderFieldsRelatedFindingsProductArn[].valuestringyes
filters.findingProviderFieldsSeverityLabelarray<object>—The finding provider value for the severity label.
filters.findingProviderFieldsSeverityLabel[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.findingProviderFieldsSeverityLabel[].valuestringyes
filters.findingProviderFieldsSeverityOriginalarray<object>—The finding provider's original value for the severity.
filters.findingProviderFieldsSeverityOriginal[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.findingProviderFieldsSeverityOriginal[].valuestringyes
filters.findingProviderFieldsTypesarray<object>—One or more finding types that the finding provider assigned to the finding.
filters.findingProviderFieldsTypes[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.findingProviderFieldsTypes[].valuestringyes
filters.firstObservedAtarray<object>—An ISO8601-formatted timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured.
filters.firstObservedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.firstObservedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.firstObservedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.firstObservedAt[].endstring—
filters.firstObservedAt[].startstring—
filters.generatorIdarray<object>—The identifier for the solution-specific component (a discrete unit of logic) that generated a finding.
filters.generatorId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.generatorId[].valuestringyes
filters.idarray<object>—The security findings provider-specific identifier for a finding.
filters.id[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.id[].valuestringyes
filters.keywordarray<object>—A keyword for a finding.
filters.keyword[].valuestringyesA value for the keyword.
filters.lastObservedAtarray<object>—An ISO8601-formatted timestamp that indicates when the security findings provider most recently observed the potential security issue that a finding captured.
filters.lastObservedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.lastObservedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.lastObservedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.lastObservedAt[].endstring—
filters.lastObservedAt[].startstring—
filters.malwareNamearray<object>—The name of the malware that was observed.
filters.malwareName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.malwareName[].valuestringyes
filters.malwarePatharray<object>—The filesystem path of the malware that was observed.
filters.malwarePath[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.malwarePath[].valuestringyes
filters.malwareStatearray<object>—The state of the malware that was observed.
filters.malwareState[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.malwareState[].valuestringyes
filters.malwareTypearray<object>—The type of the malware that was observed.
filters.malwareType[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.malwareType[].valuestringyes
filters.networkDestinationDomainarray<object>—The destination domain of network-related information about a finding.
filters.networkDestinationDomain[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.networkDestinationDomain[].valuestringyes
filters.networkDestinationIpV4array<object>—The destination IPv4 address of network-related information about a finding.
filters.networkDestinationIpV4[].cidrstringyesA finding's CIDR value.
filters.networkDestinationIpV6array<object>—The destination IPv6 address of network-related information about a finding.
filters.networkDestinationIpV6[].cidrstringyesA finding's CIDR value.
filters.networkDestinationPortarray<object>—The destination port of network-related information about a finding.
filters.networkDestinationPort[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.networkDestinationPort[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.networkDestinationPort[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.networkDirectionarray<object>—Indicates the direction of network traffic associated with a finding.
filters.networkDirection[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.networkDirection[].valuestringyes
filters.networkProtocolarray<object>—The protocol of network-related information about a finding.
filters.networkProtocol[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.networkProtocol[].valuestringyes
filters.networkSourceDomainarray<object>—The source domain of network-related information about a finding.
filters.networkSourceDomain[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.networkSourceDomain[].valuestringyes
filters.networkSourceIpV4array<object>—The source IPv4 address of network-related information about a finding.
filters.networkSourceIpV4[].cidrstringyesA finding's CIDR value.
filters.networkSourceIpV6array<object>—The source IPv6 address of network-related information about a finding.
filters.networkSourceIpV6[].cidrstringyesA finding's CIDR value.
filters.networkSourceMacarray<object>—The source media access control (MAC) address of network-related information about a finding.
filters.networkSourceMac[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.networkSourceMac[].valuestringyes
filters.networkSourcePortarray<object>—The source port of network-related information about a finding.
filters.networkSourcePort[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.networkSourcePort[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.networkSourcePort[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.noteTextarray<object>—The text of a note.
filters.noteText[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.noteText[].valuestringyes
filters.noteUpdatedAtarray<object>—The timestamp of when the note was updated.
filters.noteUpdatedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.noteUpdatedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.noteUpdatedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.noteUpdatedAt[].endstring—
filters.noteUpdatedAt[].startstring—
filters.noteUpdatedByarray<object>—The principal that created a note.
filters.noteUpdatedBy[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.noteUpdatedBy[].valuestringyes
filters.processLaunchedAtarray<object>—A timestamp that identifies when the process was launched.
filters.processLaunchedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.processLaunchedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.processLaunchedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.processLaunchedAt[].endstring—
filters.processLaunchedAt[].startstring—
filters.processNamearray<object>—The name of the process.
filters.processName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.processName[].valuestringyes
filters.processParentPidarray<object>—The parent process ID.
filters.processParentPid[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.processParentPid[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.processParentPid[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.processPatharray<object>—The path to the process executable.
filters.processPath[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.processPath[].valuestringyes
filters.processPidarray<object>—The process ID.
filters.processPid[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.processPid[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.processPid[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.processTerminatedAtarray<object>—A timestamp that identifies when the process was terminated.
filters.processTerminatedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.processTerminatedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.processTerminatedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.processTerminatedAt[].endstring—
filters.processTerminatedAt[].startstring—
filters.productArnarray<object>—The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.
filters.productArn[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.productArn[].valuestringyes
filters.productFieldsarray<object>—A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.
filters.productFields[].comparisonenumyesThe condition to apply to the key value when filtering Security Hub findings with a map filter. Allowed: EQUALS, NOT_EQUALS
filters.productFields[].keystringyes
filters.productFields[].valuestringyes
filters.productNamearray<object>—The name of the solution (product) that generates findings.
filters.productName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.productName[].valuestringyes
filters.recommendationTextarray<object>—The recommendation of what to do about the issue described in a finding.
filters.recommendationText[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.recommendationText[].valuestringyes
filters.recordStatearray<object>—The updated record state for the finding.
filters.recordState[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.recordState[].valuestringyes
filters.regionarray<object>—The Region from which the finding was generated.
filters.region[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.region[].valuestringyes
filters.relatedFindingsIdarray<object>—The solution-generated identifier for a related finding.
filters.relatedFindingsId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.relatedFindingsId[].valuestringyes
filters.relatedFindingsProductArnarray<object>—The ARN of the solution that generated a related finding.
filters.relatedFindingsProductArn[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.relatedFindingsProductArn[].valuestringyes
filters.resourceApplicationArnarray<object>—The ARN of the application that is related to a finding.
filters.resourceApplicationArn[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceApplicationArn[].valuestringyes
filters.resourceApplicationNamearray<object>—The name of the application that is related to a finding.
filters.resourceApplicationName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceApplicationName[].valuestringyes
filters.resourceAwsEc2InstanceIamInstanceProfileArnarray<object>—The IAM profile ARN of the instance.
filters.resourceAwsEc2InstanceIamInstanceProfileArn[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsEc2InstanceIamInstanceProfileArn[].valuestringyes
filters.resourceAwsEc2InstanceImageIdarray<object>—The Amazon Machine Image (AMI) ID of the instance.
filters.resourceAwsEc2InstanceImageId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsEc2InstanceImageId[].valuestringyes
filters.resourceAwsEc2InstanceIpV4Addressesarray<object>—The IPv4 addresses associated with the instance.
filters.resourceAwsEc2InstanceIpV4Addresses[].cidrstringyesA finding's CIDR value.
filters.resourceAwsEc2InstanceIpV6Addressesarray<object>—The IPv6 addresses associated with the instance.
filters.resourceAwsEc2InstanceIpV6Addresses[].cidrstringyesA finding's CIDR value.
filters.resourceAwsEc2InstanceKeyNamearray<object>—The key name associated with the instance.
filters.resourceAwsEc2InstanceKeyName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsEc2InstanceKeyName[].valuestringyes
filters.resourceAwsEc2InstanceLaunchedAtarray<object>—The date and time the instance was launched.
filters.resourceAwsEc2InstanceLaunchedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.resourceAwsEc2InstanceLaunchedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.resourceAwsEc2InstanceLaunchedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.resourceAwsEc2InstanceLaunchedAt[].endstring—
filters.resourceAwsEc2InstanceLaunchedAt[].startstring—
filters.resourceAwsEc2InstanceSubnetIdarray<object>—The identifier of the subnet that the instance was launched in.
filters.resourceAwsEc2InstanceSubnetId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsEc2InstanceSubnetId[].valuestringyes
filters.resourceAwsEc2InstanceTypearray<object>—The instance type of the instance.
filters.resourceAwsEc2InstanceType[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsEc2InstanceType[].valuestringyes
filters.resourceAwsEc2InstanceVpcIdarray<object>—The identifier of the VPC that the instance was launched in.
filters.resourceAwsEc2InstanceVpcId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsEc2InstanceVpcId[].valuestringyes
filters.resourceAwsIamAccessKeyCreatedAtarray<object>—The creation date/time of the IAM access key related to a finding.
filters.resourceAwsIamAccessKeyCreatedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.resourceAwsIamAccessKeyCreatedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.resourceAwsIamAccessKeyCreatedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.resourceAwsIamAccessKeyCreatedAt[].endstring—
filters.resourceAwsIamAccessKeyCreatedAt[].startstring—
filters.resourceAwsIamAccessKeyPrincipalNamearray<object>—The name of the principal that is associated with an IAM access key.
filters.resourceAwsIamAccessKeyPrincipalName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsIamAccessKeyPrincipalName[].valuestringyes
filters.resourceAwsIamAccessKeyStatusarray<object>—The status of the IAM access key related to a finding.
filters.resourceAwsIamAccessKeyStatus[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsIamAccessKeyStatus[].valuestringyes
filters.resourceAwsIamAccessKeyUserNamearray<object>—The user associated with the IAM access key related to a finding.
filters.resourceAwsIamAccessKeyUserName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsIamAccessKeyUserName[].valuestringyes
filters.resourceAwsIamUserUserNamearray<object>—The name of an IAM user.
filters.resourceAwsIamUserUserName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsIamUserUserName[].valuestringyes
filters.resourceAwsS3BucketOwnerIdarray<object>—The canonical user ID of the owner of the S3 bucket.
filters.resourceAwsS3BucketOwnerId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsS3BucketOwnerId[].valuestringyes
filters.resourceAwsS3BucketOwnerNamearray<object>—The display name of the owner of the S3 bucket.
filters.resourceAwsS3BucketOwnerName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceAwsS3BucketOwnerName[].valuestringyes
filters.resourceContainerImageIdarray<object>—The identifier of the image related to a finding.
filters.resourceContainerImageId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceContainerImageId[].valuestringyes
filters.resourceContainerImageNamearray<object>—The name of the image related to a finding.
filters.resourceContainerImageName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceContainerImageName[].valuestringyes
filters.resourceContainerLaunchedAtarray<object>—A timestamp that identifies when the container was started.
filters.resourceContainerLaunchedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.resourceContainerLaunchedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.resourceContainerLaunchedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.resourceContainerLaunchedAt[].endstring—
filters.resourceContainerLaunchedAt[].startstring—
filters.resourceContainerNamearray<object>—The name of the container related to a finding.
filters.resourceContainerName[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceContainerName[].valuestringyes
filters.resourceDetailsOtherarray<object>—The details of a resource that doesn't have a specific subfield for the resource type defined.
filters.resourceDetailsOther[].comparisonenumyesThe condition to apply to the key value when filtering Security Hub findings with a map filter. Allowed: EQUALS, NOT_EQUALS
filters.resourceDetailsOther[].keystringyes
filters.resourceDetailsOther[].valuestringyes
filters.resourceIdarray<object>—The canonical identifier for the given resource type.
filters.resourceId[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceId[].valuestringyes
filters.resourcePartitionarray<object>—The canonical AWS partition name that the Region is assigned to.
filters.resourcePartition[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourcePartition[].valuestringyes
filters.resourceRegionarray<object>—The canonical AWS external Region name where this resource is located.
filters.resourceRegion[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceRegion[].valuestringyes
filters.resourceTagsarray<object>—A list of AWS tags associated with a resource at the time the finding was processed.
filters.resourceTags[].comparisonenumyesThe condition to apply to the key value when filtering Security Hub findings with a map filter. Allowed: EQUALS, NOT_EQUALS
filters.resourceTags[].keystringyes
filters.resourceTags[].valuestringyes
filters.resourceTypearray<object>—Specifies the type of the resource that details are provided for.
filters.resourceType[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.resourceType[].valuestringyes
filters.samplearray<object>—Indicates whether or not sample findings are included in the filter results.
filters.sample[].valuebooleanyesThe value of the boolean.
filters.severityLabelarray<object>—The label of a finding's severity.
filters.severityLabel[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.severityLabel[].valuestringyes
filters.severityNormalizedarray<object>—The normalized severity of a finding.
filters.severityNormalized[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.severityNormalized[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.severityNormalized[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.severityProductarray<object>—The native severity as defined by the security findings provider's solution that generated the finding.
filters.severityProduct[].eqnumber—The equal-to condition to be applied to a single field when querying for findings.
filters.severityProduct[].gtenumber—The greater-than-equal condition to be applied to a single field when querying for findings.
filters.severityProduct[].ltenumber—The less-than-equal condition to be applied to a single field when querying for findings.
filters.sourceUrlarray<object>—A URL that links to a page about the current finding in the security findings provider's solution.
filters.sourceUrl[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.sourceUrl[].valuestringyes
filters.threatIntelIndicatorCategoryarray<object>—The category of a threat intelligence indicator.
filters.threatIntelIndicatorCategory[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.threatIntelIndicatorCategory[].valuestringyes
filters.threatIntelIndicatorLastObservedAtarray<object>—A timestamp that identifies the last observation of a threat intelligence indicator.
filters.threatIntelIndicatorLastObservedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.threatIntelIndicatorLastObservedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.threatIntelIndicatorLastObservedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.threatIntelIndicatorLastObservedAt[].endstring—
filters.threatIntelIndicatorLastObservedAt[].startstring—
filters.threatIntelIndicatorSourcearray<object>—The source of the threat intelligence.
filters.threatIntelIndicatorSource[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.threatIntelIndicatorSource[].valuestringyes
filters.threatIntelIndicatorSourceUrlarray<object>—The URL for more details from the source of the threat intelligence.
filters.threatIntelIndicatorSourceUrl[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.threatIntelIndicatorSourceUrl[].valuestringyes
filters.threatIntelIndicatorTypearray<object>—The type of a threat intelligence indicator.
filters.threatIntelIndicatorType[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.threatIntelIndicatorType[].valuestringyes
filters.threatIntelIndicatorValuearray<object>—The value of a threat intelligence indicator.
filters.threatIntelIndicatorValue[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.threatIntelIndicatorValue[].valuestringyes
filters.titlearray<object>—A finding's title.
filters.title[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.title[].valuestringyes
filters.typearray<object>—A finding type in the format of namespace/category/classifier that classifies a finding.
filters.type[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.type[].valuestringyes
filters.updatedAtarray<object>—An ISO8601-formatted timestamp that indicates when the security findings provider last updated the finding record.
filters.updatedAt[].dateRangeobject—SecurityHubInsightDateRange is a nested property type of AWS::SecurityHub::Insight.
filters.updatedAt[].dateRange.unitenumyesA date range unit for the date filter. Allowed: DAYS
filters.updatedAt[].dateRange.valuenumberyesA date range value for the date filter.
filters.updatedAt[].endstring—
filters.updatedAt[].startstring—
filters.userDefinedFieldsarray<object>—A list of name/value string pairs associated with the finding.
filters.userDefinedFields[].comparisonenumyesThe condition to apply to the key value when filtering Security Hub findings with a map filter. Allowed: EQUALS, NOT_EQUALS
filters.userDefinedFields[].keystringyes
filters.userDefinedFields[].valuestringyes
filters.verificationStatearray<object>—The veracity of a finding.
filters.verificationState[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.verificationState[].valuestringyes
filters.vulnerabilitiesExploitAvailablearray<object>—Indicates whether a software vulnerability in your environment has a known exploit.
filters.vulnerabilitiesExploitAvailable[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.vulnerabilitiesExploitAvailable[].valuestringyes
filters.vulnerabilitiesFixAvailablearray<object>—Indicates whether a vulnerability is fixed in a newer version of the affected software packages.
filters.vulnerabilitiesFixAvailable[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.vulnerabilitiesFixAvailable[].valuestringyes
filters.workflowStatearray<object>—The workflow state of a finding.
filters.workflowState[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.workflowState[].valuestringyes
filters.workflowStatusarray<object>—The status of the investigation into a finding.
filters.workflowStatus[].comparisonenumyesAllowed: EQUALS, PREFIX, NOT_EQUALS, PREFIX_NOT_EQUALS
filters.workflowStatus[].valuestringyes
groupByAttributestringyesThe grouping attribute for the insight's findings
namestringyesThe name of a Security Hub insight
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
insightArnstring—The ARN of a Security Hub insight Read-only: reported by AWS after creation.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

SecurityHubOrganizationConfiguration # CLOUD CONTROL · AWS::SecurityHub::OrganizationConfiguration ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: organization-wide Security Hub configuration. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. SecurityHubOrganizationConfiguration manages AWS::SecurityHub::OrganizationConfiguration through the AWS Cloud Control API.

kubectl get securityhuborganizationconfigurations · example on GitHub

Example

# SecurityHubOrganizationConfiguration — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhuborganizationconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubOrganizationConfiguration
metadata:
  name: example-securityhuborganizationconfiguration
  namespace: default
spec:
  autoEnable: true
  autoEnableStandards: DEFAULT
  configurationType: CENTRAL
  providerRef:
    name: example-securityhuborganizationconfiguration
    region: us-east-1

Spec

FieldTypeRequiredDescription
autoEnablebooleanyesWhether to automatically enable Security Hub in new member accounts when they join the organization.
autoEnableStandardsenum—Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. Allowed: DEFAULT, NONE
configurationTypeenum—Indicates whether the organization uses local or central configuration. Allowed: CENTRAL, LOCAL
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
memberAccountLimitReachedboolean—Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
organizationConfigurationIdentifierstring—The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
statusenum—Describes whether central configuration could be enabled as the ConfigurationType for the organization. Allowed: PENDING, ENABLED, FAILED
statusMessagestring—Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.

SecurityHubPolicyAssociation # CLOUD CONTROL · AWS::SecurityHub::PolicyAssociation

SecurityHubPolicyAssociation manages AWS::SecurityHub::PolicyAssociation through the AWS Cloud Control API.

kubectl get securityhubpolicyassociations · example on GitHub

Example

# SecurityHubPolicyAssociation — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubpolicyassociation
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubPolicyAssociation
metadata:
  name: example-securityhubpolicyassociation
  namespace: default
spec:
  configurationPolicyId: example-id
  providerRef:
    name: example-securityhubpolicyassociation
    region: us-east-1
  targetId: example-id
  targetType: ACCOUNT

Spec

FieldTypeRequiredDescription
configurationPolicyIdstringyesThe universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
targetIdstringyesThe identifier of the target account, organizational unit, or the root Create-only in AWS: changing it requires replacing the resource.
targetTypeenumyesIndicates whether the target is an AWS account, organizational unit, or the organization root Create-only in AWS: changing it requires replacing the resource. Allowed: ACCOUNT, ORGANIZATIONAL_UNIT, ROOT

Status

FieldTypeRequiredDescription
associationIdentifierstring—A unique identifier to indicates if the target has an association Read-only: reported by AWS after creation.
associationStatusenum—The current status of the association between the specified target and the configuration Read-only: reported by AWS after creation. Allowed: SUCCESS, PENDING, FAILED, DISABLED
associationStatusMessagestring—An explanation for a FAILED value for AssociationStatus Read-only: reported by AWS after creation.
associationTypeenum—Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent Read-only: reported by AWS after creation. Allowed: APPLIED, INHERITED
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
updatedAtstring—The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated Read-only: reported by AWS after creation.

SecurityHubProductSubscription # CLOUD CONTROL · AWS::SecurityHub::ProductSubscription

SecurityHubProductSubscription manages AWS::SecurityHub::ProductSubscription through the AWS Cloud Control API.

kubectl get securityhubproductsubscriptions · example on GitHub

Example

# SecurityHubProductSubscription — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubproductsubscription
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubProductSubscription
metadata:
  name: example-securityhubproductsubscription
  namespace: default
spec:
  productArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-securityhubproductsubscription
    region: us-east-1

Spec

FieldTypeRequiredDescription
productArnstringyesThe generic ARN of the product being subscribed to Create-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
productSubscriptionArnstring—The ARN of the product subscription for the account Read-only: reported by AWS after creation.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

SecurityHubSecurityControl # CLOUD CONTROL · AWS::SecurityHub::SecurityControl

SecurityHubSecurityControl manages AWS::SecurityHub::SecurityControl through the AWS Cloud Control API.

kubectl get securityhubsecuritycontrols · example on GitHub

Example

# SecurityHubSecurityControl — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubsecuritycontrol
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubSecurityControl
metadata:
  name: example-securityhubsecuritycontrol
  namespace: default
spec:
  lastUpdateReason: example
  parameters: {}
  providerRef:
    name: example-securityhubsecuritycontrol
    region: us-east-1
  securityControlArn: arn:aws:iam::123456789012:role/example-role

Spec

FieldTypeRequiredDescription
lastUpdateReasonstring—The most recent reason for updating the customizable properties of a security control.
parametersmap<string>yesAn object that identifies the name of a control parameter, its current value, and whether it has been customized.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
securityControlArnstring—The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`.
securityControlIdstring—The unique identifier of a security control across standards.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

SecurityHubStandard # GA

SecurityHubStandard is the Schema for managing Security Hub standards subscriptions.

kubectl get securityhubstandards · example on GitHub

Example

# SecurityHubStandard — Security Hub
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/securityhub.html#securityhubstandard
apiVersion: aws.konfig.io/v1alpha1
kind: SecurityHubStandard
metadata:
  name: example-securityhubstandard
  namespace: default
spec:
  providerRef:
    name: example-securityhubstandard
    region: us-east-1
  standardsArn: arn:aws:iam::123456789012:role/example-role

Spec

FieldTypeRequiredDescription
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
standardsArnstringyesStandardsARN is the ARN of the standard to enable (see DescribeStandards), e.g.

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
standardsStatusstring—StandardsStatus is the subscription status reported by AWS (PENDING, READY, INCOMPLETE, DELETING, FAILED).
subscriptionArnstring—SubscriptionARN is the ARN of the standards subscription.