1. Packages
  2. AWS Classic
  3. API Docs
  4. guardduty
  5. Detector

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi

aws.guardduty.Detector

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi

    Provides a resource to manage an Amazon 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

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const myDetector = new aws.guardduty.Detector("MyDetector", {
        enable: true,
        datasources: {
            s3Logs: {
                enable: true,
            },
            kubernetes: {
                auditLogs: {
                    enable: false,
                },
            },
            malwareProtection: {
                scanEc2InstanceWithFindings: {
                    ebsVolumes: {
                        enable: true,
                    },
                },
            },
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    my_detector = aws.guardduty.Detector("MyDetector",
        enable=True,
        datasources=aws.guardduty.DetectorDatasourcesArgs(
            s3_logs=aws.guardduty.DetectorDatasourcesS3LogsArgs(
                enable=True,
            ),
            kubernetes=aws.guardduty.DetectorDatasourcesKubernetesArgs(
                audit_logs=aws.guardduty.DetectorDatasourcesKubernetesAuditLogsArgs(
                    enable=False,
                ),
            ),
            malware_protection=aws.guardduty.DetectorDatasourcesMalwareProtectionArgs(
                scan_ec2_instance_with_findings=aws.guardduty.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs(
                    ebs_volumes=aws.guardduty.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs(
                        enable=True,
                    ),
                ),
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/guardduty"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := guardduty.NewDetector(ctx, "MyDetector", &guardduty.DetectorArgs{
    			Enable: pulumi.Bool(true),
    			Datasources: &guardduty.DetectorDatasourcesArgs{
    				S3Logs: &guardduty.DetectorDatasourcesS3LogsArgs{
    					Enable: pulumi.Bool(true),
    				},
    				Kubernetes: &guardduty.DetectorDatasourcesKubernetesArgs{
    					AuditLogs: &guardduty.DetectorDatasourcesKubernetesAuditLogsArgs{
    						Enable: pulumi.Bool(false),
    					},
    				},
    				MalwareProtection: &guardduty.DetectorDatasourcesMalwareProtectionArgs{
    					ScanEc2InstanceWithFindings: &guardduty.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs{
    						EbsVolumes: &guardduty.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs{
    							Enable: pulumi.Bool(true),
    						},
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var myDetector = new Aws.GuardDuty.Detector("MyDetector", new()
        {
            Enable = true,
            Datasources = new Aws.GuardDuty.Inputs.DetectorDatasourcesArgs
            {
                S3Logs = new Aws.GuardDuty.Inputs.DetectorDatasourcesS3LogsArgs
                {
                    Enable = true,
                },
                Kubernetes = new Aws.GuardDuty.Inputs.DetectorDatasourcesKubernetesArgs
                {
                    AuditLogs = new Aws.GuardDuty.Inputs.DetectorDatasourcesKubernetesAuditLogsArgs
                    {
                        Enable = false,
                    },
                },
                MalwareProtection = new Aws.GuardDuty.Inputs.DetectorDatasourcesMalwareProtectionArgs
                {
                    ScanEc2InstanceWithFindings = new Aws.GuardDuty.Inputs.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs
                    {
                        EbsVolumes = new Aws.GuardDuty.Inputs.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs
                        {
                            Enable = true,
                        },
                    },
                },
            },
        });
    
    });
    
    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.inputs.DetectorDatasourcesArgs;
    import com.pulumi.aws.guardduty.inputs.DetectorDatasourcesS3LogsArgs;
    import com.pulumi.aws.guardduty.inputs.DetectorDatasourcesKubernetesArgs;
    import com.pulumi.aws.guardduty.inputs.DetectorDatasourcesKubernetesAuditLogsArgs;
    import com.pulumi.aws.guardduty.inputs.DetectorDatasourcesMalwareProtectionArgs;
    import com.pulumi.aws.guardduty.inputs.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs;
    import com.pulumi.aws.guardduty.inputs.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 myDetector = new Detector("myDetector", DetectorArgs.builder()        
                .enable(true)
                .datasources(DetectorDatasourcesArgs.builder()
                    .s3Logs(DetectorDatasourcesS3LogsArgs.builder()
                        .enable(true)
                        .build())
                    .kubernetes(DetectorDatasourcesKubernetesArgs.builder()
                        .auditLogs(DetectorDatasourcesKubernetesAuditLogsArgs.builder()
                            .enable(false)
                            .build())
                        .build())
                    .malwareProtection(DetectorDatasourcesMalwareProtectionArgs.builder()
                        .scanEc2InstanceWithFindings(DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs.builder()
                            .ebsVolumes(DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs.builder()
                                .enable(true)
                                .build())
                            .build())
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      myDetector:
        type: aws:guardduty:Detector
        name: MyDetector
        properties:
          enable: true
          datasources:
            s3Logs:
              enable: true
            kubernetes:
              auditLogs:
                enable: false
            malwareProtection:
              scanEc2InstanceWithFindings:
                ebsVolumes:
                  enable: true
    

    Create Detector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Detector(name: string, args?: DetectorArgs, opts?: CustomResourceOptions);
    @overload
    def Detector(resource_name: str,
                 args: Optional[DetectorArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Detector(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 datasources: Optional[DetectorDatasourcesArgs] = None,
                 enable: Optional[bool] = None,
                 finding_publishing_frequency: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None)
    func NewDetector(ctx *Context, name string, args *DetectorArgs, opts ...ResourceOption) (*Detector, error)
    public Detector(string name, DetectorArgs? args = null, CustomResourceOptions? opts = null)
    public Detector(String name, DetectorArgs args)
    public Detector(String name, DetectorArgs args, CustomResourceOptions options)
    
    type: aws:guardduty:Detector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DetectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DetectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DetectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DetectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DetectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var detectorResource = new Aws.GuardDuty.Detector("detectorResource", new()
    {
        Datasources = new Aws.GuardDuty.Inputs.DetectorDatasourcesArgs
        {
            Kubernetes = new Aws.GuardDuty.Inputs.DetectorDatasourcesKubernetesArgs
            {
                AuditLogs = new Aws.GuardDuty.Inputs.DetectorDatasourcesKubernetesAuditLogsArgs
                {
                    Enable = false,
                },
            },
            MalwareProtection = new Aws.GuardDuty.Inputs.DetectorDatasourcesMalwareProtectionArgs
            {
                ScanEc2InstanceWithFindings = new Aws.GuardDuty.Inputs.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs
                {
                    EbsVolumes = new Aws.GuardDuty.Inputs.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs
                    {
                        Enable = false,
                    },
                },
            },
            S3Logs = new Aws.GuardDuty.Inputs.DetectorDatasourcesS3LogsArgs
            {
                Enable = false,
            },
        },
        Enable = false,
        FindingPublishingFrequency = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := guardduty.NewDetector(ctx, "detectorResource", &guardduty.DetectorArgs{
    	Datasources: &guardduty.DetectorDatasourcesArgs{
    		Kubernetes: &guardduty.DetectorDatasourcesKubernetesArgs{
    			AuditLogs: &guardduty.DetectorDatasourcesKubernetesAuditLogsArgs{
    				Enable: pulumi.Bool(false),
    			},
    		},
    		MalwareProtection: &guardduty.DetectorDatasourcesMalwareProtectionArgs{
    			ScanEc2InstanceWithFindings: &guardduty.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs{
    				EbsVolumes: &guardduty.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs{
    					Enable: pulumi.Bool(false),
    				},
    			},
    		},
    		S3Logs: &guardduty.DetectorDatasourcesS3LogsArgs{
    			Enable: pulumi.Bool(false),
    		},
    	},
    	Enable:                     pulumi.Bool(false),
    	FindingPublishingFrequency: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var detectorResource = new Detector("detectorResource", DetectorArgs.builder()        
        .datasources(DetectorDatasourcesArgs.builder()
            .kubernetes(DetectorDatasourcesKubernetesArgs.builder()
                .auditLogs(DetectorDatasourcesKubernetesAuditLogsArgs.builder()
                    .enable(false)
                    .build())
                .build())
            .malwareProtection(DetectorDatasourcesMalwareProtectionArgs.builder()
                .scanEc2InstanceWithFindings(DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs.builder()
                    .ebsVolumes(DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs.builder()
                        .enable(false)
                        .build())
                    .build())
                .build())
            .s3Logs(DetectorDatasourcesS3LogsArgs.builder()
                .enable(false)
                .build())
            .build())
        .enable(false)
        .findingPublishingFrequency("string")
        .tags(Map.of("string", "string"))
        .build());
    
    detector_resource = aws.guardduty.Detector("detectorResource",
        datasources=aws.guardduty.DetectorDatasourcesArgs(
            kubernetes=aws.guardduty.DetectorDatasourcesKubernetesArgs(
                audit_logs=aws.guardduty.DetectorDatasourcesKubernetesAuditLogsArgs(
                    enable=False,
                ),
            ),
            malware_protection=aws.guardduty.DetectorDatasourcesMalwareProtectionArgs(
                scan_ec2_instance_with_findings=aws.guardduty.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs(
                    ebs_volumes=aws.guardduty.DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs(
                        enable=False,
                    ),
                ),
            ),
            s3_logs=aws.guardduty.DetectorDatasourcesS3LogsArgs(
                enable=False,
            ),
        ),
        enable=False,
        finding_publishing_frequency="string",
        tags={
            "string": "string",
        })
    
    const detectorResource = new aws.guardduty.Detector("detectorResource", {
        datasources: {
            kubernetes: {
                auditLogs: {
                    enable: false,
                },
            },
            malwareProtection: {
                scanEc2InstanceWithFindings: {
                    ebsVolumes: {
                        enable: false,
                    },
                },
            },
            s3Logs: {
                enable: false,
            },
        },
        enable: false,
        findingPublishingFrequency: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:guardduty:Detector
    properties:
        datasources:
            kubernetes:
                auditLogs:
                    enable: false
            malwareProtection:
                scanEc2InstanceWithFindings:
                    ebsVolumes:
                        enable: false
            s3Logs:
                enable: false
        enable: false
        findingPublishingFrequency: string
        tags:
            string: string
    

    Detector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Detector resource accepts the following input properties:

    Datasources DetectorDatasources
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    Enable bool
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    FindingPublishingFrequency string
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Datasources DetectorDatasourcesArgs
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    Enable bool
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    FindingPublishingFrequency string
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    datasources DetectorDatasources
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    enable Boolean
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    findingPublishingFrequency String
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    datasources DetectorDatasources
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    enable boolean
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    findingPublishingFrequency string
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    datasources DetectorDatasourcesArgs
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    enable bool
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    finding_publishing_frequency str
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    datasources Property Map
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    enable Boolean
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    findingPublishingFrequency String
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Detector resource produces the following output properties:

    AccountId string
    The AWS account ID of the GuardDuty detector
    Arn string
    Amazon Resource Name (ARN) of the GuardDuty detector
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AccountId string
    The AWS account ID of the GuardDuty detector
    Arn string
    Amazon Resource Name (ARN) of the GuardDuty detector
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountId String
    The AWS account ID of the GuardDuty detector
    arn String
    Amazon Resource Name (ARN) of the GuardDuty detector
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountId string
    The AWS account ID of the GuardDuty detector
    arn string
    Amazon Resource Name (ARN) of the GuardDuty detector
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    account_id str
    The AWS account ID of the GuardDuty detector
    arn str
    Amazon Resource Name (ARN) of the GuardDuty detector
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountId String
    The AWS account ID of the GuardDuty detector
    arn String
    Amazon Resource Name (ARN) of the GuardDuty detector
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Detector Resource

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

    public static get(name: string, id: Input<ID>, state?: DetectorState, opts?: CustomResourceOptions): Detector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            arn: Optional[str] = None,
            datasources: Optional[DetectorDatasourcesArgs] = None,
            enable: Optional[bool] = None,
            finding_publishing_frequency: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Detector
    func GetDetector(ctx *Context, name string, id IDInput, state *DetectorState, opts ...ResourceOption) (*Detector, error)
    public static Detector Get(string name, Input<string> id, DetectorState? state, CustomResourceOptions? opts = null)
    public static Detector get(String name, Output<String> id, DetectorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    The AWS account ID of the GuardDuty detector
    Arn string
    Amazon Resource Name (ARN) of the GuardDuty detector
    Datasources DetectorDatasources
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    Enable bool
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    FindingPublishingFrequency string
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AccountId string
    The AWS account ID of the GuardDuty detector
    Arn string
    Amazon Resource Name (ARN) of the GuardDuty detector
    Datasources DetectorDatasourcesArgs
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    Enable bool
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    FindingPublishingFrequency string
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountId String
    The AWS account ID of the GuardDuty detector
    arn String
    Amazon Resource Name (ARN) of the GuardDuty detector
    datasources DetectorDatasources
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    enable Boolean
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    findingPublishingFrequency String
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountId string
    The AWS account ID of the GuardDuty detector
    arn string
    Amazon Resource Name (ARN) of the GuardDuty detector
    datasources DetectorDatasources
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    enable boolean
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    findingPublishingFrequency string
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    account_id str
    The AWS account ID of the GuardDuty detector
    arn str
    Amazon Resource Name (ARN) of the GuardDuty detector
    datasources DetectorDatasourcesArgs
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    enable bool
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    finding_publishing_frequency str
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accountId String
    The AWS account ID of the GuardDuty detector
    arn String
    Amazon Resource Name (ARN) of the GuardDuty detector
    datasources Property Map
    Describes which data sources will be enabled for the detector. See Data Sources below for more details. Deprecated in favor of aws.guardduty.DetectorFeature resources.
    enable Boolean
    Enable monitoring and feedback reporting. Setting to false is equivalent to "suspending" GuardDuty. Defaults to true.
    findingPublishingFrequency String
    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 primary account and cannot be modified, otherwise defaults to SIX_HOURS. For standalone and GuardDuty primary accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and primary accounts: FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS. See AWS Documentation for more information.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    DetectorDatasources, DetectorDatasourcesArgs

    Kubernetes DetectorDatasourcesKubernetes
    Configures Kubernetes protection. See Kubernetes and Kubernetes Audit Logs below for more details.
    MalwareProtection DetectorDatasourcesMalwareProtection

    Configures Malware Protection. See Malware Protection, Scan EC2 instance with findings and EBS volumes below for more details.

    The datasources block is deprecated since March 2023. Use the features block instead and map each datasources block to the corresponding features block.

    S3Logs DetectorDatasourcesS3Logs
    Configures S3 protection. See S3 Logs below for more details.
    Kubernetes DetectorDatasourcesKubernetes
    Configures Kubernetes protection. See Kubernetes and Kubernetes Audit Logs below for more details.
    MalwareProtection DetectorDatasourcesMalwareProtection

    Configures Malware Protection. See Malware Protection, Scan EC2 instance with findings and EBS volumes below for more details.

    The datasources block is deprecated since March 2023. Use the features block instead and map each datasources block to the corresponding features block.

    S3Logs DetectorDatasourcesS3Logs
    Configures S3 protection. See S3 Logs below for more details.
    kubernetes DetectorDatasourcesKubernetes
    Configures Kubernetes protection. See Kubernetes and Kubernetes Audit Logs below for more details.
    malwareProtection DetectorDatasourcesMalwareProtection

    Configures Malware Protection. See Malware Protection, Scan EC2 instance with findings and EBS volumes below for more details.

    The datasources block is deprecated since March 2023. Use the features block instead and map each datasources block to the corresponding features block.

    s3Logs DetectorDatasourcesS3Logs
    Configures S3 protection. See S3 Logs below for more details.
    kubernetes DetectorDatasourcesKubernetes
    Configures Kubernetes protection. See Kubernetes and Kubernetes Audit Logs below for more details.
    malwareProtection DetectorDatasourcesMalwareProtection

    Configures Malware Protection. See Malware Protection, Scan EC2 instance with findings and EBS volumes below for more details.

    The datasources block is deprecated since March 2023. Use the features block instead and map each datasources block to the corresponding features block.

    s3Logs DetectorDatasourcesS3Logs
    Configures S3 protection. See S3 Logs below for more details.
    kubernetes DetectorDatasourcesKubernetes
    Configures Kubernetes protection. See Kubernetes and Kubernetes Audit Logs below for more details.
    malware_protection DetectorDatasourcesMalwareProtection

    Configures Malware Protection. See Malware Protection, Scan EC2 instance with findings and EBS volumes below for more details.

    The datasources block is deprecated since March 2023. Use the features block instead and map each datasources block to the corresponding features block.

    s3_logs DetectorDatasourcesS3Logs
    Configures S3 protection. See S3 Logs below for more details.
    kubernetes Property Map
    Configures Kubernetes protection. See Kubernetes and Kubernetes Audit Logs below for more details.
    malwareProtection Property Map

    Configures Malware Protection. See Malware Protection, Scan EC2 instance with findings and EBS volumes below for more details.

    The datasources block is deprecated since March 2023. Use the features block instead and map each datasources block to the corresponding features block.

    s3Logs Property Map
    Configures S3 protection. See S3 Logs below for more details.

    DetectorDatasourcesKubernetes, DetectorDatasourcesKubernetesArgs

    AuditLogs DetectorDatasourcesKubernetesAuditLogs
    Configures Kubernetes audit logs as a data source for Kubernetes protection. See Kubernetes Audit Logs below for more details.
    AuditLogs DetectorDatasourcesKubernetesAuditLogs
    Configures Kubernetes audit logs as a data source for Kubernetes protection. See Kubernetes Audit Logs below for more details.
    auditLogs DetectorDatasourcesKubernetesAuditLogs
    Configures Kubernetes audit logs as a data source for Kubernetes protection. See Kubernetes Audit Logs below for more details.
    auditLogs DetectorDatasourcesKubernetesAuditLogs
    Configures Kubernetes audit logs as a data source for Kubernetes protection. See Kubernetes Audit Logs below for more details.
    audit_logs DetectorDatasourcesKubernetesAuditLogs
    Configures Kubernetes audit logs as a data source for Kubernetes protection. See Kubernetes Audit Logs below for more details.
    auditLogs Property Map
    Configures Kubernetes audit logs as a data source for Kubernetes protection. See Kubernetes Audit Logs below for more details.

    DetectorDatasourcesKubernetesAuditLogs, DetectorDatasourcesKubernetesAuditLogsArgs

    Enable bool
    If true, enables Kubernetes audit logs as a data source for Kubernetes protection. Defaults to true.
    Enable bool
    If true, enables Kubernetes audit logs as a data source for Kubernetes protection. Defaults to true.
    enable Boolean
    If true, enables Kubernetes audit logs as a data source for Kubernetes protection. Defaults to true.
    enable boolean
    If true, enables Kubernetes audit logs as a data source for Kubernetes protection. Defaults to true.
    enable bool
    If true, enables Kubernetes audit logs as a data source for Kubernetes protection. Defaults to true.
    enable Boolean
    If true, enables Kubernetes audit logs as a data source for Kubernetes protection. Defaults to true.

    DetectorDatasourcesMalwareProtection, DetectorDatasourcesMalwareProtectionArgs

    ScanEc2InstanceWithFindings DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings
    Configure whether Malware Protection is enabled as data source for EC2 instances with findings for the detector. See Scan EC2 instance with findings below for more details.
    ScanEc2InstanceWithFindings DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings
    Configure whether Malware Protection is enabled as data source for EC2 instances with findings for the detector. See Scan EC2 instance with findings below for more details.
    scanEc2InstanceWithFindings DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings
    Configure whether Malware Protection is enabled as data source for EC2 instances with findings for the detector. See Scan EC2 instance with findings below for more details.
    scanEc2InstanceWithFindings DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings
    Configure whether Malware Protection is enabled as data source for EC2 instances with findings for the detector. See Scan EC2 instance with findings below for more details.
    scan_ec2_instance_with_findings DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings
    Configure whether Malware Protection is enabled as data source for EC2 instances with findings for the detector. See Scan EC2 instance with findings below for more details.
    scanEc2InstanceWithFindings Property Map
    Configure whether Malware Protection is enabled as data source for EC2 instances with findings for the detector. See Scan EC2 instance with findings below for more details.

    DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindings, DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsArgs

    EbsVolumes DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes
    Configure whether scanning EBS volumes is enabled as data source for the detector for instances with findings. See EBS volumes below for more details.
    EbsVolumes DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes
    Configure whether scanning EBS volumes is enabled as data source for the detector for instances with findings. See EBS volumes below for more details.
    ebsVolumes DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes
    Configure whether scanning EBS volumes is enabled as data source for the detector for instances with findings. See EBS volumes below for more details.
    ebsVolumes DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes
    Configure whether scanning EBS volumes is enabled as data source for the detector for instances with findings. See EBS volumes below for more details.
    ebs_volumes DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes
    Configure whether scanning EBS volumes is enabled as data source for the detector for instances with findings. See EBS volumes below for more details.
    ebsVolumes Property Map
    Configure whether scanning EBS volumes is enabled as data source for the detector for instances with findings. See EBS volumes below for more details.

    DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumes, DetectorDatasourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesArgs

    Enable bool
    If true, enables Malware Protection as data source for the detector. Defaults to true.
    Enable bool
    If true, enables Malware Protection as data source for the detector. Defaults to true.
    enable Boolean
    If true, enables Malware Protection as data source for the detector. Defaults to true.
    enable boolean
    If true, enables Malware Protection as data source for the detector. Defaults to true.
    enable bool
    If true, enables Malware Protection as data source for the detector. Defaults to true.
    enable Boolean
    If true, enables Malware Protection as data source for the detector. Defaults to true.

    DetectorDatasourcesS3Logs, DetectorDatasourcesS3LogsArgs

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

    Import

    Using pulumi import, import GuardDuty detectors using the detector ID. For example:

    $ pulumi import aws:guardduty/detector:Detector MyDetector 00b00fd5aecc0ab60a708659477e9617
    

    The ID of the detector can be retrieved via the AWS CLI using aws guardduty list-detectors.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi