KeyRegistration class

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

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

const example = new aws.quicksight.KeyRegistration("example", {keyRegistrations: [
    {
        keyArn: example1.arn,
    },
    {
        keyArn: example2.arn,
        defaultKey: true,
    },
]});
import pulumi
import pulumi_aws as aws

example = aws.quicksight.KeyRegistration("example", key_registrations=[
    {
        "key_arn": example1["arn"],
    },
    {
        "key_arn": example2["arn"],
        "default_key": True,
    },
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Quicksight.KeyRegistration("example", new()
    {
        KeyRegistrations = new[]
        {
            new Aws.Quicksight.Inputs.KeyRegistrationKeyRegistrationArgs
            {
                KeyArn = example1.Arn,
            },
            new Aws.Quicksight.Inputs.KeyRegistrationKeyRegistrationArgs
            {
                KeyArn = example2.Arn,
                DefaultKey = true,
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewKeyRegistration(ctx, "example", &quicksight.KeyRegistrationArgs{
			KeyRegistrations: quicksight.KeyRegistrationKeyRegistrationArray{
				&quicksight.KeyRegistrationKeyRegistrationArgs{
					KeyArn: pulumi.Any(example1.Arn),
				},
				&quicksight.KeyRegistrationKeyRegistrationArgs{
					KeyArn:     pulumi.Any(example2.Arn),
					DefaultKey: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_keyregistration" "example" {
  key_registrations {
    key_arn = example1.arn
  }
  key_registrations {
    key_arn     = example2.arn
    default_key = true
  }
}
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());

    }
}
resources:
  example:
    type: aws:quicksight:KeyRegistration
    properties:
      keyRegistrations:
        - keyArn: ${example1.arn}
        - keyArn: ${example2.arn}
          defaultKey: true

Import

Using pulumi import, import QuickSight key registration using the AWS account ID. For example:

$ pulumi import aws:quicksight/keyRegistration:KeyRegistration example "012345678901"

Constructors

KeyRegistration(String name, {KeyRegistrationArgs? args, CustomResourceOptions? options})
Creates a new KeyRegistration. name The Pulumi resource name. args Arguments used to configure this KeyRegistration. The set of arguments for KeyRegistration. options Resource options controlling this resource's behavior.
KeyRegistration.reference(String urn)
Creates a typed reference to an existing KeyRegistration resource.

Properties

awsAccountId ↔ Output<String>
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
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
keyRegistrations ↔ Output<List<KeyRegistrationKeyRegistration>>
Registered keys. See key_registration.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

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, {KeyRegistrationState? state, CustomResourceOptions? options}) → KeyRegistration
Gets an existing KeyRegistration resource's state with the given name and id.