Instance

• Implements: com.aliyun.ros.cdk.kafka.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::KAFKA::Instance.

Initializers

import com.aliyun.ros.cdk.kafka.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

instanceId^Required

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

Property instanceId: The ID of the instance.

refreshOptions^Optional

• 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

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• 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)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.kafka.datasource.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrAllConfig^Required

public java.lang.Object getAttrAllConfig();

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

Attribute AllConfig: The current configuration of the deployed message queue Kafka version.

attrAllowedList^Required

public java.lang.Object getAttrAllowedList();

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

Attribute AllowedList: White list.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: Creation time.

attrDeployType^Required

public java.lang.Object getAttrDeployType();

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

Attribute DeployType: Deployment method.

attrDiskSize^Required

public java.lang.Object getAttrDiskSize();

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

Attribute DiskSize: Disk size.

attrDiskType^Required

public java.lang.Object getAttrDiskType();

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

Attribute DiskType: Disk type.

attrDomainEndpoint^Required

public java.lang.Object getAttrDomainEndpoint();

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

Attribute DomainEndpoint: The domain name access point of the default access point.

The Kafka instance supports domain name access points and IP access points.

attrEipMax^Required

public java.lang.Object getAttrEipMax();

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

Attribute EipMax: Peak public network traffic.

attrEndPoint^Required

public java.lang.Object getAttrEndPoint();

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

Attribute EndPoint: Access point.

attrExpiredTime^Required

public java.lang.Object getAttrExpiredTime();

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

Attribute ExpiredTime: Expiration time.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: The ID of the instance.

attrInstanceName^Required

public java.lang.Object getAttrInstanceName();

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

Attribute InstanceName: Note name.

attrIoMax^Required

public java.lang.Object getAttrIoMax();

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

Attribute IoMax: Peak flow.

attrIoMaxSpec^Required

public java.lang.Object getAttrIoMaxSpec();

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

Attribute IoMaxSpec: Flow specifications (recommended).

attrMsgRetain^Required

public java.lang.Object getAttrMsgRetain();

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

Attribute MsgRetain: Message save time.

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

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

Attribute PaymentType: The paymen type of the resource.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

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

Attribute ResourceGroupId: The ID of the resource group.

attrSaslDomainEndpoint^Required

public java.lang.Object getAttrSaslDomainEndpoint();

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

Attribute SaslDomainEndpoint: The domain name access point of the SASL access point.

The Kafka instance supports domain name access points and IP access points.

attrServiceVersion^Required

public java.lang.Object getAttrServiceVersion();

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

Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue.

The value is 0.10.2 or 2.2.0.

attrSpecType^Required

public java.lang.Object getAttrSpecType();

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

Attribute SpecType: Instance type.

attrSslDomainEndpoint^Required

public java.lang.Object getAttrSslDomainEndpoint();

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

Attribute SslDomainEndpoint: The domain name of the SSL access point.

The Kafka instance supports domain name access points and IP access points.

attrSslEndPoint^Required

public java.lang.Object getAttrSslEndPoint();

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

Attribute SslEndPoint: External access point.

attrTags^Required

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.

attrTopicNumLimit^Required

public java.lang.Object getAttrTopicNumLimit();

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

Attribute TopicNumLimit: Maximum number of topic creation.

attrVpcId^Required

public java.lang.Object getAttrVpcId();

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

Attribute VpcId: VpcId.

attrVSwitchId^Required

public java.lang.Object getAttrVSwitchId();

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

Attribute VSwitchId: Switch id.

attrZoneId^Required

public java.lang.Object getAttrZoneId();

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

Attribute ZoneId: The ID of the zone in which the instance is deployed.

props^Required

public InstanceProps getProps();

• Type: InstanceProps