Key

• Implements: IKey

This class encapsulates and extends the ROS resource type ALIYUN::KMS::Key.

Initializers

import ros_cdk_kms
ros_cdk_kms.Key(
  scope: Construct,
  id: str,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  dkms_instance_id: typing.Union[str, IResolvable] = None,
  enable: typing.Union[bool, IResolvable] = None,
  enable_automatic_rotation: typing.Union[bool, IResolvable] = None,
  key_spec: typing.Union[str, IResolvable] = None,
  key_usage: typing.Union[str, IResolvable] = None,
  pending_window_in_days: typing.Union[typing.Union[int, float], IResolvable] = None,
  policy: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  protection_level: typing.Union[str, IResolvable] = None,
  rotation_interval: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

deletion_protection^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionProtection: Specifies whether to enable the release protection feature for the key.

Default is false.

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the CMK.

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

dkms_instance_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dkmsInstanceId: The ID of the KMS instance.

This parameter is required when you create a key for a KMS instance. This parameter is not required when you create a default key (master key).

enable^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enable: Specifies whether the key is enabled.

Defaults to true.

enable_automatic_rotation^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableAutomaticRotation: Whether to enable automatic key rotation.

Valid value: true/false (default)

key_spec^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property keySpec: Key type.

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

key_usage^Optional

• Type: typing.Union[str, 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.

pending_window_in_days^Optional

• Type: typing.Union[typing.Union[int, float], 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.

policy^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property policy: The policy of key.

protection_level^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property protectionLevel: You do not need to specify this parameter.

KMS automatically sets an appropriate protection level for your key. The protection level of the key. Valid values:

• SOFTWARE
• HSM

• If you specify DKMSInstanceId, this parameter is ignored. If the instance is a software key management instance, the protection level is SOFTWARE. If the instance is a hardware key management instance, the protection level is HSM.

• If you do not specify DKMSInstanceId, leave this parameter empty. KMS sets the protection level. If a managed HSM is available in the region, KMS sets this parameter to HSM. Otherwise, KMS sets this parameter to SOFTWARE. For more information, see Managed HSM overview.

rotation_interval^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property rotationInterval: The automatic rotation period.

The format is integer[unit]. integer indicates the length of the period. unit indicates the unit of time. Valid units: d (day), h (hour), m (minute), and s (second). For example, both 7d and 604800s represent a period of 7 days.

• If the key is a default key, the value is 365d.
• If the key is a software-protected key, the value can be from 7d to 365d.
• If the key is a hardware-protected key, automatic rotation is not supported.

This parameter is required if you set EnableAutomaticRotation to true.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to key.

Max support 20 tags to add during create key. Each tag with two properties Key and Value, and Key is required.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_kms
ros_cdk_kms.Key.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_key_id^Required

attr_key_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute KeyId: The globally unique identifier for the CMK.

props^Required

props: KeyProps

• Type: KeyProps