Package com.pulumi.aws.paymentcryptography

Class Key

  • public class Key
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Payment Cryptography Control Plane Key. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.paymentcryptography.Key;
 import com.pulumi.aws.paymentcryptography.KeyArgs;
 import com.pulumi.aws.paymentcryptography.inputs.KeyKeyAttributeArgs;
 import com.pulumi.aws.paymentcryptography.inputs.KeyKeyAttributeKeyModesOfUseArgs;
 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 test = new Key("test", KeyArgs.builder()
             .keyAttributes(KeyKeyAttributeArgs.builder()
                 .keyModesOfUses(KeyKeyAttributeKeyModesOfUseArgs.builder()
                     .decrypt(true)
                     .encrypt(true)
                     .wrap(true)
                     .unwrap(true)
                     .build())
                 .keyAlgorithm("TDES_3KEY")
                 .keyClass("SYMMETRIC_KEY")
                 .keyUsage("TR31_P0_PIN_ENCRYPTION_KEY")
                 .build())
             .exportable(true)
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the Payment Cryptography key. Using `pulumi import`, import Payment Cryptography Control Plane Key using the `arn:aws:payment-cryptography:us-east-1:123456789012:key/qtbojf64yshyvyzf`. For example: ```sh $ pulumi import aws:paymentcryptography/key:Key example arn:aws:payment-cryptography:us-east-1:123456789012:key/qtbojf64yshyvyzf ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Key​(java.lang.String name)  
      Key​(java.lang.String name, KeyArgs args)  
      Key​(java.lang.String name, KeyArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.Integer> deletionWindowInDays()  
      com.pulumi.core.Output<java.lang.Boolean> enabled()  
      com.pulumi.core.Output<java.lang.Boolean> exportable()  
      static Key get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, KeyState 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.util.Optional<java.util.List<KeyKeyAttribute>>> keyAttributes()  
      com.pulumi.core.Output<java.lang.String> keyCheckValue()  
      com.pulumi.core.Output<java.lang.String> keyCheckValueAlgorithm()  
      com.pulumi.core.Output<java.lang.String> keyOrigin()  
      com.pulumi.core.Output<java.lang.String> keyState()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<KeyTimeouts>> timeouts()  

      • 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

      • Key

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

      • Key

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

      • Key

        public Key​(java.lang.String name,
           KeyArgs 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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the key.

      • deletionWindowInDays

        public com.pulumi.core.Output<java.lang.Integer> deletionWindowInDays()
        Returns:
        Number of days between 3 and 180 to wait after the resource is deleted before the key is deleted.

      • enabled

        public com.pulumi.core.Output<java.lang.Boolean> enabled()
        Returns:
        Whether to enable the key.

      • exportable

        public com.pulumi.core.Output<java.lang.Boolean> exportable()
        Returns:
        Whether the key is exportable from the service.

      • keyAttributes

        public com.pulumi.core.Output<java.util.Optional<java.util.List<KeyKeyAttribute>>> keyAttributes()
        Returns:
        Role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. The following arguments are optional:

      • keyCheckValue

        public com.pulumi.core.Output<java.lang.String> keyCheckValue()
        Returns:
        Key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      • keyCheckValueAlgorithm

        public com.pulumi.core.Output<java.lang.String> keyCheckValueAlgorithm()
        Returns:
        Algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV).

      • keyOrigin

        public com.pulumi.core.Output<java.lang.String> keyOrigin()
        Returns:
        Source of the key material.

      • keyState

        public com.pulumi.core.Output<java.lang.String> keyState()
        Returns:
        State of key that is being created or deleted.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the key. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<KeyTimeouts>> timeouts()

      • get

        public static Key get​(java.lang.String name,
                      com.pulumi.core.Output<java.lang.String> id,
                      @Nullable
                      KeyState 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.