Skip to content

Latest commit

 

History

History
2036 lines (1285 loc) · 86.1 KB

role.java.md

File metadata and controls

2036 lines (1285 loc) · 86.1 KB

role Submodule

Constructs

Role

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

Initializers 

import com.hashicorp.cdktf.providers.postgresql.role.Role;

Role.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .assumeRole(java.lang.String)
//  .bypassRowLevelSecurity(java.lang.Boolean)
//  .bypassRowLevelSecurity(IResolvable)
//  .connectionLimit(java.lang.Number)
//  .createDatabase(java.lang.Boolean)
//  .createDatabase(IResolvable)
//  .createRole(java.lang.Boolean)
//  .createRole(IResolvable)
//  .encrypted(java.lang.String)
//  .encryptedPassword(java.lang.Boolean)
//  .encryptedPassword(IResolvable)
//  .id(java.lang.String)
//  .idleInTransactionSessionTimeout(java.lang.Number)
//  .inherit(java.lang.Boolean)
//  .inherit(IResolvable)
//  .login(java.lang.Boolean)
//  .login(IResolvable)
//  .password(java.lang.String)
//  .replication(java.lang.Boolean)
//  .replication(IResolvable)
//  .roles(java.util.List<java.lang.String>)
//  .searchPath(java.util.List<java.lang.String>)
//  .skipDropRole(java.lang.Boolean)
//  .skipDropRole(IResolvable)
//  .skipReassignOwned(java.lang.Boolean)
//  .skipReassignOwned(IResolvable)
//  .statementTimeout(java.lang.Number)
//  .superuser(java.lang.Boolean)
//  .superuser(IResolvable)
//  .validUntil(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String The name of the role.
assumeRole java.lang.String Role to switch to at login.
bypassRowLevelSecurity java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether a role bypasses every row-level security (RLS) policy.
connectionLimit java.lang.Number How many concurrent connections can be made with this role.
createDatabase java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Define a role's ability to create databases.
createRole java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether this role will be permitted to create new roles.
encrypted java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#encrypted Role#encrypted}.
encryptedPassword java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Control whether the password is stored encrypted in the system catalogs.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#id Role#id}.
idleInTransactionSessionTimeout java.lang.Number Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds.
inherit java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether a role "inherits" the privileges of roles it is a member of.
login java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether a role is allowed to log in.
password java.lang.String Sets the role's password.
replication java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether a role is allowed to initiate streaming replication or put the system in and out of backup mode.
roles java.util.List<java.lang.String> Role(s) to grant to this new role.
searchPath java.util.List<java.lang.String> Sets the role's search path.
skipDropRole java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip actually running the DROP ROLE command when removing a ROLE from PostgreSQL.
skipReassignOwned java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip actually running the REASSIGN OWNED command when removing a role from PostgreSQL.
statementTimeout java.lang.Number Abort any statement that takes more than the specified number of milliseconds.
superuser java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether the new role is a "superuser".
validUntil java.lang.String Sets a date and time after which the role's password is no longer valid.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nameRequired
  • Type: java.lang.String

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}

assumeRoleOptional
  • Type: java.lang.String

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}

bypassRowLevelSecurityOptional
  • Type: java.lang.Boolean OR com.hashicorp.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}

connectionLimitOptional
  • Type: java.lang.Number

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}

createDatabaseOptional
  • Type: java.lang.Boolean OR com.hashicorp.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}

createRoleOptional
  • Type: java.lang.Boolean OR com.hashicorp.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: java.lang.String

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

encryptedPasswordOptional
  • Type: java.lang.Boolean OR com.hashicorp.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: java.lang.String

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.

idleInTransactionSessionTimeoutOptional
  • Type: java.lang.Number

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: java.lang.Boolean OR com.hashicorp.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: java.lang.Boolean OR com.hashicorp.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: java.lang.String

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: java.lang.Boolean OR com.hashicorp.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: java.util.List<java.lang.String>

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}

searchPathOptional
  • Type: java.util.List<java.lang.String>

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}

skipDropRoleOptional
  • Type: java.lang.Boolean OR com.hashicorp.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}

