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

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

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.guardduty.Detector

Explore with Pulumi AI

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

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::GuardDuty::Detector

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: DetectorArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Detector(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             enable: Optional[bool] = None,
             data_sources: Optional[DetectorCfnDataSourceConfigurationsArgs] = None,
             features: Optional[Sequence[DetectorCfnFeatureConfigurationArgs]] = None,
             finding_publishing_frequency: Optional[str] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDetector(ctx *Context, name string, args DetectorArgs, opts ...ResourceOption) (*Detector, error)
public Detector(string name, DetectorArgs args, CustomResourceOptions? opts = null)
public Detector(String name, DetectorArgs args)
public Detector(String name, DetectorArgs args, CustomResourceOptions options)

type: aws-native:guardduty:Detector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DetectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DetectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DetectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DetectorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Detector resource accepts the following input properties:

Enable This property is required. bool
Specifies whether the detector is to be enabled on creation.
DataSources Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfnDataSourceConfigurations
Describes which data sources will be enabled for the detector.
Features List<Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfnFeatureConfiguration>
A list of features that will be configured for the detector.
FindingPublishingFrequency string
Specifies how frequently updated findings are exported.
Tags List<Pulumi.AwsNative.Inputs.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 .

Enable This property is required. bool
Specifies whether the detector is to be enabled on creation.
DataSources DetectorCfnDataSourceConfigurationsArgs
Describes which data sources will be enabled for the detector.
Features []DetectorCfnFeatureConfigurationArgs
A list of features that will be configured for the detector.
FindingPublishingFrequency string
Specifies how frequently updated findings are exported.
Tags TagArgs

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 .

enable This property is required. Boolean
Specifies whether the detector is to be enabled on creation.
dataSources DetectorCfnDataSourceConfigurations
Describes which data sources will be enabled for the detector.
features List<DetectorCfnFeatureConfiguration>
A list of features that will be configured for the detector.
findingPublishingFrequency String
Specifies how frequently updated findings are exported.
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 .

enable This property is required. boolean
Specifies whether the detector is to be enabled on creation.
dataSources DetectorCfnDataSourceConfigurations
Describes which data sources will be enabled for the detector.
features DetectorCfnFeatureConfiguration[]
A list of features that will be configured for the detector.
findingPublishingFrequency string
Specifies how frequently updated findings are exported.
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 .

enable This property is required. bool
Specifies whether the detector is to be enabled on creation.
data_sources DetectorCfnDataSourceConfigurationsArgs
Describes which data sources will be enabled for the detector.
features Sequence[DetectorCfnFeatureConfigurationArgs]
A list of features that will be configured for the detector.
finding_publishing_frequency str
Specifies how frequently updated findings are exported.
tags Sequence[TagArgs]

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 .

enable This property is required. Boolean
Specifies whether the detector is to be enabled on creation.
dataSources Property Map
Describes which data sources will be enabled for the detector.
features List<Property Map>
A list of features that will be configured for the detector.
findingPublishingFrequency String
Specifies how frequently updated findings are exported.
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 .

Outputs

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

AwsId string
The unique ID of the detector.
Id string
The provider-assigned unique ID for this managed resource.
AwsId string
The unique ID of the detector.
Id string
The provider-assigned unique ID for this managed resource.
awsId String
The unique ID of the detector.
id String
The provider-assigned unique ID for this managed resource.
awsId string
The unique ID of the detector.
id string
The provider-assigned unique ID for this managed resource.
aws_id str
The unique ID of the detector.
id str
The provider-assigned unique ID for this managed resource.
awsId String
The unique ID of the detector.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

DetectorCfnDataSourceConfigurations
, DetectorCfnDataSourceConfigurationsArgs

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
, DetectorCfnFeatureAdditionalConfigurationArgs

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
, DetectorCfnFeatureConfigurationArgs

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
, DetectorCfnFeatureConfigurationStatusArgs

Enabled
ENABLED
Disabled
DISABLED
DetectorCfnFeatureConfigurationStatusEnabled
ENABLED
DetectorCfnFeatureConfigurationStatusDisabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
ENABLED
ENABLED
DISABLED
DISABLED
"ENABLED"
ENABLED
"DISABLED"
DISABLED

DetectorCfnKubernetesAuditLogsConfiguration
, DetectorCfnKubernetesAuditLogsConfigurationArgs

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
, DetectorCfnKubernetesConfigurationArgs

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
, DetectorCfnMalwareProtectionConfigurationArgs

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
, DetectorCfnScanEc2InstanceWithFindingsConfigurationArgs

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
, DetectorCfns3LogsConfigurationArgs

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
, TagArgs

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.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native