Publication class
The postgresql.Publication resource creates and manages a publication on a PostgreSQL
server.
Usage
import * as pulumi from "@pulumi/pulumi";
import * as postgresql from "@pulumi/postgresql";
const publication = new postgresql.Publication("publication", {
name: "publication",
tables: [
"public.test",
"another_schema.test",
],
});
import pulumi
import pulumi_postgresql as postgresql
publication = postgresql.Publication("publication",
name="publication",
tables=[
"public.test",
"another_schema.test",
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;
return await Deployment.RunAsync(() =>
{
var publication = new PostgreSql.Publication("publication", new()
{
Name = "publication",
Tables = new[]
{
"public.test",
"another_schema.test",
},
});
});
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.NewPublication(ctx, "publication", &postgresql.PublicationArgs{
Name: pulumi.String("publication"),
Tables: pulumi.StringArray{
pulumi.String("public.test"),
pulumi.String("another_schema.test"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
postgresql = {
source = "pulumi/postgresql"
}
}
}
resource "postgresql_publication" "publication" {
name = "publication"
tables = ["public.test", "another_schema.test"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Publication;
import com.pulumi.postgresql.PublicationArgs;
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 publication = new Publication("publication", PublicationArgs.builder()
.name("publication")
.tables(
"public.test",
"another_schema.test")
.build());
}
}
resources:
publication:
type: postgresql:Publication
properties:
name: publication
tables:
- public.test
- another_schema.test
Import Example
Publication can be imported using this format:
$ terraform import postgresql_publication.publication {{database_name}}.{{publication_name}}
Constructors
- Publication(String name, {PublicationArgs? args, CustomResourceOptions? options})
-
Creates a new Publication.
nameThe Pulumi resource name.argsArguments used to configure this Publication. The set of arguments for Publication.optionsResource options controlling this resource's behavior.
Properties
-
allTables
↔ Output<
bool> -
Should be ALL TABLES added to the publication. Defaults to 'false'
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
database
↔ Output<
String> -
Which database to create the publication on. Defaults to provider database.
latefinal
-
dropCascade
↔ Output<
bool?> -
Should all subsequent resources of the publication be dropped. Defaults to 'false'
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
-
owner
↔ Output<
String> -
Who owns the publication. Defaults to provider user.
latefinal
-
publishParams
↔ Output<
List< String> > -
Which 'publish' options should be turned on. Default to 'insert','update','delete'
latefinal
-
publishViaPartitionRootParam
↔ Output<
bool?> -
Should be option 'publish_via_partition_root' be turned on. Default to 'false'
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
tables
↔ Output<
List< String> > -
Which tables add to the publication. By defaults no tables added. Format of table is
<schema_name>.<table_name>. If<schema_name>is not specified - default database schema will be used. Table string must be listed in alphabetical order.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, {PublicationState? state}) → Publication -
Gets an existing Publication resource's state with the given
nameandid.