Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Postgresql Provider
  3. API Docs
  4. DefaultPrivileges
PostgreSQL v3.13.0 published on Monday, Oct 28, 2024 by Pulumi
pulumi/pulumi-postgresql

postgresql.DefaultPrivileges

Explore with Pulumi AI

postgresql logo
PostgreSQL v3.13.0 published on Monday, Oct 28, 2024 by Pulumi
pulumi/pulumi-postgresql

    The postgresql.DefaultPrivileges resource creates and manages default privileges given to a user for a database schema.

    Note: This resource needs Postgresql version 9 or above.

    Usage

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

const readOnlyTables = new postgresql.DefaultPrivileges("read_only_tables", {
    role: "test_role",
    database: "test_db",
    schema: "public",
    owner: "db_owner",
    objectType: "table",
    privileges: ["SELECT"],
});

    import pulumi
import pulumi_postgresql as postgresql

read_only_tables = postgresql.DefaultPrivileges("read_only_tables",
    role="test_role",
    database="test_db",
    schema="public",
    owner="db_owner",
    object_type="table",
    privileges=["SELECT"])

    package main

import (
	"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := postgresql.NewDefaultPrivileges(ctx, "read_only_tables", &postgresql.DefaultPrivilegesArgs{
			Role:       pulumi.String("test_role"),
			Database:   pulumi.String("test_db"),
			Schema:     pulumi.String("public"),
			Owner:      pulumi.String("db_owner"),
			ObjectType: pulumi.String("table"),
			Privileges: pulumi.StringArray{
				pulumi.String("SELECT"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

return await Deployment.RunAsync(() => 
{
    var readOnlyTables = new PostgreSql.DefaultPrivileges("read_only_tables", new()
    {
        Role = "test_role",
        Database = "test_db",
        Schema = "public",
        Owner = "db_owner",
        ObjectType = "table",
        Privileges = new[]
        {
            "SELECT",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.DefaultPrivileges;
import com.pulumi.postgresql.DefaultPrivilegesArgs;
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 readOnlyTables = new DefaultPrivileges("readOnlyTables", DefaultPrivilegesArgs.builder()
            .role("test_role")
            .database("test_db")
            .schema("public")
            .owner("db_owner")
            .objectType("table")
            .privileges("SELECT")
            .build());

    }
}

    resources:
  readOnlyTables:
    type: postgresql:DefaultPrivileges
    name: read_only_tables
    properties:
      role: test_role
      database: test_db
      schema: public
      owner: db_owner
      objectType: table
      privileges:
        - SELECT

    Examples

    Revoke default privileges for functions for “public” role:

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

const revokePublic = new postgresql.DefaultPrivileges("revoke_public", {
    database: exampleDb.name,
    role: "public",
    owner: "object_owner",
    objectType: "function",
    privileges: [],
});

    import pulumi
import pulumi_postgresql as postgresql

revoke_public = postgresql.DefaultPrivileges("revoke_public",
    database=example_db["name"],
    role="public",
    owner="object_owner",
    object_type="function",
    privileges=[])

    package main

import (
	"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := postgresql.NewDefaultPrivileges(ctx, "revoke_public", &postgresql.DefaultPrivilegesArgs{
			Database:   pulumi.Any(exampleDb.Name),
			Role:       pulumi.String("public"),
			Owner:      pulumi.String("object_owner"),
			ObjectType: pulumi.String("function"),
			Privileges: pulumi.StringArray{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

return await Deployment.RunAsync(() => 
{
    var revokePublic = new PostgreSql.DefaultPrivileges("revoke_public", new()
    {
        Database = exampleDb.Name,
        Role = "public",
        Owner = "object_owner",
        ObjectType = "function",
        Privileges = new[] {},
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.DefaultPrivileges;
import com.pulumi.postgresql.DefaultPrivilegesArgs;
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 revokePublic = new DefaultPrivileges("revokePublic", DefaultPrivilegesArgs.builder()
            .database(exampleDb.name())
            .role("public")
            .owner("object_owner")
            .objectType("function")
            .privileges()
            .build());

    }
}

    resources:
  revokePublic:
    type: postgresql:DefaultPrivileges
    name: revoke_public
    properties:
      database: ${exampleDb.name}
      role: public
      owner: object_owner
      objectType: function
      privileges: []

    Create DefaultPrivileges Resource

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

    Constructor syntax

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

@overload
def DefaultPrivileges(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      database: Optional[str] = None,
                      object_type: Optional[str] = None,
                      owner: Optional[str] = None,
                      privileges: Optional[Sequence[str]] = None,
                      role: Optional[str] = None,
                      schema: Optional[str] = None,
                      with_grant_option: Optional[bool] = None)
    func NewDefaultPrivileges(ctx *Context, name string, args DefaultPrivilegesArgs, opts ...ResourceOption) (*DefaultPrivileges, error)
    public DefaultPrivileges(string name, DefaultPrivilegesArgs args, CustomResourceOptions? opts = null)
    public DefaultPrivileges(String name, DefaultPrivilegesArgs args)
public DefaultPrivileges(String name, DefaultPrivilegesArgs args, CustomResourceOptions options)

    type: postgresql:DefaultPrivileges
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 DefaultPrivilegesArgs
    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 DefaultPrivilegesArgs
    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 DefaultPrivilegesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DefaultPrivilegesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DefaultPrivilegesArgs
    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 defaultPrivilegesResource = new PostgreSql.DefaultPrivileges("defaultPrivilegesResource", new()
{
    Database = "string",
    ObjectType = "string",
    Owner = "string",
    Privileges = new[]
    {
        "string",
    },
    Role = "string",
    Schema = "string",
    WithGrantOption = false,
});

    example, err := postgresql.NewDefaultPrivileges(ctx, "defaultPrivilegesResource", &postgresql.DefaultPrivilegesArgs{
	Database:   pulumi.String("string"),
	ObjectType: pulumi.String("string"),
	Owner:      pulumi.String("string"),
	Privileges: pulumi.StringArray{
		pulumi.String("string"),
	},
	Role:            pulumi.String("string"),
	Schema:          pulumi.String("string"),
	WithGrantOption: pulumi.Bool(false),
})

    var defaultPrivilegesResource = new DefaultPrivileges("defaultPrivilegesResource", DefaultPrivilegesArgs.builder()
    .database("string")
    .objectType("string")
    .owner("string")
    .privileges("string")
    .role("string")
    .schema("string")
    .withGrantOption(false)
    .build());

    default_privileges_resource = postgresql.DefaultPrivileges("defaultPrivilegesResource",
    database="string",
    object_type="string",
    owner="string",
    privileges=["string"],
    role="string",
    schema="string",
    with_grant_option=False)

    const defaultPrivilegesResource = new postgresql.DefaultPrivileges("defaultPrivilegesResource", {
    database: "string",
    objectType: "string",
    owner: "string",
    privileges: ["string"],
    role: "string",
    schema: "string",
    withGrantOption: false,
});

    type: postgresql:DefaultPrivileges
properties:
    database: string
    objectType: string
    owner: string
    privileges:
        - string
    role: string
    schema: string
    withGrantOption: false

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

    Database string
    The database to grant default privileges for this role.
    ObjectType string
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    Owner string
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    Privileges List<string>
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    Role string
    The name of the role to which grant default privileges on.
    Schema string
    The database schema to set default privileges for this role.
    WithGrantOption bool
    Permit the grant recipient to grant it to others
    Database string
    The database to grant default privileges for this role.
    ObjectType string
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    Owner string
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    Privileges []string
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    Role string
    The name of the role to which grant default privileges on.
    Schema string
    The database schema to set default privileges for this role.
    WithGrantOption bool
    Permit the grant recipient to grant it to others
    database String
    The database to grant default privileges for this role.
    objectType String
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    owner String
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    privileges List<String>
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    role String
    The name of the role to which grant default privileges on.
    schema String
    The database schema to set default privileges for this role.
    withGrantOption Boolean
    Permit the grant recipient to grant it to others
    database string
    The database to grant default privileges for this role.
    objectType string
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    owner string
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    privileges string[]
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    role string
    The name of the role to which grant default privileges on.
    schema string
    The database schema to set default privileges for this role.
    withGrantOption boolean
    Permit the grant recipient to grant it to others
    database str
    The database to grant default privileges for this role.
    object_type str
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    owner str
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    privileges Sequence[str]
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    role str
    The name of the role to which grant default privileges on.
    schema str
    The database schema to set default privileges for this role.
    with_grant_option bool
    Permit the grant recipient to grant it to others
    database String
    The database to grant default privileges for this role.
    objectType String
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    owner String
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    privileges List<String>
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    role String
    The name of the role to which grant default privileges on.
    schema String
    The database schema to set default privileges for this role.
    withGrantOption Boolean
    Permit the grant recipient to grant it to others

    Outputs

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

    Get an existing DefaultPrivileges 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?: DefaultPrivilegesState, opts?: CustomResourceOptions): DefaultPrivileges
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database: Optional[str] = None,
        object_type: Optional[str] = None,
        owner: Optional[str] = None,
        privileges: Optional[Sequence[str]] = None,
        role: Optional[str] = None,
        schema: Optional[str] = None,
        with_grant_option: Optional[bool] = None) -> DefaultPrivileges
    func GetDefaultPrivileges(ctx *Context, name string, id IDInput, state *DefaultPrivilegesState, opts ...ResourceOption) (*DefaultPrivileges, error)
    public static DefaultPrivileges Get(string name, Input<string> id, DefaultPrivilegesState? state, CustomResourceOptions? opts = null)
    public static DefaultPrivileges get(String name, Output<String> id, DefaultPrivilegesState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Database string
    The database to grant default privileges for this role.
    ObjectType string
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    Owner string
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    Privileges List<string>
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    Role string
    The name of the role to which grant default privileges on.
    Schema string
    The database schema to set default privileges for this role.
    WithGrantOption bool
    Permit the grant recipient to grant it to others
    Database string
    The database to grant default privileges for this role.
    ObjectType string
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    Owner string
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    Privileges []string
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    Role string
    The name of the role to which grant default privileges on.
    Schema string
    The database schema to set default privileges for this role.
    WithGrantOption bool
    Permit the grant recipient to grant it to others
    database String
    The database to grant default privileges for this role.
    objectType String
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    owner String
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    privileges List<String>
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    role String
    The name of the role to which grant default privileges on.
    schema String
    The database schema to set default privileges for this role.
    withGrantOption Boolean
    Permit the grant recipient to grant it to others
    database string
    The database to grant default privileges for this role.
    objectType string
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    owner string
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    privileges string[]
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    role string
    The name of the role to which grant default privileges on.
    schema string
    The database schema to set default privileges for this role.
    withGrantOption boolean
    Permit the grant recipient to grant it to others
    database str
    The database to grant default privileges for this role.
    object_type str
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    owner str
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    privileges Sequence[str]
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    role str
    The name of the role to which grant default privileges on.
    schema str
    The database schema to set default privileges for this role.
    with_grant_option bool
    Permit the grant recipient to grant it to others
    database String
    The database to grant default privileges for this role.
    objectType String
    The PostgreSQL object type to set the default privileges on (one of: table, sequence, function, type, schema).
    owner String
    Role for which apply default privileges (You can change default privileges only for objects that will be created by yourself or by roles that you are a member of).
    privileges List<String>
    The list of privileges to apply as default privileges. An empty list could be provided to revoke all default privileges for this role.
    role String
    The name of the role to which grant default privileges on.
    schema String
    The database schema to set default privileges for this role.
    withGrantOption Boolean
    Permit the grant recipient to grant it to others

    Package Details

    Repository
    PostgreSQL pulumi/pulumi-postgresql
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the postgresql Terraform Provider.
    postgresql logo
    PostgreSQL v3.13.0 published on Monday, Oct 28, 2024 by Pulumi
    pulumi/pulumi-postgresql