Instance

This class encapsulates and extends the ROS resource type ALIYUN::KMS::Instance, which is used to create a Key Management Service (KMS) instance.

Initializers

import ros_cdk_kms
ros_cdk_kms.Instance(
  scope: Construct,
  id: str,
  product_version: typing.Union[str, IResolvable],
  connection: typing.Union[IResolvable, ConnectionProperty] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  key_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  log: typing.Union[bool, IResolvable] = None,
  log_storage: typing.Union[typing.Union[int, float], IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  renew_status: typing.Union[str, IResolvable] = None,
  secret_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  spec: typing.Union[typing.Union[int, float], IResolvable] = None,
  vpc_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
product_version	typing.Union[str, ros_cdk_core.IResolvable]	Property productVersion: KMS Instance commodity type (software\/software-small\/hardware\/hardware-small).
connection	typing.Union[ros_cdk_core.IResolvable, ConnectionProperty]	Property connection:.
instance_charge_type	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceChargeType: Billing method of the KMS instance, default to Subscription.
key_num	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property keyNum: Maximum number of stored keys.
log	typing.Union[bool, ros_cdk_core.IResolvable]	Property log: Whether to enable log.
log_storage	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property logStorage: Log storage.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property period: The subscription duration of the KMS instance.
period_unit	typing.Union[str, ros_cdk_core.IResolvable]	Property periodUnit: The unit of the subscription duration.
renew_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property renewPeriod: Automatic renewal period, in months.
renew_status	typing.Union[str, ros_cdk_core.IResolvable]	Property renewStatus: Renewal options (manual renewal, automatic renewal, no renewal).
secret_num	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property secretNum: Maximum number of secrets.
spec	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property spec: The computation performance level of the KMS instance.
vpc_num	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property vpcNum: The number of managed accesses.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

product_version^Required

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

Property productVersion: KMS Instance commodity type (software\/software-small\/hardware\/hardware-small).

---

connection^Optional

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

Property connection:.

---

instance_charge_type^Optional

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

Property instanceChargeType: Billing method of the KMS instance, default to Subscription.

---

key_num^Optional

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

Property keyNum: Maximum number of stored keys.

It is required when the InstanceCharge is Subscription.

---

log^Optional

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

Property log: Whether to enable log.

---

log_storage^Optional

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

Property logStorage: Log storage.

---

period^Optional

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

Property period: The subscription duration of the KMS instance.

If PeriodUnit is Month, the valid range is 1, 2, 3, 6, 12, 24, 36 If PeriodUnit is Year, the valid range is 1, 2, 3

---

period_unit^Optional

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

---

renew_period^Optional

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

Property renewPeriod: Automatic renewal period, in months.

---

renew_status^Optional

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

Property renewStatus: Renewal options (manual renewal, automatic renewal, no renewal).

---

secret_num^Optional

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

Property secretNum: Maximum number of secrets.

It is required when the InstanceCharge is Subscription.

---

spec^Optional

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

Property spec: The computation performance level of the KMS instance.

---

vpc_num^Optional

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

Property vpcNum: The number of managed accesses.

The maximum number of VPCs that can access this KMS instance. It is required when the InstanceCharge is Subscription.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_instance_id	ros_cdk_core.IResolvable	Attribute InstanceId: The ID of the instance.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_instance_id^Required

attr_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the instance.

---