software.amazon.awscdk.services.kms

Class CfnKey

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kms.CfnKey

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.601Z")
 @Stability(value=Stable)
public class CfnKey
extends CfnResource
implements IInspectable

A CloudFormation `AWS::KMS::Key`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnKey.Builder A fluent builder for CfnKey.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnKey(software.constructs.Construct scope, String id, CfnKeyProps props) Create a new `AWS::KMS::Key`.
protected	CfnKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKey(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrKeyId()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::KMS::Key.Description`.
Object	getEnabled() `AWS::KMS::Key.Enabled`.
Object	getEnableKeyRotation() `AWS::KMS::Key.EnableKeyRotation`.
Object	getKeyPolicy() `AWS::KMS::Key.KeyPolicy`.
String	getKeySpec() `AWS::KMS::Key.KeySpec`.
String	getKeyUsage() `AWS::KMS::Key.KeyUsage`.
Number	getPendingWindowInDays() `AWS::KMS::Key.PendingWindowInDays`.
TagManager	getTags() `AWS::KMS::Key.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::KMS::Key.Description`.
void	setEnabled(Boolean value) `AWS::KMS::Key.Enabled`.
void	setEnabled(IResolvable value) `AWS::KMS::Key.Enabled`.
void	setEnableKeyRotation(Boolean value) `AWS::KMS::Key.EnableKeyRotation`.
void	setEnableKeyRotation(IResolvable value) `AWS::KMS::Key.EnableKeyRotation`.
void	setKeyPolicy(Object value) `AWS::KMS::Key.KeyPolicy`.
void	setKeySpec(String value) `AWS::KMS::Key.KeySpec`.
void	setKeyUsage(String value) `AWS::KMS::Key.KeyUsage`.
void	setPendingWindowInDays(Number value) `AWS::KMS::Key.PendingWindowInDays`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnKey

protected CfnKey(software.amazon.jsii.JsiiObjectRef objRef)

CfnKey

protected CfnKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnKey

@Stability(value=Stable)
public CfnKey(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @NotNull
                                       CfnKeyProps props)

Create a new `AWS::KMS::Key`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrKeyId

@Stability(value=Stable)
 @NotNull
public String getAttrKeyId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::KMS::Key.Tags`.

getKeyPolicy

@Stability(value=Stable)
 @NotNull
public Object getKeyPolicy()

`AWS::KMS::Key.KeyPolicy`.

setKeyPolicy

@Stability(value=Stable)
public void setKeyPolicy(@NotNull
                                                  Object value)

`AWS::KMS::Key.KeyPolicy`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::KMS::Key.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::KMS::Key.Description`.

getEnabled

@Stability(value=Stable)
 @Nullable
public Object getEnabled()

`AWS::KMS::Key.Enabled`.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

`AWS::KMS::Key.Enabled`.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

`AWS::KMS::Key.Enabled`.

getEnableKeyRotation

@Stability(value=Stable)
 @Nullable
public Object getEnableKeyRotation()

`AWS::KMS::Key.EnableKeyRotation`.

setEnableKeyRotation

@Stability(value=Stable)
public void setEnableKeyRotation(@Nullable
                                                          Boolean value)

`AWS::KMS::Key.EnableKeyRotation`.

setEnableKeyRotation

@Stability(value=Stable)
public void setEnableKeyRotation(@Nullable
                                                          IResolvable value)

`AWS::KMS::Key.EnableKeyRotation`.

getKeySpec

@Stability(value=Stable)
 @Nullable
public String getKeySpec()

`AWS::KMS::Key.KeySpec`.

setKeySpec

@Stability(value=Stable)
public void setKeySpec(@Nullable
                                                String value)

`AWS::KMS::Key.KeySpec`.

getKeyUsage

@Stability(value=Stable)
 @Nullable
public String getKeyUsage()

`AWS::KMS::Key.KeyUsage`.

setKeyUsage

@Stability(value=Stable)
public void setKeyUsage(@Nullable
                                                 String value)

`AWS::KMS::Key.KeyUsage`.

getPendingWindowInDays

@Stability(value=Stable)
 @Nullable
public Number getPendingWindowInDays()

`AWS::KMS::Key.PendingWindowInDays`.

setPendingWindowInDays

@Stability(value=Stable)
public void setPendingWindowInDays(@Nullable
                                                            Number value)

`AWS::KMS::Key.PendingWindowInDays`.