Topic
- Implements: com.aliyun.ros.cdk.kafka.datasource.ITopic
This class encapsulates and extends the ROS resource type DATASOURCE::KAFKA::Topic.
Initializers
import com.aliyun.ros.cdk.kafka.datasource.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.instanceId(java.lang.String)
.instanceId(IResolvable)
.topic(java.lang.String)
.topic(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(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: Resource id. |
topic | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property topic: Topic Name. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
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: Resource id.
topicRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property topic: Topic Name.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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.kafka.datasource.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. |
attrCompactTopic | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CompactTopic: Can log merge. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: Creation time. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: Resource id. |
attrLocalTopic | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LocalTopic: Whether to store locally. |
attrPartitionNum | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PartitionNum: Number of partitions. |
attrRemark | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Remark: Remarks. |
attrStatusName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute StatusName: Meaning of status value. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption. |
attrTopic | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Topic: Topic Name. |
attrTopicStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TopicStatus: The Topic status. |
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
attrCompactTopicRequired
public java.lang.Object getAttrCompactTopic();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CompactTopic: Can log merge.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: Creation time.
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: Resource id.
attrLocalTopicRequired
public java.lang.Object getAttrLocalTopic();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LocalTopic: Whether to store locally.
attrPartitionNumRequired
public java.lang.Object getAttrPartitionNum();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PartitionNum: Number of partitions.
attrRemarkRequired
public java.lang.Object getAttrRemark();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Remark: Remarks.
attrStatusNameRequired
public java.lang.Object getAttrStatusName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute StatusName: Meaning of status value.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.
attrTopicRequired
public java.lang.Object getAttrTopic();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Topic: Topic Name.
attrTopicStatusRequired
public java.lang.Object getAttrTopicStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TopicStatus: The Topic status.
propsRequired
public TopicProps getProps();
- Type: TopicProps