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 

from ros_cdk_kafka import datasource
datasource.Instance(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the instance.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_idRequired

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

Property instanceId: The ID of the instance.

refresh_optionsOptional

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

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 

from ros_cdk_kafka import datasource
datasource.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_all_config ros_cdk_core.IResolvable Attribute AllConfig: The current configuration of the deployed message queue Kafka version.
attr_allowed_list ros_cdk_core.IResolvable Attribute AllowedList: White list.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: Creation time.
attr_deploy_type ros_cdk_core.IResolvable Attribute DeployType: Deployment method.
attr_disk_size ros_cdk_core.IResolvable Attribute DiskSize: Disk size.
attr_disk_type ros_cdk_core.IResolvable Attribute DiskType: Disk type.
attr_domain_endpoint ros_cdk_core.IResolvable Attribute DomainEndpoint: The domain name access point of the default access point.
attr_eip_max ros_cdk_core.IResolvable Attribute EipMax: Peak public network traffic.
attr_end_point ros_cdk_core.IResolvable Attribute EndPoint: Access point.
attr_expired_time ros_cdk_core.IResolvable Attribute ExpiredTime: Expiration time.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the instance.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: Note name.
attr_io_max ros_cdk_core.IResolvable Attribute IoMax: Peak flow.
attr_io_max_spec ros_cdk_core.IResolvable Attribute IoMaxSpec: Flow specifications (recommended).
attr_msg_retain ros_cdk_core.IResolvable Attribute MsgRetain: Message save time.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The paymen type of the resource.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attr_sasl_domain_endpoint ros_cdk_core.IResolvable Attribute SaslDomainEndpoint: The domain name access point of the SASL access point.
attr_service_version ros_cdk_core.IResolvable Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue.
attr_spec_type ros_cdk_core.IResolvable Attribute SpecType: Instance type.
attr_ssl_domain_endpoint ros_cdk_core.IResolvable Attribute SslDomainEndpoint: The domain name of the SSL access point.
attr_ssl_end_point ros_cdk_core.IResolvable Attribute SslEndPoint: External access point.
attr_tags ros_cdk_core.IResolvable Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.
attr_topic_num_limit ros_cdk_core.IResolvable Attribute TopicNumLimit: Maximum number of topic creation.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: VpcId.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: Switch id.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: The ID of the zone in which the instance is deployed.

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_all_configRequired 

attr_all_config: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_allowed_listRequired 

attr_allowed_list: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AllowedList: White list.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: Creation time.

attr_deploy_typeRequired 

attr_deploy_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DeployType: Deployment method.

attr_disk_sizeRequired 

attr_disk_size: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskSize: Disk size.

attr_disk_typeRequired 

attr_disk_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskType: Disk type.

attr_domain_endpointRequired 

attr_domain_endpoint: IResolvable
  • Type: 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.

attr_eip_maxRequired 

attr_eip_max: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EipMax: Peak public network traffic.

attr_end_pointRequired 

attr_end_point: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EndPoint: Access point.

attr_expired_timeRequired 

attr_expired_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpiredTime: Expiration time.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the instance.

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: Note name.

attr_io_maxRequired 

attr_io_max: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IoMax: Peak flow.

attr_io_max_specRequired 

attr_io_max_spec: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IoMaxSpec: Flow specifications (recommended).

attr_msg_retainRequired 

attr_msg_retain: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MsgRetain: Message save time.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: The paymen type of the resource.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attr_sasl_domain_endpointRequired 

attr_sasl_domain_endpoint: IResolvable
  • Type: 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.

attr_service_versionRequired 

attr_service_version: IResolvable
  • Type: 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.

attr_spec_typeRequired 

attr_spec_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SpecType: Instance type.

attr_ssl_domain_endpointRequired 

attr_ssl_domain_endpoint: IResolvable
  • Type: 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.

attr_ssl_end_pointRequired 

attr_ssl_end_point: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SslEndPoint: External access point.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_topic_num_limitRequired 

attr_topic_num_limit: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TopicNumLimit: Maximum number of topic creation.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: VpcId.

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: Switch id.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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