|
63 | 63 | * [`postgresql::server::schema`](#postgresql--server--schema): Create a new schema. |
64 | 64 | * [`postgresql::server::table_grant`](#postgresql--server--table_grant): This resource wraps the grant resource to manage table grants specifically. |
65 | 65 | * [`postgresql::server::tablespace`](#postgresql--server--tablespace): This module creates tablespace. |
66 | | -* [`postgresql::validate_db_connection`](#postgresql--validate_db_connection): This type validates that a successful postgres connection. |
67 | 66 |
|
68 | 67 | #### Private Defined types |
69 | 68 |
|
@@ -3763,107 +3762,6 @@ Specifies a hash of environment variables used when connecting to a remote serve |
3763 | 3762 |
|
3764 | 3763 | Default value: `$postgresql::server::default_connect_settings` |
3765 | 3764 |
|
3766 | | -### <a name="postgresql--validate_db_connection"></a>`postgresql::validate_db_connection` |
3767 | | - |
3768 | | -This validated if the postgres connection can be established |
3769 | | -between the node on which this resource is run and a specified postgres |
3770 | | -instance (host/port/user/password/database name). |
3771 | | - |
3772 | | -#### Parameters |
3773 | | - |
3774 | | -The following parameters are available in the `postgresql::validate_db_connection` defined type: |
3775 | | - |
3776 | | -* [`database_host`](#-postgresql--validate_db_connection--database_host) |
3777 | | -* [`database_name`](#-postgresql--validate_db_connection--database_name) |
3778 | | -* [`database_password`](#-postgresql--validate_db_connection--database_password) |
3779 | | -* [`database_username`](#-postgresql--validate_db_connection--database_username) |
3780 | | -* [`database_port`](#-postgresql--validate_db_connection--database_port) |
3781 | | -* [`connect_settings`](#-postgresql--validate_db_connection--connect_settings) |
3782 | | -* [`run_as`](#-postgresql--validate_db_connection--run_as) |
3783 | | -* [`sleep`](#-postgresql--validate_db_connection--sleep) |
3784 | | -* [`tries`](#-postgresql--validate_db_connection--tries) |
3785 | | -* [`create_db_first`](#-postgresql--validate_db_connection--create_db_first) |
3786 | | - |
3787 | | -##### <a name="-postgresql--validate_db_connection--database_host"></a>`database_host` |
3788 | | - |
3789 | | -Data type: `Optional[String[1]]` |
3790 | | - |
3791 | | -Database host address |
3792 | | - |
3793 | | -Default value: `undef` |
3794 | | - |
3795 | | -##### <a name="-postgresql--validate_db_connection--database_name"></a>`database_name` |
3796 | | - |
3797 | | -Data type: `Optional[String[1]]` |
3798 | | - |
3799 | | -Specifies the name of the database you wish to test. |
3800 | | - |
3801 | | -Default value: `undef` |
3802 | | - |
3803 | | -##### <a name="-postgresql--validate_db_connection--database_password"></a>`database_password` |
3804 | | - |
3805 | | -Data type: `Optional[Variant[String, Sensitive[String]]]` |
3806 | | - |
3807 | | -Specifies the password to connect with. |
3808 | | - |
3809 | | -Default value: `undef` |
3810 | | - |
3811 | | -##### <a name="-postgresql--validate_db_connection--database_username"></a>`database_username` |
3812 | | - |
3813 | | -Data type: `Optional[String[1]]` |
3814 | | - |
3815 | | -Specifies the username to connect with. |
3816 | | - |
3817 | | -Default value: `undef` |
3818 | | - |
3819 | | -##### <a name="-postgresql--validate_db_connection--database_port"></a>`database_port` |
3820 | | - |
3821 | | -Data type: `Optional[Variant[String[1], Integer]]` |
3822 | | - |
3823 | | -Defines the port to use when connecting. |
3824 | | - |
3825 | | -Default value: `undef` |
3826 | | - |
3827 | | -##### <a name="-postgresql--validate_db_connection--connect_settings"></a>`connect_settings` |
3828 | | - |
3829 | | -Data type: `Optional[Hash]` |
3830 | | - |
3831 | | -Specifies a hash of environment variables used when connecting to a remote server. |
3832 | | - |
3833 | | -Default value: `undef` |
3834 | | - |
3835 | | -##### <a name="-postgresql--validate_db_connection--run_as"></a>`run_as` |
3836 | | - |
3837 | | -Data type: `Optional[String[1]]` |
3838 | | - |
3839 | | -Specifies the user to run the psql command as. |
3840 | | - |
3841 | | -Default value: `undef` |
3842 | | - |
3843 | | -##### <a name="-postgresql--validate_db_connection--sleep"></a>`sleep` |
3844 | | - |
3845 | | -Data type: `Integer` |
3846 | | - |
3847 | | -Sets the number of seconds to sleep for before trying again after a failure. |
3848 | | - |
3849 | | -Default value: `2` |
3850 | | - |
3851 | | -##### <a name="-postgresql--validate_db_connection--tries"></a>`tries` |
3852 | | - |
3853 | | -Data type: `Integer` |
3854 | | - |
3855 | | -Sets the number of attempts after failure before giving up and failing the resource. |
3856 | | - |
3857 | | -Default value: `10` |
3858 | | - |
3859 | | -##### <a name="-postgresql--validate_db_connection--create_db_first"></a>`create_db_first` |
3860 | | - |
3861 | | -Data type: `Boolean` |
3862 | | - |
3863 | | -Creates the database when obtaining a successful connection. |
3864 | | - |
3865 | | -Default value: `true` |
3866 | | - |
3867 | 3765 | ## Resource types |
3868 | 3766 |
|
3869 | 3767 | ### <a name="postgresql_conf"></a>`postgresql_conf` |
|
0 commit comments