alicloudroscdkkafka

package module
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 25, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

README

Aliyun ROS KAFKA Construct Library

This module is part of the AliCloud ROS Cloud Development Kit (ROS CDK) project.

import * as KAFKA from '@alicloud/ros-cdk-kafka';

Documentation

Overview

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Acl_IsConstruct 

func Acl_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func ConsumerGroup_IsConstruct 

func ConsumerGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func Instance_IsConstruct 

func Instance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewAcl_Override 

func NewAcl_Override(a Acl, scope alicloudroscdkcore.Construct, id *string, props *AclProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewConsumerGroup_Override 

func NewConsumerGroup_Override(c ConsumerGroup, scope alicloudroscdkcore.Construct, id *string, props *ConsumerGroupProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewInstance_Override 

func NewInstance_Override(i Instance, scope alicloudroscdkcore.Construct, id *string, props *InstanceProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewRosAcl_Override 

func NewRosAcl_Override(r RosAcl, scope alicloudroscdkcore.Construct, id *string, props *RosAclProps, enableResourcePropertyConstraint *bool)

func NewRosConsumerGroup_Override 

func NewRosConsumerGroup_Override(r RosConsumerGroup, scope alicloudroscdkcore.Construct, id *string, props *RosConsumerGroupProps, enableResourcePropertyConstraint *bool)

func NewRosInstance_Override 

func NewRosInstance_Override(r RosInstance, scope alicloudroscdkcore.Construct, id *string, props *RosInstanceProps, enableResourcePropertyConstraint *bool)

func NewRosSaslUser_Override 

func NewRosSaslUser_Override(r RosSaslUser, scope alicloudroscdkcore.Construct, id *string, props *RosSaslUserProps, enableResourcePropertyConstraint *bool)

func NewRosTopic_Override 

func NewRosTopic_Override(r RosTopic, scope alicloudroscdkcore.Construct, id *string, props *RosTopicProps, enableResourcePropertyConstraint *bool)

func NewSaslUser_Override 

func NewSaslUser_Override(s SaslUser, scope alicloudroscdkcore.Construct, id *string, props *SaslUserProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewTopic_Override 

func NewTopic_Override(t Topic, scope alicloudroscdkcore.Construct, id *string, props *TopicProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func RosAcl_IsConstruct 

func RosAcl_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosAcl_IsRosElement 

func RosAcl_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosAcl_IsRosResource 

func RosAcl_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosAcl_ROS_RESOURCE_TYPE_NAME 

func RosAcl_ROS_RESOURCE_TYPE_NAME() *string

func RosConsumerGroup_IsConstruct 

func RosConsumerGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosConsumerGroup_IsRosElement 

func RosConsumerGroup_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosConsumerGroup_IsRosResource 

func RosConsumerGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosConsumerGroup_ROS_RESOURCE_TYPE_NAME 

func RosConsumerGroup_ROS_RESOURCE_TYPE_NAME() *string

func RosInstance_IsConstruct 

func RosInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosInstance_IsRosElement 

func RosInstance_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosInstance_IsRosResource 

func RosInstance_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosInstance_ROS_RESOURCE_TYPE_NAME 

func RosInstance_ROS_RESOURCE_TYPE_NAME() *string

func RosSaslUser_IsConstruct 

func RosSaslUser_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosSaslUser_IsRosElement 

func RosSaslUser_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosSaslUser_IsRosResource 

func RosSaslUser_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosSaslUser_ROS_RESOURCE_TYPE_NAME 

func RosSaslUser_ROS_RESOURCE_TYPE_NAME() *string

func RosTopic_IsConstruct 

func RosTopic_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosTopic_IsRosElement 

func RosTopic_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosTopic_IsRosResource 

func RosTopic_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosTopic_ROS_RESOURCE_TYPE_NAME 

func RosTopic_ROS_RESOURCE_TYPE_NAME() *string

func SaslUser_IsConstruct 

func SaslUser_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func Topic_IsConstruct 

func Topic_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

Types

type Acl 

type Acl interface {
	alicloudroscdkcore.Resource
	IAcl
	// Attribute AclResourceType: The resource type.
	AttrAclResourceType() interface{}
	// Attribute InstanceId: The instance ID.
	AttrInstanceId() interface{}
	// Attribute Username: The username.
	AttrUsername() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *AclProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::KAFKA::Acl`, which is used to create an access control list (ACL).

func NewAcl 

func NewAcl(scope alicloudroscdkcore.Construct, id *string, props *AclProps, enableResourcePropertyConstraint *bool) Acl

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type AclProps 

type AclProps struct {
	// Property aclOperationTypes: The types of operations allowed by the ACL.
	AclOperationTypes interface{} `field:"required" json:"aclOperationTypes" yaml:"aclOperationTypes"`
	// Property aclResourceName: The resource name.
	//
	// The value can be a topic name, a group ID, a cluster name, or a transaction ID.
	// You can use an asterisk (*) to specify the names of all resources of the specified type.
	// Note You can use an asterisk (*) to query the resources on which permissions are granted only after you grant the user the required permissions on all resources.
	AclResourceName interface{} `field:"required" json:"aclResourceName" yaml:"aclResourceName"`
	// Property aclResourcePatternType: The matching mode.
	//
	// Valid values:
	// LITERAL: exact match
	// PREFIXED: prefix match.
	AclResourcePatternType interface{} `field:"required" json:"aclResourcePatternType" yaml:"aclResourcePatternType"`
	// Property aclResourceType: The resource type.
	//
	// Valid values:
	// Topic
	// Group
	// Cluster
	// TransactionalId: transactional ID.
	AclResourceType interface{} `field:"required" json:"aclResourceType" yaml:"aclResourceType"`
	// Property instanceId: The instance ID.
	InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"`
	// Property username: The username.
	//
	// You can use an asterisk (*) to specify all usernames.
	// Note You can use an asterisk (*) to query the authorized users only after you grant the required permissions to all users.
	Username interface{} `field:"required" json:"username" yaml:"username"`
	// Property aclPermissionType: The authorization method.
	//
	// Valid values:
	// DENY
	// ALLOW
	// Note This parameter is available only for ApsaraMQ for Kafka V3 serverless instances.
	AclPermissionType interface{} `field:"optional" json:"aclPermissionType" yaml:"aclPermissionType"`
	// Property host: The source IP address.
	//
	// Note
	// You can specify only a specific IP address or use the asterisk (*) wildcard character to specify all IP addresses. CIDR blocks are not supported.
	// This parameter is available only for ApsaraMQ for Kafka V3 serverless instances.
	Host interface{} `field:"optional" json:"host" yaml:"host"`
}

Properties for defining a `Acl`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-acl

type ConsumerGroup 

type ConsumerGroup interface {
	alicloudroscdkcore.Resource
	IConsumerGroup
	// Attribute ConsumerId: Consumer group ID.
	AttrConsumerId() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *ConsumerGroupProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::KAFKA::ConsumerGroup`, which is used to create a consumer group.

func NewConsumerGroup 

func NewConsumerGroup(scope alicloudroscdkcore.Construct, id *string, props *ConsumerGroupProps, enableResourcePropertyConstraint *bool) ConsumerGroup

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type ConsumerGroupProps 

type ConsumerGroupProps struct {
	// Property consumerId: Group name.
	//
	// Value:
	// Can only contain letters, numbers, dashes (-), underscores (_), and at least one English or number.
	// The length is limited to 3 to 128 characters, and more than 128 characters will be automatically intercepted.
	// Once the group name is created, it cannot be modified.
	ConsumerId interface{} `field:"required" json:"consumerId" yaml:"consumerId"`
	// Property instanceId: Kafka instance id.
	InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"`
	// Property remark: Remark description.
	Remark interface{} `field:"optional" json:"remark" yaml:"remark"`
	// Property tags: Tags to attach to instance.
	//
	// Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
	Tags *[]*RosConsumerGroup_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `ConsumerGroup`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-consumergroup

type IAcl added in v1.6.0 

type IAcl interface {
	alicloudroscdkcore.IResource
	// Attribute AclResourceType: The resource type.
	AttrAclResourceType() interface{}
	// Attribute InstanceId: The instance ID.
	AttrInstanceId() interface{}
	// Attribute Username: The username.
	AttrUsername() interface{}
	Props() *AclProps
}

Represents a `Acl`.

type IConsumerGroup added in v1.6.0 

type IConsumerGroup interface {
	alicloudroscdkcore.IResource
	// Attribute ConsumerId: Consumer group ID.
	AttrConsumerId() interface{}
	Props() *ConsumerGroupProps
}

Represents a `ConsumerGroup`.

type IInstance added in v1.6.0 

type IInstance interface {
	alicloudroscdkcore.IResource
	// Attribute DomainEndpoint: The default endpoints of the instance in domain name mode.
	AttrDomainEndpoint() interface{}
	// Attribute Endpoint: The SSL endpoints of the instance in IP address mode.
	AttrEndpoint() interface{}
	// Attribute InstanceId: Id of the instance.
	AttrInstanceId() interface{}
	// Attribute Name: Name of the instance.
	AttrName() interface{}
	// Attribute OrderId: Id of the order.
	AttrOrderId() interface{}
	// Attribute SaslDomainEndpoint: The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode.
	AttrSaslDomainEndpoint() interface{}
	// Attribute SslDomainEndpoint: The SSL endpoints of the instance in domain name mode.
	AttrSslDomainEndpoint() interface{}
	// Attribute SslEndpoint: The SSL endpoints of the instance in IP address mode.
	AttrSslEndpoint() interface{}
	Props() *InstanceProps
}

Represents a `Instance`.

type ISaslUser added in v1.6.0 

type ISaslUser interface {
	alicloudroscdkcore.IResource
	// Attribute InstanceId: The instance ID.
	AttrInstanceId() interface{}
	// Attribute Username: The user name of the instance.
	AttrUsername() interface{}
	Props() *SaslUserProps
}

Represents a `SaslUser`.

type ITopic added in v1.6.0 

type ITopic interface {
	alicloudroscdkcore.IResource
	// Attribute InstanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.
	//
	// You can call the GetInstanceList operation to query instances.
	AttrInstanceId() interface{}
	// Attribute Topic: Topic name.
	AttrTopic() interface{}
	Props() *TopicProps
}

Represents a `Topic`.

type Instance 

type Instance interface {
	alicloudroscdkcore.Resource
	IInstance
	// Attribute DomainEndpoint: The default endpoints of the instance in domain name mode.
	AttrDomainEndpoint() interface{}
	// Attribute Endpoint: The SSL endpoints of the instance in IP address mode.
	AttrEndpoint() interface{}
	// Attribute InstanceId: Id of the instance.
	AttrInstanceId() interface{}
	// Attribute Name: Name of the instance.
	AttrName() interface{}
	// Attribute OrderId: Id of the order.
	AttrOrderId() interface{}
	// Attribute SaslDomainEndpoint: The Simple Authentication and Security Layer (SASL) endpoints of the instance in domain name mode.
	AttrSaslDomainEndpoint() interface{}
	// Attribute SslDomainEndpoint: The SSL endpoints of the instance in domain name mode.
	AttrSslDomainEndpoint() interface{}
	// Attribute SslEndpoint: The SSL endpoints of the instance in IP address mode.
	AttrSslEndpoint() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *InstanceProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::KAFKA::Instance`, which is used to create an ApsaraMQ for Kafka instance.

func NewInstance 

func NewInstance(scope alicloudroscdkcore.Construct, id *string, props *InstanceProps, enableResourcePropertyConstraint *bool) Instance

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type InstanceProps 

type InstanceProps struct {
	// Property deployType: The deployment mode of the Message Queue for Apache Kafka instance.
	//
	// Valid values:
	//    4: Instance of the public type
	// 5: Instance of the VPC type.
	DeployType interface{} `field:"required" json:"deployType" yaml:"deployType"`
	// Property deletionForce: Whether delete all topics, consumer groups of the kafka instance and then delete instance.
	//
	// Default is false.
	DeletionForce interface{} `field:"optional" json:"deletionForce" yaml:"deletionForce"`
	// Property deployOption: If you want to deploy instance after create at once, the VSwitchId and DeployModule parameters is required.
	DeployOption interface{} `field:"optional" json:"deployOption" yaml:"deployOption"`
	// Property diskSize: The size of the disk to be configured for the Message Queue for Apache Kafka instance.
	DiskSize interface{} `field:"optional" json:"diskSize" yaml:"diskSize"`
	// Property diskType: The type of the disk to be configured for the Message Queue for Apache Kafka instance.
	//
	// Valid values:
	// 0: Ultra disk
	// 1: SSD.
	DiskType interface{} `field:"optional" json:"diskType" yaml:"diskType"`
	// Property eipMax: The public traffic to be configured for the Message Queue for Apache Kafka instance.
	//
	// This parameter must be specified when the DeployType parameter is set to 4.
	EipMax interface{} `field:"optional" json:"eipMax" yaml:"eipMax"`
	// Property ioMax: The peak traffic to be configured for the Message Queue for Apache Kafka instance.
	//
	// For more information about the value range, see Billing.
	IoMax interface{} `field:"optional" json:"ioMax" yaml:"ioMax"`
	// Property ioMaxSpec: Flow specification (recommended)  The IoMax and IoMaxSpec must be optional.
	//
	// When filling in at the same time, subject to IoMaxSpec.
	// It is recommended that you only fill in the flow specification.
	IoMaxSpec interface{} `field:"optional" json:"ioMaxSpec" yaml:"ioMaxSpec"`
	// Property openConnector: Whether open kafka connector or not.
	OpenConnector interface{} `field:"optional" json:"openConnector" yaml:"openConnector"`
	// Property partitionNum: Number of partitions(recommended).
	//
	// The number of partitions to be configured for the Message Queue for Apache Kafka instance.
	// PartitionNum and TopicQuota must be selected.
	// It is recommended that you only fill in the number of partitions.
	PartitionNum interface{} `field:"optional" json:"partitionNum" yaml:"partitionNum"`
	// Property payType: Pay by hour or month.
	PayType interface{} `field:"optional" json:"payType" yaml:"payType"`
	// Property serverlessConfig: Serverless instance related settings.
	ServerlessConfig interface{} `field:"optional" json:"serverlessConfig" yaml:"serverlessConfig"`
	// Property specType: The edition of the Message Queue for Apache Kafka instance.
	//
	// Valid values:
	// normal: Normal version
	// professional: Professional Edition (high writing edition)
	// professionalForHighRead: Professional Edition (high reading edition).
	SpecType interface{} `field:"optional" json:"specType" yaml:"specType"`
	// Property tags: Tags to attach to instance.
	//
	// Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
	Tags *[]*RosInstance_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
	// Property topicQuota: Number of topics (not recommended).
	//
	// The number of topics to be configured for the Message Queue for Apache Kafka instance.
	// PartitionNum and TopicQuota must be selected.
	// It is recommended that you only fill in the number of partitions.
	// The default value of this parameter varies with different peak traffic values.
	// Additional fees are charged if the default values are exceeded.
	//   Different specifications have different default values, and extra fees are charged.
	// For more information, see Billing.
	TopicQuota interface{} `field:"optional" json:"topicQuota" yaml:"topicQuota"`
}

Properties for defining a `Instance`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-instance

type RosAcl 

type RosAcl interface {
	alicloudroscdkcore.RosResource
	AclOperationTypes() interface{}
	SetAclOperationTypes(val interface{})
	AclPermissionType() interface{}
	SetAclPermissionType(val interface{})
	AclResourceName() interface{}
	SetAclResourceName(val interface{})
	AclResourcePatternType() interface{}
	SetAclResourcePatternType(val interface{})
	AclResourceType() interface{}
	SetAclResourceType(val interface{})
	AttrAclResourceType() alicloudroscdkcore.IResolvable
	AttrInstanceId() alicloudroscdkcore.IResolvable
	AttrUsername() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	Host() interface{}
	SetHost(val interface{})
	InstanceId() interface{}
	SetInstanceId(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	Username() interface{}
	SetUsername(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::KAFKA::Acl`, which is used to create an access control list (ACL).

func NewRosAcl 

func NewRosAcl(scope alicloudroscdkcore.Construct, id *string, props *RosAclProps, enableResourcePropertyConstraint *bool) RosAcl

type RosAclProps 

type RosAclProps struct {
	AclOperationTypes      interface{} `field:"required" json:"aclOperationTypes" yaml:"aclOperationTypes"`
	AclResourceName        interface{} `field:"required" json:"aclResourceName" yaml:"aclResourceName"`
	AclResourcePatternType interface{} `field:"required" json:"aclResourcePatternType" yaml:"aclResourcePatternType"`
	AclResourceType        interface{} `field:"required" json:"aclResourceType" yaml:"aclResourceType"`
	InstanceId             interface{} `field:"required" json:"instanceId" yaml:"instanceId"`
	Username               interface{} `field:"required" json:"username" yaml:"username"`
	AclPermissionType      interface{} `field:"optional" json:"aclPermissionType" yaml:"aclPermissionType"`
	Host                   interface{} `field:"optional" json:"host" yaml:"host"`
}

Properties for defining a `RosAcl`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-acl

type RosConsumerGroup 

type RosConsumerGroup interface {
	alicloudroscdkcore.RosResource
	AttrConsumerId() alicloudroscdkcore.IResolvable
	ConsumerId() interface{}
	SetConsumerId(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	InstanceId() interface{}
	SetInstanceId(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	Remark() interface{}
	SetRemark(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	Tags() *[]*RosConsumerGroup_TagsProperty
	SetTags(val *[]*RosConsumerGroup_TagsProperty)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::KAFKA::ConsumerGroup`, which is used to create a consumer group.

func NewRosConsumerGroup 

func NewRosConsumerGroup(scope alicloudroscdkcore.Construct, id *string, props *RosConsumerGroupProps, enableResourcePropertyConstraint *bool) RosConsumerGroup

type RosConsumerGroupProps 

type RosConsumerGroupProps struct {
	ConsumerId interface{}                       `field:"required" json:"consumerId" yaml:"consumerId"`
	InstanceId interface{}                       `field:"required" json:"instanceId" yaml:"instanceId"`
	Remark     interface{}                       `field:"optional" json:"remark" yaml:"remark"`
	Tags       *[]*RosConsumerGroup_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `RosConsumerGroup`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-consumergroup

type RosConsumerGroup_TagsProperty 

type RosConsumerGroup_TagsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

type RosInstance 

type RosInstance interface {
	alicloudroscdkcore.RosResource
	AttrDomainEndpoint() alicloudroscdkcore.IResolvable
	AttrEndpoint() alicloudroscdkcore.IResolvable
	AttrInstanceId() alicloudroscdkcore.IResolvable
	AttrName() alicloudroscdkcore.IResolvable
	AttrOrderId() alicloudroscdkcore.IResolvable
	AttrSaslDomainEndpoint() alicloudroscdkcore.IResolvable
	AttrSslDomainEndpoint() alicloudroscdkcore.IResolvable
	AttrSslEndpoint() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DeletionForce() interface{}
	SetDeletionForce(val interface{})
	DeployOption() interface{}
	SetDeployOption(val interface{})
	DeployType() interface{}
	SetDeployType(val interface{})
	DiskSize() interface{}
	SetDiskSize(val interface{})
	DiskType() interface{}
	SetDiskType(val interface{})
	EipMax() interface{}
	SetEipMax(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	IoMax() interface{}
	SetIoMax(val interface{})
	IoMaxSpec() interface{}
	SetIoMaxSpec(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	OpenConnector() interface{}
	SetOpenConnector(val interface{})
	PartitionNum() interface{}
	SetPartitionNum(val interface{})
	PayType() interface{}
	SetPayType(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	ServerlessConfig() interface{}
	SetServerlessConfig(val interface{})
	SpecType() interface{}
	SetSpecType(val interface{})
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	Tags() *[]*RosInstance_TagsProperty
	SetTags(val *[]*RosInstance_TagsProperty)
	TopicQuota() interface{}
	SetTopicQuota(val interface{})
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::KAFKA::Instance`, which is used to create an ApsaraMQ for Kafka instance.

func NewRosInstance 

func NewRosInstance(scope alicloudroscdkcore.Construct, id *string, props *RosInstanceProps, enableResourcePropertyConstraint *bool) RosInstance

type RosInstanceProps 

type RosInstanceProps struct {
	DeployType       interface{}                  `field:"required" json:"deployType" yaml:"deployType"`
	DeletionForce    interface{}                  `field:"optional" json:"deletionForce" yaml:"deletionForce"`
	DeployOption     interface{}                  `field:"optional" json:"deployOption" yaml:"deployOption"`
	DiskSize         interface{}                  `field:"optional" json:"diskSize" yaml:"diskSize"`
	DiskType         interface{}                  `field:"optional" json:"diskType" yaml:"diskType"`
	EipMax           interface{}                  `field:"optional" json:"eipMax" yaml:"eipMax"`
	IoMax            interface{}                  `field:"optional" json:"ioMax" yaml:"ioMax"`
	IoMaxSpec        interface{}                  `field:"optional" json:"ioMaxSpec" yaml:"ioMaxSpec"`
	OpenConnector    interface{}                  `field:"optional" json:"openConnector" yaml:"openConnector"`
	PartitionNum     interface{}                  `field:"optional" json:"partitionNum" yaml:"partitionNum"`
	PayType          interface{}                  `field:"optional" json:"payType" yaml:"payType"`
	ServerlessConfig interface{}                  `field:"optional" json:"serverlessConfig" yaml:"serverlessConfig"`
	SpecType         interface{}                  `field:"optional" json:"specType" yaml:"specType"`
	Tags             *[]*RosInstance_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
	TopicQuota       interface{}                  `field:"optional" json:"topicQuota" yaml:"topicQuota"`
}

Properties for defining a `RosInstance`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-instance

type RosInstance_DeployOptionProperty 

type RosInstance_DeployOptionProperty struct {
	DeployModule         interface{} `field:"required" json:"deployModule" yaml:"deployModule"`
	VSwitchId            interface{} `field:"required" json:"vSwitchId" yaml:"vSwitchId"`
	Config               interface{} `field:"optional" json:"config" yaml:"config"`
	CrossZone            interface{} `field:"optional" json:"crossZone" yaml:"crossZone"`
	IsEipInner           interface{} `field:"optional" json:"isEipInner" yaml:"isEipInner"`
	IsForceSelectedZones interface{} `field:"optional" json:"isForceSelectedZones" yaml:"isForceSelectedZones"`
	IsSetUserAndPassword interface{} `field:"optional" json:"isSetUserAndPassword" yaml:"isSetUserAndPassword"`
	KmsKeyId             interface{} `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
	Name                 interface{} `field:"optional" json:"name" yaml:"name"`
	Notifier             interface{} `field:"optional" json:"notifier" yaml:"notifier"`
	Password             interface{} `field:"optional" json:"password" yaml:"password"`
	SecurityGroup        interface{} `field:"optional" json:"securityGroup" yaml:"securityGroup"`
	SelectedZones        interface{} `field:"optional" json:"selectedZones" yaml:"selectedZones"`
	ServiceVersion       interface{} `field:"optional" json:"serviceVersion" yaml:"serviceVersion"`
	Username             interface{} `field:"optional" json:"username" yaml:"username"`
	UserPhoneNum         interface{} `field:"optional" json:"userPhoneNum" yaml:"userPhoneNum"`
	VpcId                interface{} `field:"optional" json:"vpcId" yaml:"vpcId"`
	VSwitchIds           interface{} `field:"optional" json:"vSwitchIds" yaml:"vSwitchIds"`
	ZoneId               interface{} `field:"optional" json:"zoneId" yaml:"zoneId"`
}

type RosInstance_ServerlessConfigProperty 

type RosInstance_ServerlessConfigProperty struct {
	ReservedPublishCapacity   interface{} `field:"required" json:"reservedPublishCapacity" yaml:"reservedPublishCapacity"`
	ReservedSubscribeCapacity interface{} `field:"required" json:"reservedSubscribeCapacity" yaml:"reservedSubscribeCapacity"`
}

type RosInstance_TagsProperty 

type RosInstance_TagsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

type RosSaslUser 

type RosSaslUser interface {
	alicloudroscdkcore.RosResource
	AttrInstanceId() alicloudroscdkcore.IResolvable
	AttrUsername() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	InstanceId() interface{}
	SetInstanceId(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	Mechanism() interface{}
	SetMechanism(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	Password() interface{}
	SetPassword(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	Type() interface{}
	SetType(val interface{})
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	Username() interface{}
	SetUsername(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::KAFKA::SaslUser`, which is used to create a Simple Authentication and Security Layer (SASL) user.

func NewRosSaslUser 

func NewRosSaslUser(scope alicloudroscdkcore.Construct, id *string, props *RosSaslUserProps, enableResourcePropertyConstraint *bool) RosSaslUser

type RosSaslUserProps 

type RosSaslUserProps struct {
	InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"`
	Password   interface{} `field:"required" json:"password" yaml:"password"`
	Username   interface{} `field:"required" json:"username" yaml:"username"`
	Mechanism  interface{} `field:"optional" json:"mechanism" yaml:"mechanism"`
	Type       interface{} `field:"optional" json:"type" yaml:"type"`
}

Properties for defining a `RosSaslUser`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-sasluser

type RosTopic 

type RosTopic interface {
	alicloudroscdkcore.RosResource
	AttrInstanceId() alicloudroscdkcore.IResolvable
	AttrTopic() alicloudroscdkcore.IResolvable
	CompactTopic() interface{}
	SetCompactTopic(val interface{})
	Config() interface{}
	SetConfig(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	InstanceId() interface{}
	SetInstanceId(val interface{})
	LocalTopic() interface{}
	SetLocalTopic(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	MinInsyncReplicas() interface{}
	SetMinInsyncReplicas(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	PartitionNum() interface{}
	SetPartitionNum(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	Remark() interface{}
	SetRemark(val interface{})
	ReplicationFactor() interface{}
	SetReplicationFactor(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	Tags() *[]*RosTopic_TagsProperty
	SetTags(val *[]*RosTopic_TagsProperty)
	Topic() interface{}
	SetTopic(val interface{})
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::KAFKA::Topic`, which is used to create a topic.

func NewRosTopic 

func NewRosTopic(scope alicloudroscdkcore.Construct, id *string, props *RosTopicProps, enableResourcePropertyConstraint *bool) RosTopic

type RosTopicProps 

type RosTopicProps struct {
	InstanceId        interface{}               `field:"required" json:"instanceId" yaml:"instanceId"`
	Remark            interface{}               `field:"required" json:"remark" yaml:"remark"`
	Topic             interface{}               `field:"required" json:"topic" yaml:"topic"`
	CompactTopic      interface{}               `field:"optional" json:"compactTopic" yaml:"compactTopic"`
	Config            interface{}               `field:"optional" json:"config" yaml:"config"`
	LocalTopic        interface{}               `field:"optional" json:"localTopic" yaml:"localTopic"`
	MinInsyncReplicas interface{}               `field:"optional" json:"minInsyncReplicas" yaml:"minInsyncReplicas"`
	PartitionNum      interface{}               `field:"optional" json:"partitionNum" yaml:"partitionNum"`
	ReplicationFactor interface{}               `field:"optional" json:"replicationFactor" yaml:"replicationFactor"`
	Tags              *[]*RosTopic_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `RosTopic`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-topic

type RosTopic_TagsProperty 

type RosTopic_TagsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

type SaslUser 

type SaslUser interface {
	alicloudroscdkcore.Resource
	ISaslUser
	// Attribute InstanceId: The instance ID.
	AttrInstanceId() interface{}
	// Attribute Username: The user name of the instance.
	AttrUsername() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *SaslUserProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::KAFKA::SaslUser`, which is used to create a Simple Authentication and Security Layer (SASL) user.

func NewSaslUser 

func NewSaslUser(scope alicloudroscdkcore.Construct, id *string, props *SaslUserProps, enableResourcePropertyConstraint *bool) SaslUser

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type SaslUserProps 

type SaslUserProps struct {
	// Property instanceId: The instance ID.
	InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"`
	// Property password: The password of the SASL user.
	Password interface{} `field:"required" json:"password" yaml:"password"`
	// Property username: The name of the SASL user.
	Username interface{} `field:"required" json:"username" yaml:"username"`
	// Property mechanism: The encryption method.
	//
	// Valid values:
	// SCRAM-SHA-512 (default)
	// SCRAM-SHA-256
	// Note
	// This parameter is available only for ApsaraMQ for Kafka V3 serverless instances.
	Mechanism interface{} `field:"optional" json:"mechanism" yaml:"mechanism"`
	// Property type: The type of the Simple Authentication and Security Layer (SASL) user.
	//
	// Valid values:
	// plain: a simple mechanism that uses usernames and passwords to verify user identities. ApsaraMQ for Kafka provides an improved PLAIN mechanism that allows you to dynamically add SASL users without the need to restart an instance.
	// SCRAM: a mechanism that uses usernames and passwords to verify user identities. Compared with the PLAIN mechanism, this mechanism provides better security protection. ApsaraMQ for Kafka uses the SCRAM-SHA-256 algorithm.
	// LDAP: This value is available only for the SASL users of ApsaraMQ for Confluent instances.
	// Default value: plain.
	Type interface{} `field:"optional" json:"type" yaml:"type"`
}

Properties for defining a `SaslUser`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-sasluser

type Topic 

type Topic interface {
	alicloudroscdkcore.Resource
	ITopic
	// Attribute InstanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.
	//
	// You can call the GetInstanceList operation to query instances.
	AttrInstanceId() interface{}
	// Attribute Topic: Topic name.
	AttrTopic() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *TopicProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::KAFKA::Topic`, which is used to create a topic.

func NewTopic 

func NewTopic(scope alicloudroscdkcore.Construct, id *string, props *TopicProps, enableResourcePropertyConstraint *bool) Topic

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type TopicProps 

type TopicProps struct {
	// Property instanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.
	//
	// You can call the GetInstanceList operation to query instances.
	InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"`
	// Property remark: The description of the topic.
	//
	// The value of this parameter must meet the following
	// requirements:
	// The value can only contain letters, digits, hyphens (-), and underscores (_).
	// The value must be 3 to 64 characters in length.
	Remark interface{} `field:"required" json:"remark" yaml:"remark"`
	// Property topic: The name of the topic.
	//
	// The value of this parameter must meet the following requirements:
	// The name can only contain letters, digits, hyphens (-), and underscores (_).
	// The name must be 3 to 64 characters in length, and will be automatically truncated
	// if it contains more characters.
	// The name cannot be modified after being created.
	Topic interface{} `field:"required" json:"topic" yaml:"topic"`
	// Property compactTopic: The log cleanup policy for the topic.
	//
	// This parameter is available when the Local Storage mode is specified for the topic. Valid values:
	// false: uses the default log cleanup policy.
	// true: uses the Apache Kafka log compaction policy.
	CompactTopic interface{} `field:"optional" json:"compactTopic" yaml:"compactTopic"`
	// Property config: Supplementary configuration.
	//
	// Currently supports Key as replications. Indicates the number of Topic copies, the value type is Integer, and the value limit is 1~3.
	// This parameter can only be specified if the LocalTopic value is true.
	// NOTE If replications is specified in this parameter, the specified ReplicationFactor parameter no longer takes effect.
	Config interface{} `field:"optional" json:"config" yaml:"config"`
	// Property localTopic: The storage engine of the topic.
	//
	// Valid values:
	// false: the Cloud Storage mode.
	// true: the Local Storage mode.
	LocalTopic interface{} `field:"optional" json:"localTopic" yaml:"localTopic"`
	// Property minInsyncReplicas: The minimum number of ISR sync replicas.
	//
	// This parameter can only be specified if the LocalTopic value is true.
	// The value must be less than the number of Topic copies.
	// The number of synchronous replicas is limited to 1~3.
	MinInsyncReplicas interface{} `field:"optional" json:"minInsyncReplicas" yaml:"minInsyncReplicas"`
	// Property partitionNum: The number of partitions in the topic.
	//
	// Valid values:
	// 1 to 48
	// We recommend that you set the number of partitions to a multiple of 6 to reduce the
	// risk of data skew.Note:For special requirements,submit a ticket.
	PartitionNum interface{} `field:"optional" json:"partitionNum" yaml:"partitionNum"`
	// Property replicationFactor: The number of copies of the topic.
	//
	// This parameter can only be specified if the LocalTopic value is true.
	// The number of copies is limited to 1~3.
	// Note When the number of replicas is 1, there is a risk of data loss. Please set it carefully.
	ReplicationFactor interface{} `field:"optional" json:"replicationFactor" yaml:"replicationFactor"`
	// Property tags: Tags to attach to instance.
	//
	// Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
	Tags *[]*RosTopic_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `Topic`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-topic

Source Files

View all Source files

Directories

Path Synopsis
internal
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.