Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::KAFKA::Instance, which is used to query the information about an ApsaraMQ for 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();
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 instance.
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: The ID of the instance.

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.
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.datasource.Instance;
Instance.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.
attrAllConfig com.aliyun.ros.cdk.core.IResolvable Attribute AllConfig: The current configuration of the deployed message queue Kafka version.
attrAllowedList com.aliyun.ros.cdk.core.IResolvable Attribute AllowedList: White list.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: Creation time.
attrDeployType com.aliyun.ros.cdk.core.IResolvable Attribute DeployType: Deployment method.
attrDiskSize com.aliyun.ros.cdk.core.IResolvable Attribute DiskSize: Disk size.
attrDiskType com.aliyun.ros.cdk.core.IResolvable Attribute DiskType: Disk type.
attrDomainEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute DomainEndpoint: The domain name access point of the default access point.
attrEipMax com.aliyun.ros.cdk.core.IResolvable Attribute EipMax: Peak public network traffic.
attrEndPoint com.aliyun.ros.cdk.core.IResolvable Attribute EndPoint: Access point.
attrExpiredTime com.aliyun.ros.cdk.core.IResolvable Attribute ExpiredTime: Expiration time.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the instance.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: Note name.
attrIoMax com.aliyun.ros.cdk.core.IResolvable Attribute IoMax: Peak flow.
attrIoMaxSpec com.aliyun.ros.cdk.core.IResolvable Attribute IoMaxSpec: Flow specifications (recommended).
attrMsgRetain com.aliyun.ros.cdk.core.IResolvable Attribute MsgRetain: Message save time.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: The paymen type of the resource.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSaslDomainEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute SaslDomainEndpoint: The domain name access point of the SASL access point.
attrServiceVersion com.aliyun.ros.cdk.core.IResolvable Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue.
attrSpecType com.aliyun.ros.cdk.core.IResolvable Attribute SpecType: Instance type.
attrSslDomainEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute SslDomainEndpoint: The domain name of the SSL access point.
attrSslEndPoint com.aliyun.ros.cdk.core.IResolvable Attribute SslEndPoint: External access point.
attrTags com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.
attrTopicNumLimit com.aliyun.ros.cdk.core.IResolvable Attribute TopicNumLimit: Maximum number of topic creation.
attrVpcId com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: VpcId.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: Switch id.
attrZoneId com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: The ID of the zone in which the instance is deployed.

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

attrAllConfigRequired 

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

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

attrAllowedListRequired 

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

Attribute AllowedList: White list.

attrCreateTimeRequired 

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

Attribute CreateTime: Creation time.

attrDeployTypeRequired 

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

Attribute DeployType: Deployment method.

attrDiskSizeRequired 

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

Attribute DiskSize: Disk size.

attrDiskTypeRequired 

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

Attribute DiskType: Disk type.

attrDomainEndpointRequired 

public IResolvable getAttrDomainEndpoint();
  • Type: 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.

attrEipMaxRequired 

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

Attribute EipMax: Peak public network traffic.

attrEndPointRequired 

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

Attribute EndPoint: Access point.

attrExpiredTimeRequired 

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

Attribute ExpiredTime: Expiration time.

attrInstanceIdRequired 

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

Attribute InstanceId: The ID of the instance.

attrInstanceNameRequired 

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

Attribute InstanceName: Note name.

attrIoMaxRequired 

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

Attribute IoMax: Peak flow.

attrIoMaxSpecRequired 

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

Attribute IoMaxSpec: Flow specifications (recommended).

attrMsgRetainRequired 

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

Attribute MsgRetain: Message save time.

attrPaymentTypeRequired 

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

Attribute PaymentType: The paymen type of the resource.

attrResourceGroupIdRequired 

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

Attribute ResourceGroupId: The ID of the resource group.

attrSaslDomainEndpointRequired 

public IResolvable getAttrSaslDomainEndpoint();
  • Type: 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.

attrServiceVersionRequired 

public IResolvable getAttrServiceVersion();
  • Type: 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.

attrSpecTypeRequired 

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

Attribute SpecType: Instance type.

attrSslDomainEndpointRequired 

public IResolvable getAttrSslDomainEndpoint();
  • Type: 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.

attrSslEndPointRequired 

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

Attribute SslEndPoint: External access point.

attrTagsRequired 

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

Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.

attrTopicNumLimitRequired 

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

Attribute TopicNumLimit: Maximum number of topic creation.

attrVpcIdRequired 

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

Attribute VpcId: VpcId.

attrVSwitchIdRequired 

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

Attribute VSwitchId: Switch id.

attrZoneIdRequired 

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

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