Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

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

Properties

Name Type Description
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: The name of the instance.
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: The instance type.
maxEipTps number | @alicloud/ros-cdk-core.IResolvable Property maxEipTps: The max eip tps.
maxTps number | @alicloud/ros-cdk-core.IResolvable Property maxTps: If instance type is professional, the valid value is [1000, 1500, 2000, 2500, 3000, 4000, 5000].
orderNum number | @alicloud/ros-cdk-core.IResolvable Property orderNum: Set the number of instances to be created.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method of the instance.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The period.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: The unit of the subscription duration.
queueCapacity number | @alicloud/ros-cdk-core.IResolvable Property queueCapacity: The queue capacity.
storageSize number | @alicloud/ros-cdk-core.IResolvable Property storageSize: The storage size.
supportEip string | @alicloud/ros-cdk-core.IResolvable Property supportEip: Specifies whether to enable access over the public network.
supportTracing string | @alicloud/ros-cdk-core.IResolvable Property supportTracing: Specifies whether to enable the message trace feature.
tracingStorageTime number | @alicloud/ros-cdk-core.IResolvable Property tracingStorageTime: The retention period of message traces.

instanceNameOptional

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

Property instanceName: The name of the instance.

The name can be up to 64 characters long.


instanceTypeOptional

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

Property instanceType: The instance type.

This parameter is required for subscription instances. Valid values: - professional: Professional Edition - enterprise: Enterprise Edition - vip: Platinum Edition You do not need to specify this parameter for serverless instances.


maxEipTpsOptional

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

Property maxEipTps: The max eip tps.

It is valid when support_eip is true. The minimum value is 128, with the step size 128.


maxTpsOptional

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

Property maxTps: If instance type is professional, the valid value is [1000, 1500, 2000, 2500, 3000, 4000, 5000].

If instance type is enterprise, the valid value is [3000, 5000, 8000, 10000, 15000, 20000, 3000040000, 50000, 80000, 10000]. If instance type is vip, the valid value is [8000, 15000, 25000, 40000, 50000, 100000, 200000, 300000, 500000, 800000, 1000000].


orderNumOptional

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

Property orderNum: Set the number of instances to be created.


payTypeOptional

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

Property payType: The billing method of the instance.

The Message Queue RabbitMQ version does not support new pay-as-you-go instances. Valid values: PrePaid: subscription


periodOptional

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

Property period: The period.

Valid values: 1, 2, 3, 6, 12, 24, 36.


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.


queueCapacityOptional

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

Property queueCapacity: The queue capacity.

If instance type is professional, the valid value is [50, 1000] with the step size 5. If instance type is enterprise, the valid value is [200, 6000] with the step size 100 If instance type is vip, the valid value is [200, 80000] with the step size 100


storageSizeOptional

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

Property storageSize: The storage size.

It is valid when instance_type is vip. If instance type is professional or enterprise, the valid value is 0.If instance type is vip, the valid value is [700, 2800] with the step size 100


supportEipOptional

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

Property supportEip: Specifies whether to enable access over the public network.

Valid values: - true: Enables access over the public network. - false: Disables access over the public network.


supportTracingOptional

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

Property supportTracing: Specifies whether to enable the message trace feature.

Valid values: - true: Enables the message trace feature. - false: Disables the message trace feature.

  • The message trace feature is included for 15 days at no charge on Platinum Edition instances. For these instances, you must enable this feature and set the retention period to 15 days.
  • For other instance types, you can enable or disable this feature.

tracingStorageTimeOptional

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

Property tracingStorageTime: The retention period of message traces.

Unit: days. Valid values: - 3 - 7 - 15 This parameter is required if you set SupportTracing to true.