Skip to content

Topic

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

Initializers 

import com.aliyun.ros.cdk.kafka.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .remark(java.lang.String)
    .remark(IResolvable)
    .topic(java.lang.String)
    .topic(IResolvable)
//  .compactTopic(java.lang.Boolean)
//  .compactTopic(IResolvable)
//  .config(IResolvable)
//  .config(java.util.Map<java.lang.String, java.lang.Object>)
//  .localTopic(java.lang.Boolean)
//  .localTopic(IResolvable)
//  .minInsyncReplicas(java.lang.Number)
//  .minInsyncReplicas(IResolvable)
//  .partitionNum(java.lang.Number)
//  .partitionNum(IResolvable)
//  .replicationFactor(java.lang.Number)
//  .replicationFactor(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.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.
remark java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property remark: The description of the topic.
topic java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property topic: The name of the topic.
compactTopic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property compactTopic: The log cleanup policy for the topic.
config com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property config: Supplementary configuration.
localTopic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property localTopic: The storage engine of the topic.
minInsyncReplicas java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property minInsyncReplicas: The minimum number of ISR sync replicas.
partitionNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property partitionNum: The number of partitions in the topic.
replicationFactor java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property replicationFactor: The number of copies of the topic.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.

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 Message Queue for Apache Kafka instance where the topic is located.

You can call the GetInstanceList operation to query instances.

remarkRequired

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

Property remark: The description of the topic.

The value of this parameter must meet the following requirements: The value can only contain letters, digits, hyphens (-), and underscores (_). The value must be 3 to 64 characters in length.

topicRequired

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

Property topic: The name of the topic.

The value of this parameter must meet the following requirements: The name can only contain letters, digits, hyphens (-), and underscores (_). The name must be 3 to 64 characters in length, and will be automatically truncated if it contains more characters. The name cannot be modified after being created.

compactTopicOptional

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

Property compactTopic: The log cleanup policy for the topic.

This parameter is available when the Local Storage mode is specified for the topic. Valid values: false: uses the default log cleanup policy. true: uses the Apache Kafka log compaction policy.

configOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property config: Supplementary configuration.

Currently supports Key as replications. Indicates the number of Topic copies, the value type is Integer, and the value limit is 1~3. This parameter can only be specified if the LocalTopic value is true. NOTE If replications is specified in this parameter, the specified ReplicationFactor parameter no longer takes effect.

localTopicOptional

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

Property localTopic: The storage engine of the topic.

Valid values: false: the Cloud Storage mode. true: the Local Storage mode.

minInsyncReplicasOptional

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

Property minInsyncReplicas: The minimum number of ISR sync replicas.

This parameter can only be specified if the LocalTopic value is true. The value must be less than the number of Topic copies. The number of synchronous replicas is limited to 1~3.

partitionNumOptional

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

Property partitionNum: The number of partitions in the topic.

Valid values: 1 to 48 We recommend that you set the number of partitions to a multiple of 6 to reduce the risk of data skew.Note:For special requirements,submit a ticket.

replicationFactorOptional

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

Property replicationFactor: The number of copies of the topic.

This parameter can only be specified if the LocalTopic value is true. The number of copies is limited to 1~3. Note When the number of replicas is 1, there is a risk of data loss. Please set it carefully.

tagsOptional

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. 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.
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.kafka.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.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.
attrTopic com.aliyun.ros.cdk.core.IResolvable Attribute Topic: Topic name.

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 Message Queue for Apache Kafka instance where the topic is located.

You can call the GetInstanceList operation to query instances.

attrTopicRequired 

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

Attribute Topic: Topic name.