Skip to content

Instance

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
deployType java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property deployType: The deployment mode of the Message Queue for Apache Kafka instance.
deletionForce 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.
deployOption 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 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 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.
eipMax 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.
ioMax java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property ioMax: The peak traffic to be configured for the Message Queue for Apache Kafka instance.
ioMaxSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ioMaxSpec: Flow specification (recommended) The IoMax and IoMaxSpec must be optional.
openConnector java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property openConnector: Whether open kafka connector or not.
partitionNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property partitionNum: Number of partitions(recommended).
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: Pay by hour or month.
serverlessConfig com.aliyun.ros.cdk.core.IResolvable OR ServerlessConfigProperty Property serverlessConfig: Serverless instance related settings.
specType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property specType: The edition of the Message Queue for Apache Kafka instance.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
topicQuota java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property topicQuota: Number of topics (not recommended).

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

deployTypeRequired

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

Property deployType: The deployment mode of the Message Queue for Apache Kafka instance.

Valid values: 4: Instance of the public type 5: Instance of the VPC type

deletionForceOptional

  • 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

deployOptionOptional

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

diskSizeOptional

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

diskTypeOptional

  • 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

eipMaxOptional

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

ioMaxOptional

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

Property ioMax: The peak traffic to be configured for the Message Queue for Apache Kafka instance.

For more information about the value range, see Billing.

ioMaxSpecOptional

  • 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

openConnectorOptional

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

Property openConnector: Whether open kafka connector or not.

partitionNumOptional

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

payTypeOptional

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

Property payType: Pay by hour or month.

serverlessConfigOptional

Property serverlessConfig: Serverless instance related settings.

specTypeOptional

  • 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: professional: Professional Edition normal: Normal version

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.

topicQuotaOptional

  • 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

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.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.
attrDomainEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute DomainEndpoint: The default endpoints of the instance in domain name mode.
attrEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute Endpoint: The SSL endpoints of the instance in IP address mode.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: Id of the instance.
attrName com.aliyun.ros.cdk.core.IResolvable Attribute Name: Name of the instance.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: Id of the order.
attrSaslDomainEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute SaslDomainEndpoint: The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode.
attrSslDomainEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute SslDomainEndpoint: The SSL endpoints of the instance in domain name mode.
attrSslEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute SslEndpoint: The SSL endpoints of the instance in IP address mode.

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

attrDomainEndpointRequired 

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

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

attrEndpointRequired 

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

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

attrInstanceIdRequired 

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

Attribute InstanceId: Id of the instance.

attrNameRequired 

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

Attribute Name: Name of the instance.

attrOrderIdRequired 

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

Attribute OrderId: Id of the order.

attrSaslDomainEndpointRequired 

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

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

attrSslDomainEndpointRequired 

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

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

attrSslEndpointRequired 

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

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