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

ionoscloud.PgDatabase

Explore with Pulumi AI

Create PgDatabase Resource

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

Constructor syntax

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

@overload
def PgDatabase(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               cluster_id: Optional[str] = None,
               owner: Optional[str] = None,
               name: Optional[str] = None,
               pg_database_id: Optional[str] = None,
               timeouts: Optional[PgDatabaseTimeoutsArgs] = None)
func NewPgDatabase(ctx *Context, name string, args PgDatabaseArgs, opts ...ResourceOption) (*PgDatabase, error)
public PgDatabase(string name, PgDatabaseArgs args, CustomResourceOptions? opts = null)
public PgDatabase(String name, PgDatabaseArgs args)
public PgDatabase(String name, PgDatabaseArgs args, CustomResourceOptions options)
type: ionoscloud:PgDatabase
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. PgDatabaseArgs
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. PgDatabaseArgs
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. PgDatabaseArgs
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. PgDatabaseArgs
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. PgDatabaseArgs
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 pgDatabaseResource = new Ionoscloud.PgDatabase("pgDatabaseResource", new()
{
    ClusterId = "string",
    Owner = "string",
    Name = "string",
    PgDatabaseId = "string",
    Timeouts = new Ionoscloud.Inputs.PgDatabaseTimeoutsArgs
    {
        Create = "string",
        Default = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ionoscloud.NewPgDatabase(ctx, "pgDatabaseResource", &ionoscloud.PgDatabaseArgs{
ClusterId: pulumi.String("string"),
Owner: pulumi.String("string"),
Name: pulumi.String("string"),
PgDatabaseId: pulumi.String("string"),
Timeouts: &.PgDatabaseTimeoutsArgs{
Create: pulumi.String("string"),
Default: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var pgDatabaseResource = new PgDatabase("pgDatabaseResource", PgDatabaseArgs.builder()
    .clusterId("string")
    .owner("string")
    .name("string")
    .pgDatabaseId("string")
    .timeouts(PgDatabaseTimeoutsArgs.builder()
        .create("string")
        .default_("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
pg_database_resource = ionoscloud.PgDatabase("pgDatabaseResource",
    cluster_id="string",
    owner="string",
    name="string",
    pg_database_id="string",
    timeouts={
        "create": "string",
        "default": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const pgDatabaseResource = new ionoscloud.PgDatabase("pgDatabaseResource", {
    clusterId: "string",
    owner: "string",
    name: "string",
    pgDatabaseId: "string",
    timeouts: {
        create: "string",
        "default": "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ionoscloud:PgDatabase
properties:
    clusterId: string
    name: string
    owner: string
    pgDatabaseId: string
    timeouts:
        create: string
        default: string
        delete: string
        update: string
Copy

PgDatabase 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 PgDatabase resource accepts the following input properties:

ClusterId This property is required. string
Owner This property is required. string
The name of the role owning a given database.
Name string
The databasename of a given database.
PgDatabaseId string
Timeouts PgDatabaseTimeouts
ClusterId This property is required. string
Owner This property is required. string
The name of the role owning a given database.
Name string
The databasename of a given database.
PgDatabaseId string
Timeouts PgDatabaseTimeoutsArgs
clusterId This property is required. String
owner This property is required. String
The name of the role owning a given database.
name String
The databasename of a given database.
pgDatabaseId String
timeouts PgDatabaseTimeouts
clusterId This property is required. string
owner This property is required. string
The name of the role owning a given database.
name string
The databasename of a given database.
pgDatabaseId string
timeouts PgDatabaseTimeouts
cluster_id This property is required. str
owner This property is required. str
The name of the role owning a given database.
name str
The databasename of a given database.
pg_database_id str
timeouts PgDatabaseTimeoutsArgs
clusterId This property is required. String
owner This property is required. String
The name of the role owning a given database.
name String
The databasename of a given database.
pgDatabaseId String
timeouts Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing PgDatabase Resource

Get an existing PgDatabase 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?: PgDatabaseState, opts?: CustomResourceOptions): PgDatabase
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        pg_database_id: Optional[str] = None,
        timeouts: Optional[PgDatabaseTimeoutsArgs] = None) -> PgDatabase
func GetPgDatabase(ctx *Context, name string, id IDInput, state *PgDatabaseState, opts ...ResourceOption) (*PgDatabase, error)
public static PgDatabase Get(string name, Input<string> id, PgDatabaseState? state, CustomResourceOptions? opts = null)
public static PgDatabase get(String name, Output<String> id, PgDatabaseState state, CustomResourceOptions options)
resources:  _:    type: ionoscloud:PgDatabase    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
Name string
The databasename of a given database.
Owner string
The name of the role owning a given database.
PgDatabaseId string
Timeouts PgDatabaseTimeouts
ClusterId string
Name string
The databasename of a given database.
Owner string
The name of the role owning a given database.
PgDatabaseId string
Timeouts PgDatabaseTimeoutsArgs
clusterId String
name String
The databasename of a given database.
owner String
The name of the role owning a given database.
pgDatabaseId String
timeouts PgDatabaseTimeouts
clusterId string
name string
The databasename of a given database.
owner string
The name of the role owning a given database.
pgDatabaseId string
timeouts PgDatabaseTimeouts
cluster_id str
name str
The databasename of a given database.
owner str
The name of the role owning a given database.
pg_database_id str
timeouts PgDatabaseTimeoutsArgs
clusterId String
name String
The databasename of a given database.
owner String
The name of the role owning a given database.
pgDatabaseId String
timeouts Property Map

Supporting Types

PgDatabaseTimeouts
, PgDatabaseTimeoutsArgs

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.