Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::KAFKA::Instance, which is used to create an ApsaraMQ for 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.
AttrArn object Attribute Arn: The Alibaba Cloud Resource Name (ARN).
AttrDomainEndpoint object Attribute DomainEndpoint: The default endpoints of the instance in domain name mode.
AttrEndpoint object Attribute Endpoint: The SSL endpoints of the instance in IP address mode.
AttrInstanceId object Attribute InstanceId: Id of the instance.
AttrName object Attribute Name: Name of the instance.
AttrOrderId object Attribute OrderId: Id of the order.
AttrSaslDomainEndpoint object Attribute SaslDomainEndpoint: The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode.
AttrSslDomainEndpoint object Attribute SslDomainEndpoint: The SSL endpoints of the instance in domain name mode.
AttrSslEndpoint object Attribute SslEndpoint: The SSL endpoints of the instance in IP address mode.
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

AttrArnRequired

public object AttrArn { get; }
  • Type: object

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


AttrDomainEndpointRequired

public object AttrDomainEndpoint { get; }
  • Type: object

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


AttrEndpointRequired

public object AttrEndpoint { get; }
  • Type: object

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


AttrInstanceIdRequired

public object AttrInstanceId { get; }
  • Type: object

Attribute InstanceId: Id of the instance.


AttrNameRequired

public object AttrName { get; }
  • Type: object

Attribute Name: Name of the instance.


AttrOrderIdRequired

public object AttrOrderId { get; }
  • Type: object

Attribute OrderId: Id of the order.


AttrSaslDomainEndpointRequired

public object AttrSaslDomainEndpoint { get; }
  • Type: object

Attribute SaslDomainEndpoint: The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode.


AttrSslDomainEndpointRequired

public object AttrSslDomainEndpoint { get; }
  • Type: object

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


AttrSslEndpointRequired

public object AttrSslEndpoint { get; }
  • Type: object

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


PropsRequired

public InstanceProps Props { get; }