Package com.pulumi.aws.quicksight

Class KeyRegistration

  • public class KeyRegistration
extends com.pulumi.resources.CustomResource
    Registers customer managed keys in a Amazon QuickSight account. > Deletion of this resource clears all CMK registrations from a QuickSight account. QuickSight then uses AWS owned keys to encrypt your resources. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.KeyRegistration;
 import com.pulumi.aws.quicksight.KeyRegistrationArgs;
 import com.pulumi.aws.quicksight.inputs.KeyRegistrationKeyRegistrationArgs;
 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 KeyRegistration("example", KeyRegistrationArgs.builder()
             .keyRegistrations(            
                 KeyRegistrationKeyRegistrationArgs.builder()
                     .keyArn(example1.arn())
                     .build(),
                 KeyRegistrationKeyRegistrationArgs.builder()
                     .keyArn(example2.arn())
                     .defaultKey(true)
                     .build())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import QuickSight key registration using the AWS account ID. For example: ```sh $ pulumi import aws:quicksight/keyRegistration:KeyRegistration example "012345678901" ```

    • 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
      com.pulumi.core.Output<java.lang.String> awsAccountId()  
      static KeyRegistration get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, KeyRegistrationState 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.List<KeyRegistrationKeyRegistration>> keyRegistrations()  
      com.pulumi.core.Output<java.lang.String> region()  

      • 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

      • KeyRegistration

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

      • KeyRegistration

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

      • KeyRegistration

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

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.

      • keyRegistrations

        public com.pulumi.core.Output<java.util.List<KeyRegistrationKeyRegistration>> keyRegistrations()
        Returns:
        Registered keys. See `keyRegistration` Block.

      • 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.

      • get

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