Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

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

Properties

Name Type Description
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: The name of the instance, which contains 3 to 64 characters in Chinese or English.
deletionForce boolean | @alicloud/ros-cdk-core.IResolvable Property deletionForce: Whether delete all topics and groups of the instance and then delete instance.
remark string | @alicloud/ros-cdk-core.IResolvable Property remark: The remark of instance.
tags TagsProperty[] Property tags: Tags to attach to instance.

instanceNameRequired

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

Property instanceName: The name of the instance, which contains 3 to 64 characters in Chinese or English.


deletionForceOptional

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

Property deletionForce: Whether delete all topics and groups of the instance and then delete instance.

Default is false


remarkOptional

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

Property remark: The remark of instance.


tagsOptional

public readonly tags: TagsProperty[];

Property tags: Tags to attach to instance.

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