PostgreSQL

Pulumi Official
Package maintained by Pulumi
v3.4.0 published on Wednesday, Apr 6, 2022 by Pulumi

DefaultPrivileges

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", {
    database: "test_db",
    objectType: "table",
    owner: "db_owner",
    privileges: ["SELECT"],
    role: "test_role",
    schema: "public",
});
import pulumi
import pulumi_postgresql as postgresql

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

class MyStack : Stack
{
    public MyStack()
    {
        var readOnlyTables = new PostgreSql.DefaultPrivileges("readOnlyTables", new PostgreSql.DefaultPrivilegesArgs
        {
            Database = "test_db",
            ObjectType = "table",
            Owner = "db_owner",
            Privileges = 
            {
                "SELECT",
            },
            Role = "test_role",
            Schema = "public",
        });
    }

}
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, "readOnlyTables", &postgresql.DefaultPrivilegesArgs{
			Database:   pulumi.String("test_db"),
			ObjectType: pulumi.String("table"),
			Owner:      pulumi.String("db_owner"),
			Privileges: pulumi.StringArray{
				pulumi.String("SELECT"),
			},
			Role:   pulumi.String("test_role"),
			Schema: pulumi.String("public"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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("revokePublic", {
    database: postgresql_database.example_db.name,
    role: "public",
    owner: "object_owner",
    objectType: "function",
    privileges: [],
});
import pulumi
import pulumi_postgresql as postgresql

revoke_public = postgresql.DefaultPrivileges("revokePublic",
    database=postgresql_database["example_db"]["name"],
    role="public",
    owner="object_owner",
    object_type="function",
    privileges=[])
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

class MyStack : Stack
{
    public MyStack()
    {
        var revokePublic = new PostgreSql.DefaultPrivileges("revokePublic", new PostgreSql.DefaultPrivilegesArgs
        {
            Database = postgresql_database.Example_db.Name,
            Role = "public",
            Owner = "object_owner",
            ObjectType = "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, "revokePublic", &postgresql.DefaultPrivilegesArgs{
			Database:   pulumi.Any(postgresql_database.Example_db.Name),
			Role:       pulumi.String("public"),
			Owner:      pulumi.String("object_owner"),
			ObjectType: pulumi.String("function"),
			Privileges: pulumi.StringArray{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Create a DefaultPrivileges Resource

new DefaultPrivileges(name: string, args: DefaultPrivilegesArgs, opts?: CustomResourceOptions);
@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)
@overload
def DefaultPrivileges(resource_name: str,
                      args: DefaultPrivilegesArgs,
                      opts: Optional[ResourceOptions] = 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.

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.

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

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).

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).

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).

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

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).

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).

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).

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

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 an 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).

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).

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).

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

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).

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).

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).

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

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
https://github.com/pulumi/pulumi-postgresql
License
Apache-2.0
Notes

This Pulumi package is based on the postgresql Terraform Provider.