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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.guardduty.Detector

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    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 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.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const aws_nativeDetectorResource = new aws_native.guardduty.Detector("aws-nativeDetectorResource", {
        enable: false,
        dataSources: {
            kubernetes: {
                auditLogs: {
                    enable: false,
                },
            },
            malwareProtection: {
                scanEc2InstanceWithFindings: {
                    ebsVolumes: false,
                },
            },
            s3Logs: {
                enable: false,
            },
        },
        features: [{
            name: "string",
            status: aws_native.guardduty.DetectorCfnFeatureConfigurationStatus.Enabled,
            additionalConfiguration: [{
                name: "string",
                status: "string",
            }],
        }],
        findingPublishingFrequency: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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:

    Enable 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 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 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 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 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 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
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    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 string
    Name of the feature.
    Status 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 string
    Name of the feature.
    Status DetectorCfnFeatureConfigurationStatus
    Status of the feature configuration.
    AdditionalConfiguration []DetectorCfnFeatureAdditionalConfiguration
    Information about the additional configuration of a feature in your account.
    name String
    Name of the feature.
    status DetectorCfnFeatureConfigurationStatus
    Status of the feature configuration.
    additionalConfiguration List<DetectorCfnFeatureAdditionalConfiguration>
    Information about the additional configuration of a feature in your account.
    name string
    Name of the feature.
    status DetectorCfnFeatureConfigurationStatus
    Status of the feature configuration.
    additionalConfiguration DetectorCfnFeatureAdditionalConfiguration[]
    Information about the additional configuration of a feature in your account.
    name str
    Name of the feature.
    status DetectorCfnFeatureConfigurationStatus
    Status of the feature configuration.
    additional_configuration Sequence[DetectorCfnFeatureAdditionalConfiguration]
    Information about the additional configuration of a feature in your account.
    name String
    Name of the feature.
    status "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 bool
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    Enable bool
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    enable Boolean
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    enable boolean
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    enable bool
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    enable Boolean
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.

    DetectorCfnKubernetesConfiguration, DetectorCfnKubernetesConfigurationArgs

    AuditLogs Pulumi.AwsNative.GuardDuty.Inputs.DetectorCfnKubernetesAuditLogsConfiguration
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    AuditLogs DetectorCfnKubernetesAuditLogsConfiguration
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    auditLogs DetectorCfnKubernetesAuditLogsConfiguration
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    auditLogs DetectorCfnKubernetesAuditLogsConfiguration
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    audit_logs DetectorCfnKubernetesAuditLogsConfiguration
    Describes whether Kubernetes audit logs are enabled as a data source for the detector.
    auditLogs 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 bool
    The status of S3 data event logs as a data source.
    Enable bool
    The status of S3 data event logs as a data source.
    enable Boolean
    The status of S3 data event logs as a data source.
    enable boolean
    The status of S3 data event logs as a data source.
    enable bool
    The status of S3 data event logs as a data source.
    enable Boolean
    The status of S3 data event logs as a data source.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi