Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. guardduty
  5. getDetector
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.guardduty.getDetector

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Retrieve information about a GuardDuty detector.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.guardduty.getDetector({});

    import pulumi
import pulumi_aws as aws

example = aws.guardduty.get_detector()

    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.LookupDetector(ctx, &guardduty.LookupDetectorArgs{}, nil)
		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 example = Aws.GuardDuty.GetDetector.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.guardduty.GuarddutyFunctions;
import com.pulumi.aws.guardduty.inputs.GetDetectorArgs;
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) {
        final var example = GuarddutyFunctions.getDetector();

    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:guardduty:getDetector
      Arguments: {}

    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>
    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]
    func LookupDetector(ctx *Context, args *LookupDetectorArgs, opts ...InvokeOption) (*LookupDetectorResult, error)
func LookupDetectorOutput(ctx *Context, args *LookupDetectorOutputArgs, opts ...InvokeOption) LookupDetectorResultOutput

    > 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)
}
    public static CompletableFuture<GetDetectorResult> getDetector(GetDetectorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws:guardduty/getDetector:getDetector
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    ID of the detector.
    Id string
    ID of the detector.
    id String
    ID of the detector.
    id string
    ID of the detector.
    id str
    ID of the detector.
    id String
    ID of the detector.

    getDetector Result

    The following output properties are available:

    Features List<GetDetectorFeature>
    Current configuration of the detector features.
    FindingPublishingFrequency string
    The frequency of notifications sent about subsequent finding occurrences.
    Id string
    ServiceRoleArn string
    Service-linked role that grants GuardDuty access to the resources in the AWS account.
    Status string
    Current status of the detector.
    Features []GetDetectorFeatureType
    Current configuration of the detector features.
    FindingPublishingFrequency string
    The frequency of notifications sent about subsequent finding occurrences.
    Id string
    ServiceRoleArn string
    Service-linked role that grants GuardDuty access to the resources in the AWS account.
    Status string
    Current status of the detector.
    features List<GetDetectorFeature>
    Current configuration of the detector features.
    findingPublishingFrequency String
    The frequency of notifications sent about subsequent finding occurrences.
    id String
    serviceRoleArn String
    Service-linked role that grants GuardDuty access to the resources in the AWS account.
    status String
    Current status of the detector.
    features GetDetectorFeature[]
    Current configuration of the detector features.
    findingPublishingFrequency string
    The frequency of notifications sent about subsequent finding occurrences.
    id string
    serviceRoleArn string
    Service-linked role that grants GuardDuty access to the resources in the AWS account.
    status string
    Current status of the detector.
    features Sequence[GetDetectorFeature]
    Current configuration of the detector features.
    finding_publishing_frequency str
    The frequency of notifications sent about subsequent finding occurrences.
    id str
    service_role_arn str
    Service-linked role that grants GuardDuty access to the resources in the AWS account.
    status str
    Current status of the detector.
    features List<Property Map>
    Current configuration of the detector features.
    findingPublishingFrequency String
    The frequency of notifications sent about subsequent finding occurrences.
    id String
    serviceRoleArn String
    Service-linked role that grants GuardDuty access to the resources in the AWS account.
    status String
    Current status of the detector.

    Supporting Types

    GetDetectorFeature

    AdditionalConfigurations List<GetDetectorFeatureAdditionalConfiguration>
    Additional feature configuration.
    Name string
    The name of the detector feature.
    Status string
    Current status of the detector.
    AdditionalConfigurations []GetDetectorFeatureAdditionalConfiguration
    Additional feature configuration.
    Name string
    The name of the detector feature.
    Status string
    Current status of the detector.
    additionalConfigurations List<GetDetectorFeatureAdditionalConfiguration>
    Additional feature configuration.
    name String
    The name of the detector feature.
    status String
    Current status of the detector.
    additionalConfigurations GetDetectorFeatureAdditionalConfiguration[]
    Additional feature configuration.
    name string
    The name of the detector feature.
    status string
    Current status of the detector.
    additional_configurations Sequence[GetDetectorFeatureAdditionalConfiguration]
    Additional feature configuration.
    name str
    The name of the detector feature.
    status str
    Current status of the detector.
    additionalConfigurations List<Property Map>
    Additional feature configuration.
    name String
    The name of the detector feature.
    status String
    Current status of the detector.

    GetDetectorFeatureAdditionalConfiguration

    Name string
    The name of the detector feature.
    Status string
    Current status of the detector.
    Name string
    The name of the detector feature.
    Status string
    Current status of the detector.
    name String
    The name of the detector feature.
    status String
    Current status of the detector.
    name string
    The name of the detector feature.
    status string
    Current status of the detector.
    name str
    The name of the detector feature.
    status str
    Current status of the detector.
    name String
    The name of the detector feature.
    status String
    Current status of the detector.

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws