Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Supabase Provider
  3. API Docs
  4. Settings
supabase 1.5.1 published on Wednesday, Jan 15, 2025 by supabase
supabase/terraform-provider-supabase

supabase.Settings

Explore with Pulumi AI

supabase 1.5.1 published on Wednesday, Jan 15, 2025 by supabase
supabase/terraform-provider-supabase

Settings resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as supabase from "@pulumi/supabase";

const production = new supabase.Settings("production", {
    projectRef: "mayuaycdtijbctgqbycg",
    database: JSON.stringify({
        statement_timeout: "10s",
    }),
    network: JSON.stringify({
        restrictions: [
            "0.0.0.0/0",
            "::/0",
        ],
    }),
    api: JSON.stringify({
        db_schema: "public,storage,graphql_public",
        db_extra_search_path: "public,extensions",
        max_rows: 1000,
    }),
    auth: JSON.stringify({
        site_url: "http://localhost:3000",
        mailer_otp_exp: 3600,
        mfa_phone_otp_length: 6,
        sms_otp_length: 6,
    }),
});
Copy
import pulumi
import json
import pulumi_supabase as supabase

production = supabase.Settings("production",
    project_ref="mayuaycdtijbctgqbycg",
    database=json.dumps({
        "statement_timeout": "10s",
    }),
    network=json.dumps({
        "restrictions": [
            "0.0.0.0/0",
            "::/0",
        ],
    }),
    api=json.dumps({
        "db_schema": "public,storage,graphql_public",
        "db_extra_search_path": "public,extensions",
        "max_rows": 1000,
    }),
    auth=json.dumps({
        "site_url": "http://localhost:3000",
        "mailer_otp_exp": 3600,
        "mfa_phone_otp_length": 6,
        "sms_otp_length": 6,
    }))
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/supabase/supabase"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"statement_timeout": "10s",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"restrictions": []string{
				"0.0.0.0/0",
				"::/0",
			},
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		tmpJSON2, err := json.Marshal(map[string]interface{}{
			"db_schema":            "public,storage,graphql_public",
			"db_extra_search_path": "public,extensions",
			"max_rows":             1000,
		})
		if err != nil {
			return err
		}
		json2 := string(tmpJSON2)
		tmpJSON3, err := json.Marshal(map[string]interface{}{
			"site_url":             "http://localhost:3000",
			"mailer_otp_exp":       3600,
			"mfa_phone_otp_length": 6,
			"sms_otp_length":       6,
		})
		if err != nil {
			return err
		}
		json3 := string(tmpJSON3)
		_, err = supabase.NewSettings(ctx, "production", &supabase.SettingsArgs{
			ProjectRef: pulumi.String("mayuaycdtijbctgqbycg"),
			Database:   pulumi.String(json0),
			Network:    pulumi.String(json1),
			Api:        pulumi.String(json2),
			Auth:       pulumi.String(json3),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Supabase = Pulumi.Supabase;

return await Deployment.RunAsync(() => 
{
    var production = new Supabase.Settings("production", new()
    {
        ProjectRef = "mayuaycdtijbctgqbycg",
        Database = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["statement_timeout"] = "10s",
        }),
        Network = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["restrictions"] = new[]
            {
                "0.0.0.0/0",
                "::/0",
            },
        }),
        Api = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["db_schema"] = "public,storage,graphql_public",
            ["db_extra_search_path"] = "public,extensions",
            ["max_rows"] = 1000,
        }),
        Auth = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["site_url"] = "http://localhost:3000",
            ["mailer_otp_exp"] = 3600,
            ["mfa_phone_otp_length"] = 6,
            ["sms_otp_length"] = 6,
        }),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.supabase.Settings;
import com.pulumi.supabase.SettingsArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var production = new Settings("production", SettingsArgs.builder()
            .projectRef("mayuaycdtijbctgqbycg")
            .database(serializeJson(
                jsonObject(
                    jsonProperty("statement_timeout", "10s")
                )))
            .network(serializeJson(
                jsonObject(
                    jsonProperty("restrictions", jsonArray(
                        "0.0.0.0/0", 
                        "::/0"
                    ))
                )))
            .api(serializeJson(
                jsonObject(
                    jsonProperty("db_schema", "public,storage,graphql_public"),
                    jsonProperty("db_extra_search_path", "public,extensions"),
                    jsonProperty("max_rows", 1000)
                )))
            .auth(serializeJson(
                jsonObject(
                    jsonProperty("site_url", "http://localhost:3000"),
                    jsonProperty("mailer_otp_exp", 3600),
                    jsonProperty("mfa_phone_otp_length", 6),
                    jsonProperty("sms_otp_length", 6)
                )))
            .build());

    }
}
Copy
resources:
  production:
    type: supabase:Settings
    properties:
      projectRef: mayuaycdtijbctgqbycg
      database:
        fn::toJSON:
          statement_timeout: 10s
      network:
        fn::toJSON:
          restrictions:
            - 0.0.0.0/0
            - ::/0
      api:
        fn::toJSON:
          db_schema: public,storage,graphql_public
          db_extra_search_path: public,extensions
          max_rows: 1000
      auth:
        fn::toJSON:
          site_url: http://localhost:3000
          mailer_otp_exp: 3600
          mfa_phone_otp_length: 6
          sms_otp_length: 6
Copy

Create Settings Resource

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

Constructor syntax

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

@overload
def Settings(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             project_ref: Optional[str] = None,
             api: Optional[str] = None,
             auth: Optional[str] = None,
             database: Optional[str] = None,
             network: Optional[str] = None,
             pooler: Optional[str] = None,
             storage: Optional[str] = None)
func NewSettings(ctx *Context, name string, args SettingsArgs, opts ...ResourceOption) (*Settings, error)
public Settings(string name, SettingsArgs args, CustomResourceOptions? opts = null)
public Settings(String name, SettingsArgs args)
public Settings(String name, SettingsArgs args, CustomResourceOptions options)

type: supabase:Settings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SettingsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SettingsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SettingsArgs
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 settingsResource = new Supabase.Settings("settingsResource", new()
{
    ProjectRef = "string",
    Api = "string",
    Auth = "string",
    Database = "string",
    Network = "string",
    Pooler = "string",
    Storage = "string",
});
Copy
example, err := supabase.NewSettings(ctx, "settingsResource", &supabase.SettingsArgs{
	ProjectRef: pulumi.String("string"),
	Api:        pulumi.String("string"),
	Auth:       pulumi.String("string"),
	Database:   pulumi.String("string"),
	Network:    pulumi.String("string"),
	Pooler:     pulumi.String("string"),
	Storage:    pulumi.String("string"),
})
Copy
var settingsResource = new Settings("settingsResource", SettingsArgs.builder()
    .projectRef("string")
    .api("string")
    .auth("string")
    .database("string")
    .network("string")
    .pooler("string")
    .storage("string")
    .build());
Copy
settings_resource = supabase.Settings("settingsResource",
    project_ref="string",
    api="string",
    auth="string",
    database="string",
    network="string",
    pooler="string",
    storage="string")
Copy
const settingsResource = new supabase.Settings("settingsResource", {
    projectRef: "string",
    api: "string",
    auth: "string",
    database: "string",
    network: "string",
    pooler: "string",
    storage: "string",
});
Copy
type: supabase:Settings
properties:
    api: string
    auth: string
    database: string
    network: string
    pooler: string
    projectRef: string
    storage: string
Copy

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

