KeyvaluestoreKeysExclusive class

Resource for maintaining exclusive management of resource key value pairs defined in an AWS CloudFront KeyValueStore.

> This resource takes exclusive ownership over key value pairs defined in a KeyValueStore. This includes removal of key value pairs which are not explicitly configured. To prevent persistent drift, ensure any aws.cloudfront.KeyvaluestoreKey resources managed alongside this resource have an equivalent resourceKeyValuePair argument.

> Destruction of this resource means Terraform will no longer manage reconciliation of the configured key value pairs. It will not delete the configured key value pairs from the KeyValueStore.

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 exampleKeyvaluestoreKeysExclusive = new aws.cloudfront.KeyvaluestoreKeysExclusive("example", {
    resourceKeyValuePairs: [{
        key: "Test Key",
        value: "Test Value",
    }],
    keyValueStoreArn: example.arn,
});

import pulumi
import pulumi_aws as aws

example = aws.cloudfront.KeyValueStore("example",
    name="ExampleKeyValueStore",
    comment="This is an example key value store")
example_keyvaluestore_keys_exclusive = aws.cloudfront.KeyvaluestoreKeysExclusive("example",
    resource_key_value_pairs=[{
        "key": "Test Key",
        "value": "Test Value",
    }],
    key_value_store_arn=example.arn)

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 exampleKeyvaluestoreKeysExclusive = new Aws.CloudFront.KeyvaluestoreKeysExclusive("example", new()
    {
        ResourceKeyValuePairs = new[]
        {
            new Aws.CloudFront.Inputs.KeyvaluestoreKeysExclusiveResourceKeyValuePairArgs
            {
                Key = "Test Key",
                Value = "Test Value",
            },
        },
        KeyValueStoreArn = example.Arn,
    });

});

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.NewKeyvaluestoreKeysExclusive(ctx, "example", &cloudfront.KeyvaluestoreKeysExclusiveArgs{
			ResourceKeyValuePairs: cloudfront.KeyvaluestoreKeysExclusiveResourceKeyValuePairArray{
				&cloudfront.KeyvaluestoreKeysExclusiveResourceKeyValuePairArgs{
					Key:   pulumi.String("Test Key"),
					Value: pulumi.String("Test Value"),
				},
			},
			KeyValueStoreArn: example.Arn,
		})
		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_keyvaluestorekeysexclusive" "example" {
  resource_key_value_pairs {
    key   = "Test Key"
    value = "Test Value"
  }
  key_value_store_arn = aws_cloudfront_keyvaluestore.example.arn
}

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.KeyvaluestoreKeysExclusive;
import com.pulumi.aws.cloudfront.KeyvaluestoreKeysExclusiveArgs;
import com.pulumi.aws.cloudfront.inputs.KeyvaluestoreKeysExclusiveResourceKeyValuePairArgs;
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 exampleKeyvaluestoreKeysExclusive = new KeyvaluestoreKeysExclusive("exampleKeyvaluestoreKeysExclusive", KeyvaluestoreKeysExclusiveArgs.builder()
            .resourceKeyValuePairs(KeyvaluestoreKeysExclusiveResourceKeyValuePairArgs.builder()
                .key("Test Key")
                .value("Test Value")
                .build())
            .keyValueStoreArn(example.arn())
            .build());

    }
}

resources:
  example:
    type: aws:cloudfront:KeyValueStore
    properties:
      name: ExampleKeyValueStore
      comment: This is an example key value store
  exampleKeyvaluestoreKeysExclusive:
    type: aws:cloudfront:KeyvaluestoreKeysExclusive
    name: example
    properties:
      resourceKeyValuePairs:
        - key: Test Key
          value: Test Value
      keyValueStoreArn: ${example.arn}

Disallow Key Value Pairs

To automatically remove any configured key value pairs, omit a resourceKeyValuePair block.

> This will not prevent key value pairs from being defined in a KeyValueStore via Terraform (or any other interface). This resource enables bringing key value pairs into a configured state, however, this reconciliation happens only when apply is proactively run.

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

const example = new aws.cloudfront.KeyvaluestoreKeysExclusive("example", {keyValueStoreArn: exampleAwsCloudfrontKeyValueStore.arn});

import pulumi
import pulumi_aws as aws

example = aws.cloudfront.KeyvaluestoreKeysExclusive("example", key_value_store_arn=example_aws_cloudfront_key_value_store["arn"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.CloudFront.KeyvaluestoreKeysExclusive("example", new()
    {
        KeyValueStoreArn = exampleAwsCloudfrontKeyValueStore.Arn,
    });

});

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 {
		_, err := cloudfront.NewKeyvaluestoreKeysExclusive(ctx, "example", &cloudfront.KeyvaluestoreKeysExclusiveArgs{
			KeyValueStoreArn: pulumi.Any(exampleAwsCloudfrontKeyValueStore.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cloudfront_keyvaluestorekeysexclusive" "example" {
  key_value_store_arn = exampleAwsCloudfrontKeyValueStore.arn
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudfront.KeyvaluestoreKeysExclusive;
import com.pulumi.aws.cloudfront.KeyvaluestoreKeysExclusiveArgs;
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 KeyvaluestoreKeysExclusive("example", KeyvaluestoreKeysExclusiveArgs.builder()
            .keyValueStoreArn(exampleAwsCloudfrontKeyValueStore.arn())
            .build());

    }
}

resources:
  example:
    type: aws:cloudfront:KeyvaluestoreKeysExclusive
    properties:
      keyValueStoreArn: ${exampleAwsCloudfrontKeyValueStore.arn}

Import

Using pulumi import, import AWS CloudFront KeyValueStore Key Value Pairs using the keyValueStoreArn. For example:

$ pulumi import aws:cloudfront/keyvaluestoreKeysExclusive:KeyvaluestoreKeysExclusive example arn:aws:cloudfront::111111111111:key-value-store/8562g61f-caba-2845-9d99-b97diwae5d3c