Documentation ¶
Index ¶
- func Groups_IsConstruct(x interface{}) *bool
- func Instance_IsConstruct(x interface{}) *bool
- func Instances_IsConstruct(x interface{}) *bool
- func NewGroups_Override(g Groups, scope alicloudroscdkcore.Construct, id *string, props *GroupsProps, ...)
- func NewInstance_Override(i Instance, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewInstances_Override(i Instances, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosGroups_Override(r RosGroups, 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 RosGroups_IsConstruct(x interface{}) *bool
- func RosGroups_IsRosElement(x interface{}) *bool
- func RosGroups_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosGroups_ROS_RESOURCE_TYPE_NAME() *string
- 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 Groups
- type GroupsProps
- type IGroups
- type IInstance
- type IInstances
- type ITopic
- type ITopics
- type Instance
- type InstanceProps
- type Instances
- type InstancesProps
- type RosGroups
- type RosGroupsProps
- 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 Groups_IsConstruct ¶
func Groups_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 Instances_IsConstruct ¶
func Instances_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func NewGroups_Override ¶
func NewGroups_Override(g Groups, scope alicloudroscdkcore.Construct, id *string, props *GroupsProps, 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 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 NewRosGroups_Override ¶
func NewRosGroups_Override(r RosGroups, scope alicloudroscdkcore.Construct, id *string, props *RosGroupsProps, enableResourcePropertyConstraint *bool)
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 RosGroups_IsConstruct ¶
func RosGroups_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosGroups_IsRosElement ¶
func RosGroups_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 RosGroups_IsRosResource ¶
func RosGroups_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosGroups_ROS_RESOURCE_TYPE_NAME ¶
func RosGroups_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 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 Groups ¶
type Groups interface { alicloudroscdkcore.Resource IGroups // Attribute GroupNames: The list of group names. AttrGroupNames() interface{} // Attribute Groups: The list of groups. AttrGroups() 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() *GroupsProps 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::ROCKETMQ::Groups`, which is used to query groups.
func NewGroups ¶
func NewGroups(scope alicloudroscdkcore.Construct, id *string, props *GroupsProps, enableResourcePropertyConstraint *bool) Groups
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type GroupsProps ¶
type GroupsProps struct { // Property groupName: GroupName. GroupName interface{} `field:"optional" json:"groupName" yaml:"groupName"` // Property groupType: GroupType. GroupType interface{} `field:"optional" json:"groupType" yaml:"groupType"` // Property instanceId: InstanceId. 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"` }
Properties for defining a `Groups`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-rocketmq-groups
type IGroups ¶ added in v1.6.0
type IGroups interface { alicloudroscdkcore.IResource // Attribute GroupNames: The list of group names. AttrGroupNames() interface{} // Attribute Groups: The list of groups. AttrGroups() interface{} Props() *GroupsProps }
Represents a `Groups`.
type IInstance ¶ added in v1.6.0
type IInstance interface { alicloudroscdkcore.IResource // Attribute AccountInfo: The account information. AttrAccountInfo() interface{} // Attribute AclInfo: The information about access control. AttrAclInfo() interface{} // Attribute CommodityCode: The commodity code of the instance. // // The commodity code of a ApsaraMQ for RocketMQ 5.0 instance has a similar format as ons_rmqsub_public_cn. AttrCommodityCode() interface{} // Attribute CreateTime: The time when the instance was created. AttrCreateTime() interface{} // Attribute ExpireTime: The time when the instance expires. AttrExpireTime() interface{} // Attribute GroupCount: The number of groups. AttrGroupCount() interface{} // Attribute InstanceId: The ID of the RocketMQ instance. AttrInstanceId() interface{} // Attribute InstanceName: The name of instance. AttrInstanceName() interface{} // Attribute InstanceQuotas: The instance quotas. AttrInstanceQuotas() interface{} // Attribute NetworkInfo: Instance network configuration information. AttrNetworkInfo() interface{} // Attribute PaymentType: The billing method of the instance. AttrPaymentType() interface{} // Attribute ProductInfo: The extended configurations of the instance. AttrProductInfo() interface{} // Attribute ReleaseTime: The time when the instance was released. AttrReleaseTime() interface{} // Attribute Remark: The description of the instance. AttrRemark() interface{} // Attribute ResourceGroupId: The ID of the resource group. AttrResourceGroupId() interface{} // Attribute SeriesCode: The primary edition of the instance. AttrSeriesCode() interface{} // Attribute ServiceCode: The code of the service to which the instance belongs. // // The service code of ApsaraMQ for RocketMQ is rmq. AttrServiceCode() interface{} // Attribute Software: The instance software information. AttrSoftware() interface{} // Attribute StartTime: The time when the instance was started. AttrStartTime() interface{} // Attribute SubSeriesCode: The sub-category edition of the instance. // // For information about the differences between sub-category edition instances. AttrSubSeriesCode() interface{} // Attribute Tags: The tags of the RocketMQ instance. AttrTags() interface{} // Attribute TopicCount: The number of topics. AttrTopicCount() interface{} // Attribute UpdateTime: The time when the instance was last modified. AttrUpdateTime() interface{} // Attribute UserId: The ID of the user who owns the instance. AttrUserId() 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 CreateTime: The time when the topic was created. AttrCreateTime() interface{} // Attribute InstanceId: The ID of the instance to which the topic belongs. AttrInstanceId() interface{} // Attribute MessageType: The message type of the topic. AttrMessageType() interface{} // Attribute Remark: The remarks on the topic. AttrRemark() interface{} // Attribute TopicName: The name of the topic. AttrTopicName() interface{} // Attribute UpdateTime: The time when the topic was last updated. AttrUpdateTime() interface{} Props() *TopicProps }
Represents a `Topic`.
type ITopics ¶ added in v1.6.0
type ITopics interface { alicloudroscdkcore.IResource // Attribute TopicNames: The list of topic names. AttrTopicNames() interface{} // Attribute Topics: The list of topics. AttrTopics() interface{} Props() *TopicsProps }
Represents a `Topics`.
type Instance ¶
type Instance interface { alicloudroscdkcore.Resource IInstance // Attribute AccountInfo: The account information. AttrAccountInfo() interface{} // Attribute AclInfo: The information about access control. AttrAclInfo() interface{} // Attribute CommodityCode: The commodity code of the instance. // // The commodity code of a ApsaraMQ for RocketMQ 5.0 instance has a similar format as ons_rmqsub_public_cn. AttrCommodityCode() interface{} // Attribute CreateTime: The time when the instance was created. AttrCreateTime() interface{} // Attribute ExpireTime: The time when the instance expires. AttrExpireTime() interface{} // Attribute GroupCount: The number of groups. AttrGroupCount() interface{} // Attribute InstanceId: The ID of the RocketMQ instance. AttrInstanceId() interface{} // Attribute InstanceName: The name of instance. AttrInstanceName() interface{} // Attribute InstanceQuotas: The instance quotas. AttrInstanceQuotas() interface{} // Attribute NetworkInfo: Instance network configuration information. AttrNetworkInfo() interface{} // Attribute PaymentType: The billing method of the instance. AttrPaymentType() interface{} // Attribute ProductInfo: The extended configurations of the instance. AttrProductInfo() interface{} // Attribute ReleaseTime: The time when the instance was released. AttrReleaseTime() interface{} // Attribute Remark: The description of the instance. AttrRemark() interface{} // Attribute ResourceGroupId: The ID of the resource group. AttrResourceGroupId() interface{} // Attribute SeriesCode: The primary edition of the instance. AttrSeriesCode() interface{} // Attribute ServiceCode: The code of the service to which the instance belongs. // // The service code of ApsaraMQ for RocketMQ is rmq. AttrServiceCode() interface{} // Attribute Software: The instance software information. AttrSoftware() interface{} // Attribute StartTime: The time when the instance was started. AttrStartTime() interface{} // Attribute SubSeriesCode: The sub-category edition of the instance. // // For information about the differences between sub-category edition instances. AttrSubSeriesCode() interface{} // Attribute Tags: The tags of the RocketMQ instance. AttrTags() interface{} // Attribute TopicCount: The number of topics. AttrTopicCount() interface{} // Attribute UpdateTime: The time when the instance was last modified. AttrUpdateTime() interface{} // Attribute UserId: The ID of the user who owns the instance. AttrUserId() 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::ROCKETMQ::Instance`, which is used to query the details of an ApsaraMQ for RocketMQ 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 RocketMQ 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-rocketmq-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::ROCKETMQ::Instances`, which is used to query the information about all ApsaraMQ for RocketMQ 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 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 `Instances`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-rocketmq-instances
type RosGroups ¶
type RosGroups interface { alicloudroscdkcore.RosResource AttrGroupNames() alicloudroscdkcore.IResolvable AttrGroups() 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) GroupName() interface{} SetGroupName(val interface{}) GroupType() interface{} SetGroupType(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 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::ROCKETMQ::Groups`, which is used to query groups.
func NewRosGroups ¶
func NewRosGroups(scope alicloudroscdkcore.Construct, id *string, props *RosGroupsProps, enableResourcePropertyConstraint *bool) RosGroups
type RosGroupsProps ¶
type RosGroupsProps struct { GroupName interface{} `field:"optional" json:"groupName" yaml:"groupName"` GroupType interface{} `field:"optional" json:"groupType" yaml:"groupType"` InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosGroups`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-rocketmq-groups
type RosInstance ¶
type RosInstance interface { alicloudroscdkcore.RosResource AttrAccountInfo() alicloudroscdkcore.IResolvable AttrAclInfo() alicloudroscdkcore.IResolvable AttrCommodityCode() alicloudroscdkcore.IResolvable AttrCreateTime() alicloudroscdkcore.IResolvable AttrExpireTime() alicloudroscdkcore.IResolvable AttrGroupCount() alicloudroscdkcore.IResolvable AttrInstanceId() alicloudroscdkcore.IResolvable AttrInstanceName() alicloudroscdkcore.IResolvable AttrInstanceQuotas() alicloudroscdkcore.IResolvable AttrNetworkInfo() alicloudroscdkcore.IResolvable AttrPaymentType() alicloudroscdkcore.IResolvable AttrProductInfo() alicloudroscdkcore.IResolvable AttrReleaseTime() alicloudroscdkcore.IResolvable AttrRemark() alicloudroscdkcore.IResolvable AttrResourceGroupId() alicloudroscdkcore.IResolvable AttrSeriesCode() alicloudroscdkcore.IResolvable AttrServiceCode() alicloudroscdkcore.IResolvable AttrSoftware() alicloudroscdkcore.IResolvable AttrStartTime() alicloudroscdkcore.IResolvable AttrSubSeriesCode() alicloudroscdkcore.IResolvable AttrTags() alicloudroscdkcore.IResolvable AttrTopicCount() alicloudroscdkcore.IResolvable AttrUpdateTime() alicloudroscdkcore.IResolvable AttrUserId() 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::ROCKETMQ::Instance`, which is used to query the details of an ApsaraMQ for RocketMQ 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-rocketmq-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) // 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::ROCKETMQ::Instances`, which is used to query the information about all ApsaraMQ for RocketMQ instances.
func NewRosInstances ¶
func NewRosInstances(scope alicloudroscdkcore.Construct, id *string, props *RosInstancesProps, enableResourcePropertyConstraint *bool) RosInstances
type RosInstancesProps ¶
type RosInstancesProps struct {
RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
}
Properties for defining a `RosInstances`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-rocketmq-instances
type RosTopic ¶
type RosTopic interface { alicloudroscdkcore.RosResource AttrCreateTime() alicloudroscdkcore.IResolvable AttrInstanceId() alicloudroscdkcore.IResolvable AttrMessageType() alicloudroscdkcore.IResolvable AttrRemark() alicloudroscdkcore.IResolvable AttrTopicName() alicloudroscdkcore.IResolvable AttrUpdateTime() 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 TopicName() interface{} SetTopicName(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::ROCKETMQ::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"` TopicName interface{} `field:"required" json:"topicName" yaml:"topicName"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` }
Properties for defining a `RosTopic`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-rocketmq-topic
type RosTopics ¶
type RosTopics interface { alicloudroscdkcore.RosResource AttrTopicNames() alicloudroscdkcore.IResolvable 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 TopicName() interface{} SetTopicName(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::ROCKETMQ::Topics`, which is used to query topics on an ApsaraMQ for RocketMQ instance.
func NewRosTopics ¶
func NewRosTopics(scope alicloudroscdkcore.Construct, id *string, props *RosTopicsProps, enableResourcePropertyConstraint *bool) RosTopics
type RosTopicsProps ¶
type RosTopicsProps struct { InstanceId interface{} `field:"optional" json:"instanceId" yaml:"instanceId"` RefreshOptions interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"` TopicName interface{} `field:"optional" json:"topicName" yaml:"topicName"` }
Properties for defining a `RosTopics`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-rocketmq-topics
type Topic ¶
type Topic interface { alicloudroscdkcore.Resource ITopic // Attribute CreateTime: The time when the topic was created. AttrCreateTime() interface{} // Attribute InstanceId: The ID of the instance to which the topic belongs. AttrInstanceId() interface{} // Attribute MessageType: The message type of the topic. AttrMessageType() interface{} // Attribute Remark: The remarks on the topic. AttrRemark() interface{} // Attribute TopicName: The name of the topic. AttrTopicName() interface{} // Attribute UpdateTime: The time when the topic was last updated. AttrUpdateTime() 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::ROCKETMQ::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: The ID of the instance to which the topic belongs. InstanceId interface{} `field:"required" json:"instanceId" yaml:"instanceId"` // Property topicName: The name of the topic. TopicName interface{} `field:"required" json:"topicName" yaml:"topicName"` // 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-rocketmq-topic
type Topics ¶
type Topics interface { alicloudroscdkcore.Resource ITopics // Attribute TopicNames: The list of topic names. AttrTopicNames() interface{} // 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::ROCKETMQ::Topics`, which is used to query topics on an ApsaraMQ for RocketMQ instance.
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: InstanceId. 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 topicName: TopicName. TopicName interface{} `field:"optional" json:"topicName" yaml:"topicName"` }
Properties for defining a `Topics`.
See https://www.alibabacloud.com/help/ros/developer-reference/datasource-rocketmq-topics
Source Files ¶
- Groups.go
- GroupsProps.go
- Groups__checks.go
- IGroups.go
- IInstance.go
- IInstances.go
- ITopic.go
- ITopics.go
- Instance.go
- InstanceProps.go
- Instance__checks.go
- Instances.go
- InstancesProps.go
- Instances__checks.go
- RosGroups.go
- RosGroupsProps.go
- RosGroups__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