KeyvaluestoreKey class
Resource for managing an AWS CloudFront KeyValueStore Key.
> This resource manages individual key value pairs in a KeyValueStore. This can lead to high costs associated with accessing the CloudFront KeyValueStore API when performing terraform operations with many key value pairs defined. For large key value stores, consider the aws.cloudfront.KeyvaluestoreKeysExclusive resource to minimize the number of API calls made to the CloudFront KeyValueStore API.
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",
});
const exampleKeyvaluestoreKey = new aws.cloudfront.KeyvaluestoreKey("example", {
keyValueStoreArn: example.arn,
key: "Test Key",
value: "Test Value",
});
import pulumi
import pulumi_aws as aws
example = aws.cloudfront.KeyValueStore("example",
name="ExampleKeyValueStore",
comment="This is an example key value store")
example_keyvaluestore_key = aws.cloudfront.KeyvaluestoreKey("example",
key_value_store_arn=example.arn,
key="Test Key",
value="Test Value")
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",
});
var exampleKeyvaluestoreKey = new Aws.CloudFront.KeyvaluestoreKey("example", new()
{
KeyValueStoreArn = example.Arn,
Key = "Test Key",
Value = "Test Value",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudfront"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, 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
}
_, err = cloudfront.NewKeyvaluestoreKey(ctx, "example", &cloudfront.KeyvaluestoreKeyArgs{
KeyValueStoreArn: example.Arn,
Key: pulumi.String("Test Key"),
Value: pulumi.String("Test Value"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cloudfront_keyvaluestore" "example" {
name = "ExampleKeyValueStore"
comment = "This is an example key value store"
}
resource "aws_cloudfront_keyvaluestorekey" "example" {
key_value_store_arn = aws_cloudfront_keyvaluestore.example.arn
key = "Test Key"
value = "Test Value"
}
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 com.pulumi.aws.cloudfront.KeyvaluestoreKey;
import com.pulumi.aws.cloudfront.KeyvaluestoreKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
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());
var exampleKeyvaluestoreKey = new KeyvaluestoreKey("exampleKeyvaluestoreKey", KeyvaluestoreKeyArgs.builder()
.keyValueStoreArn(example.arn())
.key("Test Key")
.value("Test Value")
.build());
}
}
resources:
example:
type: aws:cloudfront:KeyValueStore
properties:
name: ExampleKeyValueStore
comment: This is an example key value store
exampleKeyvaluestoreKey:
type: aws:cloudfront:KeyvaluestoreKey
name: example
properties:
keyValueStoreArn: ${example.arn}
key: Test Key
value: Test Value
Import
Identity Schema
Required
keyValueStoreArn(String) ARN of the CloudFront Key Value Store.key(String) Key name.
Optional
accountId(String) AWS Account where this resource is managed.
Using pulumi import, import CloudFront KeyValueStore Key using the keyValueStoreArn and 'key' separated by ,. For example:
$ pulumi import aws:cloudfront/keyvaluestoreKey:KeyvaluestoreKey example arn:aws:cloudfront::111111111111:key-value-store/8562g61f-caba-2845-9d99-b97diwae5d3c,someKey
Constructors
- KeyvaluestoreKey(String name, {KeyvaluestoreKeyArgs? args, CustomResourceOptions? options})
-
Creates a new KeyvaluestoreKey.
nameThe Pulumi resource name.argsArguments used to configure this KeyvaluestoreKey. The set of arguments for KeyvaluestoreKey.optionsResource options controlling this resource's behavior. - KeyvaluestoreKey.reference(String urn)
- Creates a typed reference to an existing KeyvaluestoreKey resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
key
↔ Output<
String> -
Key to put.
latefinal
-
keyValueStoreArn
↔ Output<
String> -
ARN of the Key Value Store.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
totalSizeInBytes
↔ Output<
int> -
Total size of the Key Value Store in bytes.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
value
↔ Output<
String> -
Value to put.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {KeyvaluestoreKeyState? state, CustomResourceOptions? options}) → KeyvaluestoreKey -
Gets an existing KeyvaluestoreKey resource's state with the given
nameandid.