Package com.pulumi.aws.cloudfront

Class KeyvaluestoreKeysExclusive

  • public class KeyvaluestoreKeysExclusive
extends com.pulumi.resources.CustomResource
    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 
     
 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());
 
     }
 }
    ### 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. 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import AWS CloudFront KeyValueStore Key Value Pairs using the `keyValueStoreArn`. For example: ```sh $ pulumi import aws:cloudfront/keyvaluestoreKeysExclusive:KeyvaluestoreKeysExclusive example arn:aws:cloudfront::111111111111:key-value-store/8562g61f-caba-2845-9d99-b97diwae5d3c ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static KeyvaluestoreKeysExclusive get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, KeyvaluestoreKeysExclusiveState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> keyValueStoreArn()  
      com.pulumi.core.Output<java.lang.Integer> maxBatchSize()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<KeyvaluestoreKeysExclusiveResourceKeyValuePair>>> resourceKeyValuePairs()  
      com.pulumi.core.Output<java.lang.Integer> totalSizeInBytes()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • KeyvaluestoreKeysExclusive

        public KeyvaluestoreKeysExclusive​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • KeyvaluestoreKeysExclusive

        public KeyvaluestoreKeysExclusive​(java.lang.String name,
                                  KeyvaluestoreKeysExclusiveArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • KeyvaluestoreKeysExclusive

        public KeyvaluestoreKeysExclusive​(java.lang.String name,
                                  KeyvaluestoreKeysExclusiveArgs args,
                                  @Nullable
                                  com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • keyValueStoreArn

        public com.pulumi.core.Output<java.lang.String> keyValueStoreArn()
        Returns:
        ARN of the Key Value Store. The following arguments are optional:

      • maxBatchSize

        public com.pulumi.core.Output<java.lang.Integer> maxBatchSize()
        Returns:
        Maximum resource key values pairs that will update in a single API request. AWS has a default quota of 50 keys or a 3 MB payload, whichever is reached first. Defaults to `50`.

      • resourceKeyValuePairs

        public com.pulumi.core.Output<java.util.Optional<java.util.List<KeyvaluestoreKeysExclusiveResourceKeyValuePair>>> resourceKeyValuePairs()
        Returns:
        A list of all resource key value pairs associated with the KeyValueStore. See `resourceKeyValuePair` below.

      • totalSizeInBytes

        public com.pulumi.core.Output<java.lang.Integer> totalSizeInBytes()
        Returns:
        Total size of the Key Value Store in bytes.

      • get

        public static KeyvaluestoreKeysExclusive get​(java.lang.String name,
                                             com.pulumi.core.Output<java.lang.String> id,
                                             @Nullable
                                             KeyvaluestoreKeysExclusiveState state,
                                             @Nullable
                                             com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.