Skip to content

Topic

This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ5::Topic, which is used to create a topic for a Message Queue for Apache RocketMQ V5.0 instance.

Initializers

import com.aliyun.ros.cdk.rocketmq5.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .messageType(java.lang.String)
    .messageType(IResolvable)
    .topicName(java.lang.String)
    .topicName(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.String OR com.aliyun.ros.cdk.core.IResolvable Property messageType: The message type of the topic to be created.
topicName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property topicName: The name of the topic to be created is used to identify the topic and is globally unique.
remark java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property remark: The remark of the topic to be created.

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.String OR com.aliyun.ros.cdk.core.IResolvable

Property messageType: The message type of the topic to be created.

Valid values: NORMAL FIFO DELAY TRANSACTION


topicNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property topicName: The name of the topic to be created is used to identify the topic and is globally unique.

Valid values: Character limitation: supports letters a~z or A-Z, numbers 0-9, underscore (_), dash (-) and percent sign (%). Length limit: 1-60 characters.


remarkOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property remark: The remark of the topic to be created.


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

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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.rocketmq5.Topic;
Topic.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the instance.
attrMessageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MessageType: The type of the message.
attrTopicName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TopicName: The name of the topic.
props TopicProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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 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 java.lang.Object getAttrInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the instance.


attrMessageTypeRequired

public java.lang.Object getAttrMessageType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MessageType: The type of the message.


attrTopicNameRequired

public java.lang.Object getAttrTopicName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TopicName: The name of the topic.


propsRequired

public TopicProps getProps();