Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. guardduty
  5. getDetector

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.guardduty.getDetector

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::GuardDuty::Detector

Using getDetector

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDetector(args: GetDetectorArgs, opts?: InvokeOptions): Promise<GetDetectorResult>
function getDetectorOutput(args: GetDetectorOutputArgs, opts?: InvokeOptions): Output<GetDetectorResult>
Copy
def get_detector(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDetectorResult
def get_detector_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDetectorResult]
Copy
func LookupDetector(ctx *Context, args *LookupDetectorArgs, opts ...InvokeOption) (*LookupDetectorResult, error)
func LookupDetectorOutput(ctx *Context, args *LookupDetectorOutputArgs, opts ...InvokeOption) LookupDetectorResultOutput
Copy

> Note: This function is named LookupDetector in the Go SDK.

public static class GetDetector 
{
    public static Task<GetDetectorResult> InvokeAsync(GetDetectorArgs args, InvokeOptions? opts = null)
    public static Output<GetDetectorResult> Invoke(GetDetectorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDetectorResult> getDetector(GetDetectorArgs args, InvokeOptions options)
public static Output<GetDetectorResult> getDetector(GetDetectorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:guardduty:getDetector
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The unique ID of the detector.
Id This property is required. string
The unique ID of the detector.
id This property is required. String
The unique ID of the detector.
id This property is required. string
The unique ID of the detector.
id This property is required. str
The unique ID of the detector.
id This property is required. String
The unique ID of the detector.

getDetector Result

The following output properties are available:

DataSources Pulumi.AwsNative.GuardDuty.Outputs.DetectorCfnDataSourceConfigurations
Describes which data sources will be enabled for the detector.
Enable bool
Specifies whether the detector is to be enabled on creation.
Features List<Pulumi.AwsNative.GuardDuty.Outputs.DetectorCfnFeatureConfiguration>
A list of features that will be configured for the detector.
FindingPublishingFrequency string
Specifies how frequently updated findings are exported.
Id string
The unique ID of the detector.
Tags List<Pulumi.AwsNative.Outputs.Tag>

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 .

DataSources DetectorCfnDataSourceConfigurations
Describes which data sources will be enabled for the detector.
Enable bool
Specifies whether the detector is to be enabled on creation.
Features []DetectorCfnFeatureConfiguration
A list of features that will be configured for the detector.
FindingPublishingFrequency string
Specifies how frequently updated findings are exported.
Id string
The unique ID of the detector.
Tags Tag

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 .

dataSources DetectorCfnDataSourceConfigurations
Describes which data sources will be enabled for the detector.
enable Boolean
Specifies whether the detector is to be enabled on creation.
features List<DetectorCfnFeatureConfiguration>
A list of features that will be configured for the detector.
findingPublishingFrequency String
Specifies how frequently updated findings are exported.
id String
The unique ID of the detector.
tags List<Tag>

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 .

dataSources DetectorCfnDataSourceConfigurations
Describes which data sources will be enabled for the detector.
enable boolean
Specifies whether the detector is to be enabled on creation.
features DetectorCfnFeatureConfiguration[]
A list of features that will be configured for the detector.
findingPublishingFrequency string
Specifies how frequently updated findings are exported.
id string
The unique ID of the detector.
tags Tag[]

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 .

data_sources DetectorCfnDataSourceConfigurations
Describes which data sources will be enabled for the detector.
enable bool
Specifies whether the detector is to be enabled on creation.
features Sequence[DetectorCfnFeatureConfiguration]
A list of features that will be configured for the detector.
finding_publishing_frequency str
Specifies how frequently updated findings are exported.
id str
The unique ID of the detector.
tags Sequence[root_Tag]

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 .

dataSources Property Map
Describes which data sources will be enabled for the detector.
enable Boolean
Specifies whether the detector is to be enabled on creation.
features List<Property Map>
A list of features that will be configured for the detector.
findingPublishingFrequency String
Specifies how frequently updated findings are exported.
id String
The unique ID of the detector.
tags List<Property Map>

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 .

Supporting Types

DetectorCfnDataSourceConfigurations

Kubernetes Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfnKubernetesConfiguration
Describes which Kubernetes data sources are enabled for a detector.
MalwareProtection Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfnMalwareProtectionConfiguration
Describes whether Malware Protection will be enabled as a data source.
S3Logs Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfns3LogsConfiguration
Describes whether S3 data event logs are enabled as a data source.
Kubernetes DetectorCfnKubernetesConfiguration
Describes which Kubernetes data sources are enabled for a detector.
MalwareProtection DetectorCfnMalwareProtectionConfiguration
Describes whether Malware Protection will be enabled as a data source.
S3Logs DetectorCfns3LogsConfiguration
Describes whether S3 data event logs are enabled as a data source.
kubernetes DetectorCfnKubernetesConfiguration
Describes which Kubernetes data sources are enabled for a detector.
malwareProtection DetectorCfnMalwareProtectionConfiguration
Describes whether Malware Protection will be enabled as a data source.
s3Logs DetectorCfns3LogsConfiguration
Describes whether S3 data event logs are enabled as a data source.
kubernetes DetectorCfnKubernetesConfiguration
Describes which Kubernetes data sources are enabled for a detector.
malwareProtection DetectorCfnMalwareProtectionConfiguration
Describes whether Malware Protection will be enabled as a data source.
s3Logs DetectorCfns3LogsConfiguration
Describes whether S3 data event logs are enabled as a data source.
kubernetes DetectorCfnKubernetesConfiguration
Describes which Kubernetes data sources are enabled for a detector.
malware_protection DetectorCfnMalwareProtectionConfiguration
Describes whether Malware Protection will be enabled as a data source.
s3_logs DetectorCfns3LogsConfiguration
Describes whether S3 data event logs are enabled as a data source.
kubernetes Property Map
Describes which Kubernetes data sources are enabled for a detector.
malwareProtection Property Map
Describes whether Malware Protection will be enabled as a data source.
s3Logs Property Map
Describes whether S3 data event logs are enabled as a data source.

DetectorCfnFeatureAdditionalConfiguration

Name string
Name of the additional configuration.
Status string
Status of the additional configuration.
Name string
Name of the additional configuration.
Status string
Status of the additional configuration.
name String
Name of the additional configuration.
status String
Status of the additional configuration.
name string
Name of the additional configuration.
status string
Status of the additional configuration.
name str
Name of the additional configuration.
status str
Status of the additional configuration.
name String
Name of the additional configuration.
status String
Status of the additional configuration.

DetectorCfnFeatureConfiguration

Name This property is required. string
Name of the feature. For a list of allowed values, see DetectorFeatureConfiguration in the GuardDuty API Reference .
Status This property is required. Pulumi.AwsNative.GuardDuty.DetectorCfnFeatureConfigurationStatus
Status of the feature configuration.
AdditionalConfiguration List<Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfnFeatureAdditionalConfiguration>
Information about the additional configuration of a feature in your account.
Name This property is required. string
Name of the feature. For a list of allowed values, see DetectorFeatureConfiguration in the GuardDuty API Reference .
Status This property is required. DetectorCfnFeatureConfigurationStatus
Status of the feature configuration.
AdditionalConfiguration []DetectorCfnFeatureAdditionalConfiguration
Information about the additional configuration of a feature in your account.
name This property is required. String
Name of the feature. For a list of allowed values, see DetectorFeatureConfiguration in the GuardDuty API Reference .
status This property is required. DetectorCfnFeatureConfigurationStatus
Status of the feature configuration.
additionalConfiguration List<DetectorCfnFeatureAdditionalConfiguration>
Information about the additional configuration of a feature in your account.
name This property is required. string
Name of the feature. For a list of allowed values, see DetectorFeatureConfiguration in the GuardDuty API Reference .
status This property is required. DetectorCfnFeatureConfigurationStatus
Status of the feature configuration.
additionalConfiguration DetectorCfnFeatureAdditionalConfiguration[]
Information about the additional configuration of a feature in your account.
name This property is required. str
Name of the feature. For a list of allowed values, see DetectorFeatureConfiguration in the GuardDuty API Reference .
status This property is required. DetectorCfnFeatureConfigurationStatus
Status of the feature configuration.
additional_configuration Sequence[DetectorCfnFeatureAdditionalConfiguration]
Information about the additional configuration of a feature in your account.
name This property is required. String
Name of the feature. For a list of allowed values, see DetectorFeatureConfiguration in the GuardDuty API Reference .
status This property is required. "ENABLED" | "DISABLED"
Status of the feature configuration.
additionalConfiguration List<Property Map>
Information about the additional configuration of a feature in your account.

DetectorCfnFeatureConfigurationStatus

DetectorCfnKubernetesAuditLogsConfiguration

Enable This property is required. bool
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
Enable This property is required. bool
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
enable This property is required. Boolean
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
enable This property is required. boolean
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
enable This property is required. bool
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
enable This property is required. Boolean
Describes whether Kubernetes audit logs are enabled as a data source for the detector.

DetectorCfnKubernetesConfiguration

AuditLogs This property is required. Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfnKubernetesAuditLogsConfiguration
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
AuditLogs This property is required. DetectorCfnKubernetesAuditLogsConfiguration
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
auditLogs This property is required. DetectorCfnKubernetesAuditLogsConfiguration
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
auditLogs This property is required. DetectorCfnKubernetesAuditLogsConfiguration
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
audit_logs This property is required. DetectorCfnKubernetesAuditLogsConfiguration
Describes whether Kubernetes audit logs are enabled as a data source for the detector.
auditLogs This property is required. Property Map
Describes whether Kubernetes audit logs are enabled as a data source for the detector.

DetectorCfnMalwareProtectionConfiguration

ScanEc2InstanceWithFindings Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfnScanEc2InstanceWithFindingsConfiguration
Describes the configuration of Malware Protection for EC2 instances with findings.
ScanEc2InstanceWithFindings DetectorCfnScanEc2InstanceWithFindingsConfiguration
Describes the configuration of Malware Protection for EC2 instances with findings.
scanEc2InstanceWithFindings DetectorCfnScanEc2InstanceWithFindingsConfiguration
Describes the configuration of Malware Protection for EC2 instances with findings.
scanEc2InstanceWithFindings DetectorCfnScanEc2InstanceWithFindingsConfiguration
Describes the configuration of Malware Protection for EC2 instances with findings.
scan_ec2_instance_with_findings DetectorCfnScanEc2InstanceWithFindingsConfiguration
Describes the configuration of Malware Protection for EC2 instances with findings.
scanEc2InstanceWithFindings Property Map
Describes the configuration of Malware Protection for EC2 instances with findings.

DetectorCfnScanEc2InstanceWithFindingsConfiguration

EbsVolumes bool
Describes the configuration for scanning EBS volumes as data source.
EbsVolumes bool
Describes the configuration for scanning EBS volumes as data source.
ebsVolumes Boolean
Describes the configuration for scanning EBS volumes as data source.
ebsVolumes boolean
Describes the configuration for scanning EBS volumes as data source.
ebs_volumes bool
Describes the configuration for scanning EBS volumes as data source.
ebsVolumes Boolean
Describes the configuration for scanning EBS volumes as data source.

DetectorCfns3LogsConfiguration

Enable This property is required. bool
The status of S3 data event logs as a data source.
Enable This property is required. bool
The status of S3 data event logs as a data source.
enable This property is required. Boolean
The status of S3 data event logs as a data source.
enable This property is required. boolean
The status of S3 data event logs as a data source.
enable This property is required. bool
The status of S3 data event logs as a data source.
enable This property is required. Boolean
The status of S3 data event logs as a data source.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native