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

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

AWS Classic v6.45.2 published on Tuesday, Jul 23, 2024 by Pulumi

aws.guardduty.DetectorFeature

Explore with Pulumi AI

aws logo

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

AWS Classic v6.45.2 published on Tuesday, Jul 23, 2024 by Pulumi

    Provides a resource to manage a single Amazon GuardDuty detector feature.

    NOTE: Deleting this resource does not disable the detector feature, the resource in simply removed from state instead.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.guardduty.Detector("example", {enable: true});
    const eksRuntimeMonitoring = new aws.guardduty.DetectorFeature("eks_runtime_monitoring", {
        detectorId: example.id,
        name: "EKS_RUNTIME_MONITORING",
        status: "ENABLED",
        additionalConfigurations: [{
            name: "EKS_ADDON_MANAGEMENT",
            status: "ENABLED",
        }],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.guardduty.Detector("example", enable=True)
    eks_runtime_monitoring = aws.guardduty.DetectorFeature("eks_runtime_monitoring",
        detector_id=example.id,
        name="EKS_RUNTIME_MONITORING",
        status="ENABLED",
        additional_configurations=[{
            "name": "EKS_ADDON_MANAGEMENT",
            "status": "ENABLED",
        }])
    
    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 {
    		example, err := guardduty.NewDetector(ctx, "example", &guardduty.DetectorArgs{
    			Enable: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = guardduty.NewDetectorFeature(ctx, "eks_runtime_monitoring", &guardduty.DetectorFeatureArgs{
    			DetectorId: example.ID(),
    			Name:       pulumi.String("EKS_RUNTIME_MONITORING"),
    			Status:     pulumi.String("ENABLED"),
    			AdditionalConfigurations: guardduty.DetectorFeatureAdditionalConfigurationArray{
    				&guardduty.DetectorFeatureAdditionalConfigurationArgs{
    					Name:   pulumi.String("EKS_ADDON_MANAGEMENT"),
    					Status: pulumi.String("ENABLED"),
    				},
    			},
    		})
    		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 = new Aws.GuardDuty.Detector("example", new()
        {
            Enable = true,
        });
    
        var eksRuntimeMonitoring = new Aws.GuardDuty.DetectorFeature("eks_runtime_monitoring", new()
        {
            DetectorId = example.Id,
            Name = "EKS_RUNTIME_MONITORING",
            Status = "ENABLED",
            AdditionalConfigurations = new[]
            {
                new Aws.GuardDuty.Inputs.DetectorFeatureAdditionalConfigurationArgs
                {
                    Name = "EKS_ADDON_MANAGEMENT",
                    Status = "ENABLED",
                },
            },
        });
    
    });
    
    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.DetectorFeature;
    import com.pulumi.aws.guardduty.DetectorFeatureArgs;
    import com.pulumi.aws.guardduty.inputs.DetectorFeatureAdditionalConfigurationArgs;
    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 example = new Detector("example", DetectorArgs.builder()
                .enable(true)
                .build());
    
            var eksRuntimeMonitoring = new DetectorFeature("eksRuntimeMonitoring", DetectorFeatureArgs.builder()
                .detectorId(example.id())
                .name("EKS_RUNTIME_MONITORING")
                .status("ENABLED")
                .additionalConfigurations(DetectorFeatureAdditionalConfigurationArgs.builder()
                    .name("EKS_ADDON_MANAGEMENT")
                    .status("ENABLED")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:guardduty:Detector
        properties:
          enable: true
      eksRuntimeMonitoring:
        type: aws:guardduty:DetectorFeature
        name: eks_runtime_monitoring
        properties:
          detectorId: ${example.id}
          name: EKS_RUNTIME_MONITORING
          status: ENABLED
          additionalConfigurations:
            - name: EKS_ADDON_MANAGEMENT
              status: ENABLED
    

    Create DetectorFeature Resource

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

    Constructor syntax

    new DetectorFeature(name: string, args: DetectorFeatureArgs, opts?: CustomResourceOptions);
    @overload
    def DetectorFeature(resource_name: str,
                        args: DetectorFeatureArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def DetectorFeature(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        detector_id: Optional[str] = None,
                        status: Optional[str] = None,
                        additional_configurations: Optional[Sequence[DetectorFeatureAdditionalConfigurationArgs]] = None,
                        name: Optional[str] = None)
    func NewDetectorFeature(ctx *Context, name string, args DetectorFeatureArgs, opts ...ResourceOption) (*DetectorFeature, error)
    public DetectorFeature(string name, DetectorFeatureArgs args, CustomResourceOptions? opts = null)
    public DetectorFeature(String name, DetectorFeatureArgs args)
    public DetectorFeature(String name, DetectorFeatureArgs args, CustomResourceOptions options)
    
    type: aws:guardduty:DetectorFeature
    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 DetectorFeatureArgs
    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 DetectorFeatureArgs
    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 DetectorFeatureArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DetectorFeatureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DetectorFeatureArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var detectorFeatureResource = new Aws.GuardDuty.DetectorFeature("detectorFeatureResource", new()
    {
        DetectorId = "string",
        Status = "string",
        AdditionalConfigurations = new[]
        {
            new Aws.GuardDuty.Inputs.DetectorFeatureAdditionalConfigurationArgs
            {
                Name = "string",
                Status = "string",
            },
        },
        Name = "string",
    });
    
    example, err := guardduty.NewDetectorFeature(ctx, "detectorFeatureResource", &guardduty.DetectorFeatureArgs{
    	DetectorId: pulumi.String("string"),
    	Status:     pulumi.String("string"),
    	AdditionalConfigurations: guardduty.DetectorFeatureAdditionalConfigurationArray{
    		&guardduty.DetectorFeatureAdditionalConfigurationArgs{
    			Name:   pulumi.String("string"),
    			Status: pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    })
    
    var detectorFeatureResource = new DetectorFeature("detectorFeatureResource", DetectorFeatureArgs.builder()
        .detectorId("string")
        .status("string")
        .additionalConfigurations(DetectorFeatureAdditionalConfigurationArgs.builder()
            .name("string")
            .status("string")
            .build())
        .name("string")
        .build());
    
    detector_feature_resource = aws.guardduty.DetectorFeature("detectorFeatureResource",
        detector_id="string",
        status="string",
        additional_configurations=[{
            "name": "string",
            "status": "string",
        }],
        name="string")
    
    const detectorFeatureResource = new aws.guardduty.DetectorFeature("detectorFeatureResource", {
        detectorId: "string",
        status: "string",
        additionalConfigurations: [{
            name: "string",
            status: "string",
        }],
        name: "string",
    });
    
    type: aws:guardduty:DetectorFeature
    properties:
        additionalConfigurations:
            - name: string
              status: string
        detectorId: string
        name: string
        status: string
    

    DetectorFeature 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 DetectorFeature resource accepts the following input properties:

    DetectorId string
    Amazon GuardDuty detector ID.
    Status string
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    AdditionalConfigurations List<DetectorFeatureAdditionalConfiguration>
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    Name string
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    DetectorId string
    Amazon GuardDuty detector ID.
    Status string
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    AdditionalConfigurations []DetectorFeatureAdditionalConfigurationArgs
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    Name string
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    detectorId String
    Amazon GuardDuty detector ID.
    status String
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    additionalConfigurations List<DetectorFeatureAdditionalConfiguration>
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    name String
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    detectorId string
    Amazon GuardDuty detector ID.
    status string
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    additionalConfigurations DetectorFeatureAdditionalConfiguration[]
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    name string
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    detector_id str
    Amazon GuardDuty detector ID.
    status str
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    additional_configurations Sequence[DetectorFeatureAdditionalConfigurationArgs]
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    name str
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    detectorId String
    Amazon GuardDuty detector ID.
    status String
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    additionalConfigurations List<Property Map>
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    name String
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DetectorFeature Resource

    Get an existing DetectorFeature 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?: DetectorFeatureState, opts?: CustomResourceOptions): DetectorFeature
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_configurations: Optional[Sequence[DetectorFeatureAdditionalConfigurationArgs]] = None,
            detector_id: Optional[str] = None,
            name: Optional[str] = None,
            status: Optional[str] = None) -> DetectorFeature
    func GetDetectorFeature(ctx *Context, name string, id IDInput, state *DetectorFeatureState, opts ...ResourceOption) (*DetectorFeature, error)
    public static DetectorFeature Get(string name, Input<string> id, DetectorFeatureState? state, CustomResourceOptions? opts = null)
    public static DetectorFeature get(String name, Output<String> id, DetectorFeatureState 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:
    AdditionalConfigurations List<DetectorFeatureAdditionalConfiguration>
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    DetectorId string
    Amazon GuardDuty detector ID.
    Name string
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    Status string
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    AdditionalConfigurations []DetectorFeatureAdditionalConfigurationArgs
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    DetectorId string
    Amazon GuardDuty detector ID.
    Name string
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    Status string
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    additionalConfigurations List<DetectorFeatureAdditionalConfiguration>
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    detectorId String
    Amazon GuardDuty detector ID.
    name String
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    status String
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    additionalConfigurations DetectorFeatureAdditionalConfiguration[]
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    detectorId string
    Amazon GuardDuty detector ID.
    name string
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    status string
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    additional_configurations Sequence[DetectorFeatureAdditionalConfigurationArgs]
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    detector_id str
    Amazon GuardDuty detector ID.
    name str
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    status str
    The status of the detector feature. Valid values: ENABLED, DISABLED.
    additionalConfigurations List<Property Map>
    Additional feature configuration block for featuresEKS_RUNTIME_MONITORING or RUNTIME_MONITORING. See below.
    detectorId String
    Amazon GuardDuty detector ID.
    name String
    The name of the detector feature. Valid values: S3_DATA_EVENTS, EKS_AUDIT_LOGS, EBS_MALWARE_PROTECTION, RDS_LOGIN_EVENTS, EKS_RUNTIME_MONITORING, LAMBDA_NETWORK_LOGS, RUNTIME_MONITORING. Only one of two features EKS_RUNTIME_MONITORING or RUNTIME_MONITORING can be added, adding both features will cause an error. Refer to the AWS Documentation for the current list of supported values.
    status String
    The status of the detector feature. Valid values: ENABLED, DISABLED.

    Supporting Types

    DetectorFeatureAdditionalConfiguration, DetectorFeatureAdditionalConfigurationArgs

    Name string
    The name of the additional configuration for a feature. Valid values: EKS_ADDON_MANAGEMENT, ECS_FARGATE_AGENT_MANAGEMENT, EC2_AGENT_MANAGEMENT. Refer to the AWS Documentation for the current list of supported values.
    Status string
    The status of the additional configuration. Valid values: ENABLED, DISABLED.
    Name string
    The name of the additional configuration for a feature. Valid values: EKS_ADDON_MANAGEMENT, ECS_FARGATE_AGENT_MANAGEMENT, EC2_AGENT_MANAGEMENT. Refer to the AWS Documentation for the current list of supported values.
    Status string
    The status of the additional configuration. Valid values: ENABLED, DISABLED.
    name String
    The name of the additional configuration for a feature. Valid values: EKS_ADDON_MANAGEMENT, ECS_FARGATE_AGENT_MANAGEMENT, EC2_AGENT_MANAGEMENT. Refer to the AWS Documentation for the current list of supported values.
    status String
    The status of the additional configuration. Valid values: ENABLED, DISABLED.
    name string
    The name of the additional configuration for a feature. Valid values: EKS_ADDON_MANAGEMENT, ECS_FARGATE_AGENT_MANAGEMENT, EC2_AGENT_MANAGEMENT. Refer to the AWS Documentation for the current list of supported values.
    status string
    The status of the additional configuration. Valid values: ENABLED, DISABLED.
    name str
    The name of the additional configuration for a feature. Valid values: EKS_ADDON_MANAGEMENT, ECS_FARGATE_AGENT_MANAGEMENT, EC2_AGENT_MANAGEMENT. Refer to the AWS Documentation for the current list of supported values.
    status str
    The status of the additional configuration. Valid values: ENABLED, DISABLED.
    name String
    The name of the additional configuration for a feature. Valid values: EKS_ADDON_MANAGEMENT, ECS_FARGATE_AGENT_MANAGEMENT, EC2_AGENT_MANAGEMENT. Refer to the AWS Documentation for the current list of supported values.
    status String
    The status of the additional configuration. Valid values: ENABLED, DISABLED.

    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.45.2 published on Tuesday, Jul 23, 2024 by Pulumi