Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::KAFKA::Instance, which is used to create an ApsaraMQ for Kafka instance.

Initializers

import com.aliyun.ros.cdk.kafka.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .deployType(java.lang.Number)
    .deployType(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .deployOption(IResolvable)
//  .deployOption(DeployOptionProperty)
//  .diskSize(java.lang.Number)
//  .diskSize(IResolvable)
//  .diskType(java.lang.String)
//  .diskType(IResolvable)
//  .eipMax(java.lang.Number)
//  .eipMax(IResolvable)
//  .ioMax(java.lang.Number)
//  .ioMax(IResolvable)
//  .ioMaxSpec(java.lang.String)
//  .ioMaxSpec(IResolvable)
//  .openConnector(java.lang.Boolean)
//  .openConnector(IResolvable)
//  .partitionNum(java.lang.Number)
//  .partitionNum(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .serverlessConfig(IResolvable)
//  .serverlessConfig(ServerlessConfigProperty)
//  .specType(java.lang.String)
//  .specType(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .topicQuota(java.lang.Number)
//  .topicQuota(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

deployType^Required

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

Property deployType: The deployment type.

Valid values:

• 4: Internet/VPC instance
• 5: VPC instance

If you are creating a Confluent series instance, you cannot select the deployment type. You can only set the value to 5. After the purchase, you can adjust whether each component is open to the Internet.

deletionForce^Optional

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

Property deletionForce: Whether delete all topics, consumer groups of the kafka instance and then delete instance.

Default is false

deployOption^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR DeployOptionProperty

Property deployOption: If you want to deploy instance after create at once, the VSwitchId and DeployModule parameters is required.

diskSize^Optional

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

Property diskSize: The size of the disk to be configured for the Message Queue for Apache Kafka instance.

diskType^Optional

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

Property diskType: The type of the disk to be configured for the Message Queue for Apache Kafka instance.

Valid values: 0: Ultra disk 1: SSD

eipMax^Optional

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

Property eipMax: The public traffic to be configured for the Message Queue for Apache Kafka instance.

This parameter must be specified when the DeployType parameter is set to 4.

ioMax^Optional

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

Property ioMax: The traffic peak (not recommended).

• You must specify either IoMax or IoMaxSpec. If you specify both parameters, IoMaxSpec takes precedence. We recommend that you specify only IoMaxSpec.
• For the valid values, see Billing.

If you are creating a Confluent series instance, you do not need to pass this parameter.

ioMaxSpec^Optional

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

Property ioMaxSpec: Flow specification (recommended) The IoMax and IoMaxSpec must be optional.

When filling in at the same time, subject to IoMaxSpec. It is recommended that you only fill in the flow specification

openConnector^Optional

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

Property openConnector: Whether open kafka connector or not.

partitionNum^Optional

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

Property partitionNum: Number of partitions(recommended).

The number of partitions to be configured for the Message Queue for Apache Kafka instance. PartitionNum and TopicQuota must be selected. It is recommended that you only fill in the number of partitions.

payType^Optional

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

Property payType: Pay by hour or month.

serverlessConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR ServerlessConfigProperty

Property serverlessConfig: The settings of the Serverless instance.

This parameter is required if you create a Serverless instance.

specType^Optional

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

Property specType: The edition of the Message Queue for Apache Kafka instance.

Valid values: normal: Normal version professional: Professional Edition (high writing edition) professionalForHighRead: Professional Edition (high reading edition) basic: Basic Edition (only for serverless)

tags^Optional

• Type: java.util.List<TagsProperty>

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.

topicQuota^Optional

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

Property topicQuota: Number of topics (not recommended).

The number of topics to be configured for the Message Queue for Apache Kafka instance. PartitionNum and TopicQuota must be selected. It is recommended that you only fill in the number of partitions. The default value of this parameter varies with different peak traffic values. Additional fees are charged if the default values are exceeded. Different specifications have different default values, and extra fees are charged. For more information, see Billing.

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.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

attrArn^Required

public java.lang.Object getAttrArn();

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrDomainEndpoint^Required

public java.lang.Object getAttrDomainEndpoint();

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

Attribute DomainEndpoint: The default endpoints of the instance in domain name mode.

attrEndpoint^Required

public java.lang.Object getAttrEndpoint();

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

Attribute Endpoint: The SSL endpoints of the instance in IP address mode.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: Id of the instance.

attrName^Required

public java.lang.Object getAttrName();

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

Attribute Name: Name of the instance.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

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

Attribute OrderId: Id of the order.

attrSaslDomainEndpoint^Required

public java.lang.Object getAttrSaslDomainEndpoint();

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

Attribute SaslDomainEndpoint: The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode.

attrSslDomainEndpoint^Required

public java.lang.Object getAttrSslDomainEndpoint();

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

Attribute SslDomainEndpoint: The SSL endpoints of the instance in domain name mode.

attrSslEndpoint^Required

public java.lang.Object getAttrSslEndpoint();

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

Attribute SslEndpoint: The SSL endpoints of the instance in IP address mode.

props^Required

public InstanceProps getProps();

• Type: InstanceProps