Subscription class

The postgresql.Subscription resource creates and manages a publication on a PostgreSQL server.

Usage

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

const subscription = new postgresql.Subscription("subscription", {
    name: "subscription",
    conninfo: "host=localhost port=5432 dbname=mydb user=postgres password=postgres",
    publications: ["publication"],
});
import pulumi
import pulumi_postgresql as postgresql

subscription = postgresql.Subscription("subscription",
    name="subscription",
    conninfo="host=localhost port=5432 dbname=mydb user=postgres password=postgres",
    publications=["publication"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

return await Deployment.RunAsync(() =>
{
    var subscription = new PostgreSql.Subscription("subscription", new()
    {
        Name = "subscription",
        Conninfo = "host=localhost port=5432 dbname=mydb user=postgres password=postgres",
        Publications = new[]
        {
            "publication",
        },
    });

});
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.NewSubscription(ctx, "subscription", &postgresql.SubscriptionArgs{
			Name:     pulumi.String("subscription"),
			Conninfo: pulumi.String("host=localhost port=5432 dbname=mydb user=postgres password=postgres"),
			Publications: pulumi.StringArray{
				pulumi.String("publication"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    postgresql = {
      source = "pulumi/postgresql"
    }
  }
}

resource "postgresql_subscription" "subscription" {
  name         = "subscription"
  conninfo     = "host=localhost port=5432 dbname=mydb user=postgres password=postgres"
  publications = ["publication"]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Subscription;
import com.pulumi.postgresql.SubscriptionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 subscription = new Subscription("subscription", SubscriptionArgs.builder()
            .name("subscription")
            .conninfo("host=localhost port=5432 dbname=mydb user=postgres password=postgres")
            .publications("publication")
            .build());

    }
}
resources:
  subscription:
    type: postgresql:Subscription
    properties:
      name: subscription
      conninfo: host=localhost port=5432 dbname=mydb user=postgres password=postgres
      publications:
        - publication

Postgres documentation

Constructors

Subscription(String name, {SubscriptionArgs? args, CustomResourceOptions? options})
Creates a new Subscription. name The Pulumi resource name. args Arguments used to configure this Subscription. The set of arguments for Subscription. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
conninfo ↔ Output<String>
The connection string to the publisher. It should follow the keyword/value format
latefinal
createSlot ↔ Output<bool?>
Specifies whether the command should create the replication slot on the publisher. Default behavior is true
latefinal
database ↔ Output<String>
Which database to create the subscription on. Defaults to provider database.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the publication.
latefinal
publications ↔ Output<List<String>>
Names of the publications on the publisher to subscribe to
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
slotName ↔ Output<String?>
Name of the replication slot to use. The default behavior is to use the name of the subscription for the slot name
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {SubscriptionState? state}) → Subscription
Gets an existing Subscription resource's state with the given name and id.