Skip to content

Latest commit

 

History

History
2056 lines (1305 loc) · 82.8 KB

role.python.md

File metadata and controls

2056 lines (1305 loc) · 82.8 KB

role Submodule

Constructs

Role

Represents a {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role postgresql_role}.

Initializers 

from cdktf_cdktf_provider_postgresql import role

role.Role(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  assume_role: str = None,
  bypass_row_level_security: typing.Union[bool, IResolvable] = None,
  connection_limit: typing.Union[int, float] = None,
  create_database: typing.Union[bool, IResolvable] = None,
  create_role: typing.Union[bool, IResolvable] = None,
  encrypted: str = None,
  encrypted_password: typing.Union[bool, IResolvable] = None,
  id: str = None,
  idle_in_transaction_session_timeout: typing.Union[int, float] = None,
  inherit: typing.Union[bool, IResolvable] = None,
  login: typing.Union[bool, IResolvable] = None,
  password: str = None,
  replication: typing.Union[bool, IResolvable] = None,
  roles: typing.List[str] = None,
  search_path: typing.List[str] = None,
  skip_drop_role: typing.Union[bool, IResolvable] = None,
  skip_reassign_owned: typing.Union[bool, IResolvable] = None,
  statement_timeout: typing.Union[int, float] = None,
  superuser: typing.Union[bool, IResolvable] = None,
  valid_until: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str The name of the role.
assume_role str Role to switch to at login.
bypass_row_level_security typing.Union[bool, cdktf.IResolvable] Determine whether a role bypasses every row-level security (RLS) policy.
connection_limit typing.Union[int, float] How many concurrent connections can be made with this role.
create_database typing.Union[bool, cdktf.IResolvable] Define a role's ability to create databases.
create_role typing.Union[bool, cdktf.IResolvable] Determine whether this role will be permitted to create new roles.
encrypted str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#encrypted Role#encrypted}.
encrypted_password typing.Union[bool, cdktf.IResolvable] Control whether the password is stored encrypted in the system catalogs.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#id Role#id}.
idle_in_transaction_session_timeout typing.Union[int, float] Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds.
inherit typing.Union[bool, cdktf.IResolvable] Determine whether a role "inherits" the privileges of roles it is a member of.
login typing.Union[bool, cdktf.IResolvable] Determine whether a role is allowed to log in.
password str Sets the role's password.
replication typing.Union[bool, cdktf.IResolvable] Determine whether a role is allowed to initiate streaming replication or put the system in and out of backup mode.
roles typing.List[str] Role(s) to grant to this new role.
search_path typing.List[str] Sets the role's search path.
skip_drop_role typing.Union[bool, cdktf.IResolvable] Skip actually running the DROP ROLE command when removing a ROLE from PostgreSQL.
skip_reassign_owned typing.Union[bool, cdktf.IResolvable] Skip actually running the REASSIGN OWNED command when removing a role from PostgreSQL.
statement_timeout typing.Union[int, float] Abort any statement that takes more than the specified number of milliseconds.
superuser typing.Union[bool, cdktf.IResolvable] Determine whether the new role is a "superuser".
valid_until str Sets a date and time after which the role's password is no longer valid.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
nameRequired
  • Type: str

The name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#name Role#name}

assume_roleOptional
  • Type: str

Role to switch to at login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#assume_role Role#assume_role}

bypass_row_level_securityOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether a role bypasses every row-level security (RLS) policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#bypass_row_level_security Role#bypass_row_level_security}

connection_limitOptional
  • Type: typing.Union[int, float]

How many concurrent connections can be made with this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#connection_limit Role#connection_limit}

create_databaseOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Define a role's ability to create databases.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#create_database Role#create_database}

create_roleOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether this role will be permitted to create new roles.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#create_role Role#create_role}

encryptedOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#encrypted Role#encrypted}.

encrypted_passwordOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Control whether the password is stored encrypted in the system catalogs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#encrypted_password Role#encrypted_password}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#id Role#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

idle_in_transaction_session_timeoutOptional
  • Type: typing.Union[int, float]

Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#idle_in_transaction_session_timeout Role#idle_in_transaction_session_timeout}

inheritOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether a role "inherits" the privileges of roles it is a member of.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#inherit Role#inherit}

loginOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether a role is allowed to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#login Role#login}

passwordOptional
  • Type: str

Sets the role's password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#password Role#password}

replicationOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#replication Role#replication}

rolesOptional
  • Type: typing.List[str]

Role(s) to grant to this new role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#roles Role#roles}

search_pathOptional
  • Type: typing.List[str]

Sets the role's search path.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#search_path Role#search_path}

skip_drop_roleOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Skip actually running the DROP ROLE command when removing a ROLE from PostgreSQL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#skip_drop_role Role#skip_drop_role}

skip_reassign_ownedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Skip actually running the REASSIGN OWNED command when removing a role from PostgreSQL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#skip_reassign_owned Role#skip_reassign_owned}

statement_timeoutOptional
  • Type: typing.Union[int, float]

Abort any statement that takes more than the specified number of milliseconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#statement_timeout Role#statement_timeout}

superuserOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether the new role is a "superuser".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#superuser Role#superuser}

valid_untilOptional
  • Type: str

Sets a date and time after which the role's password is no longer valid.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#valid_until Role#valid_until}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_assume_role No description.
reset_bypass_row_level_security No description.
reset_connection_limit No description.
reset_create_database No description.
reset_create_role No description.
reset_encrypted No description.
reset_encrypted_password No description.
reset_id No description.
reset_idle_in_transaction_session_timeout No description.
reset_inherit No description.
reset_login No description.
reset_password No description.
reset_replication No description.
reset_roles No description.
reset_search_path No description.
reset_skip_drop_role No description.
reset_skip_reassign_owned No description.
reset_statement_timeout No description.
reset_superuser No description.
reset_valid_until No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

reset_assume_role 
def reset_assume_role() -> None
reset_bypass_row_level_security 
def reset_bypass_row_level_security() -> None
reset_connection_limit 
def reset_connection_limit() -> None
reset_create_database 
def reset_create_database() -> None
reset_create_role 
def reset_create_role() -> None
reset_encrypted 
def reset_encrypted() -> None
reset_encrypted_password 
def reset_encrypted_password() -> None
reset_id 
def reset_id() -> None
reset_idle_in_transaction_session_timeout 
def reset_idle_in_transaction_session_timeout() -> None
reset_inherit 
def reset_inherit() -> None
reset_login 
def reset_login() -> None
reset_password 
def reset_password() -> None
reset_replication 
def reset_replication() -> None
reset_roles 
def reset_roles() -> None
reset_search_path 
def reset_search_path() -> None
reset_skip_drop_role 
def reset_skip_drop_role() -> None
reset_skip_reassign_owned 
def reset_skip_reassign_owned() -> None
reset_statement_timeout 
def reset_statement_timeout() -> None
reset_superuser 
def reset_superuser() -> None
reset_valid_until 
def reset_valid_until() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a Role resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_postgresql import role

role.Role.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_postgresql import role

role.Role.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_postgresql import role

role.Role.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_postgresql import role

role.Role.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a Role resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the Role to import.

import_from_idRequired
  • Type: str

The id of the existing Role that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the Role to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
assume_role_input str No description.
bypass_row_level_security_input typing.Union[bool, cdktf.IResolvable] No description.
connection_limit_input typing.Union[int, float] No description.
create_database_input typing.Union[bool, cdktf.IResolvable] No description.
create_role_input typing.Union[bool, cdktf.IResolvable] No description.
encrypted_input str No description.
encrypted_password_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
idle_in_transaction_session_timeout_input typing.Union[int, float] No description.
inherit_input typing.Union[bool, cdktf.IResolvable] No description.
login_input typing.Union[bool, cdktf.IResolvable] No description.
name_input str No description.
password_input str No description.
replication_input typing.Union[bool, cdktf.IResolvable] No description.
roles_input typing.List[str] No description.
search_path_input typing.List[str] No description.
skip_drop_role_input typing.Union[bool, cdktf.IResolvable] No description.
skip_reassign_owned_input typing.Union[bool, cdktf.IResolvable] No description.
statement_timeout_input typing.Union[int, float] No description.
superuser_input typing.Union[bool, cdktf.IResolvable] No description.
valid_until_input str No description.
assume_role str No description.
bypass_row_level_security typing.Union[bool, cdktf.IResolvable] No description.
connection_limit typing.Union[int, float] No description.
create_database typing.Union[bool, cdktf.IResolvable] No description.
create_role typing.Union[bool, cdktf.IResolvable] No description.
encrypted str No description.
encrypted_password typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
idle_in_transaction_session_timeout typing.Union[int, float] No description.
inherit typing.Union[bool, cdktf.IResolvable] No description.
login typing.Union[bool, cdktf.IResolvable] No description.
name str No description.
password str No description.
replication typing.Union[bool, cdktf.IResolvable] No description.
roles typing.List[str] No description.
search_path typing.List[str] No description.
skip_drop_role typing.Union[bool, cdktf.IResolvable] No description.
skip_reassign_owned typing.Union[bool, cdktf.IResolvable] No description.
statement_timeout typing.Union[int, float] No description.
superuser typing.Union[bool, cdktf.IResolvable] No description.
valid_until str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
assume_role_inputOptional 
assume_role_input: str
  • Type: str
bypass_row_level_security_inputOptional 
bypass_row_level_security_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
connection_limit_inputOptional 
connection_limit_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
create_database_inputOptional 
create_database_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
create_role_inputOptional 
create_role_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
encrypted_inputOptional 
encrypted_input: str
  • Type: str
encrypted_password_inputOptional 
encrypted_password_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
idle_in_transaction_session_timeout_inputOptional 
idle_in_transaction_session_timeout_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
inherit_inputOptional 
inherit_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
login_inputOptional 
login_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
name_inputOptional 
name_input: str
  • Type: str
password_inputOptional 
password_input: str
  • Type: str
replication_inputOptional 
replication_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
roles_inputOptional 
roles_input: typing.List[str]
  • Type: typing.List[str]
search_path_inputOptional 
search_path_input: typing.List[str]
  • Type: typing.List[str]
skip_drop_role_inputOptional 
skip_drop_role_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
skip_reassign_owned_inputOptional 
skip_reassign_owned_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
statement_timeout_inputOptional 
statement_timeout_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
superuser_inputOptional 
superuser_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
valid_until_inputOptional 
valid_until_input: str
  • Type: str
assume_roleRequired 
assume_role: str
  • Type: str
bypass_row_level_securityRequired 
bypass_row_level_security: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
connection_limitRequired 
connection_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]
create_databaseRequired 
create_database: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
create_roleRequired 
create_role: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
encryptedRequired 
encrypted: str
  • Type: str
