Alias class
Provides an alias for a KMS customer master key. AWS Console enforces 1-to-1 mapping between aliases & keys, but API (hence this provider too) allows you to create as many aliases as the account limits allow you.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const a = new aws.kms.Key("a", {});
const aAlias = new aws.kms.Alias("a", {
name: "alias/my-key-alias",
targetKeyId: a.keyId,
});
import pulumi
import pulumi_aws as aws
a = aws.kms.Key("a")
a_alias = aws.kms.Alias("a",
name="alias/my-key-alias",
target_key_id=a.key_id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var a = new Aws.Kms.Key("a");
var aAlias = new Aws.Kms.Alias("a", new()
{
Name = "alias/my-key-alias",
TargetKeyId = a.KeyId,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kms"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
a, err := kms.NewKey(ctx, "a", nil)
if err != nil {
return err
}
_, err = kms.NewAlias(ctx, "a", &kms.AliasArgs{
Name: pulumi.String("alias/my-key-alias"),
TargetKeyId: a.KeyId,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kms_key" "a" {
}
resource "aws_kms_alias" "a" {
name = "alias/my-key-alias"
target_key_id = aws_kms_key.a.key_id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.Alias;
import com.pulumi.aws.kms.AliasArgs;
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 a = new Key("a");
var aAlias = new Alias("aAlias", AliasArgs.builder()
.name("alias/my-key-alias")
.targetKeyId(a.keyId())
.build());
}
}
resources:
a:
type: aws:kms:Key
aAlias:
type: aws:kms:Alias
name: a
properties:
name: alias/my-key-alias
targetKeyId: ${a.keyId}
Import
Identity Schema
Required
name- (String) Name of the KMS key alias.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import KMS aliases using the name. For example:
$ pulumi import aws:kms/alias:Alias a alias/my-key-alias
Constructors
- Alias(String name, {AliasArgs? args, CustomResourceOptions? options})
-
Creates a new Alias.
nameThe Pulumi resource name.argsArguments used to configure this Alias. The set of arguments for Alias.optionsResource options controlling this resource's behavior. - Alias.reference(String urn)
- Creates a typed reference to an existing Alias resource.
Properties
-
arn
↔ Output<
String> -
ARN of the key alias.
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
-
name
↔ Output<
String> -
The display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/)
latefinal
-
namePrefix
↔ Output<
String> -
Creates an unique alias beginning with the specified prefix.
The name must start with the word "alias" followed by a forward slash (alias/). Conflicts with
name.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
-
targetKeyArn
↔ Output<
String> -
ARN of the target key identifier.
latefinal
-
targetKeyId
↔ Output<
String> -
Identifier for the key for which the alias is for, can be either an ARN or key_id.
latefinal
-
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