|
190 | 190 | }, |
191 | 191 | "provider": { |
192 | 192 | "description": "The provider type for the postgresql package. By default, resources use package-wide configuration\nsettings, however an explicit `Provider` instance may be created and passed during resource\nconstruction to achieve fine-grained programmatic control over provider settings. See the\n[documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.\n", |
| 193 | + "properties": { |
| 194 | + "clientcert": { |
| 195 | + "$ref": "#/types/postgresql:index/ProviderClientcert:ProviderClientcert", |
| 196 | + "description": "SSL client certificate if required by the database.\n" |
| 197 | + }, |
| 198 | + "connectTimeout": { |
| 199 | + "type": "integer", |
| 200 | + "description": "Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.\n" |
| 201 | + }, |
| 202 | + "database": { |
| 203 | + "type": "string", |
| 204 | + "description": "The name of the database to connect to in order to conenct to (defaults to `postgres`).\n" |
| 205 | + }, |
| 206 | + "databaseUsername": { |
| 207 | + "type": "string", |
| 208 | + "description": "Database username associated to the connected user (for user name maps)\n" |
| 209 | + }, |
| 210 | + "expectedVersion": { |
| 211 | + "type": "string", |
| 212 | + "description": "Specify the expected version of PostgreSQL.\n" |
| 213 | + }, |
| 214 | + "host": { |
| 215 | + "type": "string", |
| 216 | + "description": "Name of PostgreSQL server address to connect to\n" |
| 217 | + }, |
| 218 | + "maxConnections": { |
| 219 | + "type": "integer", |
| 220 | + "description": "Maximum number of connections to establish to the database. Zero means unlimited.\n" |
| 221 | + }, |
| 222 | + "password": { |
| 223 | + "type": "string", |
| 224 | + "description": "Password to be used if the PostgreSQL server demands password authentication\n" |
| 225 | + }, |
| 226 | + "port": { |
| 227 | + "type": "integer", |
| 228 | + "description": "The PostgreSQL port number to connect to at the server host, or socket file name extension for Unix-domain connections\n" |
| 229 | + }, |
| 230 | + "scheme": { |
| 231 | + "type": "string" |
| 232 | + }, |
| 233 | + "sslMode": { |
| 234 | + "type": "string", |
| 235 | + "deprecationMessage": "Rename PostgreSQL provider `ssl_mode` attribute to `sslmode`" |
| 236 | + }, |
| 237 | + "sslmode": { |
| 238 | + "type": "string", |
| 239 | + "description": "This option determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the\nPostgreSQL server\n" |
| 240 | + }, |
| 241 | + "sslrootcert": { |
| 242 | + "type": "string", |
| 243 | + "description": "The SSL server root certificate file path. The file must contain PEM encoded data.\n" |
| 244 | + }, |
| 245 | + "superuser": { |
| 246 | + "type": "boolean", |
| 247 | + "description": "Specify if the user to connect as is a Postgres superuser or not.If not, some feature might be disabled (e.g.:\nRefreshing state password from Postgres)\n" |
| 248 | + }, |
| 249 | + "username": { |
| 250 | + "type": "string", |
| 251 | + "description": "PostgreSQL user name to connect as\n" |
| 252 | + } |
| 253 | + }, |
193 | 254 | "inputProperties": { |
194 | 255 | "clientcert": { |
195 | 256 | "$ref": "#/types/postgresql:index/ProviderClientcert:ProviderClientcert", |
|
743 | 804 | } |
744 | 805 | }, |
745 | 806 | "postgresql:index/grant:Grant": { |
746 | | - "description": "The ``postgresql.Grant`` resource creates and manages privileges given to a user for a database schema.\n\nSee [PostgreSQL documentation](https://www.postgresql.org/docs/current/sql-grant.html)\n\n\u003e **Note:** This resource needs Postgresql version 9 or above.\n\n## Usage\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as postgresql from \"@pulumi/postgresql\";\n\nconst readonlyTables = new postgresql.Grant(\"readonly_tables\", {\n database: \"test_db\",\n objectType: \"table\",\n objects: [\n \"table1\",\n \"table2\",\n ],\n privileges: [\"SELECT\"],\n role: \"test_role\",\n schema: \"public\",\n});\n```\n```python\nimport pulumi\nimport pulumi_postgresql as postgresql\n\nreadonly_tables = postgresql.Grant(\"readonlyTables\",\n database=\"test_db\",\n object_type=\"table\",\n objects=[\n \"table1\",\n \"table2\",\n ],\n privileges=[\"SELECT\"],\n role=\"test_role\",\n schema=\"public\")\n```\n```csharp\nusing Pulumi;\nusing PostgreSql = Pulumi.PostgreSql;\n\nclass MyStack : Stack\n{\n public MyStack()\n {\n var readonlyTables = new PostgreSql.Grant(\"readonlyTables\", new PostgreSql.GrantArgs\n {\n Database = \"test_db\",\n ObjectType = \"table\",\n Objects = \n {\n \"table1\",\n \"table2\",\n },\n Privileges = \n {\n \"SELECT\",\n },\n Role = \"test_role\",\n Schema = \"public\",\n });\n }\n\n}\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := postgresql.NewGrant(ctx, \"readonlyTables\", \u0026postgresql.GrantArgs{\n\t\t\tDatabase: pulumi.String(\"test_db\"),\n\t\t\tObjectType: pulumi.String(\"table\"),\n\t\t\tObjects: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"table1\"),\n\t\t\t\tpulumi.String(\"table2\"),\n\t\t\t},\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t},\n\t\t\tRole: pulumi.String(\"test_role\"),\n\t\t\tSchema: pulumi.String(\"public\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n\n## Examples\n\nRevoke default accesses for public schema:\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as postgresql from \"@pulumi/postgresql\";\n\nconst revokePublic = new postgresql.Grant(\"revoke_public\", {\n database: \"test_db\",\n objectType: \"schema\",\n privileges: [],\n role: \"public\",\n schema: \"public\",\n});\n```\n```python\nimport pulumi\nimport pulumi_postgresql as postgresql\n\nrevoke_public = postgresql.Grant(\"revokePublic\",\n database=\"test_db\",\n object_type=\"schema\",\n privileges=[],\n role=\"public\",\n schema=\"public\")\n```\n```csharp\nusing Pulumi;\nusing PostgreSql = Pulumi.PostgreSql;\n\nclass MyStack : Stack\n{\n public MyStack()\n {\n var revokePublic = new PostgreSql.Grant(\"revokePublic\", new PostgreSql.GrantArgs\n {\n Database = \"test_db\",\n ObjectType = \"schema\",\n Privileges = {},\n Role = \"public\",\n Schema = \"public\",\n });\n }\n\n}\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := postgresql.NewGrant(ctx, \"revokePublic\", \u0026postgresql.GrantArgs{\n\t\t\tDatabase: pulumi.String(\"test_db\"),\n\t\t\tObjectType: pulumi.String(\"schema\"),\n\t\t\tPrivileges: []interface{}{},\n\t\t\tRole: pulumi.String(\"public\"),\n\t\t\tSchema: pulumi.String(\"public\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n", |
| 807 | + "description": "The ``postgresql.Grant`` resource creates and manages privileges given to a user for a database schema.\n\nSee [PostgreSQL documentation](https://www.postgresql.org/docs/current/sql-grant.html)\n\n\u003e **Note:** This resource needs Postgresql version 9 or above.\n\n## Usage\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as postgresql from \"@pulumi/postgresql\";\n\nconst readonlyTables = new postgresql.Grant(\"readonly_tables\", {\n database: \"test_db\",\n objectType: \"table\",\n objects: [\n \"table1\",\n \"table2\",\n ],\n privileges: [\"SELECT\"],\n role: \"test_role\",\n schema: \"public\",\n});\n```\n```python\nimport pulumi\nimport pulumi_postgresql as postgresql\n\nreadonly_tables = postgresql.Grant(\"readonlyTables\",\n database=\"test_db\",\n object_type=\"table\",\n objects=[\n \"table1\",\n \"table2\",\n ],\n privileges=[\"SELECT\"],\n role=\"test_role\",\n schema=\"public\")\n```\n```csharp\nusing Pulumi;\nusing PostgreSql = Pulumi.PostgreSql;\n\nclass MyStack : Stack\n{\n public MyStack()\n {\n var readonlyTables = new PostgreSql.Grant(\"readonlyTables\", new PostgreSql.GrantArgs\n {\n Database = \"test_db\",\n ObjectType = \"table\",\n Objects = \n {\n \"table1\",\n \"table2\",\n },\n Privileges = \n {\n \"SELECT\",\n },\n Role = \"test_role\",\n Schema = \"public\",\n });\n }\n\n}\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := postgresql.NewGrant(ctx, \"readonlyTables\", \u0026postgresql.GrantArgs{\n\t\t\tDatabase: pulumi.String(\"test_db\"),\n\t\t\tObjectType: pulumi.String(\"table\"),\n\t\t\tObjects: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"table1\"),\n\t\t\t\tpulumi.String(\"table2\"),\n\t\t\t},\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t},\n\t\t\tRole: pulumi.String(\"test_role\"),\n\t\t\tSchema: pulumi.String(\"public\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n\n## Examples\n\nRevoke default accesses for public schema:\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as postgresql from \"@pulumi/postgresql\";\n\nconst revokePublic = new postgresql.Grant(\"revoke_public\", {\n database: \"test_db\",\n objectType: \"schema\",\n privileges: [],\n role: \"public\",\n schema: \"public\",\n});\n```\n```python\nimport pulumi\nimport pulumi_postgresql as postgresql\n\nrevoke_public = postgresql.Grant(\"revokePublic\",\n database=\"test_db\",\n object_type=\"schema\",\n privileges=[],\n role=\"public\",\n schema=\"public\")\n```\n```csharp\nusing Pulumi;\nusing PostgreSql = Pulumi.PostgreSql;\n\nclass MyStack : Stack\n{\n public MyStack()\n {\n var revokePublic = new PostgreSql.Grant(\"revokePublic\", new PostgreSql.GrantArgs\n {\n Database = \"test_db\",\n ObjectType = \"schema\",\n Privileges = {},\n Role = \"public\",\n Schema = \"public\",\n });\n }\n\n}\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := postgresql.NewGrant(ctx, \"revokePublic\", \u0026postgresql.GrantArgs{\n\t\t\tDatabase: pulumi.String(\"test_db\"),\n\t\t\tObjectType: pulumi.String(\"schema\"),\n\t\t\tPrivileges: pulumi.StringArray{},\n\t\t\tRole: pulumi.String(\"public\"),\n\t\t\tSchema: pulumi.String(\"public\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n", |
747 | 808 | "properties": { |
748 | 809 | "database": { |
749 | 810 | "type": "string", |
|
0 commit comments