Topic
- Implements: ITopic
This class encapsulates and extends the ROS resource type ALIYUN::MNS::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)
// .tags(java.util.List<TagsProperty>)
.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. |
tags | java.util.List<TagsProperty> | Property tags: Tags to attach to Topic. |
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).
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags to attach to Topic.
Max support 20 tags to add during create Topic. Each tag with two properties Key and Value, and Key is required.
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.
- 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
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)
- 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.mns.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. |
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. |
attrArnWithSlash | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ARN.WithSlash: The ARN: acs:mns:$region:$accountid:/topics/$topicName. |
attrTopicName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TopicName: Topic name. |
attrTopicUrl | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TopicUrl: URL of created 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
attrArnWithSlashRequired
public java.lang.Object getAttrArnWithSlash();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ARN.WithSlash: The ARN: acs:mns:$region:$accountid:/topics/$topicName.
attrTopicNameRequired
public java.lang.Object getAttrTopicName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TopicName: Topic name.
attrTopicUrlRequired
public java.lang.Object getAttrTopicUrl();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TopicUrl: URL of created topic.
propsRequired
public TopicProps getProps();
- Type: TopicProps