1. Packages
  2. PostgreSQL
  3. API Docs
  4. ReplicationSlot
PostgreSQL v3.11.3 published on Thursday, Jul 18, 2024 by Pulumi

postgresql.ReplicationSlot

Explore with Pulumi AI

postgresql logo
PostgreSQL v3.11.3 published on Thursday, Jul 18, 2024 by Pulumi

    The postgresql.ReplicationSlot resource creates and manages a replication slot on a PostgreSQL server.

    Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as postgresql from "@pulumi/postgresql";
    
    const mySlot = new postgresql.ReplicationSlot("my_slot", {
        name: "my_slot",
        plugin: "test_decoding",
    });
    
    import pulumi
    import pulumi_postgresql as postgresql
    
    my_slot = postgresql.ReplicationSlot("my_slot",
        name="my_slot",
        plugin="test_decoding")
    
    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.NewReplicationSlot(ctx, "my_slot", &postgresql.ReplicationSlotArgs{
    			Name:   pulumi.String("my_slot"),
    			Plugin: pulumi.String("test_decoding"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using PostgreSql = Pulumi.PostgreSql;
    
    return await Deployment.RunAsync(() => 
    {
        var mySlot = new PostgreSql.ReplicationSlot("my_slot", new()
        {
            Name = "my_slot",
            Plugin = "test_decoding",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.postgresql.ReplicationSlot;
    import com.pulumi.postgresql.ReplicationSlotArgs;
    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 ReplicationSlot("mySlot", ReplicationSlotArgs.builder()
                .name("my_slot")
                .plugin("test_decoding")
                .build());
    
        }
    }
    
    resources:
      mySlot:
        type: postgresql:ReplicationSlot
        name: my_slot
        properties:
          name: my_slot
          plugin: test_decoding
    

    Create ReplicationSlot Resource

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

    Constructor syntax

    new ReplicationSlot(name: string, args: ReplicationSlotArgs, opts?: CustomResourceOptions);
    @overload
    def ReplicationSlot(resource_name: str,
                        args: ReplicationSlotArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ReplicationSlot(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        plugin: Optional[str] = None,
                        database: Optional[str] = None,
                        name: Optional[str] = None)
    func NewReplicationSlot(ctx *Context, name string, args ReplicationSlotArgs, opts ...ResourceOption) (*ReplicationSlot, error)
    public ReplicationSlot(string name, ReplicationSlotArgs args, CustomResourceOptions? opts = null)
    public ReplicationSlot(String name, ReplicationSlotArgs args)
    public ReplicationSlot(String name, ReplicationSlotArgs args, CustomResourceOptions options)
    
    type: postgresql:ReplicationSlot
    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 ReplicationSlotArgs
    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 ReplicationSlotArgs
    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 ReplicationSlotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReplicationSlotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReplicationSlotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var replicationSlotResource = new PostgreSql.ReplicationSlot("replicationSlotResource", new()
    {
        Plugin = "string",
        Database = "string",
        Name = "string",
    });
    
    example, err := postgresql.NewReplicationSlot(ctx, "replicationSlotResource", &postgresql.ReplicationSlotArgs{
    	Plugin:   pulumi.String("string"),
    	Database: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    })
    
    var replicationSlotResource = new ReplicationSlot("replicationSlotResource", ReplicationSlotArgs.builder()
        .plugin("string")
        .database("string")
        .name("string")
        .build());
    
    replication_slot_resource = postgresql.ReplicationSlot("replicationSlotResource",
        plugin="string",
        database="string",
        name="string")
    
    const replicationSlotResource = new postgresql.ReplicationSlot("replicationSlotResource", {
        plugin: "string",
        database: "string",
        name: "string",
    });
    
    type: postgresql:ReplicationSlot
    properties:
        database: string
        name: string
        plugin: string
    

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

    Plugin string
    Sets the output plugin.
    Database string
    Which database to create the replication slot on. Defaults to provider database.
    Name string
    The name of the replication slot.
    Plugin string
    Sets the output plugin.
    Database string
    Which database to create the replication slot on. Defaults to provider database.
    Name string
    The name of the replication slot.
    plugin String
    Sets the output plugin.
    database String
    Which database to create the replication slot on. Defaults to provider database.
    name String
    The name of the replication slot.
    plugin string
    Sets the output plugin.
    database string
    Which database to create the replication slot on. Defaults to provider database.
    name string
    The name of the replication slot.
    plugin str
    Sets the output plugin.
    database str
    Which database to create the replication slot on. Defaults to provider database.
    name str
    The name of the replication slot.
    plugin String
    Sets the output plugin.
    database String
    Which database to create the replication slot on. Defaults to provider database.
    name String
    The name of the replication slot.

    Outputs

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

    Get an existing ReplicationSlot 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?: ReplicationSlotState, opts?: CustomResourceOptions): ReplicationSlot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            database: Optional[str] = None,
            name: Optional[str] = None,
            plugin: Optional[str] = None) -> ReplicationSlot
    func GetReplicationSlot(ctx *Context, name string, id IDInput, state *ReplicationSlotState, opts ...ResourceOption) (*ReplicationSlot, error)
    public static ReplicationSlot Get(string name, Input<string> id, ReplicationSlotState? state, CustomResourceOptions? opts = null)
    public static ReplicationSlot get(String name, Output<String> id, ReplicationSlotState 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:
    Database string
    Which database to create the replication slot on. Defaults to provider database.
    Name string
    The name of the replication slot.
    Plugin string
    Sets the output plugin.
    Database string
    Which database to create the replication slot on. Defaults to provider database.
    Name string
    The name of the replication slot.
    Plugin string
    Sets the output plugin.
    database String
    Which database to create the replication slot on. Defaults to provider database.
    name String
    The name of the replication slot.
    plugin String
    Sets the output plugin.
    database string
    Which database to create the replication slot on. Defaults to provider database.
    name string
    The name of the replication slot.
    plugin string
    Sets the output plugin.
    database str
    Which database to create the replication slot on. Defaults to provider database.
    name str
    The name of the replication slot.
    plugin str
    Sets the output plugin.
    database String
    Which database to create the replication slot on. Defaults to provider database.
    name String
    The name of the replication slot.
    plugin String
    Sets the output plugin.

    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.3 published on Thursday, Jul 18, 2024 by Pulumi