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 ros_cdk_kafka
ros_cdk_kafka.Instance(
  scope: Construct,
  id: str,
  deploy_type: typing.Union[typing.Union[int, float], IResolvable],
  deletion_force: typing.Union[bool, IResolvable] = None,
  deploy_option: typing.Union[IResolvable, DeployOptionProperty] = None,
  disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  disk_type: typing.Union[str, IResolvable] = None,
  eip_max: typing.Union[typing.Union[int, float], IResolvable] = None,
  io_max: typing.Union[typing.Union[int, float], IResolvable] = None,
  io_max_spec: typing.Union[str, IResolvable] = None,
  open_connector: typing.Union[bool, IResolvable] = None,
  partition_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  serverless_config: typing.Union[IResolvable, ServerlessConfigProperty] = None,
  spec_type: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  topic_quota: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
deploy_type typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property deployType: The deployment mode of the Message Queue for Apache Kafka instance.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Whether delete all topics, consumer groups of the kafka instance and then delete instance.
deploy_option typing.Union[ros_cdk_core.IResolvable, DeployOptionProperty] Property deployOption: If you want to deploy instance after create at once, the VSwitchId and DeployModule parameters is required.
disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property diskSize: The size of the disk to be configured for the Message Queue for Apache Kafka instance.
disk_type typing.Union[str, ros_cdk_core.IResolvable] Property diskType: The type of the disk to be configured for the Message Queue for Apache Kafka instance.
eip_max typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property eipMax: The public traffic to be configured for the Message Queue for Apache Kafka instance.
io_max typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ioMax: The peak traffic to be configured for the Message Queue for Apache Kafka instance.
io_max_spec typing.Union[str, ros_cdk_core.IResolvable] Property ioMaxSpec: Flow specification (recommended) The IoMax and IoMaxSpec must be optional.
open_connector typing.Union[bool, ros_cdk_core.IResolvable] Property openConnector: Whether open kafka connector or not.
partition_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property partitionNum: Number of partitions(recommended).
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: Pay by hour or month.
serverless_config typing.Union[ros_cdk_core.IResolvable, ServerlessConfigProperty] Property serverlessConfig: Serverless instance related settings.
spec_type typing.Union[str, ros_cdk_core.IResolvable] Property specType: The edition of the Message Queue for Apache Kafka instance.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
topic_quota typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property topicQuota: Number of topics (not recommended).
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

deploy_typeRequired

  • Type: typing.Union[typing.Union[int, float], 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

deletion_forceOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Default is false

deploy_optionOptional

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

disk_sizeOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

disk_typeOptional

  • Type: typing.Union[str, 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

eip_maxOptional

  • Type: typing.Union[typing.Union[int, float], 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.

io_maxOptional

  • Type: typing.Union[typing.Union[int, float], 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.

io_max_specOptional

  • Type: typing.Union[str, 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

open_connectorOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property openConnector: Whether open kafka connector or not.

partition_numOptional

  • Type: typing.Union[typing.Union[int, float], 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.

pay_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property payType: Pay by hour or month.

serverless_configOptional

Property serverlessConfig: Serverless instance related settings.

spec_typeOptional

  • Type: typing.Union[str, 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.

topic_quotaOptional

  • Type: typing.Union[typing.Union[int, float], 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_kafka
ros_cdk_kafka.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_domain_endpoint ros_cdk_core.IResolvable Attribute DomainEndpoint: The default endpoints of the instance in domain name mode.
attr_endpoint ros_cdk_core.IResolvable Attribute Endpoint: The SSL endpoints of the instance in IP address mode.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: Id of the instance.
attr_name ros_cdk_core.IResolvable Attribute Name: Name of the instance.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: Id of the order.
attr_sasl_domain_endpoint ros_cdk_core.IResolvable Attribute SaslDomainEndpoint: The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode.
attr_ssl_domain_endpoint ros_cdk_core.IResolvable Attribute SslDomainEndpoint: The SSL endpoints of the instance in domain name mode.
attr_ssl_endpoint ros_cdk_core.IResolvable Attribute SslEndpoint: The SSL endpoints of the instance in IP address mode.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_domain_endpointRequired 

attr_domain_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_endpointRequired 

attr_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: Id of the instance.

attr_nameRequired 

attr_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Name: Name of the instance.

attr_order_idRequired 

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: Id of the order.

attr_sasl_domain_endpointRequired 

attr_sasl_domain_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_ssl_domain_endpointRequired 

attr_ssl_domain_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_ssl_endpointRequired 

attr_ssl_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

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