Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Jetstream Provider
  3. API Docs
  4. KvBucket
jetstream 0.2.0 published on Monday, Apr 14, 2025 by nats-io
nats-io/terraform-provider-jetstream

jetstream.KvBucket

Explore with Pulumi AI

jetstream logo
jetstream 0.2.0 published on Monday, Apr 14, 2025 by nats-io
nats-io/terraform-provider-jetstream

    # jetstream.KvBucket Resource

    The jetstream.KvBucket Resource manages JetStream Based Key-Value buckets, supports editing Buckets in place.

    Example Usage

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

const cFG = new jetstream.KvBucket("cFG", {history: 10});

    import pulumi
import pulumi_jetstream as jetstream

c_fg = jetstream.KvBucket("cFG", history=10)

    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.NewKvBucket(ctx, "cFG", &jetstream.KvBucketArgs{
			History: pulumi.Float64(10),
		})
		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 cFG = new Jetstream.KvBucket("cFG", new()
    {
        History = 10,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.jetstream.KvBucket;
import com.pulumi.jetstream.KvBucketArgs;
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 cFG = new KvBucket("cFG", KvBucketArgs.builder()
            .history(10)
            .build());

    }
}

    resources:
  cFG:
    type: jetstream:KvBucket
    properties:
      history: 10

    Attribute Reference

    • name - (required) The unique name of the KV bucket, must match \A[a-zA-Z0-9_-]+\z
    • description - (optional) Contains additional information about this bucket
    • history - (optional) Number of historic values to keep
    • ttl - (optional) How many seconds to keep values for, keeps forever when not set
    • placement_cluster - (optional) Place the bucket in a specific cluster, influenced by placement_tags
    • placement_tags - (optional) Place the bucket only on servers with these tags
    • max_value_size - (optional) Maximum size of any value
    • max_bucket_size - (optional) The maximum size of all data in the bucket
    • replicas - (optional) How many replicas to keep on a JetStream cluster

    Create KvBucket Resource

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

    Constructor syntax

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

@overload
def KvBucket(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             description: Optional[str] = None,
             history: Optional[float] = None,
             kv_bucket_id: Optional[str] = None,
             max_bucket_size: Optional[float] = None,
             max_value_size: Optional[float] = None,
             name: Optional[str] = None,
             placement_cluster: Optional[str] = None,
             placement_tags: Optional[Sequence[str]] = None,
             replicas: Optional[float] = None,
             ttl: Optional[float] = None)
    func NewKvBucket(ctx *Context, name string, args *KvBucketArgs, opts ...ResourceOption) (*KvBucket, error)
    public KvBucket(string name, KvBucketArgs? args = null, CustomResourceOptions? opts = null)
    public KvBucket(String name, KvBucketArgs args)
public KvBucket(String name, KvBucketArgs args, CustomResourceOptions options)

    type: jetstream:KvBucket
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 KvBucketArgs
    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 KvBucketArgs
    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 KvBucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KvBucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KvBucketArgs
    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 kvBucketResource = new Jetstream.KvBucket("kvBucketResource", new()
{
    Description = "string",
    History = 0,
    KvBucketId = "string",
    MaxBucketSize = 0,
    MaxValueSize = 0,
    Name = "string",
    PlacementCluster = "string",
    PlacementTags = new[]
    {
        "string",
    },
    Replicas = 0,
    Ttl = 0,
});

    example, err := jetstream.NewKvBucket(ctx, "kvBucketResource", &jetstream.KvBucketArgs{
	Description:      pulumi.String("string"),
	History:          pulumi.Float64(0),
	KvBucketId:       pulumi.String("string"),
	MaxBucketSize:    pulumi.Float64(0),
	MaxValueSize:     pulumi.Float64(0),
	Name:             pulumi.String("string"),
	PlacementCluster: pulumi.String("string"),
	PlacementTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Replicas: pulumi.Float64(0),
	Ttl:      pulumi.Float64(0),
})

    var kvBucketResource = new KvBucket("kvBucketResource", KvBucketArgs.builder()
    .description("string")
    .history(0)
    .kvBucketId("string")
    .maxBucketSize(0)
    .maxValueSize(0)
    .name("string")
    .placementCluster("string")
    .placementTags("string")
    .replicas(0)
    .ttl(0)
    .build());

    kv_bucket_resource = jetstream.KvBucket("kvBucketResource",
    description="string",
    history=0,
    kv_bucket_id="string",
    max_bucket_size=0,
    max_value_size=0,
    name="string",
    placement_cluster="string",
    placement_tags=["string"],
    replicas=0,
    ttl=0)

    const kvBucketResource = new jetstream.KvBucket("kvBucketResource", {
    description: "string",
    history: 0,
    kvBucketId: "string",
    maxBucketSize: 0,
    maxValueSize: 0,
    name: "string",
    placementCluster: "string",
    placementTags: ["string"],
    replicas: 0,
    ttl: 0,
});

    type: jetstream:KvBucket
