Skip to content

Topic

This class encapsulates and extends the ROS resource type ALIYUN::MNS::Topic, which is used to create a topic.

Initializers 

import com.aliyun.ros.cdk.mns.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .topicName(java.lang.String)
    .topicName(IResolvable)
//  .loggingEnabled(java.lang.Boolean)
//  .loggingEnabled(IResolvable)
//  .maximumMessageSize(java.lang.Number)
//  .maximumMessageSize(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.
topicName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property topicName: Topic name.
loggingEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property loggingEnabled: Whether to enable log management.
maximumMessageSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maximumMessageSize: Maximum body length of a message sent to the topic, in the unit of bytes.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

topicNameRequired

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

Property topicName: Topic name.

loggingEnabledOptional

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

Property loggingEnabled: Whether to enable log management.

"true" indicates that log management is enabled, whereas "false" indicates that log management is disabled. The default value is false

maximumMessageSizeOptional

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

Property maximumMessageSize: Maximum body length of a message sent to the topic, in the unit of bytes.

An integer in the range of 1,024 (1 KB) to 65, 536 (64 KB); default value: 65,536 (64 KB).

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.

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

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.mns.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.
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.
attrArnWithSlash com.aliyun.ros.cdk.core.IResolvable Attribute ARN.WithSlash: The ARN: acs:mns:$region:$accountid:/topics/$topicName.
attrTopicName com.aliyun.ros.cdk.core.IResolvable Attribute TopicName: Topic name.
attrTopicUrl com.aliyun.ros.cdk.core.IResolvable Attribute TopicUrl: URL of created 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

attrArnWithSlashRequired 

public IResolvable getAttrArnWithSlash();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ARN.WithSlash: The ARN: acs:mns:$region:$accountid:/topics/$topicName.

attrTopicNameRequired 

public IResolvable getAttrTopicName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TopicName: Topic name.

attrTopicUrlRequired 

public IResolvable getAttrTopicUrl();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TopicUrl: URL of created topic.