jetstream 0.2.0, Apr 14 25

jetstream 0.2.0 published on Monday, Apr 14, 2025 by nats-io

jetstream.Stream

Explore with Pulumi AI

jetstream 0.2.0 published on Monday, Apr 14, 2025 by nats-io

nats-io/terraform-provider-jetstream

# jetstream.Stream Resource

The jetstream.Stream Resource creates a JetStream Stream, supports editing resources in place.

Example Usage

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

const oRDERS = new jetstream.Stream("oRDERS", {
    subjects: ["ORDERS.*"],
    storage: "file",
    maxAge: 60 * 60 * 24 * 365,
});

import pulumi
import pulumi_jetstream as jetstream

o_rders = jetstream.Stream("oRDERS",
    subjects=["ORDERS.*"],
    storage="file",
    max_age=60 * 60 * 24 * 365)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/jetstream/jetstream"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := jetstream.NewStream(ctx, "oRDERS", &jetstream.StreamArgs{
			Subjects: pulumi.StringArray{
				pulumi.String("ORDERS.*"),
			},
			Storage: pulumi.String("file"),
			MaxAge:  60 * 60 * 24 * 365,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var oRDERS = new Jetstream.Stream("oRDERS", new()
    {
        Subjects = new[]
        {
            "ORDERS.*",
        },
        Storage = "file",
        MaxAge = 60 * 60 * 24 * 365,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.jetstream.Stream;
import com.pulumi.jetstream.StreamArgs;
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 oRDERS = new Stream("oRDERS", StreamArgs.builder()
            .subjects("ORDERS.*")
            .storage("file")
            .maxAge(60 * 60 * 24 * 365)
            .build());

    }
}

Coming soon!

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

const oRDERSARCHIVE = new jetstream.Stream("oRDERSARCHIVE", {
    storage: "file",
    maxAge: 5 * 60 * 60 * 24 * 365,
    mirrorDirect: true,
    mirror: {
        name: "ORDERS",
    },
});

import pulumi
import pulumi_jetstream as jetstream

