Skip to content

Instance

  • Implements: AlibabaCloud.SDK.ROS.CDK.Kafka.datasource.IInstance

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.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc 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

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

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.
Env AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment The environment this resource belongs to.
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 object Attribute AllConfig: The current configuration of the deployed message queue Kafka version.
AttrAllowedList object Attribute AllowedList: White list.
AttrCreateTime object Attribute CreateTime: Creation time.
AttrDeployType object Attribute DeployType: Deployment method.
AttrDiskSize object Attribute DiskSize: Disk size.
AttrDiskType object Attribute DiskType: Disk type.
AttrDomainEndpoint object Attribute DomainEndpoint: The domain name access point of the default access point.
AttrEipMax object Attribute EipMax: Peak public network traffic.
AttrEndPoint object Attribute EndPoint: Access point.
AttrExpiredTime object Attribute ExpiredTime: Expiration time.
AttrInstanceId object Attribute InstanceId: The ID of the instance.
AttrInstanceName object Attribute InstanceName: Note name.
AttrIoMax object Attribute IoMax: Peak flow.
AttrIoMaxSpec object Attribute IoMaxSpec: Flow specifications (recommended).
AttrMsgRetain object Attribute MsgRetain: Message save time.
AttrPaymentType object Attribute PaymentType: The paymen type of the resource.
AttrResourceGroupId object Attribute ResourceGroupId: The ID of the resource group.
AttrSaslDomainEndpoint object Attribute SaslDomainEndpoint: The domain name access point of the SASL access point.
AttrServiceVersion object Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue.
AttrSpecType object Attribute SpecType: Instance type.
AttrSslDomainEndpoint object Attribute SslDomainEndpoint: The domain name of the SSL access point.
AttrSslEndPoint object Attribute SslEndPoint: External access point.
AttrTags object Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption.
AttrTopicNumLimit object Attribute TopicNumLimit: Maximum number of topic creation.
AttrVpcId object Attribute VpcId: VpcId.
AttrVSwitchId object Attribute VSwitchId: Switch id.
AttrZoneId object Attribute ZoneId: The ID of the zone in which the instance is deployed.
Props InstanceProps No description.

NodeRequired

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

The construct tree node associated with this construct.


EnvRequired

public IResourceEnvironment Env { get; }
  • Type: AlibabaCloud.SDK.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.


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 object AttrAllConfig { get; }
  • Type: object

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


AttrAllowedListRequired

public object AttrAllowedList { get; }
  • Type: object

Attribute AllowedList: White list.


AttrCreateTimeRequired

public object AttrCreateTime { get; }
  • Type: object

Attribute CreateTime: Creation time.


AttrDeployTypeRequired

public object AttrDeployType { get; }
  • Type: object

Attribute DeployType: Deployment method.


AttrDiskSizeRequired

public object AttrDiskSize { get; }
  • Type: object

Attribute DiskSize: Disk size.


AttrDiskTypeRequired

public object AttrDiskType { get; }
  • Type: object

Attribute DiskType: Disk type.


AttrDomainEndpointRequired

public object AttrDomainEndpoint { get; }
  • Type: object

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 object AttrEipMax { get; }
  • Type: object

Attribute EipMax: Peak public network traffic.


AttrEndPointRequired

public object AttrEndPoint { get; }
  • Type: object

Attribute EndPoint: Access point.


AttrExpiredTimeRequired

public object AttrExpiredTime { get; }
  • Type: object

Attribute ExpiredTime: Expiration time.


AttrInstanceIdRequired

public object AttrInstanceId { get; }
  • Type: object

Attribute InstanceId: The ID of the instance.


AttrInstanceNameRequired

public object AttrInstanceName { get; }
  • Type: object

Attribute InstanceName: Note name.


AttrIoMaxRequired

public object AttrIoMax { get; }
  • Type: object

Attribute IoMax: Peak flow.


AttrIoMaxSpecRequired

public object AttrIoMaxSpec { get; }
  • Type: object

Attribute IoMaxSpec: Flow specifications (recommended).


AttrMsgRetainRequired

public object AttrMsgRetain { get; }
  • Type: object

Attribute MsgRetain: Message save time.


AttrPaymentTypeRequired

public object AttrPaymentType { get; }
  • Type: object

Attribute PaymentType: The paymen type of the resource.


AttrResourceGroupIdRequired

public object AttrResourceGroupId { get; }
  • Type: object

Attribute ResourceGroupId: The ID of the resource group.


AttrSaslDomainEndpointRequired

public object AttrSaslDomainEndpoint { get; }
  • Type: object

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 object AttrServiceVersion { get; }
  • Type: object

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 object AttrSpecType { get; }
  • Type: object

Attribute SpecType: Instance type.


AttrSslDomainEndpointRequired

public object AttrSslDomainEndpoint { get; }
  • Type: object

Attribute SslDomainEndpoint: The domain name of the SSL access point.

The Kafka instance supports domain name access points and IP access points.


AttrSslEndPointRequired

public object AttrSslEndPoint { get; }
  • Type: object

Attribute SslEndPoint: External access point.


AttrTagsRequired

public object AttrTags { get; }
  • Type: object

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


AttrTopicNumLimitRequired

public object AttrTopicNumLimit { get; }
  • Type: object

Attribute TopicNumLimit: Maximum number of topic creation.


AttrVpcIdRequired

public object AttrVpcId { get; }
  • Type: object

Attribute VpcId: VpcId.


AttrVSwitchIdRequired

public object AttrVSwitchId { get; }
  • Type: object

Attribute VSwitchId: Switch id.


AttrZoneIdRequired

public object AttrZoneId { get; }
  • Type: object

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


PropsRequired

public InstanceProps Props { get; }