Skip to content

Instance

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

Initializers 

using AlibabaCloud.SDK.ROS.CDK.Kafka;
new Instance(Construct Scope, string Id, InstanceProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props InstanceProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired

EnableResourcePropertyConstraintOptional

  • Type: bool

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 

private string ToString()

Returns a string representation of this construct.

Synthesize 

private void Synthesize(ISynthesisSession Session)

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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition 

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount 

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency 

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc 

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy 

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

GetAtt 

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata 

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

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

IsConstruct 

using AlibabaCloud.SDK.ROS.CDK.Kafka;
Instance.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrAllConfig AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute AllConfig: The current configuration of the deployed message queue Kafka version.
AttrAllowedList AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute AllowedList: White list.
AttrCreateTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute CreateTime: Creation time.
AttrDeployType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DeployType: Deployment method.
AttrDiskSize AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DiskSize: Disk size.
AttrDiskType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DiskType: Disk type.
AttrDomainEndpoint AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DomainEndpoint: The domain name access point of the default access point.
AttrEipMax AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EipMax: Peak public network traffic.
AttrEndPoint AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute EndPoint: Access point.
AttrExpiredTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ExpiredTime: Expiration time.
AttrInstanceId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute InstanceId: The ID of the instance.
AttrInstanceName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute InstanceName: Note name.
AttrIoMax AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute IoMax: Peak flow.
AttrIoMaxSpec AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute IoMaxSpec: Flow specifications (recommended).
AttrMsgRetain AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute MsgRetain: Message save time.
AttrPaymentType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PaymentType: The paymen type of the resource.
AttrResourceGroupId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
AttrSaslDomainEndpoint AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SaslDomainEndpoint: The domain name access point of the SASL access point.
AttrServiceVersion AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue.
AttrSpecType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SpecType: Instance type.
AttrSslDomainEndpoint AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SslDomainEndpoint: The domain name of the SSL access point.
AttrSslEndPoint AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SslEndPoint: External access point.
AttrTags AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.
AttrTopicNumLimit AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute TopicNumLimit: Maximum number of topic creation.
AttrVpcId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VpcId: VpcId.
AttrVSwitchId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VSwitchId: Switch id.
AttrZoneId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ZoneId: The ID of the zone in which the instance is deployed.

NodeRequired 

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

RefRequired 

public string Ref { get; }
  • Type: string

StackRequired 

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

ResourceOptional 

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrAllConfigRequired 

public IResolvable AttrAllConfig { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrAllowedListRequired 

public IResolvable AttrAllowedList { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute AllowedList: White list.

AttrCreateTimeRequired 

public IResolvable AttrCreateTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute CreateTime: Creation time.

AttrDeployTypeRequired 

public IResolvable AttrDeployType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DeployType: Deployment method.

AttrDiskSizeRequired 

public IResolvable AttrDiskSize { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DiskSize: Disk size.

AttrDiskTypeRequired 

public IResolvable AttrDiskType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DiskType: Disk type.

AttrDomainEndpointRequired 

public IResolvable AttrDomainEndpoint { get; }
  • Type: AlibabaCloud.SDK.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 IResolvable AttrEipMax { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute EipMax: Peak public network traffic.

AttrEndPointRequired 

public IResolvable AttrEndPoint { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute EndPoint: Access point.

AttrExpiredTimeRequired 

public IResolvable AttrExpiredTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ExpiredTime: Expiration time.

AttrInstanceIdRequired 

public IResolvable AttrInstanceId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute InstanceId: The ID of the instance.

AttrInstanceNameRequired 

public IResolvable AttrInstanceName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute InstanceName: Note name.

AttrIoMaxRequired 

public IResolvable AttrIoMax { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute IoMax: Peak flow.

AttrIoMaxSpecRequired 

public IResolvable AttrIoMaxSpec { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute IoMaxSpec: Flow specifications (recommended).

AttrMsgRetainRequired 

public IResolvable AttrMsgRetain { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute MsgRetain: Message save time.

AttrPaymentTypeRequired 

public IResolvable AttrPaymentType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PaymentType: The paymen type of the resource.

AttrResourceGroupIdRequired 

public IResolvable AttrResourceGroupId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

AttrSaslDomainEndpointRequired 

public IResolvable AttrSaslDomainEndpoint { get; }
  • Type: AlibabaCloud.SDK.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 IResolvable AttrServiceVersion { get; }
  • Type: AlibabaCloud.SDK.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 IResolvable AttrSpecType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute SpecType: Instance type.

AttrSslDomainEndpointRequired 

public IResolvable AttrSslDomainEndpoint { get; }
  • Type: AlibabaCloud.SDK.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 IResolvable AttrSslEndPoint { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute SslEndPoint: External access point.

AttrTagsRequired 

public IResolvable AttrTags { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrTopicNumLimitRequired 

public IResolvable AttrTopicNumLimit { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute TopicNumLimit: Maximum number of topic creation.

AttrVpcIdRequired 

public IResolvable AttrVpcId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute VpcId: VpcId.

AttrVSwitchIdRequired 

public IResolvable AttrVSwitchId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute VSwitchId: Switch id.

AttrZoneIdRequired 

public IResolvable AttrZoneId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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