PostgreSQL

v3.6.0 published on Tuesday, Aug 23, 2022 by Pulumi

Extension

The postgresql.Extension resource creates and manages an extension on a PostgreSQL server.

Usage

import * as pulumi from "@pulumi/pulumi";
import * as postgresql from "@pulumi/postgresql";

const myExtension = new postgresql.Extension("my_extension", {});
import pulumi
import pulumi_postgresql as postgresql

my_extension = postgresql.Extension("myExtension")
using System.Collections.Generic;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

return await Deployment.RunAsync(() => 
{
    var myExtension = new PostgreSql.Extension("myExtension");

});
package main

import (
	"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := postgresql.NewExtension(ctx, "myExtension", nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Extension;
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 myExtension = new Extension("myExtension");

    }
}
resources:
  myExtension:
    type: postgresql:Extension

Create Extension Resource

new Extension(name: string, args?: ExtensionArgs, opts?: CustomResourceOptions);
@overload
def Extension(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              create_cascade: Optional[bool] = None,
              database: Optional[str] = None,
              drop_cascade: Optional[bool] = None,
              name: Optional[str] = None,
              schema: Optional[str] = None,
              version: Optional[str] = None)
@overload
def Extension(resource_name: str,
              args: Optional[ExtensionArgs] = None,
              opts: Optional[ResourceOptions] = None)
func NewExtension(ctx *Context, name string, args *ExtensionArgs, opts ...ResourceOption) (*Extension, error)
public Extension(string name, ExtensionArgs? args = null, CustomResourceOptions? opts = null)
public Extension(String name, ExtensionArgs args)
public Extension(String name, ExtensionArgs args, CustomResourceOptions options)
type: postgresql:Extension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ExtensionArgs
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 ExtensionArgs
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 ExtensionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ExtensionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ExtensionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Extension Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Extension resource accepts the following input properties:

CreateCascade bool

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

Database string

Which database to create the extension on. Defaults to provider database.

DropCascade bool

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

Name string

The name of the extension.

Schema string

Sets the schema of an extension.

Version string

Sets the version number of the extension.

CreateCascade bool

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

Database string

Which database to create the extension on. Defaults to provider database.

DropCascade bool

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

Name string

The name of the extension.

Schema string

Sets the schema of an extension.

Version string

Sets the version number of the extension.

createCascade Boolean

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

database String

Which database to create the extension on. Defaults to provider database.

dropCascade Boolean

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

name String

The name of the extension.

schema String

Sets the schema of an extension.

version String

Sets the version number of the extension.

createCascade boolean

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

database string

Which database to create the extension on. Defaults to provider database.

dropCascade boolean

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

name string

The name of the extension.

schema string

Sets the schema of an extension.

version string

Sets the version number of the extension.

create_cascade bool

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

database str

Which database to create the extension on. Defaults to provider database.

drop_cascade bool

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

name str

The name of the extension.

schema str

Sets the schema of an extension.

version str

Sets the version number of the extension.

createCascade Boolean

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

database String

Which database to create the extension on. Defaults to provider database.

dropCascade Boolean

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

name String

The name of the extension.

schema String

Sets the schema of an extension.

version String

Sets the version number of the extension.

Outputs

All input properties are implicitly available as output properties. Additionally, the Extension 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 Extension Resource

Get an existing Extension 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?: ExtensionState, opts?: CustomResourceOptions): Extension
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_cascade: Optional[bool] = None,
        database: Optional[str] = None,
        drop_cascade: Optional[bool] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        version: Optional[str] = None) -> Extension
func GetExtension(ctx *Context, name string, id IDInput, state *ExtensionState, opts ...ResourceOption) (*Extension, error)
public static Extension Get(string name, Input<string> id, ExtensionState? state, CustomResourceOptions? opts = null)
public static Extension get(String name, Output<String> id, ExtensionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
CreateCascade bool

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

Database string

Which database to create the extension on. Defaults to provider database.

DropCascade bool

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

Name string

The name of the extension.

Schema string

Sets the schema of an extension.

Version string

Sets the version number of the extension.

CreateCascade bool

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

Database string

Which database to create the extension on. Defaults to provider database.

DropCascade bool

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

Name string

The name of the extension.

Schema string

Sets the schema of an extension.

Version string

Sets the version number of the extension.

createCascade Boolean

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

database String

Which database to create the extension on. Defaults to provider database.

dropCascade Boolean

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

name String

The name of the extension.

schema String

Sets the schema of an extension.

version String

Sets the version number of the extension.

createCascade boolean

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

database string

Which database to create the extension on. Defaults to provider database.

dropCascade boolean

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

name string

The name of the extension.

schema string

Sets the schema of an extension.

version string

Sets the version number of the extension.

create_cascade bool

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

database str

Which database to create the extension on. Defaults to provider database.

drop_cascade bool

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

name str

The name of the extension.

schema str

Sets the schema of an extension.

version str

Sets the version number of the extension.

createCascade Boolean

When true, will also create any extensions that this extension depends on that are not already installed. (Default: false)

database String

Which database to create the extension on. Defaults to provider database.

dropCascade Boolean

When true, will also drop all the objects that depend on the extension, and in turn all objects that depend on those objects. (Default: false)

name String

The name of the extension.

schema String

Sets the schema of an extension.

version String

Sets the version number of the extension.

Package Details

Repository
https://github.com/pulumi/pulumi-postgresql
License
Apache-2.0
Notes

This Pulumi package is based on the postgresql Terraform Provider.