Role class
The postgresql.Role resource creates and manages a role on a PostgreSQL
server.
When a postgresql.Role resource is removed, the PostgreSQL ROLE will
automatically run a REASSIGN OWNED
and DROP OWNED to
the CURRENT_USER (normally the connected user for the provider). If the
specified PostgreSQL ROLE owns objects in multiple PostgreSQL databases in the
same PostgreSQL Cluster, one PostgreSQL provider per database must be created
and all but the final postgresql.Role must specify a skipDropRole.
> Note: All arguments including role name and password will be stored in the raw state as plain-text. Read more about sensitive data in state.
> Note: For enhanced security, consider using the passwordWo and passwordWoVersion attributes
instead of password. The write-only password attributes prevent the password from being stored in
the Terraform state file while still allowing password management through version-controlled updates.
Usage
import * as pulumi from "@pulumi/pulumi";
import * as postgresql from "@pulumi/postgresql";
const myRole = new postgresql.Role("my_role", {
name: "my_role",
login: true,
password: "mypass",
});
const myReplicationRole = new postgresql.Role("my_replication_role", {
name: "replication_role",
replication: true,
login: true,
connectionLimit: 5,
password: "md5c98cbfeb6a347a47eb8e96cfb4c4b890",
});
// Example using write-only password (password not stored in state)
const secureRole = new postgresql.Role("secure_role", {
name: "secure_role",
login: true,
passwordWo: "secure_password_123",
passwordWoVersion: "1",
});
import pulumi
import pulumi_postgresql as postgresql
my_role = postgresql.Role("my_role",
name="my_role",
login=True,
password="mypass")
my_replication_role = postgresql.Role("my_replication_role",
name="replication_role",
replication=True,
login=True,
connection_limit=5,
password="md5c98cbfeb6a347a47eb8e96cfb4c4b890")
# Example using write-only password (password not stored in state)
secure_role = postgresql.Role("secure_role",
name="secure_role",
login=True,
password_wo="secure_password_123",
password_wo_version="1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;
return await Deployment.RunAsync(() =>
{
var myRole = new PostgreSql.Role("my_role", new()
{
Name = "my_role",
Login = true,
Password = "mypass",
});
var myReplicationRole = new PostgreSql.Role("my_replication_role", new()
{
Name = "replication_role",
Replication = true,
Login = true,
ConnectionLimit = 5,
Password = "md5c98cbfeb6a347a47eb8e96cfb4c4b890",
});
// Example using write-only password (password not stored in state)
var secureRole = new PostgreSql.Role("secure_role", new()
{
Name = "secure_role",
Login = true,
PasswordWo = "secure_password_123",
PasswordWoVersion = "1",
});
});
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.NewRole(ctx, "my_role", &postgresql.RoleArgs{
Name: pulumi.String("my_role"),
Login: pulumi.Bool(true),
Password: pulumi.String("mypass"),
})
if err != nil {
return err
}
_, err = postgresql.NewRole(ctx, "my_replication_role", &postgresql.RoleArgs{
Name: pulumi.String("replication_role"),
Replication: pulumi.Bool(true),
Login: pulumi.Bool(true),
ConnectionLimit: pulumi.Int(5),
Password: pulumi.String("md5c98cbfeb6a347a47eb8e96cfb4c4b890"),
})
if err != nil {
return err
}
// Example using write-only password (password not stored in state)
_, err = postgresql.NewRole(ctx, "secure_role", &postgresql.RoleArgs{
Name: pulumi.String("secure_role"),
Login: pulumi.Bool(true),
PasswordWo: pulumi.String("secure_password_123"),
PasswordWoVersion: pulumi.String("1"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
postgresql = {
source = "pulumi/postgresql"
}
}
}
resource "postgresql_role" "my_role" {
name = "my_role"
login = true
password = "mypass"
}
resource "postgresql_role" "my_replication_role" {
name = "replication_role"
replication = true
login = true
connection_limit = 5
password = "md5c98cbfeb6a347a47eb8e96cfb4c4b890"
}
# Example using write-only password (password not stored in state)
resource "postgresql_role" "secure_role" {
name = "secure_role"
login = true
password_wo = "secure_password_123"
password_wo_version = "1"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Role;
import com.pulumi.postgresql.RoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 myRole = new Role("myRole", RoleArgs.builder()
.name("my_role")
.login(true)
.password("mypass")
.build());
var myReplicationRole = new Role("myReplicationRole", RoleArgs.builder()
.name("replication_role")
.replication(true)
.login(true)
.connectionLimit(5)
.password("md5c98cbfeb6a347a47eb8e96cfb4c4b890")
.build());
// Example using write-only password (password not stored in state)
var secureRole = new Role("secureRole", RoleArgs.builder()
.name("secure_role")
.login(true)
.passwordWo("secure_password_123")
.passwordWoVersion("1")
.build());
}
}
resources:
myRole:
type: postgresql:Role
name: my_role
properties:
name: my_role
login: true
password: mypass
myReplicationRole:
type: postgresql:Role
name: my_replication_role
properties:
name: replication_role
replication: true
login: true
connectionLimit: 5
password: md5c98cbfeb6a347a47eb8e96cfb4c4b890
# Example using write-only password (password not stored in state)
secureRole:
type: postgresql:Role
name: secure_role
properties:
name: secure_role
login: true
passwordWo: secure_password_123
passwordWoVersion: '1'
Write-Only Password Management
The passwordWo and passwordWoVersion attributes provide a secure way to manage role passwords
without storing them in the Terraform state file:
- Security: The password value is never stored in the state file, reducing the risk of exposure
- Version Control: Password updates are controlled through the
passwordWoVersionattribute - Idempotency: Terraform only updates the password when the version changes, not on every apply
To change a password when using write-only attributes:
- Update the
passwordWovalue with the new password - Increment or change the
passwordWoVersionvalue - Apply the configuration
Example of password rotation:
import * as pulumi from "@pulumi/pulumi";
import * as postgresql from "@pulumi/postgresql";
// Initial password setup
const appUser = new postgresql.Role("app_user", {
name: "app_user",
login: true,
passwordWo: "initial_password_123",
passwordWoVersion: "1",
});
import pulumi
import pulumi_postgresql as postgresql
# Initial password setup
app_user = postgresql.Role("app_user",
name="app_user",
login=True,
password_wo="initial_password_123",
password_wo_version="1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;
return await Deployment.RunAsync(() =>
{
// Initial password setup
var appUser = new PostgreSql.Role("app_user", new()
{
Name = "app_user",
Login = true,
PasswordWo = "initial_password_123",
PasswordWoVersion = "1",
});
});
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 {
// Initial password setup
_, err := postgresql.NewRole(ctx, "app_user", &postgresql.RoleArgs{
Name: pulumi.String("app_user"),
Login: pulumi.Bool(true),
PasswordWo: pulumi.String("initial_password_123"),
PasswordWoVersion: pulumi.String("1"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
postgresql = {
source = "pulumi/postgresql"
}
}
}
# Initial password setup
resource "postgresql_role" "app_user" {
name = "app_user"
login = true
password_wo = "initial_password_123"
password_wo_version = "1"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Role;
import com.pulumi.postgresql.RoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
// Initial password setup
var appUser = new Role("appUser", RoleArgs.builder()
.name("app_user")
.login(true)
.passwordWo("initial_password_123")
.passwordWoVersion("1")
.build());
}
}
resources:
# Initial password setup
appUser:
type: postgresql:Role
name: app_user
properties:
name: app_user
login: true
passwordWo: initial_password_123
passwordWoVersion: '1'
Import Example
postgresql.Role supports importing resources. Supposing the following
Terraform:
import * as pulumi from "@pulumi/pulumi";
import * as postgresql from "@pulumi/postgresql";
const replicationRole = new postgresql.Role("replication_role", {name: "replication_name"});
import pulumi
import pulumi_postgresql as postgresql
replication_role = postgresql.Role("replication_role", name="replication_name")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;
return await Deployment.RunAsync(() =>
{
var replicationRole = new PostgreSql.Role("replication_role", new()
{
Name = "replication_name",
});
});
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.NewRole(ctx, "replication_role", &postgresql.RoleArgs{
Name: pulumi.String("replication_name"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
postgresql = {
source = "pulumi/postgresql"
}
}
}
resource "postgresql_role" "replication_role" {
name = "replication_name"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Role;
import com.pulumi.postgresql.RoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 replicationRole = new Role("replicationRole", RoleArgs.builder()
.name("replication_name")
.build());
}
}
resources:
replicationRole:
type: postgresql:Role
name: replication_role
properties:
name: replication_name
It is possible to import a postgresql.Role resource with the following
command:
$ terraform import postgresql_role.replication_role replication_name
Where replicationName is the name of the role to import and
postgresql_role.replication_role is the name of the resource whose state will
be populated as a result of the command.
Constructors
Properties
-
assumeRole
↔ Output<
String?> -
Defines the role to switch to at login via
SET ROLE.latefinal -
bypassRowLevelSecurity
↔ Output<
bool?> -
Defines whether a role bypasses every
row-level security (RLS) policy. Default value is
false.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
connectionLimit
↔ Output<
int?> -
If this role can log in, this specifies how
many concurrent connections the role can establish.
-1(the default) means no limit.latefinal -
createDatabase
↔ Output<
bool?> -
Defines a role's ability to execute
CREATE DATABASE. Default value isfalse.latefinal -
createRole
↔ Output<
bool?> -
Defines a role's ability to execute
CREATE ROLE. A role with this privilege can also alter and drop other roles. Default value isfalse.latefinal -
encrypted
↔ Output<
String?> -
latefinal
-
encryptedPassword
↔ Output<
bool?> -
Defines whether the password is stored
encrypted in the system catalogs. Default value is
true. NOTE: this value is always set (to the conservative and safe value), but may interfere with the behavior of PostgreSQL'spasswordEncryptionsetting.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
idleInTransactionSessionTimeout
↔ Output<
int?> -
Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds
latefinal
-
inherit
↔ Output<
bool?> -
Defines whether a role "inherits" the privileges of
roles it is a member of. Default value is
true.latefinal - isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
login
↔ Output<
bool?> -
Defines whether role is allowed to log in. Roles without
this attribute are useful for managing database privileges, but are not users
in the usual sense of the word. Default value is
false.latefinal -
name
↔ Output<
String> -
The name of the role. Must be unique on the PostgreSQL
server instance where it is configured.
latefinal
-
password
↔ Output<
String?> -
Sets the role's password. A password is only of use
for roles having the
loginattribute set to true.latefinal -
passwordWo
↔ Output<
String?> -
NOTE: This field is write-only and its value will not be updated in state as part of read operations.
Sets the role's password without storing it in the state file.
This is useful for managing passwords securely. Must be used together with
passwordWoVersion. Conflicts withpassword.latefinal -
passwordWoVersion
↔ Output<
String?> -
Prevents applies from updating the role password on every
apply unless the value changes. This version string should be updated whenever you want to
change the password specified in
passwordWo. Must be used together withpasswordWo. Conflicts withpassword.latefinal -
replication
↔ Output<
bool?> -
Defines whether a role is allowed to initiate
streaming replication or put the system in and out of backup mode. Default
value is
falselatefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
roles
↔ Output<
List< String> ?> -
Defines list of roles which will be granted to this new role.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
searchPaths
↔ Output<
List< String> ?> -
Alters the search path of this new role. Note that
due to limitations in the implementation, values cannot contain the substring
", ".latefinal -
skipDropRole
↔ Output<
bool?> -
When a PostgreSQL ROLE exists in multiple
databases and the ROLE is dropped, the
cleanup of ownership of objects
in each of the respective databases must occur before the ROLE can be dropped
from the catalog. Set this option to true when there are multiple databases
in a PostgreSQL cluster using the same PostgreSQL ROLE for object ownership.
This is the third and final step taken when removing a ROLE from a database.
latefinal
-
skipReassignOwned
↔ Output<
bool?> -
When a PostgreSQL ROLE exists in multiple
databases and the ROLE is dropped, a
REASSIGN OWNEDin must be executed on each of the respective databases before theDROP ROLEcan be executed to drop the ROLE from the catalog. This is the first and second steps taken when removing a ROLE from a database (the second step being an implicitDROP OWNED).latefinal -
statementTimeout
↔ Output<
int?> -
Defines
statementTimeoutsetting for this role which allows to abort any statement that takes more than the specified amount of time.latefinal -
superuser
↔ Output<
bool?> -
Defines whether the role is a "superuser", and
therefore can override all access restrictions within the database. Default
value is
false.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
validUntil
↔ Output<
String?> -
Defines the date and time after which the role's
password is no longer valid. Established connections past this
validTimewill have to be manually terminated. This value corresponds to a PostgreSQL datetime. If omitted or the magic valueNULLis used,validUntilwill be set toinfinity. Default isNULL, thereforeinfinity.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited