Skip to content

KeyProps

Properties for defining a Key.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kms-key

Initializer 

import com.aliyun.ros.cdk.kms.KeyProps;
KeyProps.builder()
//  .description(java.lang.String)
//  .description(IResolvable)
//  .dkmsInstanceId(java.lang.String)
//  .dkmsInstanceId(IResolvable)
//  .enable(java.lang.Boolean)
//  .enable(IResolvable)
//  .enableAutomaticRotation(java.lang.Boolean)
//  .enableAutomaticRotation(IResolvable)
//  .keySpec(java.lang.String)
//  .keySpec(IResolvable)
//  .keyUsage(java.lang.String)
//  .keyUsage(IResolvable)
//  .pendingWindowInDays(java.lang.Number)
//  .pendingWindowInDays(IResolvable)
//  .policy(IResolvable)
//  .policy(java.util.Map<java.lang.String, java.lang.Object>)
//  .protectionLevel(java.lang.String)
//  .protectionLevel(IResolvable)
//  .rotationInterval(java.lang.String)
//  .rotationInterval(IResolvable)
    .build();

Properties

Name Type Description
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the CMK.
dkmsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dkmsInstanceId: The ID of the dedicated KMS instance.
enable java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enable: Specifies whether the key is enabled.
enableAutomaticRotation java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableAutomaticRotation: Whether to enable automatic key rotation.
keySpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keySpec: Key type.
keyUsage java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keyUsage: The usage of the CMK.
pendingWindowInDays java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property pendingWindowInDays: The waiting period, specified in number of days.
policy com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property policy: The policy of key.
protectionLevel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property protectionLevel: The protection level of the CMK to create.
rotationInterval java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property rotationInterval: The time period for automatic rotation.

descriptionOptional 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the CMK.

Length constraints: Minimum length of 0 characters. Maximum length of 8192 characters.

dkmsInstanceIdOptional 

public java.lang.Object getDkmsInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dkmsInstanceId: The ID of the dedicated KMS instance.

enableOptional 

public java.lang.Object getEnable();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enable: Specifies whether the key is enabled.

Defaults to true.

enableAutomaticRotationOptional 

public java.lang.Object getEnableAutomaticRotation();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableAutomaticRotation: Whether to enable automatic key rotation.

Valid value: true/false (default)

keySpecOptional 

public java.lang.Object getKeySpec();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property keySpec: Key type.

Valid value: Aliyun_AES_256/Aliyun_SM4/RSA_2048/EC_P256/EC_P256K/EC_SM2

keyUsageOptional 

public java.lang.Object getKeyUsage();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property keyUsage: The usage of the CMK.

Valid values: ENCRYPT/DECRYPT: encrypts or decrypts data. SIGN/VERIFY: generates or verifies a digital signature. If the CMK supports signature verification, the default value is SIGN/VERIFY. If the CMK does not support signature verification, the default value is ENCRYPT/DECRYPT.

pendingWindowInDaysOptional 

public java.lang.Object getPendingWindowInDays();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property pendingWindowInDays: The waiting period, specified in number of days.

During this period, you can cancel the CMK in PendingDeletion status. After the waiting period expires, you cannot cancel the deletion. The value must be between 7 and 366. Default value is 30.

policyOptional 

public java.lang.Object getPolicy();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property policy: The policy of key.

protectionLevelOptional 

public java.lang.Object getProtectionLevel();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property protectionLevel: The protection level of the CMK to create.

Valid value: SOFTWARE and HSM. When this parameter is set to HSM: If the Origin parameter is set to Aliyun_KMS, the CMK is created in Managed HSM. If the Origin parameter is set to EXTERNAL, you can import external keys to Managed HSM.

rotationIntervalOptional 

public java.lang.Object getRotationInterval();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property rotationInterval: The time period for automatic rotation.

The format is integer[unit], where integer represents the length of time and unit represents the time unit. The legal unit units are: d (day), h (hour), m (minute), s (second). 7d or 604800s both represent a 7-day cycle. Value: 7~730 days.