encrypted_passwordRequired 
encrypted_password: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
idle_in_transaction_session_timeoutRequired 
idle_in_transaction_session_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]
inheritRequired 
inherit: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
loginRequired 
login: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
nameRequired 
name: str
  • Type: str
passwordRequired 
password: str
  • Type: str
replicationRequired 
replication: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
rolesRequired 
roles: typing.List[str]
  • Type: typing.List[str]
search_pathRequired 
search_path: typing.List[str]
  • Type: typing.List[str]
skip_drop_roleRequired 
skip_drop_role: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
skip_reassign_ownedRequired 
skip_reassign_owned: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
statement_timeoutRequired 
statement_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]
superuserRequired 
superuser: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
valid_untilRequired 
valid_until: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

RoleConfig

Initializer 

from cdktf_cdktf_provider_postgresql import role

role.RoleConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  assume_role: str = None,
  bypass_row_level_security: typing.Union[bool, IResolvable] = None,
  connection_limit: typing.Union[int, float] = None,
  create_database: typing.Union[bool, IResolvable] = None,
  create_role: typing.Union[bool, IResolvable] = None,
  encrypted: str = None,
  encrypted_password: typing.Union[bool, IResolvable] = None,
  id: str = None,
  idle_in_transaction_session_timeout: typing.Union[int, float] = None,
  inherit: typing.Union[bool, IResolvable] = None,
  login: typing.Union[bool, IResolvable] = None,
  password: str = None,
  replication: typing.Union[bool, IResolvable] = None,
  roles: typing.List[str] = None,
  search_path: typing.List[str] = None,
  skip_drop_role: typing.Union[bool, IResolvable] = None,
  skip_reassign_owned: typing.Union[bool, IResolvable] = None,
  statement_timeout: typing.Union[int, float] = None,
  superuser: typing.Union[bool, IResolvable] = None,
  valid_until: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str The name of the role.
