Package software.amazon.awscdk.services.kms

Class AliasProps.Builder

java.lang.Object

software.amazon.awscdk.services.kms.AliasProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AliasProps>

Enclosing interface:

AliasProps

@Stability(Stable)
public static final class AliasProps.Builder
extends Object
implements software.amazon.jsii.Builder<AliasProps>

A builder for AliasProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AliasProps.Builder	aliasName(String aliasName)	Sets the value of AliasProps.getAliasName()
AliasProps	build()	Builds the configured instance.
AliasProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of AliasProps.getRemovalPolicy()
AliasProps.Builder	targetKey(IKey targetKey)	Sets the value of AliasProps.getTargetKey()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

aliasName

@Stability(Stable)
public AliasProps.Builder aliasName(String aliasName)

Sets the value of AliasProps.getAliasName()

Parameters:

aliasName - The name of the alias. This parameter is required. The name must start with alias followed by a forward slash, such as alias/. You can't specify aliases that begin with alias/AWS. These aliases are reserved.

Returns:

this

targetKey

@Stability(Stable)
public AliasProps.Builder targetKey(IKey targetKey)

Sets the value of AliasProps.getTargetKey()

Parameters:

targetKey - The ID of the key for which you are creating the alias. This parameter is required. Specify the key's globally unique identifier or Amazon Resource Name (ARN). You can't specify another alias.

Returns:

this

removalPolicy

@Stability(Stable)
public AliasProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of AliasProps.getRemovalPolicy()

Parameters:

removalPolicy - Policy to apply when the alias is removed from this stack.

Returns:

this

build

@Stability(Stable)
public AliasProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AliasProps>

Returns:

a new instance of AliasProps

Throws:

NullPointerException - if any required attribute was not provided