InstanceProps
Properties for defining a Instance.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-instance
Initializer
import com.aliyun.ros.cdk.kafka.InstanceProps;
InstanceProps.builder()
.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();
Properties
| Name | Type | Description |
|---|---|---|
deployType | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property deployType: The deployment type. |
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 traffic peak (not recommended). |
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: The settings of the Serverless instance. |
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). |
deployTypeRequired
public java.lang.Object getDeployType();
- 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.
deletionForceOptional
public java.lang.Object getDeletionForce();
- 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
public java.lang.Object getDeployOption();
- 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.
diskSizeOptional
public java.lang.Object getDiskSize();
- 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
public java.lang.Object getDiskType();
- 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
public java.lang.Object getEipMax();
- 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
public java.lang.Object getIoMax();
- 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.
ioMaxSpecOptional
public java.lang.Object getIoMaxSpec();
- 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
public java.lang.Object getOpenConnector();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property openConnector: Whether open kafka connector or not.
partitionNumOptional
public java.lang.Object getPartitionNum();
- 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
public java.lang.Object getPayType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property payType: Pay by hour or month.
serverlessConfigOptional
public java.lang.Object getServerlessConfig();
- 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.
specTypeOptional
public java.lang.Object getSpecType();
- 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)
tagsOptional
public java.util.List<TagsProperty> getTags();
- 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.
topicQuotaOptional
public java.lang.Object getTopicQuota();
- 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.