o_rdersarchive = jetstream.Stream("oRDERSARCHIVE",
    storage="file",
    max_age=5 * 60 * 60 * 24 * 365,
    mirror_direct=True,
    mirror={
        "name": "ORDERS",
    })

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/jetstream/jetstream"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := jetstream.NewStream(ctx, "oRDERSARCHIVE", &jetstream.StreamArgs{
			Storage:      pulumi.String("file"),
			MaxAge:       5 * 60 * 60 * 24 * 365,
			MirrorDirect: pulumi.Bool(true),
			Mirror: &jetstream.StreamMirrorArgs{
				Name: pulumi.String("ORDERS"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var oRDERSARCHIVE = new Jetstream.Stream("oRDERSARCHIVE", new()
    {
        Storage = "file",
        MaxAge = 5 * 60 * 60 * 24 * 365,
        MirrorDirect = true,
        Mirror = new Jetstream.Inputs.StreamMirrorArgs
        {
            Name = "ORDERS",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.jetstream.Stream;
import com.pulumi.jetstream.StreamArgs;
import com.pulumi.jetstream.inputs.StreamMirrorArgs;
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 oRDERSARCHIVE = new Stream("oRDERSARCHIVE", StreamArgs.builder()
            .storage("file")
            .maxAge(5 * 60 * 60 * 24 * 365)
            .mirrorDirect(true)
            .mirror(StreamMirrorArgs.builder()
                .name("ORDERS")
                .build())
            .build());

    }
}

Coming soon!

Sources and Mirrors

Above the ORDERS_ARCHIVE stream is a mirror of ORDERS, valid options for specifying a mirror and sources are:

name - The name of the stream to mirror
filter_subject - (optional) For sources this filters the source
start_seq - (optional) Starts the mirror or source at this sequence in the source
start_time - (optional) Starts the mirror or source at this time in the source, in RFC3339 format
external - (optional) Reference to an external stream with keys api and deliver
mirror_direct - (optional) If true the mirror will participate in a serving direct get requests for individual messages from the origin stream

Create Stream Resource

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

Constructor syntax

new Stream(name: string, args?: StreamArgs, opts?: CustomResourceOptions);

@overload
def Stream(resource_name: str,
           args: Optional[StreamArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Stream(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           ack: Optional[bool] = None,
           allow_direct: Optional[bool] = None,
           allow_msg_ttl: Optional[bool] = None,
           allow_rollup_hdrs: Optional[bool] = None,
           compression: Optional[str] = None,
           deny_delete: Optional[bool] = None,
           deny_purge: Optional[bool] = None,
           description: Optional[str] = None,
           discard: Optional[str] = None,
           discard_new_per_subject: Optional[bool] = None,
           duplicate_window: Optional[float] = None,
           inactive_threshold: Optional[float] = None,
           max_ack_pending: Optional[float] = None,
           max_age: Optional[float] = None,
           max_bytes: Optional[float] = None,
           max_consumers: Optional[float] = None,
           max_msg_size: Optional[float] = None,
           max_msgs: Optional[float] = None,
           max_msgs_per_subject: Optional[float] = None,
           metadata: Optional[Mapping[str, str]] = None,
           mirror: Optional[StreamMirrorArgs] = None,
           mirror_direct: Optional[bool] = None,
           name: Optional[str] = None,
           placement_cluster: Optional[str] = None,
           placement_tags: Optional[Sequence[str]] = None,
           replicas: Optional[float] = None,
           republish_destination: Optional[str] = None,
           republish_headers_only: Optional[bool] = None,
           republish_source: Optional[str] = None,
           retention: Optional[str] = None,
           sources: Optional[Sequence[StreamSourceArgs]] = None,
           storage: Optional[str] = None,
           stream_id: Optional[str] = None,
           subject_delete_marker_ttl: Optional[float] = None,
           subject_transform: Optional[StreamSubjectTransformArgs] = None,
           subjects: Optional[Sequence[str]] = None)

func NewStream(ctx *Context, name string, args *StreamArgs, opts ...ResourceOption) (*Stream, error)

public Stream(string name, StreamArgs? args = null, CustomResourceOptions? opts = null)

public Stream(String name, StreamArgs args)
public Stream(String name, StreamArgs args, CustomResourceOptions options)

type: jetstream:Stream
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 StreamArgs: 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 StreamArgs: 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 StreamArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StreamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args StreamArgs: 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 streamResource = new Jetstream.Stream("streamResource", new()
{
    Ack = false,
    AllowDirect = false,
    AllowMsgTtl = false,
    AllowRollupHdrs = false,
    Compression = "string",
    DenyDelete = false,
    DenyPurge = false,
    Description = "string",
    Discard = "string",
    DiscardNewPerSubject = false,
    DuplicateWindow = 0,
    InactiveThreshold = 0,
    MaxAckPending = 0,
    MaxAge = 0,
    MaxBytes = 0,
    MaxConsumers = 0,
    MaxMsgSize = 0,
    MaxMsgs = 0,
    MaxMsgsPerSubject = 0,
    Metadata = 
    {
        { "string", "string" },
    },
    Mirror = new Jetstream.Inputs.StreamMirrorArgs
    {
        Name = "string",
        External = new Jetstream.Inputs.StreamMirrorExternalArgs
        {
            Api = "string",
            Deliver = "string",
        },
        FilterSubject = "string",
        StartSeq = 0,
        StartTime = "string",
        SubjectTransforms = new[]
        {
            new Jetstream.Inputs.StreamMirrorSubjectTransformArgs
            {
                Destination = "string",
                Source = "string",
            },
        },
    },
    MirrorDirect = false,
    Name = "string",
    PlacementCluster = "string",
    PlacementTags = new[]
    {
        "string",
    },
    Replicas = 0,
    RepublishDestination = "string",
    RepublishHeadersOnly = false,
    RepublishSource = "string",
    Retention = "string",
    Sources = new[]
    {
        new Jetstream.Inputs.StreamSourceArgs
        {
            Name = "string",
            External = new Jetstream.Inputs.StreamSourceExternalArgs
            {
                Api = "string",
                Deliver = "string",
            },
            FilterSubject = "string",
            StartSeq = 0,
            StartTime = "string",
            SubjectTransforms = new[]
            {
                new Jetstream.Inputs.StreamSourceSubjectTransformArgs
                {
                    Destination = "string",
                    Source = "string",
                },
            },
        },
    },
    Storage = "string",
    StreamId = "string",
    SubjectDeleteMarkerTtl = 0,
    SubjectTransform = new Jetstream.Inputs.StreamSubjectTransformArgs
    {
        Destination = "string",
        Source = "string",
    },
    Subjects = new[]
    {
        "string",
    },
});

example, err := jetstream.NewStream(ctx, "streamResource", &jetstream.StreamArgs{
	Ack:                  pulumi.Bool(false),
	AllowDirect:          pulumi.Bool(false),
	AllowMsgTtl:          pulumi.Bool(false),
	AllowRollupHdrs:      pulumi.Bool(false),
	Compression:          pulumi.String("string"),
	DenyDelete:           pulumi.Bool(false),
	DenyPurge:            pulumi.Bool(false),
	Description:          pulumi.String("string"),
	Discard:              pulumi.String("string"),
	DiscardNewPerSubject: pulumi.Bool(false),
	DuplicateWindow:      pulumi.Float64(0),
	InactiveThreshold:    pulumi.Float64(0),
	MaxAckPending:        pulumi.Float64(0),
	MaxAge:               pulumi.Float64(0),
	MaxBytes:             pulumi.Float64(0),
	MaxConsumers:         pulumi.Float64(0),
	MaxMsgSize:           pulumi.Float64(0),
	MaxMsgs:              pulumi.Float64(0),
	MaxMsgsPerSubject:    pulumi.Float64(0),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Mirror: &jetstream.StreamMirrorArgs{
		Name: pulumi.String("string"),
		External: &jetstream.StreamMirrorExternalArgs{
			Api:     pulumi.String("string"),
			Deliver: pulumi.String("string"),
		},
		FilterSubject: pulumi.String("string"),
		StartSeq:      pulumi.Float64(0),
		StartTime:     pulumi.String("string"),
		SubjectTransforms: jetstream.StreamMirrorSubjectTransformArray{
			&jetstream.StreamMirrorSubjectTransformArgs{
				Destination: pulumi.String("string"),
				Source:      pulumi.String("string"),
			},
		},
	},
	MirrorDirect:     pulumi.Bool(false),
	Name:             pulumi.String("string"),
	PlacementCluster: pulumi.String("string"),
	PlacementTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Replicas:             pulumi.Float64(0),
	RepublishDestination: pulumi.String("string"),
	RepublishHeadersOnly: pulumi.Bool(false),
	RepublishSource:      pulumi.String("string"),
	Retention:            pulumi.String("string"),
	Sources: jetstream.StreamSourceArray{
		&jetstream.StreamSourceArgs{
			Name: pulumi.String("string"),
			External: &jetstream.StreamSourceExternalArgs{
				Api:     pulumi.String("string"),
				Deliver: pulumi.String("string"),
			},
			FilterSubject: pulumi.String("string"),
			StartSeq:      pulumi.Float64(0),
			StartTime:     pulumi.String("string"),
			SubjectTransforms: jetstream.StreamSourceSubjectTransformArray{
				&jetstream.StreamSourceSubjectTransformArgs{
					Destination: pulumi.String("string"),
					Source:      pulumi.String("string"),
				},
			},
		},
	},
	Storage:                pulumi.String("string"),
	StreamId:               pulumi.String("string"),
	SubjectDeleteMarkerTtl: pulumi.Float64(0),
	SubjectTransform: &jetstream.StreamSubjectTransformArgs{
		Destination: pulumi.String("string"),
		Source:      pulumi.String("string"),
	},
	Subjects: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var streamResource = new Stream("streamResource", StreamArgs.builder()
    .ack(false)
    .allowDirect(false)
    .allowMsgTtl(false)
    .allowRollupHdrs(false)
    .compression("string")
    .denyDelete(false)
    .denyPurge(false)
    .description("string")
    .discard("string")
    .discardNewPerSubject(false)
    .duplicateWindow(0)
    .inactiveThreshold(0)
    .maxAckPending(0)
    .maxAge(0)
    .maxBytes(0)
    .maxConsumers(0)
    .maxMsgSize(0)
    .maxMsgs(0)
    .maxMsgsPerSubject(0)
    .metadata(Map.of("string", "string"))
    .mirror(StreamMirrorArgs.builder()
        .name("string")
        .external(StreamMirrorExternalArgs.builder()
            .api("string")
            .deliver("string")
            .build())
        .filterSubject("string")
        .startSeq(0)
        .startTime("string")
        .subjectTransforms(StreamMirrorSubjectTransformArgs.builder()
            .destination("string")
            .source("string")
            .build())
        .build())
    .mirrorDirect(false)
    .name("string")
    .placementCluster("string")
    .placementTags("string")
    .replicas(0)
    .republishDestination("string")
    .republishHeadersOnly(false)
    .republishSource("string")
    .retention("string")
    .sources(StreamSourceArgs.builder()
        .name("string")
        .external(StreamSourceExternalArgs.builder()
            .api("string")
            .deliver("string")
            .build())
        .filterSubject("string")
        .startSeq(0)
        .startTime("string")
        .subjectTransforms(StreamSourceSubjectTransformArgs.builder()
            .destination("string")
            .source("string")
            .build())
        .build())
    .storage("string")
    .streamId("string")
    .subjectDeleteMarkerTtl(0)
    .subjectTransform(StreamSubjectTransformArgs.builder()
        .destination("string")
        .source("string")
        .build())
    .subjects("string")
    .build());

stream_resource = jetstream.Stream("streamResource",
    ack=False,
    allow_direct=False,
    allow_msg_ttl=False,
    allow_rollup_hdrs=False,
    compression="string",
    deny_delete=False,
    deny_purge=False,
    description="string",
    discard="string",
    discard_new_per_subject=False,
    duplicate_window=0,
    inactive_threshold=0,
    max_ack_pending=0,
    max_age=0,
    max_bytes=0,
    max_consumers=0,
    max_msg_size=0,
    max_msgs=0,
    max_msgs_per_subject=0,
    metadata={
        "string": "string",
    },
    mirror={
        "name": "string",
        "external": {
            "api": "string",
            "deliver": "string",
        },
        "filter_subject": "string",
        "start_seq": 0,
        "start_time": "string",
        "subject_transforms": [{
            "destination": "string",
            "source": "string",
        }],
    },
    mirror_direct=False,
    name="string",
    placement_cluster="string",
    placement_tags=["string"],
    replicas=0,
    republish_destination="string",
    republish_headers_only=False,
    republish_source="string",
    retention="string",
    sources=[{
        "name": "string",
        "external": {
            "api": "string",
            "deliver": "string",
        },
        "filter_subject": "string",
        "start_seq": 0,
        "start_time": "string",
        "subject_transforms": [{
            "destination": "string",
            "source": "string",
        }],
    }],
    storage="string",
    stream_id="string",
    subject_delete_marker_ttl=0,
    subject_transform={
        "destination": "string",
        "source": "string",
    },
    subjects=["string"])

const streamResource = new jetstream.Stream("streamResource", {
    ack: false,
    allowDirect: false,
    allowMsgTtl: false,
    allowRollupHdrs: false,
    compression: "string",
    denyDelete: false,
    denyPurge: false,
    description: "string",
    discard: "string",
    discardNewPerSubject: false,
    duplicateWindow: 0,
    inactiveThreshold: 0,
    maxAckPending: 0,
    maxAge: 0,
    maxBytes: 0,
    maxConsumers: 0,
    maxMsgSize: 0,
    maxMsgs: 0,
    maxMsgsPerSubject: 0,
    metadata: {
        string: "string",
    },
    mirror: {
        name: "string",
        external: {
            api: "string",
            deliver: "string",
        },
        filterSubject: "string",
        startSeq: 0,
        startTime: "string",
        subjectTransforms: [{
            destination: "string",
            source: "string",
        }],
    },
    mirrorDirect: false,
    name: "string",
    placementCluster: "string",
    placementTags: ["string"],
    replicas: 0,
    republishDestination: "string",
    republishHeadersOnly: false,
    republishSource: "string",
    retention: "string",
    sources: [{
        name: "string",
        external: {
            api: "string",
            deliver: "string",
        },
        filterSubject: "string",
        startSeq: 0,
        startTime: "string",
        subjectTransforms: [{
            destination: "string",
            source: "string",
        }],
    }],
    storage: "string",
    streamId: "string",
    subjectDeleteMarkerTtl: 0,
    subjectTransform: {
        destination: "string",
        source: "string",
    },
    subjects: ["string"],
});

type: jetstream:Stream
properties:
    ack: false
    allowDirect: false
    allowMsgTtl: false
    allowRollupHdrs: false
    compression: string
    denyDelete: false
    denyPurge: false
    description: string
    discard: string
    discardNewPerSubject: false
    duplicateWindow: 0
    inactiveThreshold: 0
    maxAckPending: 0
    maxAge: 0
    maxBytes: 0
    maxConsumers: 0
    maxMsgSize: 0
    maxMsgs: 0
    maxMsgsPerSubject: 0
    metadata:
        string: string
    mirror:
        external:
            api: string
            deliver: string
        filterSubject: string
        name: string
        startSeq: 0
        startTime: string
        subjectTransforms:
            - destination: string
              source: string
    mirrorDirect: false
    name: string
    placementCluster: string
    placementTags:
        - string
    replicas: 0
    republishDestination: string
    republishHeadersOnly: false
    republishSource: string
    retention: string
    sources:
        - external:
            api: string
            deliver: string
          filterSubject: string
          name: string
          startSeq: 0
          startTime: string
          subjectTransforms:
            - destination: string
              source: string
    storage: string
    streamId: string
    subjectDeleteMarkerTtl: 0
    subjectTransform:
        destination: string
        source: string
    subjects:
        - string

Stream Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Stream resource accepts the following input properties:

Ack bool: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
AllowDirect bool: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
AllowMsgTtl bool: (optional) Enables Per Message TTLs
AllowRollupHdrs bool: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
Compression string: (optional) Enable stream compression by setting the value to s2
DenyDelete bool: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
DenyPurge bool: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
Description string: (optional) Contains additional information about this stream (string)
Discard string: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
DiscardNewPerSubject bool: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
DuplicateWindow double: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
InactiveThreshold double: (optional) Removes the consumer after a idle period, specified as a duration in seconds
MaxAckPending double: (optional) Maximum pending Acks before consumers are paused
MaxAge double: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
MaxBytes double: (optional) The maximum size of all messages that can be kept in the stream (number)
MaxConsumers double: (optional) Number of consumers this stream allows (number)
MaxMsgSize double: (optional) The maximum individual message size that the stream will accept (number)
MaxMsgs double: (optional) The maximum amount of messages that can be kept in the stream (number)
MaxMsgsPerSubject double: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
Metadata Dictionary<string, string>: (optional) A map of strings with arbitrary metadata for the stream
Mirror StreamMirror: (optional) Stream to mirror
MirrorDirect bool: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
Name string: The name of the stream (string)
PlacementCluster string: (optional) Place the stream in a specific cluster, influenced by placement_tags
PlacementTags List<string>: (optional) Place the stream only on servers with these tags
Replicas double: (optional) How many replicas of the data to keep in a clustered environment (number)
RepublishDestination string: (optional) The destination to publish messages to
RepublishHeadersOnly bool: (optional) Republish only message headers, no bodies
RepublishSource string: (optional) Republish matching messages to republish_destination
Retention string: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
Sources List<StreamSource>: (optional) List of streams to source
Storage string: (optional) The storage engine to use to back the stream (string)
StreamId string
SubjectDeleteMarkerTtl double: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
SubjectTransform StreamSubjectTransform: Subject transform to apply to matching messages
Subjects List<string>: The list of subjects that will be consumed by the Stream (["list", "string"])

Ack bool: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
AllowDirect bool: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
AllowMsgTtl bool: (optional) Enables Per Message TTLs
AllowRollupHdrs bool: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
Compression string: (optional) Enable stream compression by setting the value to s2
DenyDelete bool: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
DenyPurge bool: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
Description string: (optional) Contains additional information about this stream (string)
Discard string: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
DiscardNewPerSubject bool: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
DuplicateWindow float64: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
InactiveThreshold float64: (optional) Removes the consumer after a idle period, specified as a duration in seconds
MaxAckPending float64: (optional) Maximum pending Acks before consumers are paused
MaxAge float64: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
MaxBytes float64: (optional) The maximum size of all messages that can be kept in the stream (number)
MaxConsumers float64: (optional) Number of consumers this stream allows (number)
MaxMsgSize float64: (optional) The maximum individual message size that the stream will accept (number)
MaxMsgs float64: (optional) The maximum amount of messages that can be kept in the stream (number)
MaxMsgsPerSubject float64: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
Metadata map[string]string: (optional) A map of strings with arbitrary metadata for the stream
Mirror StreamMirrorArgs: (optional) Stream to mirror
MirrorDirect bool: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
Name string: The name of the stream (string)
PlacementCluster string: (optional) Place the stream in a specific cluster, influenced by placement_tags
PlacementTags []string: (optional) Place the stream only on servers with these tags
Replicas float64: (optional) How many replicas of the data to keep in a clustered environment (number)
RepublishDestination string: (optional) The destination to publish messages to
RepublishHeadersOnly bool: (optional) Republish only message headers, no bodies
RepublishSource string: (optional) Republish matching messages to republish_destination
Retention string: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
Sources []StreamSourceArgs: (optional) List of streams to source
Storage string: (optional) The storage engine to use to back the stream (string)
StreamId string
SubjectDeleteMarkerTtl float64: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
SubjectTransform StreamSubjectTransformArgs: Subject transform to apply to matching messages
Subjects []string: The list of subjects that will be consumed by the Stream (["list", "string"])

ack Boolean: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
allowDirect Boolean: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
allowMsgTtl Boolean: (optional) Enables Per Message TTLs
allowRollupHdrs Boolean: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
compression String: (optional) Enable stream compression by setting the value to s2
denyDelete Boolean: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
denyPurge Boolean: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
description String: (optional) Contains additional information about this stream (string)
discard String: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
discardNewPerSubject Boolean: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
duplicateWindow Double: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
inactiveThreshold Double: (optional) Removes the consumer after a idle period, specified as a duration in seconds
maxAckPending Double: (optional) Maximum pending Acks before consumers are paused
maxAge Double: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
maxBytes Double: (optional) The maximum size of all messages that can be kept in the stream (number)
maxConsumers Double: (optional) Number of consumers this stream allows (number)
maxMsgSize Double: (optional) The maximum individual message size that the stream will accept (number)
maxMsgs Double: (optional) The maximum amount of messages that can be kept in the stream (number)
maxMsgsPerSubject Double: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
metadata Map<String,String>: (optional) A map of strings with arbitrary metadata for the stream
mirror StreamMirror: (optional) Stream to mirror
mirrorDirect Boolean: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
name String: The name of the stream (string)
placementCluster String: (optional) Place the stream in a specific cluster, influenced by placement_tags
placementTags List<String>: (optional) Place the stream only on servers with these tags
replicas Double: (optional) How many replicas of the data to keep in a clustered environment (number)
republishDestination String: (optional) The destination to publish messages to
republishHeadersOnly Boolean: (optional) Republish only message headers, no bodies
republishSource String: (optional) Republish matching messages to republish_destination
retention String: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
sources List<StreamSource>: (optional) List of streams to source
storage String: (optional) The storage engine to use to back the stream (string)
streamId String
subjectDeleteMarkerTtl Double: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
subjectTransform StreamSubjectTransform: Subject transform to apply to matching messages
subjects List<String>: The list of subjects that will be consumed by the Stream (["list", "string"])

ack boolean: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
allowDirect boolean: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
allowMsgTtl boolean: (optional) Enables Per Message TTLs
allowRollupHdrs boolean: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
compression string: (optional) Enable stream compression by setting the value to s2
denyDelete boolean: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
denyPurge boolean: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
description string: (optional) Contains additional information about this stream (string)
discard string: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
discardNewPerSubject boolean: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
duplicateWindow number: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
inactiveThreshold number: (optional) Removes the consumer after a idle period, specified as a duration in seconds
maxAckPending number: (optional) Maximum pending Acks before consumers are paused
maxAge number: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
maxBytes number: (optional) The maximum size of all messages that can be kept in the stream (number)
maxConsumers number: (optional) Number of consumers this stream allows (number)
maxMsgSize number: (optional) The maximum individual message size that the stream will accept (number)
maxMsgs number: (optional) The maximum amount of messages that can be kept in the stream (number)
maxMsgsPerSubject number: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
metadata {[key: string]: string}: (optional) A map of strings with arbitrary metadata for the stream
mirror StreamMirror: (optional) Stream to mirror
mirrorDirect boolean: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
name string: The name of the stream (string)
placementCluster string: (optional) Place the stream in a specific cluster, influenced by placement_tags
placementTags string[]: (optional) Place the stream only on servers with these tags
replicas number: (optional) How many replicas of the data to keep in a clustered environment (number)
republishDestination string: (optional) The destination to publish messages to
republishHeadersOnly boolean: (optional) Republish only message headers, no bodies
republishSource string: (optional) Republish matching messages to republish_destination
retention string: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
sources StreamSource[]: (optional) List of streams to source
storage string: (optional) The storage engine to use to back the stream (string)
streamId string
subjectDeleteMarkerTtl number: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
subjectTransform StreamSubjectTransform: Subject transform to apply to matching messages
subjects string[]: The list of subjects that will be consumed by the Stream (["list", "string"])

ack bool: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
allow_direct bool: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
allow_msg_ttl bool: (optional) Enables Per Message TTLs
allow_rollup_hdrs bool: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
compression str: (optional) Enable stream compression by setting the value to s2
deny_delete bool: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
deny_purge bool: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
description str: (optional) Contains additional information about this stream (string)
discard str: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
discard_new_per_subject bool: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
duplicate_window float: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
inactive_threshold float: (optional) Removes the consumer after a idle period, specified as a duration in seconds
max_ack_pending float: (optional) Maximum pending Acks before consumers are paused
max_age float: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
max_bytes float: (optional) The maximum size of all messages that can be kept in the stream (number)
max_consumers float: (optional) Number of consumers this stream allows (number)
max_msg_size float: (optional) The maximum individual message size that the stream will accept (number)
max_msgs float: (optional) The maximum amount of messages that can be kept in the stream (number)
max_msgs_per_subject float: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
metadata Mapping[str, str]: (optional) A map of strings with arbitrary metadata for the stream
mirror StreamMirrorArgs: (optional) Stream to mirror
mirror_direct bool: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
name str: The name of the stream (string)
placement_cluster str: (optional) Place the stream in a specific cluster, influenced by placement_tags
placement_tags Sequence[str]: (optional) Place the stream only on servers with these tags
replicas float: (optional) How many replicas of the data to keep in a clustered environment (number)
republish_destination str: (optional) The destination to publish messages to
republish_headers_only bool: (optional) Republish only message headers, no bodies
republish_source str: (optional) Republish matching messages to republish_destination
retention str: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
sources Sequence[StreamSourceArgs]: (optional) List of streams to source
storage str: (optional) The storage engine to use to back the stream (string)
stream_id str
subject_delete_marker_ttl float: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
subject_transform StreamSubjectTransformArgs: Subject transform to apply to matching messages
subjects Sequence[str]: The list of subjects that will be consumed by the Stream (["list", "string"])

ack Boolean: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
allowDirect Boolean: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
allowMsgTtl Boolean: (optional) Enables Per Message TTLs
allowRollupHdrs Boolean: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
compression String: (optional) Enable stream compression by setting the value to s2
denyDelete Boolean: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
denyPurge Boolean: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
description String: (optional) Contains additional information about this stream (string)
discard String: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
discardNewPerSubject Boolean: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
duplicateWindow Number: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
inactiveThreshold Number: (optional) Removes the consumer after a idle period, specified as a duration in seconds
maxAckPending Number: (optional) Maximum pending Acks before consumers are paused
maxAge Number: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
maxBytes Number: (optional) The maximum size of all messages that can be kept in the stream (number)
maxConsumers Number: (optional) Number of consumers this stream allows (number)
maxMsgSize Number: (optional) The maximum individual message size that the stream will accept (number)
maxMsgs Number: (optional) The maximum amount of messages that can be kept in the stream (number)
maxMsgsPerSubject Number: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
metadata Map<String>: (optional) A map of strings with arbitrary metadata for the stream
mirror Property Map: (optional) Stream to mirror
mirrorDirect Boolean: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
name String: The name of the stream (string)
placementCluster String: (optional) Place the stream in a specific cluster, influenced by placement_tags
placementTags List<String>: (optional) Place the stream only on servers with these tags
replicas Number: (optional) How many replicas of the data to keep in a clustered environment (number)
republishDestination String: (optional) The destination to publish messages to
republishHeadersOnly Boolean: (optional) Republish only message headers, no bodies
republishSource String: (optional) Republish matching messages to republish_destination
retention String: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
sources List<Property Map>: (optional) List of streams to source
storage String: (optional) The storage engine to use to back the stream (string)
streamId String
subjectDeleteMarkerTtl Number: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
subjectTransform Property Map: Subject transform to apply to matching messages
subjects List<String>: The list of subjects that will be consumed by the Stream (["list", "string"])

Outputs

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

Get an existing Stream 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?: StreamState, opts?: CustomResourceOptions): Stream

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ack: Optional[bool] = None,
        allow_direct: Optional[bool] = None,
        allow_msg_ttl: Optional[bool] = None,
        allow_rollup_hdrs: Optional[bool] = None,
        compression: Optional[str] = None,
        deny_delete: Optional[bool] = None,
        deny_purge: Optional[bool] = None,
        description: Optional[str] = None,
        discard: Optional[str] = None,
        discard_new_per_subject: Optional[bool] = None,
        duplicate_window: Optional[float] = None,
        inactive_threshold: Optional[float] = None,
        max_ack_pending: Optional[float] = None,
        max_age: Optional[float] = None,
        max_bytes: Optional[float] = None,
        max_consumers: Optional[float] = None,
        max_msg_size: Optional[float] = None,
        max_msgs: Optional[float] = None,
        max_msgs_per_subject: Optional[float] = None,
        metadata: Optional[Mapping[str, str]] = None,
        mirror: Optional[StreamMirrorArgs] = None,
        mirror_direct: Optional[bool] = None,
        name: Optional[str] = None,
        placement_cluster: Optional[str] = None,
        placement_tags: Optional[Sequence[str]] = None,
        replicas: Optional[float] = None,
        republish_destination: Optional[str] = None,
        republish_headers_only: Optional[bool] = None,
        republish_source: Optional[str] = None,
        retention: Optional[str] = None,
        sources: Optional[Sequence[StreamSourceArgs]] = None,
        storage: Optional[str] = None,
        stream_id: Optional[str] = None,
        subject_delete_marker_ttl: Optional[float] = None,
        subject_transform: Optional[StreamSubjectTransformArgs] = None,
        subjects: Optional[Sequence[str]] = None) -> Stream

func GetStream(ctx *Context, name string, id IDInput, state *StreamState, opts ...ResourceOption) (*Stream, error)

public static Stream Get(string name, Input<string> id, StreamState? state, CustomResourceOptions? opts = null)

public static Stream get(String name, Output<String> id, StreamState state, CustomResourceOptions options)

resources:  _:    type: jetstream:Stream    get:      id: ${id}

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:

Ack bool: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
AllowDirect bool: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
AllowMsgTtl bool: (optional) Enables Per Message TTLs
AllowRollupHdrs bool: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
Compression string: (optional) Enable stream compression by setting the value to s2
DenyDelete bool: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
DenyPurge bool: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
Description string: (optional) Contains additional information about this stream (string)
Discard string: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
DiscardNewPerSubject bool: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
DuplicateWindow double: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
InactiveThreshold double: (optional) Removes the consumer after a idle period, specified as a duration in seconds
MaxAckPending double: (optional) Maximum pending Acks before consumers are paused
MaxAge double: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
MaxBytes double: (optional) The maximum size of all messages that can be kept in the stream (number)
MaxConsumers double: (optional) Number of consumers this stream allows (number)
MaxMsgSize double: (optional) The maximum individual message size that the stream will accept (number)
MaxMsgs double: (optional) The maximum amount of messages that can be kept in the stream (number)
MaxMsgsPerSubject double: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
Metadata Dictionary<string, string>: (optional) A map of strings with arbitrary metadata for the stream
Mirror StreamMirror: (optional) Stream to mirror
MirrorDirect bool: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
Name string: The name of the stream (string)
PlacementCluster string: (optional) Place the stream in a specific cluster, influenced by placement_tags
PlacementTags List<string>: (optional) Place the stream only on servers with these tags
Replicas double: (optional) How many replicas of the data to keep in a clustered environment (number)
RepublishDestination string: (optional) The destination to publish messages to
RepublishHeadersOnly bool: (optional) Republish only message headers, no bodies
RepublishSource string: (optional) Republish matching messages to republish_destination
Retention string: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
Sources List<StreamSource>: (optional) List of streams to source
Storage string: (optional) The storage engine to use to back the stream (string)
StreamId string
SubjectDeleteMarkerTtl double: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
SubjectTransform StreamSubjectTransform: Subject transform to apply to matching messages
Subjects List<string>: The list of subjects that will be consumed by the Stream (["list", "string"])

Ack bool: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
AllowDirect bool: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
AllowMsgTtl bool: (optional) Enables Per Message TTLs
AllowRollupHdrs bool: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
Compression string: (optional) Enable stream compression by setting the value to s2
DenyDelete bool: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
DenyPurge bool: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
Description string: (optional) Contains additional information about this stream (string)
Discard string: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
DiscardNewPerSubject bool: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
DuplicateWindow float64: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
InactiveThreshold float64: (optional) Removes the consumer after a idle period, specified as a duration in seconds
MaxAckPending float64: (optional) Maximum pending Acks before consumers are paused
MaxAge float64: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
MaxBytes float64: (optional) The maximum size of all messages that can be kept in the stream (number)
MaxConsumers float64: (optional) Number of consumers this stream allows (number)
MaxMsgSize float64: (optional) The maximum individual message size that the stream will accept (number)
MaxMsgs float64: (optional) The maximum amount of messages that can be kept in the stream (number)
MaxMsgsPerSubject float64: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
Metadata map[string]string: (optional) A map of strings with arbitrary metadata for the stream
Mirror StreamMirrorArgs: (optional) Stream to mirror
MirrorDirect bool: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
Name string: The name of the stream (string)
PlacementCluster string: (optional) Place the stream in a specific cluster, influenced by placement_tags
PlacementTags []string: (optional) Place the stream only on servers with these tags
Replicas float64: (optional) How many replicas of the data to keep in a clustered environment (number)
RepublishDestination string: (optional) The destination to publish messages to
RepublishHeadersOnly bool: (optional) Republish only message headers, no bodies
RepublishSource string: (optional) Republish matching messages to republish_destination
Retention string: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
Sources []StreamSourceArgs: (optional) List of streams to source
Storage string: (optional) The storage engine to use to back the stream (string)
StreamId string
SubjectDeleteMarkerTtl float64: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
SubjectTransform StreamSubjectTransformArgs: Subject transform to apply to matching messages
Subjects []string: The list of subjects that will be consumed by the Stream (["list", "string"])

ack Boolean: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
allowDirect Boolean: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
allowMsgTtl Boolean: (optional) Enables Per Message TTLs
allowRollupHdrs Boolean: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
compression String: (optional) Enable stream compression by setting the value to s2
denyDelete Boolean: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
denyPurge Boolean: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
description String: (optional) Contains additional information about this stream (string)
discard String: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
discardNewPerSubject Boolean: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
duplicateWindow Double: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
inactiveThreshold Double: (optional) Removes the consumer after a idle period, specified as a duration in seconds
maxAckPending Double: (optional) Maximum pending Acks before consumers are paused
maxAge Double: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
maxBytes Double: (optional) The maximum size of all messages that can be kept in the stream (number)
maxConsumers Double: (optional) Number of consumers this stream allows (number)
maxMsgSize Double: (optional) The maximum individual message size that the stream will accept (number)
maxMsgs Double: (optional) The maximum amount of messages that can be kept in the stream (number)
maxMsgsPerSubject Double: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
metadata Map<String,String>: (optional) A map of strings with arbitrary metadata for the stream
mirror StreamMirror: (optional) Stream to mirror
mirrorDirect Boolean: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
name String: The name of the stream (string)
placementCluster String: (optional) Place the stream in a specific cluster, influenced by placement_tags
placementTags List<String>: (optional) Place the stream only on servers with these tags
replicas Double: (optional) How many replicas of the data to keep in a clustered environment (number)
republishDestination String: (optional) The destination to publish messages to
republishHeadersOnly Boolean: (optional) Republish only message headers, no bodies
republishSource String: (optional) Republish matching messages to republish_destination
retention String: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
sources List<StreamSource>: (optional) List of streams to source
storage String: (optional) The storage engine to use to back the stream (string)
streamId String
subjectDeleteMarkerTtl Double: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
subjectTransform StreamSubjectTransform: Subject transform to apply to matching messages
subjects List<String>: The list of subjects that will be consumed by the Stream (["list", "string"])

ack boolean: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
allowDirect boolean: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
allowMsgTtl boolean: (optional) Enables Per Message TTLs
allowRollupHdrs boolean: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
compression string: (optional) Enable stream compression by setting the value to s2
denyDelete boolean: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
denyPurge boolean: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
description string: (optional) Contains additional information about this stream (string)
discard string: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
discardNewPerSubject boolean: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
duplicateWindow number: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
inactiveThreshold number: (optional) Removes the consumer after a idle period, specified as a duration in seconds
maxAckPending number: (optional) Maximum pending Acks before consumers are paused
maxAge number: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
maxBytes number: (optional) The maximum size of all messages that can be kept in the stream (number)
maxConsumers number: (optional) Number of consumers this stream allows (number)
maxMsgSize number: (optional) The maximum individual message size that the stream will accept (number)
maxMsgs number: (optional) The maximum amount of messages that can be kept in the stream (number)
maxMsgsPerSubject number: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
metadata {[key: string]: string}: (optional) A map of strings with arbitrary metadata for the stream
mirror StreamMirror: (optional) Stream to mirror
mirrorDirect boolean: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
name string: The name of the stream (string)
placementCluster string: (optional) Place the stream in a specific cluster, influenced by placement_tags
placementTags string[]: (optional) Place the stream only on servers with these tags
replicas number: (optional) How many replicas of the data to keep in a clustered environment (number)
republishDestination string: (optional) The destination to publish messages to
republishHeadersOnly boolean: (optional) Republish only message headers, no bodies
republishSource string: (optional) Republish matching messages to republish_destination
retention string: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
sources StreamSource[]: (optional) List of streams to source
storage string: (optional) The storage engine to use to back the stream (string)
streamId string
subjectDeleteMarkerTtl number: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
subjectTransform StreamSubjectTransform: Subject transform to apply to matching messages
subjects string[]: The list of subjects that will be consumed by the Stream (["list", "string"])

ack bool: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
allow_direct bool: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
allow_msg_ttl bool: (optional) Enables Per Message TTLs
allow_rollup_hdrs bool: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
compression str: (optional) Enable stream compression by setting the value to s2
deny_delete bool: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
deny_purge bool: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
description str: (optional) Contains additional information about this stream (string)
discard str: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
discard_new_per_subject bool: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
duplicate_window float: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
inactive_threshold float: (optional) Removes the consumer after a idle period, specified as a duration in seconds
max_ack_pending float: (optional) Maximum pending Acks before consumers are paused
max_age float: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
max_bytes float: (optional) The maximum size of all messages that can be kept in the stream (number)
max_consumers float: (optional) Number of consumers this stream allows (number)
max_msg_size float: (optional) The maximum individual message size that the stream will accept (number)
max_msgs float: (optional) The maximum amount of messages that can be kept in the stream (number)
max_msgs_per_subject float: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
metadata Mapping[str, str]: (optional) A map of strings with arbitrary metadata for the stream
mirror StreamMirrorArgs: (optional) Stream to mirror
mirror_direct bool: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
name str: The name of the stream (string)
placement_cluster str: (optional) Place the stream in a specific cluster, influenced by placement_tags
placement_tags Sequence[str]: (optional) Place the stream only on servers with these tags
replicas float: (optional) How many replicas of the data to keep in a clustered environment (number)
republish_destination str: (optional) The destination to publish messages to
republish_headers_only bool: (optional) Republish only message headers, no bodies
republish_source str: (optional) Republish matching messages to republish_destination
retention str: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
sources Sequence[StreamSourceArgs]: (optional) List of streams to source
storage str: (optional) The storage engine to use to back the stream (string)
stream_id str
subject_delete_marker_ttl float: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
subject_transform StreamSubjectTransformArgs: Subject transform to apply to matching messages
subjects Sequence[str]: The list of subjects that will be consumed by the Stream (["list", "string"])

ack Boolean: (optional) If the Stream should support confirming receiving messages via acknowledgements (bool)
allowDirect Boolean: (optional) Allow higher performance, direct access to get individual messages via the $JS.DS.GET API (bool)
allowMsgTtl Boolean: (optional) Enables Per Message TTLs
allowRollupHdrs Boolean: (optional) Allows the use of the Nats-Rollup header to replace all contents of a stream, or subject in a stream, with a single new message (bool)
compression String: (optional) Enable stream compression by setting the value to s2
denyDelete Boolean: (optional) Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true (bool)
denyPurge Boolean: (optional) Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true (bool)
description String: (optional) Contains additional information about this stream (string)
discard String: (optional) When a Stream reach it's limits either old messages are deleted or new ones are denied (new or old)
discardNewPerSubject Boolean: (optional) When discard policy is new and the stream is one with max messages per subject set, this will apply the new behavior to every subject. Essentially turning discard new from maximum number of subjects into maximum number of messages in a subject (bool)
duplicateWindow Number: (optional) The time window size for duplicate tracking, duration specified in seconds (number)
inactiveThreshold Number: (optional) Removes the consumer after a idle period, specified as a duration in seconds
maxAckPending Number: (optional) Maximum pending Acks before consumers are paused
maxAge Number: (optional) The maximum oldest message that can be kept in the stream, duration specified in seconds (number)
maxBytes Number: (optional) The maximum size of all messages that can be kept in the stream (number)
maxConsumers Number: (optional) Number of consumers this stream allows (number)
maxMsgSize Number: (optional) The maximum individual message size that the stream will accept (number)
maxMsgs Number: (optional) The maximum amount of messages that can be kept in the stream (number)
maxMsgsPerSubject Number: (optional) The maximum amount of messages that can be kept in the stream on a per-subject basis (number)
metadata Map<String>: (optional) A map of strings with arbitrary metadata for the stream
mirror Property Map: (optional) Stream to mirror
mirrorDirect Boolean: If true, and the stream is a mirror, the mirror will participate in a serving direct get requests for individual messages from origin stream
name String: The name of the stream (string)
placementCluster String: (optional) Place the stream in a specific cluster, influenced by placement_tags
placementTags List<String>: (optional) Place the stream only on servers with these tags
replicas Number: (optional) How many replicas of the data to keep in a clustered environment (number)
republishDestination String: (optional) The destination to publish messages to
republishHeadersOnly Boolean: (optional) Republish only message headers, no bodies
republishSource String: (optional) Republish matching messages to republish_destination
retention String: (optional) The retention policy to apply over and above max_msgs, max_bytes and max_age (string). Options are limits, interest and workqueue. Defaults to limits.
sources List<Property Map>: (optional) List of streams to source
storage String: (optional) The storage engine to use to back the stream (string)
streamId String
subjectDeleteMarkerTtl Number: (optional) Enables placing markers when Max Age removes messages, duration specified in seconds (number)
subjectTransform Property Map: Subject transform to apply to matching messages
subjects List<String>: The list of subjects that will be consumed by the Stream (["list", "string"])

Supporting Types

StreamMirror, StreamMirrorArgs

Name string: The name of the stream (string)
External StreamMirrorExternal: Streams replicated from other accounts
FilterSubject string: Only copy messages matching a specific subject, not usable for mirrors
StartSeq double: The sequence to start mirroring from
StartTime string: The time stamp in the source stream to start from, in RFC3339 format
SubjectTransforms List<StreamMirrorSubjectTransform>: The subject filtering sources and associated destination transforms

Name string: The name of the stream (string)
External StreamMirrorExternal: Streams replicated from other accounts
FilterSubject string: Only copy messages matching a specific subject, not usable for mirrors
StartSeq float64: The sequence to start mirroring from
StartTime string: The time stamp in the source stream to start from, in RFC3339 format
SubjectTransforms []StreamMirrorSubjectTransform: The subject filtering sources and associated destination transforms

name String: The name of the stream (string)
external StreamMirrorExternal: Streams replicated from other accounts
filterSubject String: Only copy messages matching a specific subject, not usable for mirrors
startSeq Double: The sequence to start mirroring from
startTime String: The time stamp in the source stream to start from, in RFC3339 format
subjectTransforms List<StreamMirrorSubjectTransform>: The subject filtering sources and associated destination transforms

name string: The name of the stream (string)
external StreamMirrorExternal: Streams replicated from other accounts
filterSubject string: Only copy messages matching a specific subject, not usable for mirrors
startSeq number: The sequence to start mirroring from
startTime string: The time stamp in the source stream to start from, in RFC3339 format
subjectTransforms StreamMirrorSubjectTransform[]: The subject filtering sources and associated destination transforms

name str: The name of the stream (string)
external StreamMirrorExternal: Streams replicated from other accounts
filter_subject str: Only copy messages matching a specific subject, not usable for mirrors
start_seq float: The sequence to start mirroring from
start_time str: The time stamp in the source stream to start from, in RFC3339 format
subject_transforms Sequence[StreamMirrorSubjectTransform]: The subject filtering sources and associated destination transforms

name String: The name of the stream (string)
external Property Map: Streams replicated from other accounts
filterSubject String: Only copy messages matching a specific subject, not usable for mirrors
startSeq Number: The sequence to start mirroring from
startTime String: The time stamp in the source stream to start from, in RFC3339 format
subjectTransforms List<Property Map>: The subject filtering sources and associated destination transforms

StreamMirrorExternal, StreamMirrorExternalArgs

Api string: The subject prefix for the remote API
Deliver string: The subject prefix where messages will be delivered to

Api string: The subject prefix for the remote API
Deliver string: The subject prefix where messages will be delivered to

api String: The subject prefix for the remote API
deliver String: The subject prefix where messages will be delivered to

api string: The subject prefix for the remote API
deliver string: The subject prefix where messages will be delivered to

api str: The subject prefix for the remote API
deliver str: The subject prefix where messages will be delivered to

api String: The subject prefix for the remote API
deliver String: The subject prefix where messages will be delivered to

StreamMirrorSubjectTransform, StreamMirrorSubjectTransformArgs

Destination string: The subject transform destination
Source string: (optional) List of streams to source

Destination string: The subject transform destination
Source string: (optional) List of streams to source

destination String: The subject transform destination
source String: (optional) List of streams to source

destination string: The subject transform destination
source string: (optional) List of streams to source

destination str: The subject transform destination
source str: (optional) List of streams to source

destination String: The subject transform destination
source String: (optional) List of streams to source

StreamSource, StreamSourceArgs

Name string: The name of the stream (string)
External StreamSourceExternal: Streams replicated from other accounts
FilterSubject string: Only copy messages matching a specific subject, not usable for mirrors
StartSeq double: The sequence to start mirroring from
StartTime string: The time stamp in the source stream to start from, in RFC3339 format
SubjectTransforms List<StreamSourceSubjectTransform>: The subject filtering sources and associated destination transforms

Name string: The name of the stream (string)
External StreamSourceExternal: Streams replicated from other accounts
FilterSubject string: Only copy messages matching a specific subject, not usable for mirrors
StartSeq float64: The sequence to start mirroring from
StartTime string: The time stamp in the source stream to start from, in RFC3339 format
SubjectTransforms []StreamSourceSubjectTransform: The subject filtering sources and associated destination transforms

name String: The name of the stream (string)
external StreamSourceExternal: Streams replicated from other accounts
filterSubject String: Only copy messages matching a specific subject, not usable for mirrors
startSeq Double: The sequence to start mirroring from
startTime String: The time stamp in the source stream to start from, in RFC3339 format
subjectTransforms List<StreamSourceSubjectTransform>: The subject filtering sources and associated destination transforms

name string: The name of the stream (string)
external StreamSourceExternal: Streams replicated from other accounts
filterSubject string: Only copy messages matching a specific subject, not usable for mirrors
startSeq number: The sequence to start mirroring from
startTime string: The time stamp in the source stream to start from, in RFC3339 format
subjectTransforms StreamSourceSubjectTransform[]: The subject filtering sources and associated destination transforms

name str: The name of the stream (string)
external StreamSourceExternal: Streams replicated from other accounts
filter_subject str: Only copy messages matching a specific subject, not usable for mirrors
start_seq float: The sequence to start mirroring from
start_time str: The time stamp in the source stream to start from, in RFC3339 format
subject_transforms Sequence[StreamSourceSubjectTransform]: The subject filtering sources and associated destination transforms

name String: The name of the stream (string)
external Property Map: Streams replicated from other accounts
filterSubject String: Only copy messages matching a specific subject, not usable for mirrors
startSeq Number: The sequence to start mirroring from
startTime String: The time stamp in the source stream to start from, in RFC3339 format
subjectTransforms List<Property Map>: The subject filtering sources and associated destination transforms

StreamSourceExternal, StreamSourceExternalArgs

Api string: The subject prefix for the remote API
Deliver string: The subject prefix where messages will be delivered to

Api string: The subject prefix for the remote API
Deliver string: The subject prefix where messages will be delivered to

api String: The subject prefix for the remote API
deliver String: The subject prefix where messages will be delivered to

api string: The subject prefix for the remote API
deliver string: The subject prefix where messages will be delivered to

api str: The subject prefix for the remote API
deliver str: The subject prefix where messages will be delivered to

api String: The subject prefix for the remote API
deliver String: The subject prefix where messages will be delivered to

StreamSourceSubjectTransform, StreamSourceSubjectTransformArgs

Destination string: The subject transform destination
Source string: (optional) List of streams to source

Destination string: The subject transform destination
Source string: (optional) List of streams to source

destination String: The subject transform destination
source String: (optional) List of streams to source

destination string: The subject transform destination
source string: (optional) List of streams to source

destination str: The subject transform destination
source str: (optional) List of streams to source

destination String: The subject transform destination
source String: (optional) List of streams to source

StreamSubjectTransform, StreamSubjectTransformArgs

Destination string: The subject transform destination
Source string: (optional) List of streams to source

Destination string: The subject transform destination
Source string: (optional) List of streams to source

destination String: The subject transform destination
source String: (optional) List of streams to source

destination string: The subject transform destination
source string: (optional) List of streams to source

destination str: The subject transform destination
source str: (optional) List of streams to source

destination String: The subject transform destination
source String: (optional) List of streams to source

Package Details

Repository: jetstream nats-io/terraform-provider-jetstream
License
Notes: This Pulumi package is based on the jetstream Terraform Provider.

jetstream 0.2.0 published on Monday, Apr 14, 2025 by nats-io

nats-io/terraform-provider-jetstream

jetstream.Stream

On this page

On this page

# jetstream.Stream Resource

Example Usage

Sources and Mirrors

Create Stream Resource

Constructor syntax

Parameters

Constructor example

Stream Resource Properties

Inputs

Outputs

Look up Existing Stream Resource

Supporting Types

StreamMirror, StreamMirrorArgs

StreamMirrorExternal, StreamMirrorExternalArgs

StreamMirrorSubjectTransform, StreamMirrorSubjectTransformArgs

StreamSource, StreamSourceArgs

StreamSourceExternal, StreamSourceExternalArgs

StreamSourceSubjectTransform, StreamSourceSubjectTransformArgs

StreamSubjectTransform, StreamSubjectTransformArgs

Package Details

On this page

On this page