1. Registry
  2. Packages
  3. Formal Provider
  4. API Docs
  5. Provider
Viewing docs for Formal v1.2.7
published on Monday, Sep 21, 2026 by Formal
formal logo Formal
Viewing docs for Formal v1.2.7
published on Monday, Sep 21, 2026 by Formal

    The provider type for the formal package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 api_key: Optional[str] = None,
                 oidc: Optional[ProviderOidcArgs] = None,
                 retrieve_sensitive_values: Optional[bool] = None,
                 url: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:formal
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "pulumi_providers_formal" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ApiKey string
    Formal API key. May also be set with the FORMAL_API_KEY environment variable. Conflicts with oidc.
    Oidc Formal.Pulumi.Inputs.ProviderOidc
    OIDC authentication configuration. Conflicts with apiKey.
    RetrieveSensitiveValues bool
    Url string
    Formal control plane URL. Defaults to https://api.formal.ai.
    ApiKey string
    Formal API key. May also be set with the FORMAL_API_KEY environment variable. Conflicts with oidc.
    Oidc ProviderOidcArgs
    OIDC authentication configuration. Conflicts with apiKey.
    RetrieveSensitiveValues bool
    Url string
    Formal control plane URL. Defaults to https://api.formal.ai.
    api_key string
    Formal API key. May also be set with the FORMAL_API_KEY environment variable. Conflicts with oidc.
    oidc object
    OIDC authentication configuration. Conflicts with apiKey.
    retrieve_sensitive_values bool
    url string
    Formal control plane URL. Defaults to https://api.formal.ai.
    apiKey String
    Formal API key. May also be set with the FORMAL_API_KEY environment variable. Conflicts with oidc.
    oidc ProviderOidc
    OIDC authentication configuration. Conflicts with apiKey.
    retrieveSensitiveValues Boolean
    url String
    Formal control plane URL. Defaults to https://api.formal.ai.
    apiKey string
    Formal API key. May also be set with the FORMAL_API_KEY environment variable. Conflicts with oidc.
    oidc ProviderOidc
    OIDC authentication configuration. Conflicts with apiKey.
    retrieveSensitiveValues boolean
    url string
    Formal control plane URL. Defaults to https://api.formal.ai.
    api_key str
    Formal API key. May also be set with the FORMAL_API_KEY environment variable. Conflicts with oidc.
    oidc ProviderOidcArgs
    OIDC authentication configuration. Conflicts with apiKey.
    retrieve_sensitive_values bool
    url str
    Formal control plane URL. Defaults to https://api.formal.ai.
    apiKey String
    Formal API key. May also be set with the FORMAL_API_KEY environment variable. Conflicts with oidc.
    oidc Property Map
    OIDC authentication configuration. Conflicts with apiKey.
    retrieveSensitiveValues Boolean
    url String
    Formal control plane URL. Defaults to https://api.formal.ai.

    Outputs

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

    Provider Resource Methods

    TerraformConfig Method

    This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

    Using TerraformConfig

    terraformConfig(): Output<Provider.TerraformConfigResult>
    def terraform_config() -> Output[Provider.Terraform_configResult]
    func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)
    public Output<Provider.TerraformConfigResult> TerraformConfig()

    TerraformConfig Result

    Result Dictionary<string, object>
    Result map[string]interface{}
    result map(any)
    result Map<String,Object>
    result {[key: string]: any}
    result Mapping[str, Any]
    result Map<Any>

    Supporting Types

    ProviderOidc, ProviderOidcArgs

    Aws Formal.Pulumi.Inputs.ProviderOidcAws
    Mint short-lived OIDC tokens using the AWS credential chain and STS.
    Azure Formal.Pulumi.Inputs.ProviderOidcAzure
    Mint Microsoft Entra access tokens for Azure Resource Manager using AKS Workload Identity or managed identity through IMDS.
    Env string
    Name of an environment variable containing a pre-minted OIDC JWT.
    IntegrationId string
    Formal OIDC integration ID. Required for aws and azure; with env, selects the integration through X-Formal-OIDC-Integration-Id.
    Aws ProviderOidcAws
    Mint short-lived OIDC tokens using the AWS credential chain and STS.
    Azure ProviderOidcAzure
    Mint Microsoft Entra access tokens for Azure Resource Manager using AKS Workload Identity or managed identity through IMDS.
    Env string
    Name of an environment variable containing a pre-minted OIDC JWT.
    IntegrationId string
    Formal OIDC integration ID. Required for aws and azure; with env, selects the integration through X-Formal-OIDC-Integration-Id.
    aws object
    Mint short-lived OIDC tokens using the AWS credential chain and STS.
    azure object
    Mint Microsoft Entra access tokens for Azure Resource Manager using AKS Workload Identity or managed identity through IMDS.
    env string
    Name of an environment variable containing a pre-minted OIDC JWT.
    integration_id string
    Formal OIDC integration ID. Required for aws and azure; with env, selects the integration through X-Formal-OIDC-Integration-Id.
    aws ProviderOidcAws
    Mint short-lived OIDC tokens using the AWS credential chain and STS.
    azure ProviderOidcAzure
    Mint Microsoft Entra access tokens for Azure Resource Manager using AKS Workload Identity or managed identity through IMDS.
    env String
    Name of an environment variable containing a pre-minted OIDC JWT.
    integrationId String
    Formal OIDC integration ID. Required for aws and azure; with env, selects the integration through X-Formal-OIDC-Integration-Id.
    aws ProviderOidcAws
    Mint short-lived OIDC tokens using the AWS credential chain and STS.
    azure ProviderOidcAzure
    Mint Microsoft Entra access tokens for Azure Resource Manager using AKS Workload Identity or managed identity through IMDS.
    env string
    Name of an environment variable containing a pre-minted OIDC JWT.
    integrationId string
    Formal OIDC integration ID. Required for aws and azure; with env, selects the integration through X-Formal-OIDC-Integration-Id.
    aws ProviderOidcAws
    Mint short-lived OIDC tokens using the AWS credential chain and STS.
    azure ProviderOidcAzure
    Mint Microsoft Entra access tokens for Azure Resource Manager using AKS Workload Identity or managed identity through IMDS.
    env str
    Name of an environment variable containing a pre-minted OIDC JWT.
    integration_id str
    Formal OIDC integration ID. Required for aws and azure; with env, selects the integration through X-Formal-OIDC-Integration-Id.
    aws Property Map
    Mint short-lived OIDC tokens using the AWS credential chain and STS.
    azure Property Map
    Mint Microsoft Entra access tokens for Azure Resource Manager using AKS Workload Identity or managed identity through IMDS.
    env String
    Name of an environment variable containing a pre-minted OIDC JWT.
    integrationId String
    Formal OIDC integration ID. Required for aws and azure; with env, selects the integration through X-Formal-OIDC-Integration-Id.

    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
    Viewing docs for Formal v1.2.7
    published on Monday, Sep 21, 2026 by Formal

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial