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

formal.IntegrationBi

Explore with Pulumi AI

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

    Registering a BI App.

    Create IntegrationBi Resource

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

    Constructor syntax

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

@overload
def IntegrationBi(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  sync: Optional[bool] = None,
                  metabase: Optional[IntegrationBiMetabaseArgs] = None,
                  name: Optional[str] = None)
    func NewIntegrationBi(ctx *Context, name string, args IntegrationBiArgs, opts ...ResourceOption) (*IntegrationBi, error)
    public IntegrationBi(string name, IntegrationBiArgs args, CustomResourceOptions? opts = null)
    public IntegrationBi(String name, IntegrationBiArgs args)
public IntegrationBi(String name, IntegrationBiArgs args, CustomResourceOptions options)

    type: formal:IntegrationBi
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 IntegrationBiArgs
    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 IntegrationBiArgs
    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 IntegrationBiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationBiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationBiArgs
    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 integrationBiResource = new Pulumi.IntegrationBi("integrationBiResource", new()
{
    Sync = false,
    Metabase = new Pulumi.Inputs.IntegrationBiMetabaseArgs
    {
        Hostname = "string",
        Password = "string",
        Username = "string",
    },
    Name = "string",
});

    example, err := formal.NewIntegrationBi(ctx, "integrationBiResource", &formal.IntegrationBiArgs{
	Sync: pulumi.Bool(false),
	Metabase: &formal.IntegrationBiMetabaseArgs{
		Hostname: pulumi.String("string"),
		Password: pulumi.String("string"),
		Username: pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var integrationBiResource = new IntegrationBi("integrationBiResource", IntegrationBiArgs.builder()
    .sync(false)
    .metabase(IntegrationBiMetabaseArgs.builder()
        .hostname("string")
        .password("string")
        .username("string")
        .build())
    .name("string")
    .build());

    integration_bi_resource = formal.IntegrationBi("integrationBiResource",
    sync=False,
    metabase={
        "hostname": "string",
        "password": "string",
        "username": "string",
    },
    name="string")

    const integrationBiResource = new formal.IntegrationBi("integrationBiResource", {
    sync: false,
    metabase: {
        hostname: "string",
        password: "string",
        username: "string",
    },
    name: "string",
});

    type: formal:IntegrationBi
properties:
    metabase:
        hostname: string
        password: string
        username: string
    name: string
    sync: false

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

    Sync bool
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    Metabase Formal.Pulumi.Inputs.IntegrationBiMetabase
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    Name string
    Friendly name for the App.
    Sync bool
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    Metabase IntegrationBiMetabaseArgs
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    Name string
    Friendly name for the App.
    sync Boolean
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    metabase IntegrationBiMetabase
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    name String
    Friendly name for the App.
    sync boolean
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    metabase IntegrationBiMetabase
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    name string
    Friendly name for the App.
    sync bool
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    metabase IntegrationBiMetabaseArgs
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    name str
    Friendly name for the App.
    sync Boolean
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    metabase Property Map
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    name String
    Friendly name for the App.

    Outputs

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

    Get an existing IntegrationBi 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?: IntegrationBiState, opts?: CustomResourceOptions): IntegrationBi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        metabase: Optional[IntegrationBiMetabaseArgs] = None,
        name: Optional[str] = None,
        sync: Optional[bool] = None) -> IntegrationBi
    func GetIntegrationBi(ctx *Context, name string, id IDInput, state *IntegrationBiState, opts ...ResourceOption) (*IntegrationBi, error)
    public static IntegrationBi Get(string name, Input<string> id, IntegrationBiState? state, CustomResourceOptions? opts = null)
    public static IntegrationBi get(String name, Output<String> id, IntegrationBiState state, CustomResourceOptions options)
    resources:  _:    type: formal:IntegrationBi    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:
    Metabase Formal.Pulumi.Inputs.IntegrationBiMetabase
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    Name string
    Friendly name for the App.
    Sync bool
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    Metabase IntegrationBiMetabaseArgs
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    Name string
    Friendly name for the App.
    Sync bool
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    metabase IntegrationBiMetabase
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    name String
    Friendly name for the App.
    sync Boolean
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    metabase IntegrationBiMetabase
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    name string
    Friendly name for the App.
    sync boolean
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    metabase IntegrationBiMetabaseArgs
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    name str
    Friendly name for the App.
    sync bool
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.
    metabase Property Map
    Configuration block for Metabase integration. This block is optional and may be omitted if not configuring a Metabase integration.
    name String
    Friendly name for the App.
    sync Boolean
    Auto synchronize users from Metabase to Formal (occurs every hour). Note that a lambda worker will need to be deployed in your infrastructure to synchronise users.

    Supporting Types

    IntegrationBiMetabase, IntegrationBiMetabaseArgs

    Hostname string
    Hostname of the Metabase instance.
    Password string
    Password for the Metabase instance.
    Username string
    Username for the Metabase instance.
    Hostname string
    Hostname of the Metabase instance.
    Password string
    Password for the Metabase instance.
    Username string
    Username for the Metabase instance.
    hostname String
    Hostname of the Metabase instance.
    password String
    Password for the Metabase instance.
    username String
    Username for the Metabase instance.
    hostname string
    Hostname of the Metabase instance.
    password string
    Password for the Metabase instance.
    username string
    Username for the Metabase instance.
    hostname str
    Hostname of the Metabase instance.
    password str
    Password for the Metabase instance.
    username str
    Username for the Metabase instance.
    hostname String
    Hostname of the Metabase instance.
    password String
    Password for the Metabase instance.
    username String
    Username for the Metabase 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