Documentation ¶
Index ¶
- func Instance_IsConstruct(x interface{}) *bool
- func Instances_IsConstruct(x interface{}) *bool
- func NewInstance_Override(i Instance, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewInstances_Override(i Instances, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosInstance_Override(r RosInstance, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosInstances_Override(r RosInstances, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosTopic_Override(r RosTopic, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosTopics_Override(r RosTopics, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewTopic_Override(t Topic, scope alicloudroscdkcore.Construct, id *string, props *TopicProps, ...)
- func NewTopics_Override(t Topics, scope alicloudroscdkcore.Construct, id *string, props *TopicsProps, ...)
- func RosInstance_IsConstruct(x interface{}) *bool
- func RosInstance_IsRosElement(x interface{}) *bool
- func RosInstance_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosInstance_ROS_RESOURCE_TYPE_NAME() *string
- func RosInstances_IsConstruct(x interface{}) *bool
- func RosInstances_IsRosElement(x interface{}) *bool
- func RosInstances_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosInstances_ROS_RESOURCE_TYPE_NAME() *string
- func RosTopic_IsConstruct(x interface{}) *bool
- func RosTopic_IsRosElement(x interface{}) *bool
- func RosTopic_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosTopic_ROS_RESOURCE_TYPE_NAME() *string
- func RosTopics_IsConstruct(x interface{}) *bool
- func RosTopics_IsRosElement(x interface{}) *bool
- func RosTopics_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosTopics_ROS_RESOURCE_TYPE_NAME() *string
- func Topic_IsConstruct(x interface{}) *bool
- func Topics_IsConstruct(x interface{}) *bool
- type IInstance
- type IInstances
- type ITopic
- type ITopics
- type Instance
- type InstanceProps
- type Instances
- type InstancesProps
- type RosInstance
- type RosInstanceProps
- type RosInstances
- type RosInstancesProps
- type RosTopic
- type RosTopicProps
- type RosTopics
- type RosTopicsProps
- type Topic
- type TopicProps
- type Topics
- type TopicsProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Instance_IsConstruct ¶
func Instance_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Instances_IsConstruct ¶
func Instances_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
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 NewInstances_Override ¶
func NewInstances_Override(i Instances, scope alicloudroscdkcore.Construct, id *string, props *InstancesProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewRosInstance_Override ¶
func NewRosInstance_Override(r RosInstance, scope alicloudroscdkcore.Construct, id *string, props *RosInstanceProps, enableResourcePropertyConstraint *bool)
func NewRosInstances_Override ¶
func NewRosInstances_Override(r RosInstances, scope alicloudroscdkcore.Construct, id *string, props *RosInstancesProps, enableResourcePropertyConstraint *bool)
func NewRosTopic_Override ¶
func NewRosTopic_Override(r RosTopic, scope alicloudroscdkcore.Construct, id *string, props *RosTopicProps, enableResourcePropertyConstraint *bool)
func NewRosTopics_Override ¶
func NewRosTopics_Override(r RosTopics, scope alicloudroscdkcore.Construct, id *string, props *RosTopicsProps, enableResourcePropertyConstraint *bool)
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 NewTopics_Override ¶
func NewTopics_Override(t Topics, scope alicloudroscdkcore.Construct, id *string, props *TopicsProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
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 RosInstances_IsConstruct ¶
func RosInstances_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosInstances_IsRosElement ¶
func RosInstances_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 RosInstances_IsRosResource ¶
func RosInstances_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosInstances_ROS_RESOURCE_TYPE_NAME ¶
func RosInstances_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 RosTopics_IsConstruct ¶
func RosTopics_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosTopics_IsRosElement ¶
func RosTopics_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 RosTopics_IsRosResource ¶
func RosTopics_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosTopics_ROS_RESOURCE_TYPE_NAME ¶
func RosTopics_ROS_RESOURCE_TYPE_NAME() *string
func Topic_IsConstruct ¶
func Topic_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Topics_IsConstruct ¶
func Topics_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
Types ¶
type IInstance ¶ added in v1.6.0
type IInstance interface { alicloudroscdkcore.IResource // Attribute AllConfig: The current configuration of the deployed message queue Kafka version. AttrAllConfig() interface{} // Attribute AllowedList: White list. AttrAllowedList() interface{} // Attribute CreateTime: Creation time. AttrCreateTime() interface{} // Attribute DeployType: Deployment method. AttrDeployType() interface{} // Attribute DiskSize: Disk size. AttrDiskSize() interface{} // Attribute DiskType: Disk type. AttrDiskType() interface{} // Attribute DomainEndpoint: The domain name access point of the default access point. // // The Kafka instance supports domain name access points and IP access points. AttrDomainEndpoint() interface{} // Attribute EipMax: Peak public network traffic. AttrEipMax() interface{} // Attribute EndPoint: Access point. AttrEndPoint() interface{} // Attribute ExpiredTime: Expiration time. AttrExpiredTime() interface{} // Attribute InstanceId: The ID of the instance. AttrInstanceId() interface{} // Attribute InstanceName: Note name. AttrInstanceName() interface{} // Attribute IoMax: Peak flow. AttrIoMax() interface{} // Attribute IoMaxSpec: Flow specifications (recommended). AttrIoMaxSpec() interface{} // Attribute MsgRetain: Message save time. AttrMsgRetain() interface{} // Attribute PaymentType: The paymen type of the resource. AttrPaymentType() interface{} // Attribute ResourceGroupId: The ID of the resource group. AttrResourceGroupId() interface{} // Attribute SaslDomainEndpoint: The domain name access point of the SASL access point. // // The Kafka instance supports domain name access points and IP access points. AttrSaslDomainEndpoint() interface{} // Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue. // // The value is 0.10.2 or 2.2.0. AttrServiceVersion() interface{} // Attribute SpecType: Instance type. AttrSpecType() interface{} // Attribute SslDomainEndpoint: The domain name of the SSL access point. // // The Kafka instance supports domain name access points and IP access points. AttrSslDomainEndpoint() interface{} // Attribute SslEndPoint: External access point. AttrSslEndPoint() interface{} // Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption. AttrTags() interface{} // Attribute TopicNumLimit: Maximum number of topic creation. AttrTopicNumLimit() interface{} // Attribute VpcId: VpcId. AttrVpcId() interface{} // Attribute VSwitchId: Switch id. AttrVSwitchId() interface{} // Attribute ZoneId: The ID of the zone in which the instance is deployed. AttrZoneId() interface{} Props() *InstanceProps }
Represents a `Instance`.
type IInstances ¶ added in v1.6.0
type IInstances interface { alicloudroscdkcore.IResource // Attribute InstanceIds: The list of instance IDs. AttrInstanceIds() interface{} // Attribute Instances: The list of instances. AttrInstances() interface{} Props() *InstancesProps }
Represents a `Instances`.
type ITopic ¶ added in v1.6.0
type ITopic interface { alicloudroscdkcore.IResource // Attribute CompactTopic: Can log merge. AttrCompactTopic() interface{} // Attribute CreateTime: Creation time. AttrCreateTime() interface{} // Attribute InstanceId: Resource id. AttrInstanceId() interface{} // Attribute LocalTopic: Whether to store locally. AttrLocalTopic() interface{} // Attribute PartitionNum: Number of partitions. AttrPartitionNum() interface{} // Attribute Remark: Remarks. AttrRemark() interface{} // Attribute StatusName: Meaning of status value. AttrStatusName() interface{} // Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption. AttrTags() interface{} // Attribute Topic: Topic Name. AttrTopic() interface{} // Attribute TopicStatus: The Topic status. AttrTopicStatus() interface{} Props() *TopicProps }
Represents a `Topic`.
type ITopics ¶ added in v1.6.0
type ITopics interface { alicloudroscdkcore.IResource // Attribute Topics: The list of topics. AttrTopics() interface{} Props() *TopicsProps }
Represents a `Topics`.
type Instance ¶
type Instance interface { alicloudroscdkcore.Resource IInstance // Attribute AllConfig: The current configuration of the deployed message queue Kafka version. AttrAllConfig() interface{} // Attribute AllowedList: White list. AttrAllowedList() interface{} // Attribute CreateTime: Creation time. AttrCreateTime() interface{} // Attribute DeployType: Deployment method. AttrDeployType() interface{} // Attribute DiskSize: Disk size. AttrDiskSize() interface{} // Attribute DiskType: Disk type. AttrDiskType() interface{} // Attribute DomainEndpoint: The domain name access point of the default access point. // // The Kafka instance supports domain name access points and IP access points. AttrDomainEndpoint() interface{} // Attribute EipMax: Peak public network traffic. AttrEipMax() interface{} // Attribute EndPoint: Access point. AttrEndPoint() interface{} // Attribute ExpiredTime: Expiration time. AttrExpiredTime() interface{} // Attribute InstanceId: The ID of the instance. AttrInstanceId() interface{} // Attribute InstanceName: Note name. AttrInstanceName() interface{} // Attribute IoMax: Peak flow. AttrIoMax() interface{} // Attribute IoMaxSpec: Flow specifications (recommended). AttrIoMaxSpec() interface{} // Attribute MsgRetain: Message save time. AttrMsgRetain() interface{} // Attribute PaymentType: The paymen type of the resource. AttrPaymentType() interface{} // Attribute ResourceGroupId: The ID of the resource group. AttrResourceGroupId() interface{} // Attribute SaslDomainEndpoint: The domain name access point of the SASL access point. // // The Kafka instance supports domain name access points and IP access points. AttrSaslDomainEndpoint() interface{} // Attribute ServiceVersion: The version of the Kafka version of the deployed Message Queue. // // The value is 0.10.2 or 2.2.0. AttrServiceVersion() interface{} // Attribute SpecType: Instance type. AttrSpecType() interface{} // Attribute SslDomainEndpoint: The domain name of the SSL access point. // // The Kafka instance supports domain name access points and IP access points. AttrSslDomainEndpoint() interface{} // Attribute SslEndPoint: External access point. AttrSslEndPoint() interface{} // Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption. AttrTags() interface{} // Attribute TopicNumLimit: Maximum number of topic creation. AttrTopicNumLimit() interface{} // Attribute VpcId: VpcId. AttrVpcId() interface{} // Attribute VSwitchId: Switch id. AttrVSwitchId() interface{} // Attribute ZoneId: The ID of the zone in which the instance is deployed. AttrZoneId() 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 `DATASOURCE::KAFKA::Instance`, which is used to query the information about 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 instanceId: The ID of the instance. InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` // Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. // // Valid values: // - Never: Never refresh the datasource resource when the stack is updated. // - Always: Always refresh the datasource resource when the stack is updated. // Default is Never. RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `Instance`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-kafka-instance
type Instances ¶
type Instances interface { alicloudroscdkcore.Resource IInstances // Attribute InstanceIds: The list of instance IDs. AttrInstanceIds() interface{} // Attribute Instances: The list of instances. AttrInstances() 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() *InstancesProps 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 `DATASOURCE::KAFKA::Instances`, which is used to query the information about ApsaraMQ for Kafka instances.
func NewInstances ¶
func NewInstances(scope alicloudroscdkcore.Construct, id *string, props *InstancesProps, enableResourcePropertyConstraint *bool) Instances
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type InstancesProps ¶
type InstancesProps struct { // Property instanceId: The ID of the instance. InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` // Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. // // Valid values: // - Never: Never refresh the datasource resource when the stack is updated. // - Always: Always refresh the datasource resource when the stack is updated. // Default is Never. RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` // Property resourceGroupId: The ID of the resource group. ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"` }
Properties for defining a `Instances`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-kafka-instances
type RosInstance ¶
type RosInstance interface { alicloudroscdkcore.RosResource AttrAllConfig() alicloudroscdkcore.IResolvable AttrAllowedList() alicloudroscdkcore.IResolvable AttrCreateTime() alicloudroscdkcore.IResolvable AttrDeployType() alicloudroscdkcore.IResolvable AttrDiskSize() alicloudroscdkcore.IResolvable AttrDiskType() alicloudroscdkcore.IResolvable AttrDomainEndpoint() alicloudroscdkcore.IResolvable AttrEipMax() alicloudroscdkcore.IResolvable AttrEndPoint() alicloudroscdkcore.IResolvable AttrExpiredTime() alicloudroscdkcore.IResolvable AttrInstanceId() alicloudroscdkcore.IResolvable AttrInstanceName() alicloudroscdkcore.IResolvable AttrIoMax() alicloudroscdkcore.IResolvable AttrIoMaxSpec() alicloudroscdkcore.IResolvable AttrMsgRetain() alicloudroscdkcore.IResolvable AttrPaymentType() alicloudroscdkcore.IResolvable AttrResourceGroupId() alicloudroscdkcore.IResolvable AttrSaslDomainEndpoint() alicloudroscdkcore.IResolvable AttrServiceVersion() alicloudroscdkcore.IResolvable AttrSpecType() alicloudroscdkcore.IResolvable AttrSslDomainEndpoint() alicloudroscdkcore.IResolvable AttrSslEndPoint() alicloudroscdkcore.IResolvable AttrTags() alicloudroscdkcore.IResolvable AttrTopicNumLimit() alicloudroscdkcore.IResolvable AttrVpcId() alicloudroscdkcore.IResolvable AttrVSwitchId() alicloudroscdkcore.IResolvable AttrZoneId() 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 // 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 RefreshOptions() interface{} SetRefreshOptions(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 // 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 `DATASOURCE::KAFKA::Instance`, which is used to query the information about an ApsaraMQ for Kafka instance.
func NewRosInstance ¶
func NewRosInstance(scope alicloudroscdkcore.Construct, id *string, props *RosInstanceProps, enableResourcePropertyConstraint *bool) RosInstance
type RosInstanceProps ¶
type RosInstanceProps struct { InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosInstance`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-kafka-instance
type RosInstances ¶
type RosInstances interface { alicloudroscdkcore.RosResource AttrInstanceIds() alicloudroscdkcore.IResolvable AttrInstances() 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 // 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 RefreshOptions() interface{} SetRefreshOptions(val interface{}) ResourceGroupId() interface{} SetResourceGroupId(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 // 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 `DATASOURCE::KAFKA::Instances`, which is used to query the information about ApsaraMQ for Kafka instances.
func NewRosInstances ¶
func NewRosInstances(scope alicloudroscdkcore.Construct, id *string, props *RosInstancesProps, enableResourcePropertyConstraint *bool) RosInstances
type RosInstancesProps ¶
type RosInstancesProps struct { InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"` }
Properties for defining a `RosInstances`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-kafka-instances
type RosTopic ¶
type RosTopic interface { alicloudroscdkcore.RosResource AttrCompactTopic() alicloudroscdkcore.IResolvable AttrCreateTime() alicloudroscdkcore.IResolvable AttrInstanceId() alicloudroscdkcore.IResolvable AttrLocalTopic() alicloudroscdkcore.IResolvable AttrPartitionNum() alicloudroscdkcore.IResolvable AttrRemark() alicloudroscdkcore.IResolvable AttrStatusName() alicloudroscdkcore.IResolvable AttrTags() alicloudroscdkcore.IResolvable AttrTopic() alicloudroscdkcore.IResolvable AttrTopicStatus() 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 // 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 RefreshOptions() interface{} SetRefreshOptions(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 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 `DATASOURCE::KAFKA::Topic`, which is used to query the information about 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"` Topic interface{} `field:"required" json:"topic" yaml:"topic"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosTopic`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-kafka-topic
type RosTopics ¶
type RosTopics interface { alicloudroscdkcore.RosResource AttrTopics() 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 // 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 RefreshOptions() interface{} SetRefreshOptions(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 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 `DATASOURCE::KAFKA::Topics`, which is used to query the information about topics.
func NewRosTopics ¶
func NewRosTopics(scope alicloudroscdkcore.Construct, id *string, props *RosTopicsProps, enableResourcePropertyConstraint *bool) RosTopics
type RosTopicsProps ¶
type RosTopicsProps struct { InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` Topic interface{} `field:"required" json:"topic" yaml:"topic"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosTopics`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-kafka-topics
type Topic ¶
type Topic interface { alicloudroscdkcore.Resource ITopic // Attribute CompactTopic: Can log merge. AttrCompactTopic() interface{} // Attribute CreateTime: Creation time. AttrCreateTime() interface{} // Attribute InstanceId: Resource id. AttrInstanceId() interface{} // Attribute LocalTopic: Whether to store locally. AttrLocalTopic() interface{} // Attribute PartitionNum: Number of partitions. AttrPartitionNum() interface{} // Attribute Remark: Remarks. AttrRemark() interface{} // Attribute StatusName: Meaning of status value. AttrStatusName() interface{} // Attribute Tags: The tag of the kafka console, which is used to group instance,topic, and consumption. AttrTags() interface{} // Attribute Topic: Topic Name. AttrTopic() interface{} // Attribute TopicStatus: The Topic status. AttrTopicStatus() 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 `DATASOURCE::KAFKA::Topic`, which is used to query the information about 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: Resource id. InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` // Property topic: Topic Name. Topic interface{} `field:"required" json:"topic" yaml:"topic"` // Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. // // Valid values: // - Never: Never refresh the datasource resource when the stack is updated. // - Always: Always refresh the datasource resource when the stack is updated. // Default is Never. RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `Topic`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-kafka-topic
type Topics ¶
type Topics interface { alicloudroscdkcore.Resource ITopics // Attribute Topics: The list of topics. AttrTopics() 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() *TopicsProps 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 `DATASOURCE::KAFKA::Topics`, which is used to query the information about topics.
func NewTopics ¶
func NewTopics(scope alicloudroscdkcore.Construct, id *string, props *TopicsProps, enableResourcePropertyConstraint *bool) Topics
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type TopicsProps ¶
type TopicsProps struct { // Property instanceId: Resource id. InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` // Property topic: Topic Name. Topic interface{} `field:"required" json:"topic" yaml:"topic"` // Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. // // Valid values: // - Never: Never refresh the datasource resource when the stack is updated. // - Always: Always refresh the datasource resource when the stack is updated. // Default is Never. RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `Topics`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-kafka-topics
Source Files ¶
- IInstance.go
- IInstances.go
- ITopic.go
- ITopics.go
- Instance.go
- InstanceProps.go
- Instance__checks.go
- Instances.go
- InstancesProps.go
- Instances__checks.go
- RosInstance.go
- RosInstanceProps.go
- RosInstance__checks.go
- RosInstances.go
- RosInstancesProps.go
- RosInstances__checks.go
- RosTopic.go
- RosTopicProps.go
- RosTopic__checks.go
- RosTopics.go
- RosTopicsProps.go
- RosTopics__checks.go
- Topic.go
- TopicProps.go
- Topic__checks.go
- Topics.go
- TopicsProps.go
- Topics__checks.go
- main.go