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

formal.IntegrationDataCatalog

Explore with Pulumi AI

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

    Registering a Data Catalog integration.

    Create IntegrationDataCatalog Resource

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

    Constructor syntax

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

@overload
def IntegrationDataCatalog(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           sync_direction: Optional[str] = None,
                           synced_entities: Optional[Sequence[str]] = None,
                           datahub: Optional[IntegrationDataCatalogDatahubArgs] = None,
                           name: Optional[str] = None)
    func NewIntegrationDataCatalog(ctx *Context, name string, args IntegrationDataCatalogArgs, opts ...ResourceOption) (*IntegrationDataCatalog, error)
    public IntegrationDataCatalog(string name, IntegrationDataCatalogArgs args, CustomResourceOptions? opts = null)
    public IntegrationDataCatalog(String name, IntegrationDataCatalogArgs args)
public IntegrationDataCatalog(String name, IntegrationDataCatalogArgs args, CustomResourceOptions options)

    type: formal:IntegrationDataCatalog
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 IntegrationDataCatalogArgs
    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 IntegrationDataCatalogArgs
    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 IntegrationDataCatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationDataCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationDataCatalogArgs
    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 integrationDataCatalogResource = new Pulumi.IntegrationDataCatalog("integrationDataCatalogResource", new()
{
    SyncDirection = "string",
    SyncedEntities = new[]
    {
        "string",
    },
    Datahub = new Pulumi.Inputs.IntegrationDataCatalogDatahubArgs
    {
        ApiKey = "string",
        GeneralizedMetadataServiceUrl = "string",
        WebhookSecret = "string",
    },
    Name = "string",
});

    example, err := formal.NewIntegrationDataCatalog(ctx, "integrationDataCatalogResource", &formal.IntegrationDataCatalogArgs{
	SyncDirection: pulumi.String("string"),
	SyncedEntities: pulumi.StringArray{
		pulumi.String("string"),
	},
	Datahub: &formal.IntegrationDataCatalogDatahubArgs{
		ApiKey:                        pulumi.String("string"),
		GeneralizedMetadataServiceUrl: pulumi.String("string"),
		WebhookSecret:                 pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var integrationDataCatalogResource = new IntegrationDataCatalog("integrationDataCatalogResource", IntegrationDataCatalogArgs.builder()
    .syncDirection("string")
    .syncedEntities("string")
    .datahub(IntegrationDataCatalogDatahubArgs.builder()
        .apiKey("string")
        .generalizedMetadataServiceUrl("string")
        .webhookSecret("string")
        .build())
    .name("string")
    .build());

    integration_data_catalog_resource = formal.IntegrationDataCatalog("integrationDataCatalogResource",
    sync_direction="string",
    synced_entities=["string"],
    datahub={
        "api_key": "string",
        "generalized_metadata_service_url": "string",
        "webhook_secret": "string",
    },
    name="string")

    const integrationDataCatalogResource = new formal.IntegrationDataCatalog("integrationDataCatalogResource", {
    syncDirection: "string",
    syncedEntities: ["string"],
    datahub: {
        apiKey: "string",
        generalizedMetadataServiceUrl: "string",
        webhookSecret: "string",
    },
    name: "string",
});

    type: formal:IntegrationDataCatalog
properties:
    datahub:
        apiKey: string
        generalizedMetadataServiceUrl: string
        webhookSecret: string
    name: string
    syncDirection: string
    syncedEntities:
        - string

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

    SyncDirection string
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    SyncedEntities List<string>
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    Datahub Formal.Pulumi.Inputs.IntegrationDataCatalogDatahub
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    Name string
    Name of the Integration
    SyncDirection string
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    SyncedEntities []string
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    Datahub IntegrationDataCatalogDatahubArgs
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    Name string
    Name of the Integration
    syncDirection String
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    syncedEntities List<String>
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    datahub IntegrationDataCatalogDatahub
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    name String
    Name of the Integration
    syncDirection string
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    syncedEntities string[]
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    datahub IntegrationDataCatalogDatahub
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    name string
    Name of the Integration
    sync_direction str
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    synced_entities Sequence[str]
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    datahub IntegrationDataCatalogDatahubArgs
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    name str
    Name of the Integration
    syncDirection String
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    syncedEntities List<String>
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    datahub Property Map
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    name String
    Name of the Integration

    Outputs

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

    Get an existing IntegrationDataCatalog 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?: IntegrationDataCatalogState, opts?: CustomResourceOptions): IntegrationDataCatalog
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        datahub: Optional[IntegrationDataCatalogDatahubArgs] = None,
        name: Optional[str] = None,
        sync_direction: Optional[str] = None,
        synced_entities: Optional[Sequence[str]] = None) -> IntegrationDataCatalog
    func GetIntegrationDataCatalog(ctx *Context, name string, id IDInput, state *IntegrationDataCatalogState, opts ...ResourceOption) (*IntegrationDataCatalog, error)
    public static IntegrationDataCatalog Get(string name, Input<string> id, IntegrationDataCatalogState? state, CustomResourceOptions? opts = null)
    public static IntegrationDataCatalog get(String name, Output<String> id, IntegrationDataCatalogState state, CustomResourceOptions options)
    resources:  _:    type: formal:IntegrationDataCatalog    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:
    Datahub Formal.Pulumi.Inputs.IntegrationDataCatalogDatahub
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    Name string
    Name of the Integration
    SyncDirection string
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    SyncedEntities List<string>
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    Datahub IntegrationDataCatalogDatahubArgs
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    Name string
    Name of the Integration
    SyncDirection string
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    SyncedEntities []string
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    datahub IntegrationDataCatalogDatahub
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    name String
    Name of the Integration
    syncDirection String
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    syncedEntities List<String>
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    datahub IntegrationDataCatalogDatahub
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    name string
    Name of the Integration
    syncDirection string
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    syncedEntities string[]
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    datahub IntegrationDataCatalogDatahubArgs
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    name str
    Name of the Integration
    sync_direction str
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    synced_entities Sequence[str]
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.
    datahub Property Map
    Configuration block for Datahub integration. This block is optional and may be omitted if not configuring a Datahub integration.
    name String
    Name of the Integration
    syncDirection String
    Sync direction of the Integration: supported values are 'bidirectional', 'formaltodatahub', 'datahubtoformal'.
    syncedEntities List<String>
    Synced entities of the Integration: currently supported values are 'tags', 'data_labels'.

    Supporting Types

    IntegrationDataCatalogDatahub, IntegrationDataCatalogDatahubArgs

    ApiKey string
    Api Key for the Datahub instance.
    GeneralizedMetadataServiceUrl string
    Generalized metadata service url for the Datahub instance.
    WebhookSecret string
    Webhook secret of the Datahub instance.
    ApiKey string
    Api Key for the Datahub instance.
    GeneralizedMetadataServiceUrl string
    Generalized metadata service url for the Datahub instance.
    WebhookSecret string
    Webhook secret of the Datahub instance.
    apiKey String
    Api Key for the Datahub instance.
    generalizedMetadataServiceUrl String
    Generalized metadata service url for the Datahub instance.
    webhookSecret String
    Webhook secret of the Datahub instance.
    apiKey string
    Api Key for the Datahub instance.
    generalizedMetadataServiceUrl string
    Generalized metadata service url for the Datahub instance.
    webhookSecret string
    Webhook secret of the Datahub instance.
    api_key str
    Api Key for the Datahub instance.
    generalized_metadata_service_url str
    Generalized metadata service url for the Datahub instance.
    webhook_secret str
    Webhook secret of the Datahub instance.
    apiKey String
    Api Key for the Datahub instance.
    generalizedMetadataServiceUrl String
    Generalized metadata service url for the Datahub instance.
    webhookSecret String
    Webhook secret of the Datahub instance.

    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