interface CfnDetectorProps

Language	Type name
.NET	`Amazon.CDK.AWS.GuardDuty.CfnDetectorProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsguardduty#CfnDetectorProps`
Java	`software.amazon.awscdk.services.guardduty.CfnDetectorProps`
Python	`aws_cdk.aws_guardduty.CfnDetectorProps`
TypeScript	`aws-cdk-lib` » `aws_guardduty` » `CfnDetectorProps`

Properties for defining a CfnDetector.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_guardduty as guardduty } from 'aws-cdk-lib';
const cfnDetectorProps: guardduty.CfnDetectorProps = {
  enable: false,

  // the properties below are optional
  dataSources: {
    kubernetes: {
      auditLogs: {
        enable: false,
      },
    },
    malwareProtection: {
      scanEc2InstanceWithFindings: {
        ebsVolumes: false,
      },
    },
    s3Logs: {
      enable: false,
    },
  },
  features: [{
    name: 'name',
    status: 'status',

    // the properties below are optional
    additionalConfiguration: [{
      name: 'name',
      status: 'status',
    }],
  }],
  findingPublishingFrequency: 'findingPublishingFrequency',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
enable	`boolean \|` `IResolvable`	Specifies whether the detector is to be enabled on creation.
dataSources?	`IResolvable` `\|` `CFNDataSourceConfigurationsProperty`	Describes which data sources will be enabled for the detector.
features?	`IResolvable` `\| (IResolvable` `\|` `CFNFeatureConfigurationProperty)[]`	A list of features that will be configured for the detector.
findingPublishingFrequency?	`string`	Specifies how frequently updated findings are exported.
tags?	`TagItemProperty[]`	Specifies tags added to a new detector resource.

enable

Type: boolean | IResolvable

Specifies whether the detector is to be enabled on creation.

dataSources?

Type: IResolvable | CFNDataSourceConfigurationsProperty (optional)

Describes which data sources will be enabled for the detector.

features?

Type: IResolvable | (IResolvable | CFNFeatureConfigurationProperty)[] (optional)

A list of features that will be configured for the detector.

findingPublishingFrequency?

Type: string (optional)

Specifies how frequently updated findings are exported.

tags?

Type: TagItemProperty[] (optional)

Specifies tags added to a new detector resource.

Each tag consists of a key and an optional value, both of which you define.

Currently, support is available only for creating and deleting a tag. No support exists for updating the tags.

For more information, see Tag .