Docs Packages
  1. Packages
  2. PostgreSQL
  3. API Docs
  4. PhysicalReplicationSlot
PostgreSQL v3.11.0 published on Sunday, Mar 3, 2024 by Pulumi
pulumi/pulumi-postgresql

postgresql.PhysicalReplicationSlot

Explore with Pulumi AI

postgresql logo
PostgreSQL v3.11.0 published on Sunday, Mar 3, 2024 by Pulumi
pulumi/pulumi-postgresql

    The postgresql.PhysicalReplicationSlot resource creates and manages a physical replication slot on a PostgreSQL server. This is useful to setup a cross datacenter replication, with Patroni for example, or permit any stand-by cluster to replicate physically data.

    Usage

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

const mySlot = new postgresql.PhysicalReplicationSlot("mySlot", {});

    import pulumi
import pulumi_postgresql as postgresql

my_slot = postgresql.PhysicalReplicationSlot("mySlot")

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

return await Deployment.RunAsync(() => 
{
    var mySlot = new PostgreSql.PhysicalReplicationSlot("mySlot");

});

    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.NewPhysicalReplicationSlot(ctx, "mySlot", 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.PhysicalReplicationSlot;
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 mySlot = new PhysicalReplicationSlot("mySlot");

    }
}

    resources:
  mySlot:
    type: postgresql:PhysicalReplicationSlot

    Create PhysicalReplicationSlot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PhysicalReplicationSlot(name: string, args?: PhysicalReplicationSlotArgs, opts?: CustomResourceOptions);
    @overload
def PhysicalReplicationSlot(resource_name: str,
                            args: Optional[PhysicalReplicationSlotArgs] = None,
                            opts: Optional[ResourceOptions] = None)

@overload
def PhysicalReplicationSlot(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            name: Optional[str] = None)
    func NewPhysicalReplicationSlot(ctx *Context, name string, args *PhysicalReplicationSlotArgs, opts ...ResourceOption) (*PhysicalReplicationSlot, error)
    public PhysicalReplicationSlot(string name, PhysicalReplicationSlotArgs? args = null, CustomResourceOptions? opts = null)
    public PhysicalReplicationSlot(String name, PhysicalReplicationSlotArgs args)
public PhysicalReplicationSlot(String name, PhysicalReplicationSlotArgs args, CustomResourceOptions options)

    type: postgresql:PhysicalReplicationSlot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var physicalReplicationSlotResource = new PostgreSql.PhysicalReplicationSlot("physicalReplicationSlotResource", new()
{
    Name = "string",
});

    example, err := postgresql.NewPhysicalReplicationSlot(ctx, "physicalReplicationSlotResource", &postgresql.PhysicalReplicationSlotArgs{
	Name: pulumi.String("string"),
})

    var physicalReplicationSlotResource = new PhysicalReplicationSlot("physicalReplicationSlotResource", PhysicalReplicationSlotArgs.builder()        
    .name("string")
    .build());

    physical_replication_slot_resource = postgresql.PhysicalReplicationSlot("physicalReplicationSlotResource", name="string")

    const physicalReplicationSlotResource = new postgresql.PhysicalReplicationSlot("physicalReplicationSlotResource", {name: "string"});

    type: postgresql:PhysicalReplicationSlot
properties:
    name: string

    PhysicalReplicationSlot 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 PhysicalReplicationSlot resource accepts the following input properties:

    Name string
    The name of the replication slot.
    Name string
    The name of the replication slot.
    name String
    The name of the replication slot.
    name string
    The name of the replication slot.
    name str
    The name of the replication slot.
    name String
    The name of the replication slot.

    Outputs

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

    Get an existing PhysicalReplicationSlot 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?: PhysicalReplicationSlotState, opts?: CustomResourceOptions): PhysicalReplicationSlot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None) -> PhysicalReplicationSlot
    func GetPhysicalReplicationSlot(ctx *Context, name string, id IDInput, state *PhysicalReplicationSlotState, opts ...ResourceOption) (*PhysicalReplicationSlot, error)
    public static PhysicalReplicationSlot Get(string name, Input<string> id, PhysicalReplicationSlotState? state, CustomResourceOptions? opts = null)
    public static PhysicalReplicationSlot get(String name, Output<String> id, PhysicalReplicationSlotState 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:
    Name string
    The name of the replication slot.
    Name string
    The name of the replication slot.
    name String
    The name of the replication slot.
    name string
    The name of the replication slot.
    name str
    The name of the replication slot.
    name String
    The name of the replication slot.

    Package Details

    Repository
    PostgreSQL pulumi/pulumi-postgresql
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the postgresql Terraform Provider.
    postgresql logo
    PostgreSQL v3.11.0 published on Sunday, Mar 3, 2024 by Pulumi
    pulumi/pulumi-postgresql