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 { Instance } from '@alicloud/ros-cdk-kafka'
new Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	InstanceProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: InstanceProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { Instance } from '@alicloud/ros-cdk-kafka'
Instance.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrDomainEndpoint	@alicloud/ros-cdk-core.IResolvable	Attribute DomainEndpoint: The default endpoints of the instance in domain name mode.
attrEndpoint	@alicloud/ros-cdk-core.IResolvable	Attribute Endpoint: The SSL endpoints of the instance in IP address mode.
attrInstanceId	@alicloud/ros-cdk-core.IResolvable	Attribute InstanceId: Id of the instance.
attrName	@alicloud/ros-cdk-core.IResolvable	Attribute Name: Name of the instance.
attrOrderId	@alicloud/ros-cdk-core.IResolvable	Attribute OrderId: Id of the order.
attrSaslDomainEndpoint	@alicloud/ros-cdk-core.IResolvable	Attribute SaslDomainEndpoint: The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode.
attrSslDomainEndpoint	@alicloud/ros-cdk-core.IResolvable	Attribute SslDomainEndpoint: The SSL endpoints of the instance in domain name mode.
attrSslEndpoint	@alicloud/ros-cdk-core.IResolvable	Attribute SslEndpoint: The SSL endpoints of the instance in IP address mode.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrDomainEndpoint^Required

public readonly attrDomainEndpoint: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrEndpoint^Required

public readonly attrEndpoint: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrInstanceId^Required

public readonly attrInstanceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: Id of the instance.

---

attrName^Required

public readonly attrName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Name: Name of the instance.

---

attrOrderId^Required

public readonly attrOrderId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute OrderId: Id of the order.

---

attrSaslDomainEndpoint^Required

public readonly attrSaslDomainEndpoint: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrSslDomainEndpoint^Required

public readonly attrSslDomainEndpoint: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrSslEndpoint^Required

public readonly attrSslEndpoint: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---