Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

import { InstanceProps } from '@alicloud/ros-cdk-kms'
const instanceProps: InstanceProps = { ... }

Properties

Name Type Description
productVersion string | @alicloud/ros-cdk-core.IResolvable Property productVersion: KMS Instance commodity type (software\/software-small\/hardware\/hardware-small).
connection @alicloud/ros-cdk-core.IResolvable | ConnectionProperty Property connection:.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: Billing method of the KMS instance, default to Subscription.
keyNum number | @alicloud/ros-cdk-core.IResolvable Property keyNum: Maximum number of stored keys.
log boolean | @alicloud/ros-cdk-core.IResolvable Property log: Whether to enable log.
logStorage number | @alicloud/ros-cdk-core.IResolvable Property logStorage: Log storage.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The subscription duration of the KMS instance.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: The unit of the subscription duration.
renewPeriod number | @alicloud/ros-cdk-core.IResolvable Property renewPeriod: Automatic renewal period, in months.
renewStatus string | @alicloud/ros-cdk-core.IResolvable Property renewStatus: Renewal options (manual renewal, automatic renewal, no renewal).
secretNum number | @alicloud/ros-cdk-core.IResolvable Property secretNum: Maximum number of secrets.
spec number | @alicloud/ros-cdk-core.IResolvable Property spec: The computation performance level of the KMS instance.
vpcNum number | @alicloud/ros-cdk-core.IResolvable Property vpcNum: The number of managed accesses.

productVersionRequired 

public readonly productVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

connectionOptional 

public readonly connection: IResolvable | ConnectionProperty;

Property connection:.

instanceChargeTypeOptional 

public readonly instanceChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

keyNumOptional 

public readonly keyNum: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property keyNum: Maximum number of stored keys.

It is required when the InstanceCharge is Subscription.

logOptional 

public readonly log: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property log: Whether to enable log.

logStorageOptional 

public readonly logStorage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property logStorage: Log storage.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/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

periodUnitOptional 

public readonly periodUnit: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

renewPeriodOptional 

public readonly renewPeriod: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property renewPeriod: Automatic renewal period, in months.

renewStatusOptional 

public readonly renewStatus: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

secretNumOptional 

public readonly secretNum: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property secretNum: Maximum number of secrets.

It is required when the InstanceCharge is Subscription.

specOptional 

public readonly spec: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

vpcNumOptional 

public readonly vpcNum: number | IResolvable;
  • Type: number | @alicloud/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.