Class Detector

Provides a resource to manage a GuardDuty detector.

NOTE: Deleting this resource is equivalent to "disabling" GuardDuty for an AWS region, which removes all existing findings. You can set the enable attribute to false to instead "suspend" monitoring and feedback reporting while keeping existing data. See the Suspending or Disabling Amazon GuardDuty documentation for more information.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var myDetector = new Aws.GuardDuty.Detector(&quot;myDetector&quot;, new Aws.GuardDuty.DetectorArgs
    {
        Enable = true,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Detector

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.GuardDuty

Assembly: Pulumi.Aws.dll

Syntax

public class Detector : CustomResource

Constructors

View Source

Detector(String, DetectorArgs, CustomResourceOptions)

Create a Detector resource with the given unique name, arguments, and options.

Declaration

public Detector(string name, DetectorArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DetectorArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AccountId

The AWS account ID of the GuardDuty detector

Declaration

public Output<string> AccountId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Enable

Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.

Declaration

public Output<bool?> Enable { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

FindingPublishingFrequency

Specifies the frequency of notifications sent for subsequent finding occurrences. If the detector is a GuardDuty member account, the value is determined by the GuardDuty master account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty master accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and master accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.

Declaration

public Output<string> FindingPublishingFrequency { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, DetectorState, CustomResourceOptions)

Get an existing Detector resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Detector Get(string name, Input<string> id, DetectorState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DetectorState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Detector