Topic
This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ::Topic, which is used to create a topic.
Initializers
import com.aliyun.ros.cdk.rocketmq.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.instanceId(java.lang.String)
.instanceId(IResolvable)
.messageType(java.lang.Number)
.messageType(IResolvable)
.topic(java.lang.String)
.topic(IResolvable)
// .remark(java.lang.String)
// .remark(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope |
com.aliyun.ros.cdk.core.Construct |
No description. |
id |
java.lang.String |
No description. |
enableResourcePropertyConstraint |
java.lang.Boolean |
No description. |
instanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property instanceId: The ID of the instance. |
messageType |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property messageType: The type of the message. |
topic |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property topic: The name of the topic you want to create. |
remark |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property remark: The remarks on the request. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
instanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the instance.
messageTypeRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property messageType: The type of the message.
Valid values: 0: normal message 1: partitionally ordered message 2: globally ordered message 4: transactional message 5: scheduled/delayed message
topicRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property topic: The name of the topic you want to create.
Note: "CID" and "GID" are the reserved fields of a group ID, and they cannot be the start of a topic name. If namespaces are available in the instance for which the topic is created, the topic name must be unique in the instance and can be duplicated across instances. If no namespaces are available in the instance, the topic name must be unique both in the instance and across instances.
remarkOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remark: The remarks on the request.
This parameter can be left blank.
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. |
getAtt |
No description. |
setMetadata |
No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.rocketmq.Topic;
Topic.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node |
com.aliyun.ros.cdk.core.ConstructNode |
The construct tree node associated with this construct. |
ref |
java.lang.String |
No description. |
stack |
com.aliyun.ros.cdk.core.Stack |
The stack in which this resource is defined. |
resource |
com.aliyun.ros.cdk.core.RosResource |
No description. |
attrInstanceId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute InstanceId: The ID of the instance. |
attrMessageType |
com.aliyun.ros.cdk.core.IResolvable |
Attribute MessageType: The type of the message. |
attrTopic |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Topic: The name of the topic. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrInstanceIdRequired
public IResolvable getAttrInstanceId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the instance.
attrMessageTypeRequired
public IResolvable getAttrMessageType();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute MessageType: The type of the message.
attrTopicRequired
public IResolvable getAttrTopic();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Topic: The name of the topic.