ProjectRef This property is required. string
Project reference ID
Api string
API settings as serialised JSON
Auth string
Auth settings as serialised JSON
Database string
Database settings as serialised JSON
Network string
Network settings as serialised JSON
Pooler string
Pooler settings as serialised JSON
Storage string
Storage settings as serialised JSON
ProjectRef This property is required. string
Project reference ID
Api string
API settings as serialised JSON
Auth string
Auth settings as serialised JSON
Database string
Database settings as serialised JSON
Network string
Network settings as serialised JSON
Pooler string
Pooler settings as serialised JSON
Storage string
Storage settings as serialised JSON
projectRef This property is required. String
Project reference ID
api String
API settings as serialised JSON
auth String
Auth settings as serialised JSON
database String
Database settings as serialised JSON
network String
Network settings as serialised JSON
pooler String
Pooler settings as serialised JSON
storage String
Storage settings as serialised JSON
projectRef This property is required. string
Project reference ID
api string
API settings as serialised JSON
auth string
Auth settings as serialised JSON
database string
Database settings as serialised JSON
network string
Network settings as serialised JSON
pooler string
Pooler settings as serialised JSON
storage string
Storage settings as serialised JSON
project_ref This property is required. str
Project reference ID
api str
API settings as serialised JSON
auth str
Auth settings as serialised JSON
database str
Database settings as serialised JSON
network str
Network settings as serialised JSON
pooler str
Pooler settings as serialised JSON
storage str
Storage settings as serialised JSON
projectRef This property is required. String
Project reference ID
api String
API settings as serialised JSON
auth String
Auth settings as serialised JSON
database String
Database settings as serialised JSON
network String
Network settings as serialised JSON
pooler String
Pooler settings as serialised JSON
storage String
Storage settings as serialised JSON

Outputs

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

Get an existing Settings 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?: SettingsState, opts?: CustomResourceOptions): Settings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api: Optional[str] = None,
        auth: Optional[str] = None,
        database: Optional[str] = None,
        network: Optional[str] = None,
        pooler: Optional[str] = None,
        project_ref: Optional[str] = None,
        storage: Optional[str] = None) -> Settings
func GetSettings(ctx *Context, name string, id IDInput, state *SettingsState, opts ...ResourceOption) (*Settings, error)
public static Settings Get(string name, Input<string> id, SettingsState? state, CustomResourceOptions? opts = null)
public static Settings get(String name, Output<String> id, SettingsState state, CustomResourceOptions options)
resources:  _:    type: supabase:Settings    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Api string
API settings as serialised JSON
Auth string
Auth settings as serialised JSON
Database string
Database settings as serialised JSON
Network string
Network settings as serialised JSON
Pooler string
Pooler settings as serialised JSON
ProjectRef string
Project reference ID
Storage string
Storage settings as serialised JSON
Api string
API settings as serialised JSON
Auth string
Auth settings as serialised JSON
Database string
Database settings as serialised JSON
Network string
Network settings as serialised JSON
Pooler string
Pooler settings as serialised JSON
ProjectRef string
Project reference ID
Storage string
Storage settings as serialised JSON
api String
API settings as serialised JSON
auth String
Auth settings as serialised JSON
database String
Database settings as serialised JSON
network String
Network settings as serialised JSON
pooler String
Pooler settings as serialised JSON
projectRef String
Project reference ID
storage String
Storage settings as serialised JSON
api string
API settings as serialised JSON
auth string
Auth settings as serialised JSON
database string
Database settings as serialised JSON
network string
Network settings as serialised JSON
pooler string
Pooler settings as serialised JSON
projectRef string
Project reference ID
storage string
Storage settings as serialised JSON
api str
API settings as serialised JSON
auth str
Auth settings as serialised JSON
database str
Database settings as serialised JSON
network str
Network settings as serialised JSON
pooler str
Pooler settings as serialised JSON
project_ref str
Project reference ID
storage str
Storage settings as serialised JSON
api String
API settings as serialised JSON
auth String
Auth settings as serialised JSON
database String
Database settings as serialised JSON
network String
Network settings as serialised JSON
pooler String
Pooler settings as serialised JSON
projectRef String
Project reference ID
storage String
Storage settings as serialised JSON

Package Details

Repository
supabase supabase/terraform-provider-supabase
License
Notes
This Pulumi package is based on the supabase Terraform Provider.
supabase 1.5.1 published on Wednesday, Jan 15, 2025 by supabase
supabase/terraform-provider-supabase