Formal v1.0.3, Aug 18 25

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formal.DataDiscovery

Explore with Pulumi AI

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

Create DataDiscovery Resource

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

Constructor syntax

new DataDiscovery(name: string, args: DataDiscoveryArgs, opts?: CustomResourceOptions);

@overload
def DataDiscovery(resource_name: str,
                  args: DataDiscoveryArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def DataDiscovery(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  deletion_policy: Optional[str] = None,
                  native_user_id: Optional[str] = None,
                  resource_id: Optional[str] = None,
                  schedule: Optional[str] = None,
                  path: Optional[str] = None)

func NewDataDiscovery(ctx *Context, name string, args DataDiscoveryArgs, opts ...ResourceOption) (*DataDiscovery, error)

public DataDiscovery(string name, DataDiscoveryArgs args, CustomResourceOptions? opts = null)

public DataDiscovery(String name, DataDiscoveryArgs args)
public DataDiscovery(String name, DataDiscoveryArgs args, CustomResourceOptions options)

type: formal:DataDiscovery
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 DataDiscoveryArgs: 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 DataDiscoveryArgs: 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 DataDiscoveryArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DataDiscoveryArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DataDiscoveryArgs: 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 dataDiscoveryResource = new Pulumi.DataDiscovery("dataDiscoveryResource", new()
{
    DeletionPolicy = "string",
    NativeUserId = "string",
    ResourceId = "string",
    Schedule = "string",
    Path = "string",
});

example, err := formal.NewDataDiscovery(ctx, "dataDiscoveryResource", &formal.DataDiscoveryArgs{
	DeletionPolicy: pulumi.String("string"),
	NativeUserId:   pulumi.String("string"),
	ResourceId:     pulumi.String("string"),
	Schedule:       pulumi.String("string"),
	Path:           pulumi.String("string"),
})

var dataDiscoveryResource = new DataDiscovery("dataDiscoveryResource", DataDiscoveryArgs.builder()
    .deletionPolicy("string")
    .nativeUserId("string")
    .resourceId("string")
    .schedule("string")
    .path("string")
    .build());

data_discovery_resource = formal.DataDiscovery("dataDiscoveryResource",
    deletion_policy="string",
    native_user_id="string",
    resource_id="string",
    schedule="string",
    path="string")

const dataDiscoveryResource = new formal.DataDiscovery("dataDiscoveryResource", {
    deletionPolicy: "string",
    nativeUserId: "string",
    resourceId: "string",
    schedule: "string",
    path: "string",
});

type: formal:DataDiscovery
properties:
    deletionPolicy: string
    nativeUserId: string
    path: string
    resourceId: string
    schedule: string

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

DeletionPolicy string: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
NativeUserId string: Native user ID linked to this Data Discovery.
ResourceId string: Resource ID linked to this Data Discovery.
Schedule string: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.
Path string: Path of the inventory object.

DeletionPolicy string: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
NativeUserId string: Native user ID linked to this Data Discovery.
ResourceId string: Resource ID linked to this Data Discovery.
Schedule string: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.
Path string: Path of the inventory object.

deletionPolicy String: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
nativeUserId String: Native user ID linked to this Data Discovery.
resourceId String: Resource ID linked to this Data Discovery.
schedule String: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.
path String: Path of the inventory object.

deletionPolicy string: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
nativeUserId string: Native user ID linked to this Data Discovery.
resourceId string: Resource ID linked to this Data Discovery.
schedule string: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.
path string: Path of the inventory object.

deletion_policy str: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
native_user_id str: Native user ID linked to this Data Discovery.
resource_id str: Resource ID linked to this Data Discovery.
schedule str: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.
path str: Path of the inventory object.

deletionPolicy String: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
nativeUserId String: Native user ID linked to this Data Discovery.
resourceId String: Resource ID linked to this Data Discovery.
schedule String: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.
path String: Path of the inventory object.

Outputs

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

CreatedAt int: Creation time of the Data Discovery.
Id string: The provider-assigned unique ID for this managed resource.

CreatedAt int: Creation time of the Data Discovery.
Id string: The provider-assigned unique ID for this managed resource.

createdAt Integer: Creation time of the Data Discovery.
id String: The provider-assigned unique ID for this managed resource.

createdAt number: Creation time of the Data Discovery.
id string: The provider-assigned unique ID for this managed resource.

created_at int: Creation time of the Data Discovery.
id str: The provider-assigned unique ID for this managed resource.

createdAt Number: Creation time of the Data Discovery.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing DataDiscovery Resource

Get an existing DataDiscovery 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?: DataDiscoveryState, opts?: CustomResourceOptions): DataDiscovery

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[int] = None,
        deletion_policy: Optional[str] = None,
        native_user_id: Optional[str] = None,
        path: Optional[str] = None,
        resource_id: Optional[str] = None,
        schedule: Optional[str] = None) -> DataDiscovery

func GetDataDiscovery(ctx *Context, name string, id IDInput, state *DataDiscoveryState, opts ...ResourceOption) (*DataDiscovery, error)

public static DataDiscovery Get(string name, Input<string> id, DataDiscoveryState? state, CustomResourceOptions? opts = null)

public static DataDiscovery get(String name, Output<String> id, DataDiscoveryState state, CustomResourceOptions options)

resources:  _:    type: formal:DataDiscovery    get:      id: ${id}

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:

CreatedAt int: Creation time of the Data Discovery.
DeletionPolicy string: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
NativeUserId string: Native user ID linked to this Data Discovery.
Path string: Path of the inventory object.
ResourceId string: Resource ID linked to this Data Discovery.
Schedule string: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.

CreatedAt int: Creation time of the Data Discovery.
DeletionPolicy string: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
NativeUserId string: Native user ID linked to this Data Discovery.
Path string: Path of the inventory object.
ResourceId string: Resource ID linked to this Data Discovery.
Schedule string: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.

createdAt Integer: Creation time of the Data Discovery.
deletionPolicy String: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
nativeUserId String: Native user ID linked to this Data Discovery.
path String: Path of the inventory object.
resourceId String: Resource ID linked to this Data Discovery.
schedule String: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.

createdAt number: Creation time of the Data Discovery.
deletionPolicy string: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
nativeUserId string: Native user ID linked to this Data Discovery.
path string: Path of the inventory object.
resourceId string: Resource ID linked to this Data Discovery.
schedule string: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.

created_at int: Creation time of the Data Discovery.
deletion_policy str: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
native_user_id str: Native user ID linked to this Data Discovery.
path str: Path of the inventory object.
resource_id str: Resource ID linked to this Data Discovery.
schedule str: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.

createdAt Number: Creation time of the Data Discovery.
deletionPolicy String: Deletion policy of the Data Discovery. Possible values: delete, mark_for_deletion.
nativeUserId String: Native user ID linked to this Data Discovery.
path String: Path of the inventory object.
resourceId String: Resource ID linked to this Data Discovery.
schedule String: Schedule at which the Data Discovery will be executed. Possible values: 6h, 12h, 18h, 24h or a valid cron expression, for example 0 4,16 * * * to run daily at 04:00 and 16:00 UTC.

Package Details

Repository: formal formalco/pulumi-formal
License: MPL-2.0
Notes: This Pulumi package is based on the formal Terraform Provider.

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formalco/pulumi-formal

formal.DataDiscovery

On this page

On this page

Create DataDiscovery Resource

Constructor syntax

Parameters

Constructor example

DataDiscovery Resource Properties

Inputs

Outputs

Look up Existing DataDiscovery Resource

Package Details

On this page

On this page