Cloudflare v5.0.0, Mar 13 23

cloudflare.WorkersKv

Provides a resource to manage a Cloudflare Workers KV Pair.

This resource uses the Cloudflare account APIs. This requires setting the CLOUDFLARE_ACCOUNT_ID environment variable or account_id provider argument if you do not explicitly set the resource level account_id value.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleNs = new Cloudflare.WorkersKvNamespace("exampleNs", new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        Title = "test-namespace",
    });

    var example = new Cloudflare.WorkersKv("example", new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        NamespaceId = exampleNs.Id,
        Key = "test-key",
        Value = "test value",
    });

});

package main

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

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

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.WorkersKvNamespace;
import com.pulumi.cloudflare.WorkersKvNamespaceArgs;
import com.pulumi.cloudflare.WorkersKv;
import com.pulumi.cloudflare.WorkersKvArgs;
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 exampleNs = new WorkersKvNamespace("exampleNs", WorkersKvNamespaceArgs.builder()        
            .accountId("f037e56e89293a057740de681ac9abbe")
            .title("test-namespace")
            .build());

        var example = new WorkersKv("example", WorkersKvArgs.builder()        
            .accountId("f037e56e89293a057740de681ac9abbe")
            .namespaceId(exampleNs.id())
            .key("test-key")
            .value("test value")
            .build());

    }
}

import pulumi
import pulumi_cloudflare as cloudflare

example_ns = cloudflare.WorkersKvNamespace("exampleNs",
    account_id="f037e56e89293a057740de681ac9abbe",
    title="test-namespace")
example = cloudflare.WorkersKv("example",
    account_id="f037e56e89293a057740de681ac9abbe",
    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", {
    accountId: "f037e56e89293a057740de681ac9abbe",
    title: "test-namespace",
});
const example = new cloudflare.WorkersKv("example", {
    accountId: "f037e56e89293a057740de681ac9abbe",
    namespaceId: exampleNs.id,
    key: "test-key",
    value: "test value",
});

resources:
  exampleNs:
    type: cloudflare:WorkersKvNamespace
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      title: test-namespace
  example:
    type: cloudflare:WorkersKv
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      namespaceId: ${exampleNs.id}
      key: test-key
      value: test value

Create WorkersKv Resource

new WorkersKv(name: string, args: WorkersKvArgs, opts?: CustomResourceOptions);

@overload
def WorkersKv(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              account_id: Optional[str] = None,
              key: Optional[str] = None,
              namespace_id: Optional[str] = None,
              value: Optional[str] = None)
@overload
def WorkersKv(resource_name: str,
              args: WorkersKvArgs,
              opts: Optional[ResourceOptions] = None)

func NewWorkersKv(ctx *Context, name string, args WorkersKvArgs, opts ...ResourceOption) (*WorkersKv, error)

public WorkersKv(string name, WorkersKvArgs args, CustomResourceOptions? opts = null)

public WorkersKv(String name, WorkersKvArgs args)
public WorkersKv(String name, WorkersKvArgs args, CustomResourceOptions options)

type: cloudflare:WorkersKv
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args WorkersKvArgs: 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 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.

name String: The unique name of the resource.
args WorkersKvArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The WorkersKv resource accepts the following input properties:

AccountId string: The account identifier to target for the resource.
Key string: Name of the KV pair. Modifying this attribute will force creation of a new resource.
NamespaceId string: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
Value string: Value of the KV pair.

AccountId string: The account identifier to target for the resource.
Key string: Name of the KV pair. Modifying this attribute will force creation of a new resource.
NamespaceId string: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
Value string: Value of the KV pair.

accountId String: The account identifier to target for the resource.
key String: Name of the KV pair. Modifying this attribute will force creation of a new resource.
namespaceId String: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
value String: Value of the KV pair.

accountId string: The account identifier to target for the resource.
key string: Name of the KV pair. Modifying this attribute will force creation of a new resource.
namespaceId string: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
value string: Value of the KV pair.

account_id str: The account identifier to target for the resource.
key str: Name of the KV pair. Modifying this attribute will force creation of a new resource.
namespace_id str: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
value str: Value of the KV pair.

accountId String: The account identifier to target for the resource.
key String: Name of the KV pair. Modifying this attribute will force creation of a new resource.
namespaceId String: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
value String: Value of the KV pair.

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 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 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,
        account_id: Optional[str] = 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)

public static WorkersKv get(String name, Output<String> id, WorkersKvState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountId string: The account identifier to target for the resource.
Key string: Name of the KV pair. Modifying this attribute will force creation of a new resource.
NamespaceId string: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
Value string: Value of the KV pair.

AccountId string: The account identifier to target for the resource.
Key string: Name of the KV pair. Modifying this attribute will force creation of a new resource.
NamespaceId string: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
Value string: Value of the KV pair.

accountId String: The account identifier to target for the resource.
key String: Name of the KV pair. Modifying this attribute will force creation of a new resource.
namespaceId String: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
value String: Value of the KV pair.

accountId string: The account identifier to target for the resource.
key string: Name of the KV pair. Modifying this attribute will force creation of a new resource.
namespaceId string: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
value string: Value of the KV pair.

account_id str: The account identifier to target for the resource.
key str: Name of the KV pair. Modifying this attribute will force creation of a new resource.
namespace_id str: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
value str: Value of the KV pair.

accountId String: The account identifier to target for the resource.
key String: Name of the KV pair. Modifying this attribute will force creation of a new resource.
namespaceId String: The ID of the Workers KV namespace in which you want to create the KV pair. Modifying this attribute will force creation of a new resource.
value String: Value of the KV pair.

Import

 $ pulumi import cloudflare:index/workersKv:WorkersKv example <account_id>/<namespace_id>/<key_name>

Package Details

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