RoleState class
Input properties used for looking up and filtering Role resources.
Constructors
-
RoleState({Input<
String> ? assumeRole, Input<bool> ? bypassRowLevelSecurity, Input<int> ? connectionLimit, Input<bool> ? createDatabase, Input<bool> ? createRole, Input<String> ? encrypted, Input<bool> ? encryptedPassword, Input<int> ? idleInTransactionSessionTimeout, Input<bool> ? inherit, Input<bool> ? login, Input<String> ? name, Input<String> ? password, Input<String> ? passwordWo, Input<String> ? passwordWoVersion, Input<bool> ? replication, Input<List< ? roles, Input<String> >List< ? searchPaths, Input<String> >bool> ? skipDropRole, Input<bool> ? skipReassignOwned, Input<int> ? statementTimeout, Input<bool> ? superuser, Input<String> ? validUntil}) -
Creates a new RoleState.
assumeRoleDefines the role to switch to at login viaSET ROLE.bypassRowLevelSecurityDefines whether a role bypasses everyconnectionLimitIf this role can log in, this specifies howcreateDatabaseDefines a role's ability to executeCREATE [createRole] Defines a role's ability to executeCREATE ROLE. [encrypted] Optional. [encryptedPassword] Defines whether the password is stored [idleInTransactionSessionTimeout] Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds [inherit] Defines whether a role "inherits" the privileges of [login] Defines whether role is allowed to log in. Roles without [name] The name of the role. Must be unique on the PostgreSQL [password] Sets the role's password. A password is only of use [passwordWo] **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. [passwordWoVersion] Prevents applies from updating the role password on every [replication] Defines whether a role is allowed to initiate [roles] Defines list of roles which will be granted to this new role. [searchPaths] Alters the search path of this new role. Note that [skipDropRole] When a PostgreSQL ROLE exists in multiple [skipReassignOwned] When a PostgreSQL ROLE exists in multiple [statementTimeout] Defines [statementTimeout`](https://www.postgresql.org/docs/current/runtime-config-client.html#RUNTIME-CONFIG-CLIENT-STATEMENT) setting for this role which allows to abort any statement that takes more than the specified amount of time.superuserDefines whether the role is a "superuser", andvalidUntilDefines the date and time after which the role'sconst -
RoleState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
assumeRole
→ Input<
String> ? -
Defines the role to switch to at login via
SET ROLE.final -
bypassRowLevelSecurity
→ Input<
bool> ? -
Defines whether a role bypasses every
row-level security (RLS) policy. Default value is
false.final -
connectionLimit
→ Input<
int> ? -
If this role can log in, this specifies how
many concurrent connections the role can establish.
-1(the default) means no limit.final -
createDatabase
→ Input<
bool> ? -
Defines a role's ability to execute
CREATE DATABASE. Default value isfalse.final -
createRole
→ Input<
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.final -
encrypted
→ Input<
String> ? -
final
-
encryptedPassword
→ Input<
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.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
idleInTransactionSessionTimeout
→ Input<
int> ? -
Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds
final
-
inherit
→ Input<
bool> ? -
Defines whether a role "inherits" the privileges of
roles it is a member of. Default value is
true.final -
login
→ Input<
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.final -
name
→ Input<
String> ? -
The name of the role. Must be unique on the PostgreSQL
server instance where it is configured.
final
-
password
→ Input<
String> ? -
Sets the role's password. A password is only of use
for roles having the
loginattribute set to true.final -
passwordWo
→ Input<
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.final -
passwordWoVersion
→ Input<
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.final -
replication
→ Input<
bool> ? -
Defines whether a role is allowed to initiate
streaming replication or put the system in and out of backup mode. Default
value is
falsefinal -
roles
→ Input<
List< ?String> > -
Defines list of roles which will be granted to this new role.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
searchPaths
→ Input<
List< ?String> > -
Alters the search path of this new role. Note that
due to limitations in the implementation, values cannot contain the substring
", ".final -
skipDropRole
→ Input<
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.
final
-
skipReassignOwned
→ Input<
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).final -
statementTimeout
→ Input<
int> ? -
Defines
statementTimeoutsetting for this role which allows to abort any statement that takes more than the specified amount of time.final -
superuser
→ Input<
bool> ? -
Defines whether the role is a "superuser", and
therefore can override all access restrictions within the database. Default
value is
false.final -
validUntil
→ Input<
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.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited