1. Packages
  2. AWS
  3. API Docs
  4. cloudfront
  5. KeyValueStore
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

aws.cloudfront.KeyValueStore

Explore with Pulumi AI

Resource for managing an AWS CloudFront Key Value Store.

Example Usage

Basic Usage

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

const example = new aws.cloudfront.KeyValueStore("example", {
    name: "ExampleKeyValueStore",
    comment: "This is an example key value store",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.cloudfront.KeyValueStore("example",
    name="ExampleKeyValueStore",
    comment="This is an example key value store")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudfront"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfront.NewKeyValueStore(ctx, "example", &cloudfront.KeyValueStoreArgs{
			Name:    pulumi.String("ExampleKeyValueStore"),
			Comment: pulumi.String("This is an example key value store"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CloudFront.KeyValueStore("example", new()
    {
        Name = "ExampleKeyValueStore",
        Comment = "This is an example key value store",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudfront.KeyValueStore;
import com.pulumi.aws.cloudfront.KeyValueStoreArgs;
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 example = new KeyValueStore("example", KeyValueStoreArgs.builder()
            .name("ExampleKeyValueStore")
            .comment("This is an example key value store")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:cloudfront:KeyValueStore
    properties:
      name: ExampleKeyValueStore
      comment: This is an example key value store
Copy

Create KeyValueStore Resource

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

Constructor syntax

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

@overload
def KeyValueStore(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  comment: Optional[str] = None,
                  name: Optional[str] = None,
                  timeouts: Optional[KeyValueStoreTimeoutsArgs] = None)
func NewKeyValueStore(ctx *Context, name string, args *KeyValueStoreArgs, opts ...ResourceOption) (*KeyValueStore, error)
public KeyValueStore(string name, KeyValueStoreArgs? args = null, CustomResourceOptions? opts = null)
public KeyValueStore(String name, KeyValueStoreArgs args)
public KeyValueStore(String name, KeyValueStoreArgs args, CustomResourceOptions options)
type: aws:cloudfront:KeyValueStore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args KeyValueStoreArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args KeyValueStoreArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args KeyValueStoreArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args KeyValueStoreArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KeyValueStoreArgs
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 keyValueStoreResource = new Aws.CloudFront.KeyValueStore("keyValueStoreResource", new()
{
    Comment = "string",
    Name = "string",
    Timeouts = new Aws.CloudFront.Inputs.KeyValueStoreTimeoutsArgs
    {
        Create = "string",
    },
});
Copy
example, err := cloudfront.NewKeyValueStore(ctx, "keyValueStoreResource", &cloudfront.KeyValueStoreArgs{
	Comment: pulumi.String("string"),
	Name:    pulumi.String("string"),
	Timeouts: &cloudfront.KeyValueStoreTimeoutsArgs{
		Create: pulumi.String("string"),
	},
})
Copy
var keyValueStoreResource = new KeyValueStore("keyValueStoreResource", KeyValueStoreArgs.builder()
    .comment("string")
    .name("string")
    .timeouts(KeyValueStoreTimeoutsArgs.builder()
        .create("string")
        .build())
    .build());
Copy
key_value_store_resource = aws.cloudfront.KeyValueStore("keyValueStoreResource",
    comment="string",
    name="string",
    timeouts={
        "create": "string",
    })
Copy
const keyValueStoreResource = new aws.cloudfront.KeyValueStore("keyValueStoreResource", {
    comment: "string",
    name: "string",
    timeouts: {
        create: "string",
    },
});
Copy
type: aws:cloudfront:KeyValueStore
properties:
    comment: string
    name: string
    timeouts:
        create: string
Copy

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

Comment string
Comment.
Name string

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

Timeouts KeyValueStoreTimeouts
Comment string
Comment.
Name string

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

Timeouts KeyValueStoreTimeoutsArgs
comment String
Comment.
name String

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

timeouts KeyValueStoreTimeouts
comment string
Comment.
name string

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

timeouts KeyValueStoreTimeouts
comment str
Comment.
name str

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

timeouts KeyValueStoreTimeoutsArgs
comment String
Comment.
name String

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

timeouts Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the KeyValueStore resource produces the following output properties:

Arn string
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
Etag string
ETag hash of the KeyValueStore.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedTime string
Arn string
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
Etag string
ETag hash of the KeyValueStore.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedTime string
arn String
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
etag String
ETag hash of the KeyValueStore.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedTime String
arn string
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
etag string
ETag hash of the KeyValueStore.
id string
The provider-assigned unique ID for this managed resource.
lastModifiedTime string
arn str
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
etag str
ETag hash of the KeyValueStore.
id str
The provider-assigned unique ID for this managed resource.
last_modified_time str
arn String
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
etag String
ETag hash of the KeyValueStore.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedTime String

Look up Existing KeyValueStore Resource

Get an existing KeyValueStore 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?: KeyValueStoreState, opts?: CustomResourceOptions): KeyValueStore
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        comment: Optional[str] = None,
        etag: Optional[str] = None,
        last_modified_time: Optional[str] = None,
        name: Optional[str] = None,
        timeouts: Optional[KeyValueStoreTimeoutsArgs] = None) -> KeyValueStore
func GetKeyValueStore(ctx *Context, name string, id IDInput, state *KeyValueStoreState, opts ...ResourceOption) (*KeyValueStore, error)
public static KeyValueStore Get(string name, Input<string> id, KeyValueStoreState? state, CustomResourceOptions? opts = null)
public static KeyValueStore get(String name, Output<String> id, KeyValueStoreState state, CustomResourceOptions options)
resources:  _:    type: aws:cloudfront:KeyValueStore    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Arn string
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
Comment string
Comment.
Etag string
ETag hash of the KeyValueStore.
LastModifiedTime string
Name string

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

Timeouts KeyValueStoreTimeouts
Arn string
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
Comment string
Comment.
Etag string
ETag hash of the KeyValueStore.
LastModifiedTime string
Name string

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

Timeouts KeyValueStoreTimeoutsArgs
arn String
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
comment String
Comment.
etag String
ETag hash of the KeyValueStore.
lastModifiedTime String
name String

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

timeouts KeyValueStoreTimeouts
arn string
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
comment string
Comment.
etag string
ETag hash of the KeyValueStore.
lastModifiedTime string
name string

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

timeouts KeyValueStoreTimeouts
arn str
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
comment str
Comment.
etag str
ETag hash of the KeyValueStore.
last_modified_time str
name str

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

timeouts KeyValueStoreTimeoutsArgs
arn String
Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore.
comment String
Comment.
etag String
ETag hash of the KeyValueStore.
lastModifiedTime String
name String

Unique name for your CloudFront KeyValueStore.

The following arguments are optional:

timeouts Property Map

Supporting Types

KeyValueStoreTimeouts
, KeyValueStoreTimeoutsArgs

Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
create String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Import

Using pulumi import, import CloudFront Key Value Store using the name. For example:

$ pulumi import aws:cloudfront/keyValueStore:KeyValueStore example example_store
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.