skipReassignOwnedOptional
  • Type: java.lang.Boolean OR com.hashicorp.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}

statementTimeoutOptional
  • Type: java.lang.Number

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: java.lang.Boolean OR com.hashicorp.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}

validUntilOptional
  • Type: java.lang.String

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
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetAssumeRole No description.
resetBypassRowLevelSecurity No description.
resetConnectionLimit No description.
resetCreateDatabase No description.
resetCreateRole No description.
resetEncrypted No description.
resetEncryptedPassword No description.
resetId No description.
resetIdleInTransactionSessionTimeout No description.
resetInherit No description.
resetLogin No description.
resetPassword No description.
resetReplication No description.
resetRoles No description.
resetSearchPath No description.
resetSkipDropRole No description.
resetSkipReassignOwned No description.
resetStatementTimeout No description.
resetSuperuser No description.
resetValidUntil No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

resetAssumeRole 
public void resetAssumeRole()
resetBypassRowLevelSecurity 
public void resetBypassRowLevelSecurity()
resetConnectionLimit 
public void resetConnectionLimit()
resetCreateDatabase 
public void resetCreateDatabase()
resetCreateRole 
public void resetCreateRole()
resetEncrypted 
public void resetEncrypted()
resetEncryptedPassword 
public void resetEncryptedPassword()
resetId 
public void resetId()
resetIdleInTransactionSessionTimeout 
public void resetIdleInTransactionSessionTimeout()
resetInherit 
public void resetInherit()
resetLogin 
public void resetLogin()
resetPassword 
public void resetPassword()
resetReplication 
public void resetReplication()
resetRoles 
public void resetRoles()
resetSearchPath 
public void resetSearchPath()
resetSkipDropRole 
public void resetSkipDropRole()
resetSkipReassignOwned 
public void resetSkipReassignOwned()
resetStatementTimeout 
public void resetStatementTimeout()
resetSuperuser 
public void resetSuperuser()
resetValidUntil 
public void resetValidUntil()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Role resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.postgresql.role.Role;

Role.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.postgresql.role.Role;

Role.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.postgresql.role.Role;

Role.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.postgresql.role.Role;

Role.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Role.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

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: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
assumeRoleInput java.lang.String No description.
bypassRowLevelSecurityInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
connectionLimitInput java.lang.Number No description.
createDatabaseInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
createRoleInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
encryptedInput java.lang.String No description.
encryptedPasswordInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
idleInTransactionSessionTimeoutInput java.lang.Number No description.
inheritInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
loginInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nameInput java.lang.String No description.
passwordInput java.lang.String No description.
replicationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
rolesInput java.util.List<java.lang.String> No description.
searchPathInput java.util.List<java.lang.String> No description.
skipDropRoleInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipReassignOwnedInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
statementTimeoutInput java.lang.Number No description.
superuserInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
validUntilInput java.lang.String No description.
assumeRole java.lang.String No description.
bypassRowLevelSecurity java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
connectionLimit java.lang.Number No description.
createDatabase java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
createRole java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
encrypted java.lang.String No description.
encryptedPassword java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
idleInTransactionSessionTimeout java.lang.Number No description.
inherit java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
login java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
name java.lang.String No description.
password java.lang.String No description.
replication java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
roles java.util.List<java.lang.String> No description.
searchPath java.util.List<java.lang.String> No description.
skipDropRole java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipReassignOwned java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
statementTimeout java.lang.Number No description.
superuser java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
validUntil java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
assumeRoleInputOptional 
public java.lang.String getAssumeRoleInput();
  • Type: java.lang.String
bypassRowLevelSecurityInputOptional 
public java.lang.Object getBypassRowLevelSecurityInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
connectionLimitInputOptional 
public java.lang.Number getConnectionLimitInput();
  • Type: java.lang.Number
createDatabaseInputOptional 
public java.lang.Object getCreateDatabaseInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
createRoleInputOptional 
public java.lang.Object getCreateRoleInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
encryptedInputOptional 
public java.lang.String getEncryptedInput();
  • Type: java.lang.String