assume_role str Role to switch to at login.
bypass_row_level_security typing.Union[bool, cdktf.IResolvable] Determine whether a role bypasses every row-level security (RLS) policy.
connection_limit typing.Union[int, float] How many concurrent connections can be made with this role.
create_database typing.Union[bool, cdktf.IResolvable] Define a role's ability to create databases.
create_role typing.Union[bool, cdktf.IResolvable] Determine whether this role will be permitted to create new roles.
encrypted str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#encrypted Role#encrypted}.
encrypted_password typing.Union[bool, cdktf.IResolvable] Control whether the password is stored encrypted in the system catalogs.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#id Role#id}.
idle_in_transaction_session_timeout typing.Union[int, float] Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds.
inherit typing.Union[bool, cdktf.IResolvable] Determine whether a role "inherits" the privileges of roles it is a member of.
login typing.Union[bool, cdktf.IResolvable] Determine whether a role is allowed to log in.
password str Sets the role's password.
replication typing.Union[bool, cdktf.IResolvable] Determine whether a role is allowed to initiate streaming replication or put the system in and out of backup mode.
roles typing.List[str] Role(s) to grant to this new role.
search_path typing.List[str] Sets the role's search path.
skip_drop_role typing.Union[bool, cdktf.IResolvable] Skip actually running the DROP ROLE command when removing a ROLE from PostgreSQL.
skip_reassign_owned typing.Union[bool, cdktf.IResolvable] Skip actually running the REASSIGN OWNED command when removing a role from PostgreSQL.
statement_timeout typing.Union[int, float] Abort any statement that takes more than the specified number of milliseconds.
superuser typing.Union[bool, cdktf.IResolvable] Determine whether the new role is a "superuser".
valid_until str Sets a date and time after which the role's password is no longer valid.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
nameRequired 
name: str
  • Type: str

