Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Formal Provider
  3. API Docs
  4. DataDomain
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
formalco/pulumi-formal

formal.DataDomain

Explore with Pulumi AI

formal logo
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
formalco/pulumi-formal

    Registering a Data Domain with Formal.

    Create DataDomain Resource

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

    Constructor syntax

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

@overload
def DataDomain(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               excluded_paths: Optional[Sequence[str]] = None,
               included_paths: Optional[Sequence[str]] = None,
               owners: Optional[Sequence[DataDomainOwnerArgs]] = None,
               description: Optional[str] = None,
               name: Optional[str] = None)
    func NewDataDomain(ctx *Context, name string, args DataDomainArgs, opts ...ResourceOption) (*DataDomain, error)
    public DataDomain(string name, DataDomainArgs args, CustomResourceOptions? opts = null)
    public DataDomain(String name, DataDomainArgs args)
public DataDomain(String name, DataDomainArgs args, CustomResourceOptions options)

    type: formal:DataDomain
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 DataDomainArgs
    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 DataDomainArgs
    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 DataDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataDomainArgs
    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 dataDomainResource = new Pulumi.DataDomain("dataDomainResource", new()
{
    ExcludedPaths = new[]
    {
        "string",
    },
    IncludedPaths = new[]
    {
        "string",
    },
    Owners = new[]
    {
        new Pulumi.Inputs.DataDomainOwnerArgs
        {
            ObjectId = "string",
            ObjectType = "string",
        },
    },
    Description = "string",
    Name = "string",
});

    example, err := formal.NewDataDomain(ctx, "dataDomainResource", &formal.DataDomainArgs{
	ExcludedPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncludedPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	Owners: formal.DataDomainOwnerArray{
		&formal.DataDomainOwnerArgs{
			ObjectId:   pulumi.String("string"),
			ObjectType: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var dataDomainResource = new DataDomain("dataDomainResource", DataDomainArgs.builder()
    .excludedPaths("string")
    .includedPaths("string")
    .owners(DataDomainOwnerArgs.builder()
        .objectId("string")
        .objectType("string")
        .build())
    .description("string")
    .name("string")
    .build());

    data_domain_resource = formal.DataDomain("dataDomainResource",
    excluded_paths=["string"],
    included_paths=["string"],
    owners=[{
        "object_id": "string",
        "object_type": "string",
    }],
    description="string",
    name="string")

    const dataDomainResource = new formal.DataDomain("dataDomainResource", {
    excludedPaths: ["string"],
    includedPaths: ["string"],
    owners: [{
        objectId: "string",
        objectType: "string",
    }],
    description: "string",
    name: "string",
});

    type: formal:DataDomain
properties:
    description: string
    excludedPaths:
        - string
    includedPaths:
        - string
    name: string
    owners:
        - objectId: string
          objectType: string

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

    ExcludedPaths List<string>
    Excluded paths of this data domain.
    IncludedPaths List<string>
    Included paths of this data domain.
    Owners List<Formal.Pulumi.Inputs.DataDomainOwner>
    Owners of this policy.
    Description string
    Description of the data domain.
    Name string
    Name of the data domain.
    ExcludedPaths []string
    Excluded paths of this data domain.
    IncludedPaths []string
    Included paths of this data domain.
    Owners []DataDomainOwnerArgs
    Owners of this policy.
    Description string
    Description of the data domain.
    Name string
    Name of the data domain.
    excludedPaths List<String>
    Excluded paths of this data domain.
    includedPaths List<String>
    Included paths of this data domain.
    owners List<DataDomainOwner>
    Owners of this policy.
    description String
    Description of the data domain.
    name String
    Name of the data domain.
    excludedPaths string[]
    Excluded paths of this data domain.
    includedPaths string[]
    Included paths of this data domain.
    owners DataDomainOwner[]
    Owners of this policy.
    description string
    Description of the data domain.
    name string
    Name of the data domain.
    excluded_paths Sequence[str]
    Excluded paths of this data domain.
    included_paths Sequence[str]
    Included paths of this data domain.
    owners Sequence[DataDomainOwnerArgs]
    Owners of this policy.
    description str
    Description of the data domain.
    name str
    Name of the data domain.
    excludedPaths List<String>
    Excluded paths of this data domain.
    includedPaths List<String>
    Included paths of this data domain.
    owners List<Property Map>
    Owners of this policy.
    description String
    Description of the data domain.
    name String
    Name of the data domain.

    Outputs

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

    CreatedAt string
    When the policy was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last update time.
    CreatedAt string
    When the policy was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last update time.
    createdAt String
    When the policy was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last update time.
    createdAt string
    When the policy was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    Last update time.
    created_at str
    When the policy was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    Last update time.
    createdAt String
    When the policy was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last update time.

    Look up Existing DataDomain Resource

    Get an existing DataDomain 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?: DataDomainState, opts?: CustomResourceOptions): DataDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        excluded_paths: Optional[Sequence[str]] = None,
        included_paths: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        owners: Optional[Sequence[DataDomainOwnerArgs]] = None,
        updated_at: Optional[str] = None) -> DataDomain
    func GetDataDomain(ctx *Context, name string, id IDInput, state *DataDomainState, opts ...ResourceOption) (*DataDomain, error)
    public static DataDomain Get(string name, Input<string> id, DataDomainState? state, CustomResourceOptions? opts = null)
    public static DataDomain get(String name, Output<String> id, DataDomainState state, CustomResourceOptions options)
    resources:  _:    type: formal:DataDomain    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 string
    When the policy was created.
    Description string
    Description of the data domain.
    ExcludedPaths List<string>
    Excluded paths of this data domain.
    IncludedPaths List<string>
    Included paths of this data domain.
    Name string
    Name of the data domain.
    Owners List<Formal.Pulumi.Inputs.DataDomainOwner>
    Owners of this policy.
    UpdatedAt string
    Last update time.
    CreatedAt string
    When the policy was created.
    Description string
    Description of the data domain.
    ExcludedPaths []string
    Excluded paths of this data domain.
    IncludedPaths []string
    Included paths of this data domain.
    Name string
    Name of the data domain.
    Owners []DataDomainOwnerArgs
    Owners of this policy.
    UpdatedAt string
    Last update time.
    createdAt String
    When the policy was created.
    description String
    Description of the data domain.
    excludedPaths List<String>
    Excluded paths of this data domain.
    includedPaths List<String>
    Included paths of this data domain.
    name String
    Name of the data domain.
    owners List<DataDomainOwner>
    Owners of this policy.
    updatedAt String
    Last update time.
    createdAt string
    When the policy was created.
    description string
    Description of the data domain.
    excludedPaths string[]
    Excluded paths of this data domain.
    includedPaths string[]
    Included paths of this data domain.
    name string
    Name of the data domain.
    owners DataDomainOwner[]
    Owners of this policy.
    updatedAt string
    Last update time.
    created_at str
    When the policy was created.
    description str
    Description of the data domain.
    excluded_paths Sequence[str]
    Excluded paths of this data domain.
    included_paths Sequence[str]
    Included paths of this data domain.
    name str
    Name of the data domain.
    owners Sequence[DataDomainOwnerArgs]
    Owners of this policy.
    updated_at str
    Last update time.
    createdAt String
    When the policy was created.
    description String
    Description of the data domain.
    excludedPaths List<String>
    Excluded paths of this data domain.
    includedPaths List<String>
    Included paths of this data domain.
    name String
    Name of the data domain.
    owners List<Property Map>
    Owners of this policy.
    updatedAt String
    Last update time.

    Supporting Types

    DataDomainOwner, DataDomainOwnerArgs

    ObjectId string
    ObjectType string
    ObjectId string
    ObjectType string
    objectId String
    objectType String
    objectId string
    objectType string
    objectId String
    objectType String

    Package Details

    Repository
    formal formalco/pulumi-formal
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the formal Terraform Provider.
    formal logo
    Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
    formalco/pulumi-formal