DetectorFeature class

Provides a resource to manage a single Amazon GuardDuty detector feature.

> NOTE: Deleting this resource does not disable the detector feature, the resource in simply removed from state instead.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.guardduty.Detector("example", {enable: true});
const s3Protection = new aws.guardduty.DetectorFeature("s3_protection", {
    detectorId: example.id,
    name: "S3_DATA_EVENTS",
    status: "ENABLED",
});
import pulumi
import pulumi_aws as aws

example = aws.guardduty.Detector("example", enable=True)
s3_protection = aws.guardduty.DetectorFeature("s3_protection",
    detector_id=example.id,
    name="S3_DATA_EVENTS",
    status="ENABLED")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.GuardDuty.Detector("example", new()
    {
        Enable = true,
    });

    var s3Protection = new Aws.GuardDuty.DetectorFeature("s3_protection", new()
    {
        DetectorId = example.Id,
        Name = "S3_DATA_EVENTS",
        Status = "ENABLED",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/guardduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := guardduty.NewDetector(ctx, "example", &guardduty.DetectorArgs{
			Enable: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = guardduty.NewDetectorFeature(ctx, "s3_protection", &guardduty.DetectorFeatureArgs{
			DetectorId: example.ID().ToIDOutput().ToStringOutput(),
			Name:       pulumi.String("S3_DATA_EVENTS"),
			Status:     pulumi.String("ENABLED"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_guardduty_detector" "example" {
  enable = true
}
resource "aws_guardduty_detectorfeature" "s3_protection" {
  detector_id = aws_guardduty_detector.example.id
  name        = "S3_DATA_EVENTS"
  status      = "ENABLED"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.guardduty.Detector;
import com.pulumi.aws.guardduty.DetectorArgs;
import com.pulumi.aws.guardduty.DetectorFeature;
import com.pulumi.aws.guardduty.DetectorFeatureArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Detector("example", DetectorArgs.builder()
            .enable(true)
            .build());

        var s3Protection = new DetectorFeature("s3Protection", DetectorFeatureArgs.builder()
            .detectorId(example.id())
            .name("S3_DATA_EVENTS")
            .status("ENABLED")
            .build());

    }
}
resources:
  example:
    type: aws:guardduty:Detector
    properties:
      enable: true
  s3Protection:
    type: aws:guardduty:DetectorFeature
    name: s3_protection
    properties:
      detectorId: ${example.id}
      name: S3_DATA_EVENTS
      status: ENABLED

Extended Threat Detection for EKS

To enable GuardDuty Extended Threat Detection for EKS, you need at least one of these features enabled: EKS Protection or Runtime Monitoring. For maximum detection coverage, enabling both is recommended to enhance detection capabilities.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.guardduty.Detector("example", {enable: true});
const eksProtection = new aws.guardduty.DetectorFeature("eks_protection", {
    detectorId: example.id,
    name: "EKS_AUDIT_LOGS",
    status: "ENABLED",
});
const eksRuntimeMonitoring = new aws.guardduty.DetectorFeature("eks_runtime_monitoring", {
    additionalConfigurations: [{
        name: "EKS_ADDON_MANAGEMENT",
        status: "ENABLED",
    }],
    detectorId: example.id,
    name: "EKS_RUNTIME_MONITORING",
    status: "ENABLED",
});
import pulumi
import pulumi_aws as aws

example = aws.guardduty.Detector("example", enable=True)
eks_protection = aws.guardduty.DetectorFeature("eks_protection",
    detector_id=example.id,
    name="EKS_AUDIT_LOGS",
    status="ENABLED")
eks_runtime_monitoring = aws.guardduty.DetectorFeature("eks_runtime_monitoring",
    additional_configurations=[{
        "name": "EKS_ADDON_MANAGEMENT",
        "status": "ENABLED",
    }],
    detector_id=example.id,
    name="EKS_RUNTIME_MONITORING",
    status="ENABLED")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.GuardDuty.Detector("example", new()
    {
        Enable = true,
    });

    var eksProtection = new Aws.GuardDuty.DetectorFeature("eks_protection", new()
    {
        DetectorId = example.Id,
        Name = "EKS_AUDIT_LOGS",
        Status = "ENABLED",
    });

    var eksRuntimeMonitoring = new Aws.GuardDuty.DetectorFeature("eks_runtime_monitoring", new()
    {
        AdditionalConfigurations = new[]
        {
            new Aws.GuardDuty.Inputs.DetectorFeatureAdditionalConfigurationArgs
            {
                Name = "EKS_ADDON_MANAGEMENT",
                Status = "ENABLED",
            },
        },
        DetectorId = example.Id,
        Name = "EKS_RUNTIME_MONITORING",
        Status = "ENABLED",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/guardduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := guardduty.NewDetector(ctx, "example", &guardduty.DetectorArgs{
			Enable: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = guardduty.NewDetectorFeature(ctx, "eks_protection", &guardduty.DetectorFeatureArgs{
			DetectorId: example.ID().ToIDOutput().ToStringOutput(),
			Name:       pulumi.String("EKS_AUDIT_LOGS"),
			Status:     pulumi.String("ENABLED"),
		})
		if err != nil {
			return err
		}
		_, err = guardduty.NewDetectorFeature(ctx, "eks_runtime_monitoring", &guardduty.DetectorFeatureArgs{
			AdditionalConfigurations: guardduty.DetectorFeatureAdditionalConfigurationArray{
				&guardduty.DetectorFeatureAdditionalConfigurationArgs{
					Name:   pulumi.String("EKS_ADDON_MANAGEMENT"),
					Status: pulumi.String("ENABLED"),
				},
			},
			DetectorId: example.ID().ToIDOutput().ToStringOutput(),
			Name:       pulumi.String("EKS_RUNTIME_MONITORING"),
			Status:     pulumi.String("ENABLED"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_guardduty_detector" "example" {
  enable = true
}
resource "aws_guardduty_detectorfeature" "eks_protection" {
  detector_id = aws_guardduty_detector.example.id
  name        = "EKS_AUDIT_LOGS"
  status      = "ENABLED"
}
resource "aws_guardduty_detectorfeature" "eks_runtime_monitoring" {
  additional_configurations {
    name   = "EKS_ADDON_MANAGEMENT"
    status = "ENABLED"
  }
  detector_id = aws_guardduty_detector.example.id
  name        = "EKS_RUNTIME_MONITORING"
  status      = "ENABLED"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.guardduty.Detector;
import com.pulumi.aws.guardduty.DetectorArgs;
import com.pulumi.aws.guardduty.DetectorFeature;
import com.pulumi.aws.guardduty.DetectorFeatureArgs;
import com.pulumi.aws.guardduty.inputs.DetectorFeatureAdditionalConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Detector("example", DetectorArgs.builder()
            .enable(true)
            .build());

        var eksProtection = new DetectorFeature("eksProtection", DetectorFeatureArgs.builder()
            .detectorId(example.id())
            .name("EKS_AUDIT_LOGS")
            .status("ENABLED")
            .build());

        var eksRuntimeMonitoring = new DetectorFeature("eksRuntimeMonitoring", DetectorFeatureArgs.builder()
            .additionalConfigurations(DetectorFeatureAdditionalConfigurationArgs.builder()
                .name("EKS_ADDON_MANAGEMENT")
                .status("ENABLED")
                .build())
            .detectorId(example.id())
            .name("EKS_RUNTIME_MONITORING")
            .status("ENABLED")
            .build());

    }
}
resources:
  example:
    type: aws:guardduty:Detector
    properties:
      enable: true
  eksProtection:
    type: aws:guardduty:DetectorFeature
    name: eks_protection
    properties:
      detectorId: ${example.id}
      name: EKS_AUDIT_LOGS
      status: ENABLED
  eksRuntimeMonitoring:
    type: aws:guardduty:DetectorFeature
    name: eks_runtime_monitoring
    properties:
      additionalConfigurations:
        - name: EKS_ADDON_MANAGEMENT
          status: ENABLED
      detectorId: ${example.id}
      name: EKS_RUNTIME_MONITORING
      status: ENABLED

Constructors

DetectorFeature(String name, {DetectorFeatureArgs? args, CustomResourceOptions? options})
Creates a new DetectorFeature. name The Pulumi resource name. args Arguments used to configure this DetectorFeature. The set of arguments for DetectorFeature. options Resource options controlling this resource's behavior.
DetectorFeature.reference(String urn)
Creates a typed reference to an existing DetectorFeature resource.

Properties

additionalConfigurations ↔ Output<List<DetectorFeatureAdditionalConfiguration>?>
Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
detectorId ↔ Output<String>
Amazon GuardDuty detector ID.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING, AI_PROTECTION, AI_ANALYST. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status ↔ Output<String>
The status of the detector feature. Valid values: ENABLED, DISABLED.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DetectorFeatureState? state, CustomResourceOptions? options}) → DetectorFeature
Gets an existing DetectorFeature resource's state with the given name and id.