1. Packages
  2. Ionoscloud Provider
  3. API Docs
  4. PgUser
ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionoscloud.PgUser

Explore with Pulumi AI

Create PgUser Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PgUser(name: string, args: PgUserArgs, opts?: CustomResourceOptions);
@overload
def PgUser(resource_name: str,
           args: PgUserArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def PgUser(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           cluster_id: Optional[str] = None,
           password: Optional[str] = None,
           username: Optional[str] = None,
           pg_user_id: Optional[str] = None,
           timeouts: Optional[PgUserTimeoutsArgs] = None)
func NewPgUser(ctx *Context, name string, args PgUserArgs, opts ...ResourceOption) (*PgUser, error)
public PgUser(string name, PgUserArgs args, CustomResourceOptions? opts = null)
public PgUser(String name, PgUserArgs args)
public PgUser(String name, PgUserArgs args, CustomResourceOptions options)
type: ionoscloud:PgUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PgUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PgUserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PgUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PgUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PgUserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var pgUserResource = new Ionoscloud.PgUser("pgUserResource", new()
{
    ClusterId = "string",
    Password = "string",
    Username = "string",
    PgUserId = "string",
    Timeouts = new Ionoscloud.Inputs.PgUserTimeoutsArgs
    {
        Create = "string",
        Default = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ionoscloud.NewPgUser(ctx, "pgUserResource", &ionoscloud.PgUserArgs{
ClusterId: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
PgUserId: pulumi.String("string"),
Timeouts: &.PgUserTimeoutsArgs{
Create: pulumi.String("string"),
Default: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var pgUserResource = new PgUser("pgUserResource", PgUserArgs.builder()
    .clusterId("string")
    .password("string")
    .username("string")
    .pgUserId("string")
    .timeouts(PgUserTimeoutsArgs.builder()
        .create("string")
        .default_("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
pg_user_resource = ionoscloud.PgUser("pgUserResource",
    cluster_id="string",
    password="string",
    username="string",
    pg_user_id="string",
    timeouts={
        "create": "string",
        "default": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const pgUserResource = new ionoscloud.PgUser("pgUserResource", {
    clusterId: "string",
    password: "string",
    username: "string",
    pgUserId: "string",
    timeouts: {
        create: "string",
        "default": "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ionoscloud:PgUser
properties:
    clusterId: string
    password: string
    pgUserId: string
    timeouts:
        create: string
        default: string
        delete: string
        update: string
    username: string
Copy

PgUser Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PgUser resource accepts the following input properties:

ClusterId This property is required. string
Password This property is required. string
Username This property is required. string
PgUserId string
Timeouts PgUserTimeouts
ClusterId This property is required. string
Password This property is required. string
Username This property is required. string
PgUserId string
Timeouts PgUserTimeoutsArgs
clusterId This property is required. String
password This property is required. String
username This property is required. String
pgUserId String
timeouts PgUserTimeouts
clusterId This property is required. string
password This property is required. string
username This property is required. string
pgUserId string
timeouts PgUserTimeouts
cluster_id This property is required. str
password This property is required. str
username This property is required. str
pg_user_id str
timeouts PgUserTimeoutsArgs
clusterId This property is required. String
password This property is required. String
username This property is required. String
pgUserId String
timeouts Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the PgUser resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
IsSystemUser bool
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
Id string
The provider-assigned unique ID for this managed resource.
IsSystemUser bool
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
id String
The provider-assigned unique ID for this managed resource.
isSystemUser Boolean
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
id string
The provider-assigned unique ID for this managed resource.
isSystemUser boolean
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
id str
The provider-assigned unique ID for this managed resource.
is_system_user bool
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
id String
The provider-assigned unique ID for this managed resource.
isSystemUser Boolean
Describes whether this user is a system user or not. A system user cannot be updated or deleted.

Look up Existing PgUser Resource

Get an existing PgUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PgUserState, opts?: CustomResourceOptions): PgUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        is_system_user: Optional[bool] = None,
        password: Optional[str] = None,
        pg_user_id: Optional[str] = None,
        timeouts: Optional[PgUserTimeoutsArgs] = None,
        username: Optional[str] = None) -> PgUser
func GetPgUser(ctx *Context, name string, id IDInput, state *PgUserState, opts ...ResourceOption) (*PgUser, error)
public static PgUser Get(string name, Input<string> id, PgUserState? state, CustomResourceOptions? opts = null)
public static PgUser get(String name, Output<String> id, PgUserState state, CustomResourceOptions options)
resources:  _:    type: ionoscloud:PgUser    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClusterId string
IsSystemUser bool
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
Password string
PgUserId string
Timeouts PgUserTimeouts
Username string
ClusterId string
IsSystemUser bool
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
Password string
PgUserId string
Timeouts PgUserTimeoutsArgs
Username string
clusterId String
isSystemUser Boolean
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
password String
pgUserId String
timeouts PgUserTimeouts
username String
clusterId string
isSystemUser boolean
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
password string
pgUserId string
timeouts PgUserTimeouts
username string
cluster_id str
is_system_user bool
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
password str
pg_user_id str
timeouts PgUserTimeoutsArgs
username str
clusterId String
isSystemUser Boolean
Describes whether this user is a system user or not. A system user cannot be updated or deleted.
password String
pgUserId String
timeouts Property Map
username String

Supporting Types

PgUserTimeouts
, PgUserTimeoutsArgs

Create string
Default string
Delete string
Update string
Create string
Default string
Delete string
Update string
create String
default_ String
delete String
update String
create string
default string
delete string
update string
create String
default String
delete String
update String

Package Details

Repository
ionoscloud ionos-cloud/terraform-provider-ionoscloud
License
Notes
This Pulumi package is based on the ionoscloud Terraform Provider.