Skip to content
v2.275.0

CfnInsightProps Struct ​

Properties for defining a CfnInsight.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securityhub as securityhub } from 'aws-cdk-lib';
const cfnInsightProps: securityhub.CfnInsightProps = {
  filters: {
    awsAccountId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    awsAccountName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    companyName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    complianceAssociatedStandardsId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    complianceSecurityControlId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    complianceSecurityControlParametersName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    complianceSecurityControlParametersValue: [{
      comparison: 'comparison',
      value: 'value',
    }],
    complianceStatus: [{
      comparison: 'comparison',
      value: 'value',
    }],
    confidence: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    createdAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    criticality: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    description: [{
      comparison: 'comparison',
      value: 'value',
    }],
    findingProviderFieldsConfidence: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    findingProviderFieldsCriticality: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    findingProviderFieldsRelatedFindingsId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    findingProviderFieldsRelatedFindingsProductArn: [{
      comparison: 'comparison',
      value: 'value',
    }],
    findingProviderFieldsSeverityLabel: [{
      comparison: 'comparison',
      value: 'value',
    }],
    findingProviderFieldsSeverityOriginal: [{
      comparison: 'comparison',
      value: 'value',
    }],
    findingProviderFieldsTypes: [{
      comparison: 'comparison',
      value: 'value',
    }],
    firstObservedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    generatorId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    id: [{
      comparison: 'comparison',
      value: 'value',
    }],
    keyword: [{
      value: 'value',
    }],
    lastObservedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    malwareName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    malwarePath: [{
      comparison: 'comparison',
      value: 'value',
    }],
    malwareState: [{
      comparison: 'comparison',
      value: 'value',
    }],
    malwareType: [{
      comparison: 'comparison',
      value: 'value',
    }],
    networkDestinationDomain: [{
      comparison: 'comparison',
      value: 'value',
    }],
    networkDestinationIpV4: [{
      cidr: 'cidr',
    }],
    networkDestinationIpV6: [{
      cidr: 'cidr',
    }],
    networkDestinationPort: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    networkDirection: [{
      comparison: 'comparison',
      value: 'value',
    }],
    networkProtocol: [{
      comparison: 'comparison',
      value: 'value',
    }],
    networkSourceDomain: [{
      comparison: 'comparison',
      value: 'value',
    }],
    networkSourceIpV4: [{
      cidr: 'cidr',
    }],
    networkSourceIpV6: [{
      cidr: 'cidr',
    }],
    networkSourceMac: [{
      comparison: 'comparison',
      value: 'value',
    }],
    networkSourcePort: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    noteText: [{
      comparison: 'comparison',
      value: 'value',
    }],
    noteUpdatedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    noteUpdatedBy: [{
      comparison: 'comparison',
      value: 'value',
    }],
    processLaunchedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    processName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    processParentPid: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    processPath: [{
      comparison: 'comparison',
      value: 'value',
    }],
    processPid: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    processTerminatedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    productArn: [{
      comparison: 'comparison',
      value: 'value',
    }],
    productFields: [{
      comparison: 'comparison',
      key: 'key',
      value: 'value',
    }],
    productName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    recommendationText: [{
      comparison: 'comparison',
      value: 'value',
    }],
    recordState: [{
      comparison: 'comparison',
      value: 'value',
    }],
    region: [{
      comparison: 'comparison',
      value: 'value',
    }],
    relatedFindingsId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    relatedFindingsProductArn: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceApplicationArn: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceApplicationName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsEc2InstanceIamInstanceProfileArn: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsEc2InstanceImageId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsEc2InstanceIpV4Addresses: [{
      cidr: 'cidr',
    }],
    resourceAwsEc2InstanceIpV6Addresses: [{
      cidr: 'cidr',
    }],
    resourceAwsEc2InstanceKeyName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsEc2InstanceLaunchedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    resourceAwsEc2InstanceSubnetId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsEc2InstanceType: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsEc2InstanceVpcId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsIamAccessKeyCreatedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    resourceAwsIamAccessKeyPrincipalName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsIamAccessKeyStatus: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsIamAccessKeyUserName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsIamUserUserName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsS3BucketOwnerId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceAwsS3BucketOwnerName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceContainerImageId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceContainerImageName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceContainerLaunchedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    resourceContainerName: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceDetailsOther: [{
      comparison: 'comparison',
      key: 'key',
      value: 'value',
    }],
    resourceId: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourcePartition: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceRegion: [{
      comparison: 'comparison',
      value: 'value',
    }],
    resourceTags: [{
      comparison: 'comparison',
      key: 'key',
      value: 'value',
    }],
    resourceType: [{
      comparison: 'comparison',
      value: 'value',
    }],
    sample: [{
      value: false,
    }],
    severityLabel: [{
      comparison: 'comparison',
      value: 'value',
    }],
    severityNormalized: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    severityProduct: [{
      eq: 123,
      gte: 123,
      lte: 123,
    }],
    sourceUrl: [{
      comparison: 'comparison',
      value: 'value',
    }],
    threatIntelIndicatorCategory: [{
      comparison: 'comparison',
      value: 'value',
    }],
    threatIntelIndicatorLastObservedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    threatIntelIndicatorSource: [{
      comparison: 'comparison',
      value: 'value',
    }],
    threatIntelIndicatorSourceUrl: [{
      comparison: 'comparison',
      value: 'value',
    }],
    threatIntelIndicatorType: [{
      comparison: 'comparison',
      value: 'value',
    }],
    threatIntelIndicatorValue: [{
      comparison: 'comparison',
      value: 'value',
    }],
    title: [{
      comparison: 'comparison',
      value: 'value',
    }],
    type: [{
      comparison: 'comparison',
      value: 'value',
    }],
    updatedAt: [{
      dateRange: {
        unit: 'unit',
        value: 123,
      },
      end: 'end',
      start: 'start',
    }],
    userDefinedFields: [{
      comparison: 'comparison',
      key: 'key',
      value: 'value',
    }],
    verificationState: [{
      comparison: 'comparison',
      value: 'value',
    }],
    vulnerabilitiesExploitAvailable: [{
      comparison: 'comparison',
      value: 'value',
    }],
    vulnerabilitiesFixAvailable: [{
      comparison: 'comparison',
      value: 'value',
    }],
    workflowState: [{
      comparison: 'comparison',
      value: 'value',
    }],
    workflowStatus: [{
      comparison: 'comparison',
      value: 'value',
    }],
  },
  groupByAttribute: 'groupByAttribute',
  name: 'name',
};

Properties ​

One or more attributes used to filter the findings included in the insight.

The insight only includes findings that match the criteria defined in the filters. You can filter by up to ten finding attributes. For each attribute, you can provide up to 20 filter values.

groupByAttributestringgroup_by_attributestrgroupByAttributeStringGroupByAttributestringGroupByAttribute*stringrequired#
The grouping attribute for the insight's findings.

Indicates how to group the matching findings, and identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.

namestringnamestrnameStringNamestringName*stringrequired#
The name of a Security Hub CSPM insight.