encryptedPasswordInputOptional 
public java.lang.Object getEncryptedPasswordInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
idleInTransactionSessionTimeoutInputOptional 
public java.lang.Number getIdleInTransactionSessionTimeoutInput();
  • Type: java.lang.Number
inheritInputOptional 
public java.lang.Object getInheritInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
loginInputOptional 
public java.lang.Object getLoginInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
passwordInputOptional 
public java.lang.String getPasswordInput();
  • Type: java.lang.String
replicationInputOptional 
public java.lang.Object getReplicationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
rolesInputOptional 
public java.util.List<java.lang.String> getRolesInput();
  • Type: java.util.List<java.lang.String>
searchPathInputOptional 
public java.util.List<java.lang.String> getSearchPathInput();
  • Type: java.util.List<java.lang.String>
skipDropRoleInputOptional 
public java.lang.Object getSkipDropRoleInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipReassignOwnedInputOptional 
public java.lang.Object getSkipReassignOwnedInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
statementTimeoutInputOptional 
public java.lang.Number getStatementTimeoutInput();
  • Type: java.lang.Number
superuserInputOptional 
public java.lang.Object getSuperuserInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
validUntilInputOptional 
public java.lang.String getValidUntilInput();
  • Type: java.lang.String
assumeRoleRequired 
public java.lang.String getAssumeRole();
  • Type: java.lang.String
bypassRowLevelSecurityRequired 
public java.lang.Object getBypassRowLevelSecurity();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
connectionLimitRequired 
public java.lang.Number getConnectionLimit();
  • Type: java.lang.Number
createDatabaseRequired 
public java.lang.Object getCreateDatabase();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
createRoleRequired 
public java.lang.Object getCreateRole();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
encryptedRequired 
public java.lang.String getEncrypted();
  • Type: java.lang.String
encryptedPasswordRequired 
public java.lang.Object getEncryptedPassword();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
idleInTransactionSessionTimeoutRequired 
public java.lang.Number getIdleInTransactionSessionTimeout();
  • Type: java.lang.Number
inheritRequired 
public java.lang.Object getInherit();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
loginRequired 
public java.lang.Object getLogin();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
passwordRequired 
public java.lang.String getPassword();
  • Type: java.lang.String
replicationRequired 
public java.lang.Object getReplication();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
rolesRequired 
public java.util.List<java.lang.String> getRoles();
  • Type: java.util.List<java.lang.String>
searchPathRequired 
public java.util.List<java.lang.String> getSearchPath();
  • Type: java.util.List<java.lang.String>
skipDropRoleRequired 
public java.lang.Object getSkipDropRole();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipReassignOwnedRequired 
public java.lang.Object getSkipReassignOwned();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
statementTimeoutRequired 
public java.lang.Number getStatementTimeout();
  • Type: java.lang.Number
superuserRequired 
public java.lang.Object getSuperuser();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
validUntilRequired 
public java.lang.String getValidUntil();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

RoleConfig

Initializer 

import com.hashicorp.cdktf.providers.postgresql.role.RoleConfig;

RoleConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .assumeRole(java.lang.String)
//  .bypassRowLevelSecurity(java.lang.Boolean)
//  .bypassRowLevelSecurity(IResolvable)
//  .connectionLimit(java.lang.Number)
//  .createDatabase(java.lang.Boolean)
//  .createDatabase(IResolvable)
//  .createRole(java.lang.Boolean)
//  .createRole(IResolvable)
//  .encrypted(java.lang.String)
//  .encryptedPassword(java.lang.Boolean)
//  .encryptedPassword(IResolvable)
//  .id(java.lang.String)
//  .idleInTransactionSessionTimeout(java.lang.Number)
//  .inherit(java.lang.Boolean)
//  .inherit(IResolvable)
//  .login(java.lang.Boolean)
//  .login(IResolvable)
//  .password(java.lang.String)
//  .replication(java.lang.Boolean)
//  .replication(IResolvable)
//  .roles(java.util.List<java.lang.String>)
//  .searchPath(java.util.List<java.lang.String>)
//  .skipDropRole(java.lang.Boolean)
//  .skipDropRole(IResolvable)
//  .skipReassignOwned(java.lang.Boolean)
//  .skipReassignOwned(IResolvable)
//  .statementTimeout(java.lang.Number)
//  .superuser(java.lang.Boolean)
//  .superuser(IResolvable)
//  .validUntil(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String The name of the role.
assumeRole java.lang.String Role to switch to at login.
bypassRowLevelSecurity java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether a role bypasses every row-level security (RLS) policy.
connectionLimit java.lang.Number How many concurrent connections can be made with this role.
createDatabase java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Define a role's ability to create databases.
createRole java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether this role will be permitted to create new roles.
encrypted java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#encrypted Role#encrypted}.
encryptedPassword java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Control whether the password is stored encrypted in the system catalogs.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role#id Role#id}.
idleInTransactionSessionTimeout java.lang.Number Terminate any session with an open transaction that has been idle for longer than the specified duration in milliseconds.
inherit java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether a role "inherits" the privileges of roles it is a member of.
login java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether a role is allowed to log in.
password java.lang.String Sets the role's password.
replication java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether a role is allowed to initiate streaming replication or put the system in and out of backup mode.
roles java.util.List<java.lang.String> Role(s) to grant to this new role.
searchPath java.util.List<java.lang.String> Sets the role's search path.
skipDropRole java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip actually running the DROP ROLE command when removing a ROLE from PostgreSQL.
skipReassignOwned java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip actually running the REASSIGN OWNED command when removing a role from PostgreSQL.
statementTimeout java.lang.Number Abort any statement that takes more than the specified number of milliseconds.
superuser java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Determine whether the new role is a "superuser".
validUntil java.lang.String Sets a date and time after which the role's password is no longer valid.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

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}

assumeRoleOptional 
public java.lang.String getAssumeRole();
  • Type: java.lang.String

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}

bypassRowLevelSecurityOptional 
public java.lang.Object getBypassRowLevelSecurity();
  • Type: java.lang.Boolean OR com.hashicorp.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}

connectionLimitOptional 
public java.lang.Number getConnectionLimit();
  • Type: java.lang.Number

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}

createDatabaseOptional 
public java.lang.Object getCreateDatabase();
  • Type: java.lang.Boolean OR com.hashicorp.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}

createRoleOptional 
public java.lang.Object getCreateRole();
  • Type: java.lang.Boolean OR com.hashicorp.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 
public java.lang.String getEncrypted();
  • Type: java.lang.String

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

encryptedPasswordOptional 
public java.lang.Object getEncryptedPassword();
  • Type: java.lang.Boolean OR com.hashicorp.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 
public java.lang.String getId();
  • Type: java.lang.String

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.

idleInTransactionSessionTimeoutOptional 
public java.lang.Number getIdleInTransactionSessionTimeout();
  • Type: java.lang.Number

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 
public java.lang.Object getInherit();
  • Type: java.lang.Boolean OR com.hashicorp.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 
public java.lang.Object getLogin();
  • Type: java.lang.Boolean OR com.hashicorp.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 
public java.lang.String getPassword();
  • Type: java.lang.String

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 
public java.lang.Object getReplication();
  • Type: java.lang.Boolean OR com.hashicorp.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 
public java.util.List<java.lang.String> getRoles();
  • Type: java.util.List<java.lang.String>

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}

searchPathOptional 
public java.util.List<java.lang.String> getSearchPath();
  • Type: java.util.List<java.lang.String>

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}

skipDropRoleOptional 
public java.lang.Object getSkipDropRole();
  • Type: java.lang.Boolean OR com.hashicorp.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}

skipReassignOwnedOptional 
public java.lang.Object getSkipReassignOwned();
  • Type: java.lang.Boolean OR com.hashicorp.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}

statementTimeoutOptional 
public java.lang.Number getStatementTimeout();
  • Type: java.lang.Number

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 
public java.lang.Object getSuperuser();
  • Type: java.lang.Boolean OR com.hashicorp.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}

validUntilOptional 
public java.lang.String getValidUntil();
  • Type: java.lang.String

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}