Skip to content

Instance

  • Implements: AlibabaCloud.SDK.ROS.CDK.Rocketmq5.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::ROCKETMQ5::Instance, which is used to query the information about an instance.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Rocketmq5;
new Instance(Construct Scope, string Id, InstanceProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props InstanceProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired


EnableResourcePropertyConstraintOptional

  • Type: bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
AddCondition No description.
AddCount No description.
AddDependency No description.
AddResourceDesc No description.
ApplyRemovalPolicy No description.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc No description.
GetAtt No description.
SetMetadata No description.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

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.

SessionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


AddCondition

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

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

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Rocketmq5;
Instance.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Env AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment The environment this resource belongs to.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrAccountInfo object Attribute AccountInfo: The account information.
AttrAclInfo object Attribute AclInfo: The information about access control.
AttrBid object Attribute Bid: The business ID (BID) of the commodity.
AttrCommodityCode object Attribute CommodityCode: The commodity code of the instance.
AttrCreateTime object Attribute CreateTime: The time when the instance was created.
AttrExpireTime object Attribute ExpireTime: The time when the instance expires.
AttrExtConfig object Attribute ExtConfig: The extended configurations.
AttrGroupCount object Attribute GroupCount: The number of groups.
AttrInstanceId object Attribute InstanceId: The ID of the RocketMQ instance.
AttrInstanceName object Attribute InstanceName: The name of the instance.
AttrInstanceQuotas object Attribute InstanceQuotas: The instance quotas.
AttrNetworkInfo object Attribute NetworkInfo: The network information.
AttrPaymentType object Attribute PaymentType: The billing method of the instance.
AttrProductInfo object Attribute ProductInfo: The extended configurations of the instance.
AttrReleaseTime object Attribute ReleaseTime: The time when the instance was released.
AttrRemark object Attribute Remark: The description of the instance.
AttrResourceGroupId object Attribute ResourceGroupId: The ID of the resource group.
AttrSeriesCode object Attribute SeriesCode: The primary edition of the instance.
AttrServiceCode object Attribute ServiceCode: The code of the service to which the instance belongs.
AttrSoftware object Attribute Software: The instance software information.
AttrStartTime object Attribute StartTime: The time when the instance was started.
AttrStatus object Attribute Status: The status of the instance.
AttrSubSeriesCode object Attribute SubSeriesCode: The sub-category edition of the instance.
AttrTags object Attribute Tags: The resource tags.
AttrTopicCount object Attribute TopicCount: The number of topics.
AttrUpdateTime object Attribute UpdateTime: The time when the instance was last modified.
AttrUserId object Attribute UserId: The ID of the user who owns the instance.
Props InstanceProps No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


EnvRequired

public IResourceEnvironment Env { get; }
  • Type: AlibabaCloud.SDK.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.


RefRequired

public string Ref { get; }
  • Type: string

StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.


ResourceOptional

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrAccountInfoRequired

public object AttrAccountInfo { get; }
  • Type: object

Attribute AccountInfo: The account information.


AttrAclInfoRequired

public object AttrAclInfo { get; }
  • Type: object

Attribute AclInfo: The information about access control.


AttrBidRequired

public object AttrBid { get; }
  • Type: object

Attribute Bid: The business ID (BID) of the commodity.


AttrCommodityCodeRequired

public object AttrCommodityCode { get; }
  • Type: object

Attribute CommodityCode: The commodity code of the instance.

The commodity code of a ApsaraMQ for RocketMQ 5.0 instance has a similar format as ons_rmqsub_public_cn.


AttrCreateTimeRequired

public object AttrCreateTime { get; }
  • Type: object

Attribute CreateTime: The time when the instance was created.


AttrExpireTimeRequired

public object AttrExpireTime { get; }
  • Type: object

Attribute ExpireTime: The time when the instance expires.


AttrExtConfigRequired

public object AttrExtConfig { get; }
  • Type: object

Attribute ExtConfig: The extended configurations.

We recommend you configure productInfo, internetInfo, or aclInfo instead of this parameter.


AttrGroupCountRequired

public object AttrGroupCount { get; }
  • Type: object

Attribute GroupCount: The number of groups.


AttrInstanceIdRequired

public object AttrInstanceId { get; }
  • Type: object

Attribute InstanceId: The ID of the RocketMQ instance.


AttrInstanceNameRequired

public object AttrInstanceName { get; }
  • Type: object

Attribute InstanceName: The name of the instance.


AttrInstanceQuotasRequired

public object AttrInstanceQuotas { get; }
  • Type: object

Attribute InstanceQuotas: The instance quotas.


AttrNetworkInfoRequired

public object AttrNetworkInfo { get; }
  • Type: object

Attribute NetworkInfo: The network information.


AttrPaymentTypeRequired

public object AttrPaymentType { get; }
  • Type: object

Attribute PaymentType: The billing method of the instance.


AttrProductInfoRequired

public object AttrProductInfo { get; }
  • Type: object

Attribute ProductInfo: The extended configurations of the instance.


AttrReleaseTimeRequired

public object AttrReleaseTime { get; }
  • Type: object

Attribute ReleaseTime: The time when the instance was released.


AttrRemarkRequired

public object AttrRemark { get; }
  • Type: object

Attribute Remark: The description of the instance.


AttrResourceGroupIdRequired

public object AttrResourceGroupId { get; }
  • Type: object

Attribute ResourceGroupId: The ID of the resource group.


AttrSeriesCodeRequired

public object AttrSeriesCode { get; }
  • Type: object

Attribute SeriesCode: The primary edition of the instance.


AttrServiceCodeRequired

public object AttrServiceCode { get; }
  • Type: object

Attribute ServiceCode: The code of the service to which the instance belongs.

The service code of ApsaraMQ for RocketMQ is rmq.


AttrSoftwareRequired

public object AttrSoftware { get; }
  • Type: object

Attribute Software: The instance software information.


AttrStartTimeRequired

public object AttrStartTime { get; }
  • Type: object

Attribute StartTime: The time when the instance was started.


AttrStatusRequired

public object AttrStatus { get; }
  • Type: object

Attribute Status: The status of the instance.


AttrSubSeriesCodeRequired

public object AttrSubSeriesCode { get; }
  • Type: object

Attribute SubSeriesCode: The sub-category edition of the instance.


AttrTagsRequired

public object AttrTags { get; }
  • Type: object

Attribute Tags: The resource tags.


AttrTopicCountRequired

public object AttrTopicCount { get; }
  • Type: object

Attribute TopicCount: The number of topics.


AttrUpdateTimeRequired

public object AttrUpdateTime { get; }
  • Type: object

Attribute UpdateTime: The time when the instance was last modified.


AttrUserIdRequired

public object AttrUserId { get; }
  • Type: object

Attribute UserId: The ID of the user who owns the instance.


PropsRequired

public InstanceProps Props { get; }