Class RoleState

Inheritance

System.Object

InputArgs

ResourceArgs

RoleState

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.PostgreSql

Assembly: Pulumi.PostgreSql.dll

Syntax

public sealed class RoleState : ResourceArgs

Constructors

RoleState()

Declaration

public RoleState()

Properties

BypassRowLevelSecurity

Defines whether a role bypasses every row-level security (RLS) policy. Default value is false.

Declaration

public Input<bool> BypassRowLevelSecurity { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ConnectionLimit

If this role can log in, this specifies how many concurrent connections the role can establish. -1 (the default) means no limit.

Declaration

public Input<int> ConnectionLimit { get; set; }

Property Value

Type	Description
Input<System.Int32>

CreateDatabase

Defines a role's ability to execute CREATE DATABASE. Default value is false.

Declaration

public Input<bool> CreateDatabase { get; set; }

Property Value

Type	Description
Input<System.Boolean>

CreateRole

Defines a role's ability to execute CREATE ROLE. A role with this privilege can also alter and drop other roles. Default value is false.

Declaration

public Input<bool> CreateRole { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Encrypted

Declaration

public Input<string> Encrypted { get; set; }

Property Value

Type	Description
Input<System.String>

EncryptedPassword

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's password_encryption setting.

Declaration

public Input<bool> EncryptedPassword { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Inherit

Defines whether a role "inherits" the privileges of roles it is a member of. Default value is true.

Declaration

public Input<bool> Inherit { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Login

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.

Declaration

public Input<bool> Login { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Name

The name of the role. Must be unique on the PostgreSQL server instance where it is configured.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

Password

Sets the role's password. A password is only of use for roles having the login attribute set to true.

Declaration

public Input<string> Password { get; set; }

Property Value

Type	Description
Input<System.String>

Replication

Defines whether a role is allowed to initiate streaming replication or put the system in and out of backup mode. Default value is false

Declaration

public Input<bool> Replication { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Roles

Defines list of roles which will be granted to this new role.

Declaration

public InputList<string> Roles { get; set; }

Property Value

Type	Description
InputList<System.String>

SearchPaths

Alters the search path of this new role. Note that due to limitations in the implementation, values cannot contain the substring ", ".

Declaration

public InputList<string> SearchPaths { get; set; }

Property Value

Type	Description
InputList<System.String>

SkipDropRole

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.

Declaration

public Input<bool> SkipDropRole { get; set; }

Property Value

Type	Description
Input<System.Boolean>

SkipReassignOwned

When a PostgreSQL ROLE exists in multiple databases and the ROLE is dropped, a REASSIGN OWNED in must be executed on each of the respective databases before the DROP ROLE can be executed to dropped 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 implicit DROP OWNED).

Declaration

public Input<bool> SkipReassignOwned { get; set; }

Property Value

Type	Description
Input<System.Boolean>

StatementTimeout

Defines statement_timeout setting for this role which allows to abort any statement that takes more than the specified amount of time.

Declaration

public Input<int> StatementTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

Superuser

Defines whether the role is a "superuser", and therefore can override all access restrictions within the database. Default value is false.

Declaration

public Input<bool> Superuser { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ValidUntil

Defines the date and time after which the role's password is no longer valid. Established connections past this valid_time will have to be manually terminated. This value corresponds to a PostgreSQL datetime. If omitted or the magic value NULL is used, valid_until will be set to infinity. Default is NULL, therefore infinity.

Declaration

public Input<string> ValidUntil { get; set; }

Property Value

Type	Description
Input<System.String>