azurermPostgresqlDatabase
Manages a PostgreSQL Database within a PostgreSQL Server
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "api-rg-pro",
}
);
const azurermPostgresqlServerExample =
new azurerm.postgresqlServer.PostgresqlServer(this, "example_1", {
administrator_login: "psqladmin",
administrator_login_password: "H@Sh1CoR3!",
auto_grow_enabled: true,
backup_retention_days: 7,
geo_redundant_backup_enabled: false,
location: azurermResourceGroupExample.location,
name: "postgresql-server-1",
resource_group_name: azurermResourceGroupExample.name,
sku_name: "B_Gen5_2",
ssl_enforcement_enabled: true,
storage_mb: 5120,
version: "9.5",
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermPostgresqlServerExample.overrideLogicalId("example");
const azurermPostgresqlDatabaseExample =
new azurerm.postgresqlDatabase.PostgresqlDatabase(this, "example_2", {
charset: "UTF8",
collation: "English_United States.1252",
name: "exampledb",
resource_group_name: azurermResourceGroupExample.name,
server_name: azurermPostgresqlServerExample.name,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermPostgresqlDatabaseExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
name
- (Required) Specifies the name of the PostgreSQL Database, which needs to be a valid PostgreSQL identifier. Changing this forces a new resource to be created. -
serverName
- (Required) Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created. -
resourceGroupName
- (Required) The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created. -
charset
- (Required) Specifies the Charset for the PostgreSQL Database, which needs to be a valid PostgreSQL Charset. Changing this forces a new resource to be created. -
collation
- (Required) Specifies the Collation for the PostgreSQL Database, which needs to be a valid PostgreSQL Collation. Note that Microsoft uses different notation - en-US instead of en_US. Changing this forces a new resource to be created.
Attributes Reference
The following attributes are exported:
id
- The ID of the PostgreSQL Database.
Timeouts
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 60 minutes) Used when creating the PostgreSQL Database.update
- (Defaults to 60 minutes) Used when updating the PostgreSQL Database.read
- (Defaults to 5 minutes) Used when retrieving the PostgreSQL Database.delete
- (Defaults to 60 minutes) Used when deleting the PostgreSQL Database.
Import
PostgreSQL Database's can be imported using the resourceId
, e.g.