Package com.pulumi.aws.kms

Class Alias

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.kms.Alias

public class Alias
extends com.pulumi.resources.CustomResource

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](http://docs.aws.amazon.com/kms/latest/developerguide/limits.html) allow you. ## Example Usage

 
 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());
 
     }
 }
 
 

## 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: ```sh $ pulumi import aws:kms/alias:Alias a alias/my-key-alias ```

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
Alias(java.lang.String name)
Alias(java.lang.String name, AliasArgs args)
Alias(java.lang.String name, AliasArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	arn()
static Alias	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AliasState 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>	name()
com.pulumi.core.Output<java.lang.String>	namePrefix()
com.pulumi.core.Output<java.lang.String>	region()
com.pulumi.core.Output<java.lang.String>	targetKeyArn()
com.pulumi.core.Output<java.lang.String>	targetKeyId()

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

Alias

public Alias(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

Alias

public Alias(java.lang.String name,
             AliasArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

Alias

public Alias(java.lang.String name,
             AliasArgs 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 alias.

name

public com.pulumi.core.Output<java.lang.String> name()

Returns:

Display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/).

namePrefix

public com.pulumi.core.Output<java.lang.String> namePrefix()

Returns:

Creates a unique alias beginning with the specified prefix. The name must start with the word "alias" followed by a forward slash (alias/). Conflicts with `name`.

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.

targetKeyArn

public com.pulumi.core.Output<java.lang.String> targetKeyArn()

Returns:

ARN of the target key identifier.

targetKeyId

public com.pulumi.core.Output<java.lang.String> targetKeyId()

Returns:

Identifier for the key for which the alias is for, can be either an ARN or key_id.

get

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