Instance

• Implements: IInstance

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)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: InstanceProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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

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

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

attrArn^Required

public readonly attrArn: string | IResolvable;

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrDomainEndpoint^Required

public readonly attrDomainEndpoint: string | IResolvable;

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

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

attrEndpoint^Required

public readonly attrEndpoint: string | IResolvable;

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

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

attrInstanceId^Required

public readonly attrInstanceId: string | IResolvable;

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

Attribute InstanceId: Id of the instance.

attrName^Required

public readonly attrName: string | IResolvable;

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

Attribute Name: Name of the instance.

attrOrderId^Required

public readonly attrOrderId: string | IResolvable;

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

Attribute OrderId: Id of the order.

attrSaslDomainEndpoint^Required

public readonly attrSaslDomainEndpoint: string | IResolvable;

• Type: string | @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: string | IResolvable;

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

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

attrSslEndpoint^Required

public readonly attrSslEndpoint: string | IResolvable;

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

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

props^Required

public readonly props: InstanceProps;

• Type: InstanceProps