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 

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

scopeRequired

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

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • 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.

sessionRequired

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

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount 

public addCount(count: number | IResolvable): void

countRequired

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

addDependency 

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • 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.
attrAllConfig @alicloud/ros-cdk-core.IResolvable Attribute AllConfig: The current configuration of the deployed message queue Kafka version.
attrAllowedList @alicloud/ros-cdk-core.IResolvable Attribute AllowedList: White list.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: Creation time.
attrDeployType @alicloud/ros-cdk-core.IResolvable Attribute DeployType: Deployment method.
attrDiskSize @alicloud/ros-cdk-core.IResolvable Attribute DiskSize: Disk size.
attrDiskType @alicloud/ros-cdk-core.IResolvable Attribute DiskType: Disk type.
attrDomainEndpoint @alicloud/ros-cdk-core.IResolvable Attribute DomainEndpoint: The domain name access point of the default access point.
attrEipMax @alicloud/ros-cdk-core.IResolvable Attribute EipMax: Peak public network traffic.
attrEndPoint @alicloud/ros-cdk-core.IResolvable Attribute EndPoint: Access point.
attrExpiredTime @alicloud/ros-cdk-core.IResolvable Attribute ExpiredTime: Expiration time.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The ID of the instance.
attrInstanceName @alicloud/ros-cdk-core.IResolvable Attribute InstanceName: Note name.
attrIoMax @alicloud/ros-cdk-core.IResolvable Attribute IoMax: Peak flow.
attrIoMaxSpec @alicloud/ros-cdk-core.IResolvable Attribute IoMaxSpec: Flow specifications (recommended).
attrMsgRetain @alicloud/ros-cdk-core.IResolvable Attribute MsgRetain: Message save time.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The paymen type of the resource.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSaslDomainEndpoint @alicloud/ros-cdk-core.IResolvable Attribute SaslDomainEndpoint: The domain name access point of the SASL access point.
attrServiceVersion @alicloud/ros-cdk-core.IResolvable Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue.
attrSpecType @alicloud/ros-cdk-core.IResolvable Attribute SpecType: Instance type.
attrSslDomainEndpoint @alicloud/ros-cdk-core.IResolvable Attribute SslDomainEndpoint: The domain name of the SSL access point.
attrSslEndPoint @alicloud/ros-cdk-core.IResolvable Attribute SslEndPoint: External access point.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.
attrTopicNumLimit @alicloud/ros-cdk-core.IResolvable Attribute TopicNumLimit: Maximum number of topic creation.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: VpcId.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: Switch id.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: The ID of the zone in which the instance is deployed.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAllConfigRequired 

public readonly attrAllConfig: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrAllowedListRequired 

public readonly attrAllowedList: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AllowedList: White list.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: Creation time.

attrDeployTypeRequired 

public readonly attrDeployType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DeployType: Deployment method.

attrDiskSizeRequired 

public readonly attrDiskSize: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DiskSize: Disk size.

attrDiskTypeRequired 

public readonly attrDiskType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DiskType: Disk type.

attrDomainEndpointRequired 

public readonly attrDomainEndpoint: IResolvable;
  • Type: @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.

attrEipMaxRequired 

public readonly attrEipMax: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EipMax: Peak public network traffic.

attrEndPointRequired 

public readonly attrEndPoint: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EndPoint: Access point.

attrExpiredTimeRequired 

public readonly attrExpiredTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpiredTime: Expiration time.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The ID of the instance.

attrInstanceNameRequired 

public readonly attrInstanceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceName: Note name.

attrIoMaxRequired 

public readonly attrIoMax: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IoMax: Peak flow.

attrIoMaxSpecRequired 

public readonly attrIoMaxSpec: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IoMaxSpec: Flow specifications (recommended).

attrMsgRetainRequired 

public readonly attrMsgRetain: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MsgRetain: Message save time.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The paymen type of the resource.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSaslDomainEndpointRequired 

public readonly attrSaslDomainEndpoint: IResolvable;
  • Type: @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.

attrServiceVersionRequired 

public readonly attrServiceVersion: IResolvable;
  • Type: @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.

attrSpecTypeRequired 

public readonly attrSpecType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SpecType: Instance type.

attrSslDomainEndpointRequired 

public readonly attrSslDomainEndpoint: IResolvable;
  • Type: @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.

attrSslEndPointRequired 

public readonly attrSslEndPoint: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SslEndPoint: External access point.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrTopicNumLimitRequired 

public readonly attrTopicNumLimit: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute TopicNumLimit: Maximum number of topic creation.

attrVpcIdRequired 

public readonly attrVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: VpcId.

attrVSwitchIdRequired 

public readonly attrVSwitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: Switch id.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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