1. Packages
  2. Datadog Provider
  3. API Docs
  4. SensitiveDataScannerGroup
Datadog v4.49.0 published on Thursday, Apr 17, 2025 by Pulumi

datadog.SensitiveDataScannerGroup

Explore with Pulumi AI

Provides a Sensitive Data Scanner group resource.

Example Usage

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

// Create new sensitive_data_scanner_group resource
const mygroup = new datadog.SensitiveDataScannerGroup("mygroup", {
    name: "My new scanning group",
    description: "A relevant description",
    filter: {
        query: "service:my-service",
    },
    isEnabled: true,
    productLists: ["apm"],
});
Copy
import pulumi
import pulumi_datadog as datadog

# Create new sensitive_data_scanner_group resource
mygroup = datadog.SensitiveDataScannerGroup("mygroup",
    name="My new scanning group",
    description="A relevant description",
    filter={
        "query": "service:my-service",
    },
    is_enabled=True,
    product_lists=["apm"])
Copy
package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create new sensitive_data_scanner_group resource
		_, err := datadog.NewSensitiveDataScannerGroup(ctx, "mygroup", &datadog.SensitiveDataScannerGroupArgs{
			Name:        pulumi.String("My new scanning group"),
			Description: pulumi.String("A relevant description"),
			Filter: &datadog.SensitiveDataScannerGroupFilterArgs{
				Query: pulumi.String("service:my-service"),
			},
			IsEnabled: pulumi.Bool(true),
			ProductLists: pulumi.StringArray{
				pulumi.String("apm"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;

return await Deployment.RunAsync(() => 
{
    // Create new sensitive_data_scanner_group resource
    var mygroup = new Datadog.SensitiveDataScannerGroup("mygroup", new()
    {
        Name = "My new scanning group",
        Description = "A relevant description",
        Filter = new Datadog.Inputs.SensitiveDataScannerGroupFilterArgs
        {
            Query = "service:my-service",
        },
        IsEnabled = true,
        ProductLists = new[]
        {
            "apm",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.SensitiveDataScannerGroup;
import com.pulumi.datadog.SensitiveDataScannerGroupArgs;
import com.pulumi.datadog.inputs.SensitiveDataScannerGroupFilterArgs;
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) {
        // Create new sensitive_data_scanner_group resource
        var mygroup = new SensitiveDataScannerGroup("mygroup", SensitiveDataScannerGroupArgs.builder()
            .name("My new scanning group")
            .description("A relevant description")
            .filter(SensitiveDataScannerGroupFilterArgs.builder()
                .query("service:my-service")
                .build())
            .isEnabled(true)
            .productLists("apm")
            .build());

    }
}
Copy
resources:
  # Create new sensitive_data_scanner_group resource
  mygroup:
    type: datadog:SensitiveDataScannerGroup
    properties:
      name: My new scanning group
      description: A relevant description
      filter:
        query: service:my-service
      isEnabled: true
      productLists:
        - apm
Copy

Create SensitiveDataScannerGroup Resource

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

Constructor syntax

new SensitiveDataScannerGroup(name: string, args: SensitiveDataScannerGroupArgs, opts?: CustomResourceOptions);
@overload
def SensitiveDataScannerGroup(resource_name: str,
                              args: SensitiveDataScannerGroupArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def SensitiveDataScannerGroup(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              filter: Optional[SensitiveDataScannerGroupFilterArgs] = None,
                              is_enabled: Optional[bool] = None,
                              name: Optional[str] = None,
                              product_lists: Optional[Sequence[str]] = None,
                              description: Optional[str] = None)
func NewSensitiveDataScannerGroup(ctx *Context, name string, args SensitiveDataScannerGroupArgs, opts ...ResourceOption) (*SensitiveDataScannerGroup, error)
public SensitiveDataScannerGroup(string name, SensitiveDataScannerGroupArgs args, CustomResourceOptions? opts = null)
public SensitiveDataScannerGroup(String name, SensitiveDataScannerGroupArgs args)
public SensitiveDataScannerGroup(String name, SensitiveDataScannerGroupArgs args, CustomResourceOptions options)
type: datadog:SensitiveDataScannerGroup
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. SensitiveDataScannerGroupArgs
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. SensitiveDataScannerGroupArgs
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. SensitiveDataScannerGroupArgs
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. SensitiveDataScannerGroupArgs
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. SensitiveDataScannerGroupArgs
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 sensitiveDataScannerGroupResource = new Datadog.SensitiveDataScannerGroup("sensitiveDataScannerGroupResource", new()
{
    Filter = new Datadog.Inputs.SensitiveDataScannerGroupFilterArgs
    {
        Query = "string",
    },
    IsEnabled = false,
    Name = "string",
    ProductLists = new[]
    {
        "string",
    },
    Description = "string",
});
Copy
example, err := datadog.NewSensitiveDataScannerGroup(ctx, "sensitiveDataScannerGroupResource", &datadog.SensitiveDataScannerGroupArgs{
	Filter: &datadog.SensitiveDataScannerGroupFilterArgs{
		Query: pulumi.String("string"),
	},
	IsEnabled: pulumi.Bool(false),
	Name:      pulumi.String("string"),
	ProductLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
})
Copy
var sensitiveDataScannerGroupResource = new SensitiveDataScannerGroup("sensitiveDataScannerGroupResource", SensitiveDataScannerGroupArgs.builder()
    .filter(SensitiveDataScannerGroupFilterArgs.builder()
        .query("string")
        .build())
    .isEnabled(false)
    .name("string")
    .productLists("string")
    .description("string")
    .build());
Copy
sensitive_data_scanner_group_resource = datadog.SensitiveDataScannerGroup("sensitiveDataScannerGroupResource",
    filter={
        "query": "string",
    },
    is_enabled=False,
    name="string",
    product_lists=["string"],
    description="string")
Copy
const sensitiveDataScannerGroupResource = new datadog.SensitiveDataScannerGroup("sensitiveDataScannerGroupResource", {
    filter: {
        query: "string",
    },
    isEnabled: false,
    name: "string",
    productLists: ["string"],
    description: "string",
});
Copy
type: datadog:SensitiveDataScannerGroup
properties:
    description: string
    filter:
        query: string
    isEnabled: false
    name: string
    productLists:
        - string
Copy

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

Filter This property is required. SensitiveDataScannerGroupFilter
Filter object the scanning group applies.
IsEnabled This property is required. bool
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
Name This property is required. string
Name of the Datadog scanning group.
ProductLists This property is required. List<string>
List of products the scanning group applies. Valid values are logs, rum, events, apm.
Description string
Description of the Datadog scanning group.
Filter This property is required. SensitiveDataScannerGroupFilterArgs
Filter object the scanning group applies.
IsEnabled This property is required. bool
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
Name This property is required. string
Name of the Datadog scanning group.
ProductLists This property is required. []string
List of products the scanning group applies. Valid values are logs, rum, events, apm.
Description string
Description of the Datadog scanning group.
filter This property is required. SensitiveDataScannerGroupFilter
Filter object the scanning group applies.
isEnabled This property is required. Boolean
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
name This property is required. String
Name of the Datadog scanning group.
productLists This property is required. List<String>
List of products the scanning group applies. Valid values are logs, rum, events, apm.
description String
Description of the Datadog scanning group.
filter This property is required. SensitiveDataScannerGroupFilter
Filter object the scanning group applies.
isEnabled This property is required. boolean
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
name This property is required. string
Name of the Datadog scanning group.
productLists This property is required. string[]
List of products the scanning group applies. Valid values are logs, rum, events, apm.
description string
Description of the Datadog scanning group.
filter This property is required. SensitiveDataScannerGroupFilterArgs
Filter object the scanning group applies.
is_enabled This property is required. bool
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
name This property is required. str
Name of the Datadog scanning group.
product_lists This property is required. Sequence[str]
List of products the scanning group applies. Valid values are logs, rum, events, apm.
description str
Description of the Datadog scanning group.
filter This property is required. Property Map
Filter object the scanning group applies.
isEnabled This property is required. Boolean
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
name This property is required. String
Name of the Datadog scanning group.
productLists This property is required. List<String>
List of products the scanning group applies. Valid values are logs, rum, events, apm.
description String
Description of the Datadog scanning group.

Outputs

All input properties are implicitly available as output properties. Additionally, the SensitiveDataScannerGroup 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 SensitiveDataScannerGroup Resource

Get an existing SensitiveDataScannerGroup 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?: SensitiveDataScannerGroupState, opts?: CustomResourceOptions): SensitiveDataScannerGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        filter: Optional[SensitiveDataScannerGroupFilterArgs] = None,
        is_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        product_lists: Optional[Sequence[str]] = None) -> SensitiveDataScannerGroup
func GetSensitiveDataScannerGroup(ctx *Context, name string, id IDInput, state *SensitiveDataScannerGroupState, opts ...ResourceOption) (*SensitiveDataScannerGroup, error)
public static SensitiveDataScannerGroup Get(string name, Input<string> id, SensitiveDataScannerGroupState? state, CustomResourceOptions? opts = null)
public static SensitiveDataScannerGroup get(String name, Output<String> id, SensitiveDataScannerGroupState state, CustomResourceOptions options)
resources:  _:    type: datadog:SensitiveDataScannerGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Description of the Datadog scanning group.
Filter SensitiveDataScannerGroupFilter
Filter object the scanning group applies.
IsEnabled bool
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
Name string
Name of the Datadog scanning group.
ProductLists List<string>
List of products the scanning group applies. Valid values are logs, rum, events, apm.
Description string
Description of the Datadog scanning group.
Filter SensitiveDataScannerGroupFilterArgs
Filter object the scanning group applies.
IsEnabled bool
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
Name string
Name of the Datadog scanning group.
ProductLists []string
List of products the scanning group applies. Valid values are logs, rum, events, apm.
description String
Description of the Datadog scanning group.
filter SensitiveDataScannerGroupFilter
Filter object the scanning group applies.
isEnabled Boolean
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
name String
Name of the Datadog scanning group.
productLists List<String>
List of products the scanning group applies. Valid values are logs, rum, events, apm.
description string
Description of the Datadog scanning group.
filter SensitiveDataScannerGroupFilter
Filter object the scanning group applies.
isEnabled boolean
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
name string
Name of the Datadog scanning group.
productLists string[]
List of products the scanning group applies. Valid values are logs, rum, events, apm.
description str
Description of the Datadog scanning group.
filter SensitiveDataScannerGroupFilterArgs
Filter object the scanning group applies.
is_enabled bool
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
name str
Name of the Datadog scanning group.
product_lists Sequence[str]
List of products the scanning group applies. Valid values are logs, rum, events, apm.
description String
Description of the Datadog scanning group.
filter Property Map
Filter object the scanning group applies.
isEnabled Boolean
Whether or not the scanning group is enabled. If the group doesn't contain any rule or if all the rules in it are disabled, the group is force-disabled by our backend
name String
Name of the Datadog scanning group.
productLists List<String>
List of products the scanning group applies. Valid values are logs, rum, events, apm.

Supporting Types

SensitiveDataScannerGroupFilter
, SensitiveDataScannerGroupFilterArgs

Query This property is required. string
Query to filter the events.
Query This property is required. string
Query to filter the events.
query This property is required. String
Query to filter the events.
query This property is required. string
Query to filter the events.
query This property is required. str
Query to filter the events.
query This property is required. String
Query to filter the events.

Import

$ pulumi import datadog:index/sensitiveDataScannerGroup:SensitiveDataScannerGroup new_list "<group_id>"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Datadog pulumi/pulumi-datadog
License
Apache-2.0
Notes
This Pulumi package is based on the datadog Terraform Provider.