The name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#name Role#name}

assume_roleOptional 
assume_role: str
  • Type: str

Role to switch to at login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#assume_role Role#assume_role}

bypass_row_level_securityOptional 
bypass_row_level_security: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether a role bypasses every row-level security (RLS) policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#bypass_row_level_security Role#bypass_row_level_security}

connection_limitOptional 
connection_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]

How many concurrent connections can be made with this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#connection_limit Role#connection_limit}

create_databaseOptional 
create_database: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Define a role's ability to create databases.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#create_database Role#create_database}

create_roleOptional 
create_role: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether this role will be permitted to create new roles.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#create_role Role#create_role}

encryptedOptional 
encrypted: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#encrypted Role#encrypted}.

encrypted_passwordOptional 
encrypted_password: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Control whether the password is stored encrypted in the system catalogs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#encrypted_password Role#encrypted_password}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#id Role#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

idle_in_transaction_session_timeoutOptional 
idle_in_transaction_session_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#idle_in_transaction_session_timeout Role#idle_in_transaction_session_timeout}

inheritOptional 
inherit: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether a role "inherits" the privileges of roles it is a member of.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#inherit Role#inherit}

loginOptional 
login: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether a role is allowed to log in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#login Role#login}

passwordOptional 
password: str
  • Type: str

Sets the role's password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#password Role#password}

replicationOptional 
replication: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#replication Role#replication}

rolesOptional 
roles: typing.List[str]
  • Type: typing.List[str]

Role(s) to grant to this new role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#roles Role#roles}

search_pathOptional 
search_path: typing.List[str]
  • Type: typing.List[str]

Sets the role's search path.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#search_path Role#search_path}

skip_drop_roleOptional 
skip_drop_role: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Skip actually running the DROP ROLE command when removing a ROLE from PostgreSQL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#skip_drop_role Role#skip_drop_role}

skip_reassign_ownedOptional 
skip_reassign_owned: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Skip actually running the REASSIGN OWNED command when removing a role from PostgreSQL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#skip_reassign_owned Role#skip_reassign_owned}

statement_timeoutOptional 
statement_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

Abort any statement that takes more than the specified number of milliseconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#statement_timeout Role#statement_timeout}

superuserOptional 
superuser: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Determine whether the new role is a "superuser".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#superuser Role#superuser}

valid_untilOptional 
valid_until: str
  • Type: str

Sets a date and time after which the role's password is no longer valid.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#valid_until Role#valid_until}