Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

WorkersKv

Provides a Workers KV Pair. NOTE: This resource uses the Cloudflare account APIs. This requires setting the CLOUDFLARE_ACCOUNT_ID environment variable or account_id provider argument.

Example Usage

using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleNs = new Cloudflare.WorkersKvNamespace("exampleNs", new Cloudflare.WorkersKvNamespaceArgs
        {
            Title = "test-namespace",
        });
        var example = new Cloudflare.WorkersKv("example", new Cloudflare.WorkersKvArgs
        {
            NamespaceId = exampleNs.Id,
            Key = "test-key",
            Value = "test value",
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-cloudflare/sdk/v2/go/cloudflare"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleNs, err := cloudflare.NewWorkersKvNamespace(ctx, "exampleNs", &cloudflare.WorkersKvNamespaceArgs{
            Title: pulumi.String("test-namespace"),
        })
        if err != nil {
            return err
        }
        _, err = cloudflare.NewWorkersKv(ctx, "example", &cloudflare.WorkersKvArgs{
            NamespaceId: exampleNs.ID(),
            Key:         pulumi.String("test-key"),
            Value:       pulumi.String("test value"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_cloudflare as cloudflare

example_ns = cloudflare.WorkersKvNamespace("exampleNs", title="test-namespace")
example = cloudflare.WorkersKv("example",
    namespace_id=example_ns.id,
    key="test-key",
    value="test value")
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleNs = new cloudflare.WorkersKvNamespace("exampleNs", {title: "test-namespace"});
const example = new cloudflare.WorkersKv("example", {
    namespaceId: exampleNs.id,
    key: "test-key",
    value: "test value",
});

Create a WorkersKv Resource

new WorkersKv(name: string, args: WorkersKvArgs, opts?: CustomResourceOptions);
def WorkersKv(resource_name: str, opts: Optional[ResourceOptions] = None, key: Optional[str] = None, namespace_id: Optional[str] = None, value: Optional[str] = None)
func NewWorkersKv(ctx *Context, name string, args WorkersKvArgs, opts ...ResourceOption) (*WorkersKv, error)
public WorkersKv(string name, WorkersKvArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args WorkersKvArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args WorkersKvArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args WorkersKvArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

WorkersKv Resource Properties

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

Inputs

The WorkersKv resource accepts the following input properties:

Key string

The key name

NamespaceId string

The ID of the Workers KV namespace in which you want to create the KV pair

Value string

The string value to be stored in the key

Key string

The key name

NamespaceId string

The ID of the Workers KV namespace in which you want to create the KV pair

Value string

The string value to be stored in the key

key string

The key name

namespaceId string

The ID of the Workers KV namespace in which you want to create the KV pair

value string

The string value to be stored in the key

key str

The key name

namespace_id str

The ID of the Workers KV namespace in which you want to create the KV pair

value str

The string value to be stored in the key

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkersKv 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing WorkersKv Resource

Get an existing WorkersKv 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?: WorkersKvState, opts?: CustomResourceOptions): WorkersKv
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, key: Optional[str] = None, namespace_id: Optional[str] = None, value: Optional[str] = None) -> WorkersKv
func GetWorkersKv(ctx *Context, name string, id IDInput, state *WorkersKvState, opts ...ResourceOption) (*WorkersKv, error)
public static WorkersKv Get(string name, Input<string> id, WorkersKvState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Key string

The key name

NamespaceId string

The ID of the Workers KV namespace in which you want to create the KV pair

Value string

The string value to be stored in the key

Key string

The key name

NamespaceId string

The ID of the Workers KV namespace in which you want to create the KV pair

Value string

The string value to be stored in the key

key string

The key name

namespaceId string

The ID of the Workers KV namespace in which you want to create the KV pair

value string

The string value to be stored in the key

key str

The key name

namespace_id str

The ID of the Workers KV namespace in which you want to create the KV pair

value str

The string value to be stored in the key

Import

 $ pulumi import cloudflare:index/workersKv:WorkersKv example beaeb6716c9443eaa4deef11763ccca6_test-key

where- beaeb6716c9443eaa4deef11763ccca6 is the ID of the namespace and test-key is the key

Package Details

Repository
https://github.com/pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.