published on Monday, Apr 20, 2026 by Pulumi
published on Monday, Apr 20, 2026 by Pulumi
# f5bigip.GtmMonitorPostgresql Resource
Provides a BIG-IP GTM (Global Traffic Manager) PostgreSQL Monitor resource. This resource allows you to configure and manage GTM PostgreSQL health monitors on a BIG-IP system.
Description
A GTM PostgreSQL monitor verifies PostgreSQL database services by connecting to a database and optionally executing a query and evaluating the response. PostgreSQL monitors support database-specific configuration including database name, username, password, and instance count.
Example Usage
Basic PostgreSQL Monitor
import * as pulumi from "@pulumi/pulumi";
import * as f5bigip from "@pulumi/f5bigip";
const example = new f5bigip.GtmMonitorPostgresql("example", {name: "/Common/my_postgresql_monitor"});
import pulumi
import pulumi_f5bigip as f5bigip
example = f5bigip.GtmMonitorPostgresql("example", name="/Common/my_postgresql_monitor")
package main
import (
"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := f5bigip.NewGtmMonitorPostgresql(ctx, "example", &f5bigip.GtmMonitorPostgresqlArgs{
Name: pulumi.String("/Common/my_postgresql_monitor"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;
return await Deployment.RunAsync(() =>
{
var example = new F5BigIP.Index.GtmMonitorPostgresql("example", new()
{
Name = "/Common/my_postgresql_monitor",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.GtmMonitorPostgresql;
import com.pulumi.f5bigip.GtmMonitorPostgresqlArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new GtmMonitorPostgresql("example", GtmMonitorPostgresqlArgs.builder()
.name("/Common/my_postgresql_monitor")
.build());
}
}
resources:
example:
type: f5bigip:GtmMonitorPostgresql
properties:
name: /Common/my_postgresql_monitor
PostgreSQL Monitor with Authentication
import * as pulumi from "@pulumi/pulumi";
import * as f5bigip from "@pulumi/f5bigip";
const advanced = new f5bigip.GtmMonitorPostgresql("advanced", {
name: "/Common/my_postgresql_monitor",
defaultsFrom: "/Common/postgresql",
destination: "*:5432",
interval: 10,
timeout: 60,
probeTimeout: 3,
ignoreDownResponse: "disabled",
database: "mydb",
username: "monitor_user",
password: "monitor_pass",
receive: "SELECT",
debug: "no",
});
import pulumi
import pulumi_f5bigip as f5bigip
advanced = f5bigip.GtmMonitorPostgresql("advanced",
name="/Common/my_postgresql_monitor",
defaults_from="/Common/postgresql",
destination="*:5432",
interval=10,
timeout=60,
probe_timeout=3,
ignore_down_response="disabled",
database="mydb",
username="monitor_user",
password="monitor_pass",
receive="SELECT",
debug="no")
package main
import (
"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := f5bigip.NewGtmMonitorPostgresql(ctx, "advanced", &f5bigip.GtmMonitorPostgresqlArgs{
Name: pulumi.String("/Common/my_postgresql_monitor"),
DefaultsFrom: pulumi.String("/Common/postgresql"),
Destination: pulumi.String("*:5432"),
Interval: pulumi.Int(10),
Timeout: pulumi.Int(60),
ProbeTimeout: pulumi.Int(3),
IgnoreDownResponse: pulumi.String("disabled"),
Database: pulumi.String("mydb"),
Username: pulumi.String("monitor_user"),
Password: pulumi.String("monitor_pass"),
Receive: pulumi.String("SELECT"),
Debug: pulumi.String("no"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;
return await Deployment.RunAsync(() =>
{
var advanced = new F5BigIP.Index.GtmMonitorPostgresql("advanced", new()
{
Name = "/Common/my_postgresql_monitor",
DefaultsFrom = "/Common/postgresql",
Destination = "*:5432",
Interval = 10,
Timeout = 60,
ProbeTimeout = 3,
IgnoreDownResponse = "disabled",
Database = "mydb",
Username = "monitor_user",
Password = "monitor_pass",
Receive = "SELECT",
Debug = "no",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.GtmMonitorPostgresql;
import com.pulumi.f5bigip.GtmMonitorPostgresqlArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var advanced = new GtmMonitorPostgresql("advanced", GtmMonitorPostgresqlArgs.builder()
.name("/Common/my_postgresql_monitor")
.defaultsFrom("/Common/postgresql")
.destination("*:5432")
.interval(10)
.timeout(60)
.probeTimeout(3)
.ignoreDownResponse("disabled")
.database("mydb")
.username("monitor_user")
.password("monitor_pass")
.receive("SELECT")
.debug("no")
.build());
}
}
resources:
advanced:
type: f5bigip:GtmMonitorPostgresql
properties:
name: /Common/my_postgresql_monitor
defaultsFrom: /Common/postgresql
destination: '*:5432'
interval: 10
timeout: 60
probeTimeout: 3
ignoreDownResponse: disabled
database: mydb
username: monitor_user
password: monitor_pass
receive: SELECT
debug: no
Create GtmMonitorPostgresql Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GtmMonitorPostgresql(name: string, args: GtmMonitorPostgresqlArgs, opts?: CustomResourceOptions);@overload
def GtmMonitorPostgresql(resource_name: str,
args: GtmMonitorPostgresqlArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GtmMonitorPostgresql(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
interval: Optional[int] = None,
defaults_from: Optional[str] = None,
destination: Optional[str] = None,
ignore_down_response: Optional[str] = None,
instance_count: Optional[str] = None,
database: Optional[str] = None,
debug: Optional[str] = None,
password: Optional[str] = None,
probe_timeout: Optional[int] = None,
receive: Optional[str] = None,
timeout: Optional[int] = None,
username: Optional[str] = None)func NewGtmMonitorPostgresql(ctx *Context, name string, args GtmMonitorPostgresqlArgs, opts ...ResourceOption) (*GtmMonitorPostgresql, error)public GtmMonitorPostgresql(string name, GtmMonitorPostgresqlArgs args, CustomResourceOptions? opts = null)
public GtmMonitorPostgresql(String name, GtmMonitorPostgresqlArgs args)
public GtmMonitorPostgresql(String name, GtmMonitorPostgresqlArgs args, CustomResourceOptions options)
type: f5bigip:GtmMonitorPostgresql
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GtmMonitorPostgresqlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GtmMonitorPostgresqlArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GtmMonitorPostgresqlArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GtmMonitorPostgresqlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GtmMonitorPostgresqlArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GtmMonitorPostgresql 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 GtmMonitorPostgresql resource accepts the following input properties:
- Name string
- Name of the GTM PostgreSQL monitor
- Database string
- Specifies the database in which the user is created
- Debug string
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- Defaults
From string - Inherit properties from this monitor
- Destination string
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- Ignore
Down stringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- Instance
Count string - Specifies the number of instances for which the system keeps a connection open
- Interval int
- Specifies, in seconds, the frequency at which the system issues the monitor check
- Password string
- Specifies the password if the monitored target requires authentication
- Probe
Timeout int - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- Receive string
- Specifies the text string that the monitor looks for in the returned resource
- Timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- Username string
- Specifies the user name if the monitored target requires authentication
- Name string
- Name of the GTM PostgreSQL monitor
- Database string
- Specifies the database in which the user is created
- Debug string
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- Defaults
From string - Inherit properties from this monitor
- Destination string
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- Ignore
Down stringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- Instance
Count string - Specifies the number of instances for which the system keeps a connection open
- Interval int
- Specifies, in seconds, the frequency at which the system issues the monitor check
- Password string
- Specifies the password if the monitored target requires authentication
- Probe
Timeout int - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- Receive string
- Specifies the text string that the monitor looks for in the returned resource
- Timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- Username string
- Specifies the user name if the monitored target requires authentication
- name String
- Name of the GTM PostgreSQL monitor
- database String
- Specifies the database in which the user is created
- debug String
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- defaults
From String - Inherit properties from this monitor
- destination String
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- ignore
Down StringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- instance
Count String - Specifies the number of instances for which the system keeps a connection open
- interval Integer
- Specifies, in seconds, the frequency at which the system issues the monitor check
- password String
- Specifies the password if the monitored target requires authentication
- probe
Timeout Integer - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- receive String
- Specifies the text string that the monitor looks for in the returned resource
- timeout Integer
- Specifies the number of seconds the target has in which to respond to the monitor request
- username String
- Specifies the user name if the monitored target requires authentication
- name string
- Name of the GTM PostgreSQL monitor
- database string
- Specifies the database in which the user is created
- debug string
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- defaults
From string - Inherit properties from this monitor
- destination string
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- ignore
Down stringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- instance
Count string - Specifies the number of instances for which the system keeps a connection open
- interval number
- Specifies, in seconds, the frequency at which the system issues the monitor check
- password string
- Specifies the password if the monitored target requires authentication
- probe
Timeout number - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- receive string
- Specifies the text string that the monitor looks for in the returned resource
- timeout number
- Specifies the number of seconds the target has in which to respond to the monitor request
- username string
- Specifies the user name if the monitored target requires authentication
- name str
- Name of the GTM PostgreSQL monitor
- database str
- Specifies the database in which the user is created
- debug str
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- defaults_
from str - Inherit properties from this monitor
- destination str
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- ignore_
down_ strresponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- instance_
count str - Specifies the number of instances for which the system keeps a connection open
- interval int
- Specifies, in seconds, the frequency at which the system issues the monitor check
- password str
- Specifies the password if the monitored target requires authentication
- probe_
timeout int - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- receive str
- Specifies the text string that the monitor looks for in the returned resource
- timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- username str
- Specifies the user name if the monitored target requires authentication
- name String
- Name of the GTM PostgreSQL monitor
- database String
- Specifies the database in which the user is created
- debug String
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- defaults
From String - Inherit properties from this monitor
- destination String
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- ignore
Down StringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- instance
Count String - Specifies the number of instances for which the system keeps a connection open
- interval Number
- Specifies, in seconds, the frequency at which the system issues the monitor check
- password String
- Specifies the password if the monitored target requires authentication
- probe
Timeout Number - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- receive String
- Specifies the text string that the monitor looks for in the returned resource
- timeout Number
- Specifies the number of seconds the target has in which to respond to the monitor request
- username String
- Specifies the user name if the monitored target requires authentication
Outputs
All input properties are implicitly available as output properties. Additionally, the GtmMonitorPostgresql 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 GtmMonitorPostgresql Resource
Get an existing GtmMonitorPostgresql 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?: GtmMonitorPostgresqlState, opts?: CustomResourceOptions): GtmMonitorPostgresql@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
database: Optional[str] = None,
debug: Optional[str] = None,
defaults_from: Optional[str] = None,
destination: Optional[str] = None,
ignore_down_response: Optional[str] = None,
instance_count: Optional[str] = None,
interval: Optional[int] = None,
name: Optional[str] = None,
password: Optional[str] = None,
probe_timeout: Optional[int] = None,
receive: Optional[str] = None,
timeout: Optional[int] = None,
username: Optional[str] = None) -> GtmMonitorPostgresqlfunc GetGtmMonitorPostgresql(ctx *Context, name string, id IDInput, state *GtmMonitorPostgresqlState, opts ...ResourceOption) (*GtmMonitorPostgresql, error)public static GtmMonitorPostgresql Get(string name, Input<string> id, GtmMonitorPostgresqlState? state, CustomResourceOptions? opts = null)public static GtmMonitorPostgresql get(String name, Output<String> id, GtmMonitorPostgresqlState state, CustomResourceOptions options)resources: _: type: f5bigip:GtmMonitorPostgresql get: id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Database string
- Specifies the database in which the user is created
- Debug string
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- Defaults
From string - Inherit properties from this monitor
- Destination string
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- Ignore
Down stringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- Instance
Count string - Specifies the number of instances for which the system keeps a connection open
- Interval int
- Specifies, in seconds, the frequency at which the system issues the monitor check
- Name string
- Name of the GTM PostgreSQL monitor
- Password string
- Specifies the password if the monitored target requires authentication
- Probe
Timeout int - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- Receive string
- Specifies the text string that the monitor looks for in the returned resource
- Timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- Username string
- Specifies the user name if the monitored target requires authentication
- Database string
- Specifies the database in which the user is created
- Debug string
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- Defaults
From string - Inherit properties from this monitor
- Destination string
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- Ignore
Down stringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- Instance
Count string - Specifies the number of instances for which the system keeps a connection open
- Interval int
- Specifies, in seconds, the frequency at which the system issues the monitor check
- Name string
- Name of the GTM PostgreSQL monitor
- Password string
- Specifies the password if the monitored target requires authentication
- Probe
Timeout int - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- Receive string
- Specifies the text string that the monitor looks for in the returned resource
- Timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- Username string
- Specifies the user name if the monitored target requires authentication
- database String
- Specifies the database in which the user is created
- debug String
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- defaults
From String - Inherit properties from this monitor
- destination String
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- ignore
Down StringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- instance
Count String - Specifies the number of instances for which the system keeps a connection open
- interval Integer
- Specifies, in seconds, the frequency at which the system issues the monitor check
- name String
- Name of the GTM PostgreSQL monitor
- password String
- Specifies the password if the monitored target requires authentication
- probe
Timeout Integer - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- receive String
- Specifies the text string that the monitor looks for in the returned resource
- timeout Integer
- Specifies the number of seconds the target has in which to respond to the monitor request
- username String
- Specifies the user name if the monitored target requires authentication
- database string
- Specifies the database in which the user is created
- debug string
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- defaults
From string - Inherit properties from this monitor
- destination string
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- ignore
Down stringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- instance
Count string - Specifies the number of instances for which the system keeps a connection open
- interval number
- Specifies, in seconds, the frequency at which the system issues the monitor check
- name string
- Name of the GTM PostgreSQL monitor
- password string
- Specifies the password if the monitored target requires authentication
- probe
Timeout number - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- receive string
- Specifies the text string that the monitor looks for in the returned resource
- timeout number
- Specifies the number of seconds the target has in which to respond to the monitor request
- username string
- Specifies the user name if the monitored target requires authentication
- database str
- Specifies the database in which the user is created
- debug str
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- defaults_
from str - Inherit properties from this monitor
- destination str
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- ignore_
down_ strresponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- instance_
count str - Specifies the number of instances for which the system keeps a connection open
- interval int
- Specifies, in seconds, the frequency at which the system issues the monitor check
- name str
- Name of the GTM PostgreSQL monitor
- password str
- Specifies the password if the monitored target requires authentication
- probe_
timeout int - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- receive str
- Specifies the text string that the monitor looks for in the returned resource
- timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- username str
- Specifies the user name if the monitored target requires authentication
- database String
- Specifies the database in which the user is created
- debug String
- Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor
- defaults
From String - Inherit properties from this monitor
- destination String
- Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
- ignore
Down StringResponse - Specifies whether the monitor ignores a down response from the system it is monitoring
- instance
Count String - Specifies the number of instances for which the system keeps a connection open
- interval Number
- Specifies, in seconds, the frequency at which the system issues the monitor check
- name String
- Name of the GTM PostgreSQL monitor
- password String
- Specifies the password if the monitored target requires authentication
- probe
Timeout Number - Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
- receive String
- Specifies the text string that the monitor looks for in the returned resource
- timeout Number
- Specifies the number of seconds the target has in which to respond to the monitor request
- username String
- Specifies the user name if the monitored target requires authentication
Import
GTM PostgreSQL Monitor resources can be imported using the full path name:
$ pulumi import f5bigip:index/gtmMonitorPostgresql:GtmMonitorPostgresql example /Common/my_postgresql_monitor
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- f5 BIG-IP pulumi/pulumi-f5bigip
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
bigipTerraform Provider.
published on Monday, Apr 20, 2026 by Pulumi