properties:
    description: string
    history: 0
    kvBucketId: string
    maxBucketSize: 0
    maxValueSize: 0
    name: string
    placementCluster: string
    placementTags:
        - string
    replicas: 0
    ttl: 0

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

    Description string
    Contains additional information about this bucket
    History double
    How many historical values to keep
    KvBucketId string
    MaxBucketSize double
    Maximum size of the entire bucket
    MaxValueSize double
    Maximum size of any value
    Name string
    The name of the Bucket
    PlacementCluster string
    Place the bucket in a specific cluster, influenced by placement_tags
    PlacementTags List<string>
    Place the stream only on servers with these tags
    Replicas double
    Number of cluster replicas to store
    Ttl double
    How many seconds a value will be kept in the bucket
    Description string
    Contains additional information about this bucket
    History float64
    How many historical values to keep
    KvBucketId string
    MaxBucketSize float64
    Maximum size of the entire bucket
    MaxValueSize float64
    Maximum size of any value
    Name string
    The name of the Bucket
    PlacementCluster string
    Place the bucket in a specific cluster, influenced by placement_tags
    PlacementTags []string
    Place the stream only on servers with these tags
    Replicas float64
    Number of cluster replicas to store
    Ttl float64
    How many seconds a value will be kept in the bucket
    description String
    Contains additional information about this bucket
    history Double
    How many historical values to keep
    kvBucketId String
    maxBucketSize Double
    Maximum size of the entire bucket
    maxValueSize Double
    Maximum size of any value
    name String
    The name of the Bucket
    placementCluster String
    Place the bucket in a specific cluster, influenced by placement_tags
    placementTags List<String>
    Place the stream only on servers with these tags
    replicas Double
    Number of cluster replicas to store
    ttl Double
    How many seconds a value will be kept in the bucket
    description string
    Contains additional information about this bucket
    history number
    How many historical values to keep
    kvBucketId string
    maxBucketSize number
    Maximum size of the entire bucket
    maxValueSize number
    Maximum size of any value
    name string
    The name of the Bucket
    placementCluster string
    Place the bucket in a specific cluster, influenced by placement_tags
    placementTags string[]
    Place the stream only on servers with these tags
    replicas number
    Number of cluster replicas to store
    ttl number
    How many seconds a value will be kept in the bucket
    description str
    Contains additional information about this bucket
    history float
    How many historical values to keep
    kv_bucket_id str
    max_bucket_size float
    Maximum size of the entire bucket
    max_value_size float
    Maximum size of any value
    name str
    The name of the Bucket
    placement_cluster str
    Place the bucket in a specific cluster, influenced by placement_tags
    placement_tags Sequence[str]
    Place the stream only on servers with these tags
    replicas float
    Number of cluster replicas to store
    ttl float
    How many seconds a value will be kept in the bucket
    description String
    Contains additional information about this bucket
    history Number
    How many historical values to keep
    kvBucketId String
    maxBucketSize Number
    Maximum size of the entire bucket
    maxValueSize Number
    Maximum size of any value
    name String
    The name of the Bucket
    placementCluster String
    Place the bucket in a specific cluster, influenced by placement_tags
    placementTags List<String>
    Place the stream only on servers with these tags
    replicas Number
    Number of cluster replicas to store
    ttl Number
    How many seconds a value will be kept in the bucket

    Outputs

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

    Get an existing KvBucket 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?: KvBucketState, opts?: CustomResourceOptions): KvBucket
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        history: Optional[float] = None,
        kv_bucket_id: Optional[str] = None,
        max_bucket_size: Optional[float] = None,
        max_value_size: Optional[float] = None,
        name: Optional[str] = None,
        placement_cluster: Optional[str] = None,
        placement_tags: Optional[Sequence[str]] = None,
        replicas: Optional[float] = None,
        ttl: Optional[float] = None) -> KvBucket
    func GetKvBucket(ctx *Context, name string, id IDInput, state *KvBucketState, opts ...ResourceOption) (*KvBucket, error)
    public static KvBucket Get(string name, Input<string> id, KvBucketState? state, CustomResourceOptions? opts = null)
    public static KvBucket get(String name, Output<String> id, KvBucketState state, CustomResourceOptions options)
    resources:  _:    type: jetstream:KvBucket    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:
    Description string
    Contains additional information about this bucket
    History double
    How many historical values to keep
    KvBucketId string
    MaxBucketSize double
    Maximum size of the entire bucket
    MaxValueSize double
    Maximum size of any value
    Name string
    The name of the Bucket
    PlacementCluster string
    Place the bucket in a specific cluster, influenced by placement_tags
    PlacementTags List<string>
    Place the stream only on servers with these tags
    Replicas double
    Number of cluster replicas to store
    Ttl double
    How many seconds a value will be kept in the bucket
    Description string
    Contains additional information about this bucket
    History float64
    How many historical values to keep
    KvBucketId string
    MaxBucketSize float64
    Maximum size of the entire bucket
    MaxValueSize float64
    Maximum size of any value
    Name string
    The name of the Bucket
    PlacementCluster string
    Place the bucket in a specific cluster, influenced by placement_tags
    PlacementTags []string
    Place the stream only on servers with these tags
    Replicas float64
    Number of cluster replicas to store
    Ttl float64
    How many seconds a value will be kept in the bucket
    description String
    Contains additional information about this bucket
    history Double
    How many historical values to keep
    kvBucketId String
    maxBucketSize Double
    Maximum size of the entire bucket
    maxValueSize Double
    Maximum size of any value
    name String
    The name of the Bucket
    placementCluster String
    Place the bucket in a specific cluster, influenced by placement_tags
    placementTags List<String>
    Place the stream only on servers with these tags
    replicas Double
    Number of cluster replicas to store
    ttl Double
    How many seconds a value will be kept in the bucket
    description string
    Contains additional information about this bucket
    history number
    How many historical values to keep
    kvBucketId string
    maxBucketSize number
    Maximum size of the entire bucket
    maxValueSize number
    Maximum size of any value
    name string
    The name of the Bucket
    placementCluster string
    Place the bucket in a specific cluster, influenced by placement_tags
    placementTags string[]
    Place the stream only on servers with these tags
    replicas number
    Number of cluster replicas to store
    ttl number
    How many seconds a value will be kept in the bucket
    description str
    Contains additional information about this bucket
    history float
    How many historical values to keep
    kv_bucket_id str
    max_bucket_size float
    Maximum size of the entire bucket
    max_value_size float
    Maximum size of any value
    name str
    The name of the Bucket
    placement_cluster str
    Place the bucket in a specific cluster, influenced by placement_tags
    placement_tags Sequence[str]
    Place the stream only on servers with these tags
    replicas float
    Number of cluster replicas to store
    ttl float
    How many seconds a value will be kept in the bucket
    description String
    Contains additional information about this bucket
    history Number
    How many historical values to keep
    kvBucketId String
    maxBucketSize Number
    Maximum size of the entire bucket
    maxValueSize Number
    Maximum size of any value
    name String
    The name of the Bucket
    placementCluster String
    Place the bucket in a specific cluster, influenced by placement_tags
    placementTags List<String>
    Place the stream only on servers with these tags
    replicas Number
    Number of cluster replicas to store
    ttl Number
    How many seconds a value will be kept in the bucket

    Package Details

    Repository
    jetstream nats-io/terraform-provider-jetstream
    License
    Notes
    This Pulumi package is based on the jetstream Terraform Provider.
    jetstream logo
    jetstream 0.2.0 published on Monday, Apr 14, 2025 by nats-io
    nats-io/terraform-provider-jetstream