Skip to content

Instance

  • Implements: github.com/alibabacloud-go/ros-cdk/alicloudroscdkkafka.datasource.IInstance

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

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkkafka/datasource"
datasource.NewInstance(scope Construct, id *string, props InstanceProps, enableResourcePropertyConstraint *bool) Instance
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct No description.
id *string No description.
props InstanceProps No description.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.


AddCondition

func AddCondition(condition RosCondition)

conditionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDependency

func AddDependency(resource Resource)

resourceRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource

AddResourceDesc

func AddResourceDesc(desc *string)

descRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policyRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

FetchCondition

func FetchCondition() RosCondition

FetchDependency

func FetchDependency() *[]*string

FetchResourceDesc

func FetchResourceDesc() *string

GetAtt

func GetAtt(name *string) IResolvable

nameRequired

  • Type: *string

SetMetadata

func SetMetadata(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

Static Functions

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

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkkafka/datasource"
datasource.Instance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

Properties

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

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


EnvRequired

func Env() IResourceEnvironment
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func Ref() *string
  • Type: *string

StackRequired

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this resource is defined.


ResourceOptional

func Resource() RosResource
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AttrAllConfigRequired

func AttrAllConfig() interface{}
  • Type: interface{}

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


AttrAllowedListRequired

func AttrAllowedList() interface{}
  • Type: interface{}

Attribute AllowedList: White list.


AttrCreateTimeRequired

func AttrCreateTime() interface{}
  • Type: interface{}

Attribute CreateTime: Creation time.


AttrDeployTypeRequired

func AttrDeployType() interface{}
  • Type: interface{}

Attribute DeployType: Deployment method.


AttrDiskSizeRequired

func AttrDiskSize() interface{}
  • Type: interface{}

Attribute DiskSize: Disk size.


AttrDiskTypeRequired

func AttrDiskType() interface{}
  • Type: interface{}

Attribute DiskType: Disk type.


AttrDomainEndpointRequired

func AttrDomainEndpoint() interface{}
  • Type: interface{}

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

func AttrEipMax() interface{}
  • Type: interface{}

Attribute EipMax: Peak public network traffic.


AttrEndPointRequired

func AttrEndPoint() interface{}
  • Type: interface{}

Attribute EndPoint: Access point.


AttrExpiredTimeRequired

func AttrExpiredTime() interface{}
  • Type: interface{}

Attribute ExpiredTime: Expiration time.


AttrInstanceIdRequired

func AttrInstanceId() interface{}
  • Type: interface{}

Attribute InstanceId: The ID of the instance.


AttrInstanceNameRequired

func AttrInstanceName() interface{}
  • Type: interface{}

Attribute InstanceName: Note name.


AttrIoMaxRequired

func AttrIoMax() interface{}
  • Type: interface{}

Attribute IoMax: Peak flow.


AttrIoMaxSpecRequired

func AttrIoMaxSpec() interface{}
  • Type: interface{}

Attribute IoMaxSpec: Flow specifications (recommended).


AttrMsgRetainRequired

func AttrMsgRetain() interface{}
  • Type: interface{}

Attribute MsgRetain: Message save time.


AttrPaymentTypeRequired

func AttrPaymentType() interface{}
  • Type: interface{}

Attribute PaymentType: The paymen type of the resource.


AttrResourceGroupIdRequired

func AttrResourceGroupId() interface{}
  • Type: interface{}

Attribute ResourceGroupId: The ID of the resource group.


AttrSaslDomainEndpointRequired

func AttrSaslDomainEndpoint() interface{}
  • Type: interface{}

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

func AttrServiceVersion() interface{}
  • Type: interface{}

Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue.

The value is 0.10.2 or 2.2.0.


AttrSpecTypeRequired

func AttrSpecType() interface{}
  • Type: interface{}

Attribute SpecType: Instance type.


AttrSslDomainEndpointRequired

func AttrSslDomainEndpoint() interface{}
  • Type: interface{}

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

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


AttrSslEndPointRequired

func AttrSslEndPoint() interface{}
  • Type: interface{}

Attribute SslEndPoint: External access point.


AttrTagsRequired

func AttrTags() interface{}
  • Type: interface{}

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


AttrTopicNumLimitRequired

func AttrTopicNumLimit() interface{}
  • Type: interface{}

Attribute TopicNumLimit: Maximum number of topic creation.


AttrVpcIdRequired

func AttrVpcId() interface{}
  • Type: interface{}

Attribute VpcId: VpcId.


AttrVSwitchIdRequired

func AttrVSwitchId() interface{}
  • Type: interface{}

Attribute VSwitchId: Switch id.


AttrZoneIdRequired

func AttrZoneId() interface{}
  • Type: interface{}

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


PropsRequired

func Props() InstanceProps