Instance

• Implements: @alicloud/ros-cdk-kafka.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::KAFKA::Instance.

Initializers

import { datasource } from '@alicloud/ros-cdk-kafka'
new datasource.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 { datasource } from '@alicloud/ros-cdk-kafka'
datasource.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

attrAllConfig^Required

public readonly attrAllConfig: string | IResolvable;

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

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

attrAllowedList^Required

public readonly attrAllowedList: string | IResolvable;

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

Attribute AllowedList: White list.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

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

Attribute CreateTime: Creation time.

attrDeployType^Required

public readonly attrDeployType: string | IResolvable;

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

Attribute DeployType: Deployment method.

attrDiskSize^Required

public readonly attrDiskSize: string | IResolvable;

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

Attribute DiskSize: Disk size.

attrDiskType^Required

public readonly attrDiskType: string | IResolvable;

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

Attribute DiskType: Disk type.

attrDomainEndpoint^Required

public readonly attrDomainEndpoint: string | IResolvable;

• Type: string | @alicloud/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.

attrEipMax^Required

public readonly attrEipMax: string | IResolvable;

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

Attribute EipMax: Peak public network traffic.

attrEndPoint^Required

public readonly attrEndPoint: string | IResolvable;

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

Attribute EndPoint: Access point.

attrExpiredTime^Required

public readonly attrExpiredTime: string | IResolvable;

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

Attribute ExpiredTime: Expiration time.

attrInstanceId^Required

public readonly attrInstanceId: string | IResolvable;

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

Attribute InstanceId: The ID of the instance.

attrInstanceName^Required

public readonly attrInstanceName: string | IResolvable;

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

Attribute InstanceName: Note name.

attrIoMax^Required

public readonly attrIoMax: string | IResolvable;

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

Attribute IoMax: Peak flow.

attrIoMaxSpec^Required

public readonly attrIoMaxSpec: string | IResolvable;

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

Attribute IoMaxSpec: Flow specifications (recommended).

attrMsgRetain^Required

public readonly attrMsgRetain: string | IResolvable;

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

Attribute MsgRetain: Message save time.

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

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

Attribute PaymentType: The paymen type of the resource.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

Attribute ResourceGroupId: The ID of the resource group.

attrSaslDomainEndpoint^Required

public readonly attrSaslDomainEndpoint: string | IResolvable;

• Type: string | @alicloud/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.

attrServiceVersion^Required

public readonly attrServiceVersion: string | IResolvable;

• Type: string | @alicloud/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.

attrSpecType^Required

public readonly attrSpecType: string | IResolvable;

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

Attribute SpecType: Instance type.

attrSslDomainEndpoint^Required

public readonly attrSslDomainEndpoint: string | IResolvable;

• Type: string | @alicloud/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.

attrSslEndPoint^Required

public readonly attrSslEndPoint: string | IResolvable;

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

Attribute SslEndPoint: External access point.

attrTags^Required

public readonly attrTags: string | IResolvable;

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

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

attrTopicNumLimit^Required

public readonly attrTopicNumLimit: string | IResolvable;

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

Attribute TopicNumLimit: Maximum number of topic creation.

attrVpcId^Required

public readonly attrVpcId: string | IResolvable;

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

Attribute VpcId: VpcId.

attrVSwitchId^Required

public readonly attrVSwitchId: string | IResolvable;

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

Attribute VSwitchId: Switch id.

attrZoneId^Required

public readonly attrZoneId: string | IResolvable;

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

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

props^Required

public readonly props: InstanceProps;

• Type: InstanceProps