alicloudroscdkeventbridge

package module
v1.6.0 Latest Latest
Warning

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

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

README

Aliyun ROS EVENTBRIDGE Construct Library

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

import * as EVENTBRIDGE from '@alicloud/ros-cdk-eventbridge';

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewRosRule_Override 

func NewRosRule_Override(r RosRule, scope alicloudroscdkcore.Construct, id *string, props *RosRuleProps, enableResourcePropertyConstraint *bool)

func NewRule_Override 

func NewRule_Override(r Rule, scope alicloudroscdkcore.Construct, id *string, props *RuleProps, enableResourcePropertyConstraint *bool)

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

func RosRule_IsConstruct 

func RosRule_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosRule_IsRosElement 

func RosRule_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 RosRule_IsRosResource 

func RosRule_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosRule_ROS_RESOURCE_TYPE_NAME 

func RosRule_ROS_RESOURCE_TYPE_NAME() *string

func Rule_IsConstruct 

func Rule_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

Types

type IRule added in v1.6.0 

type IRule interface {
	alicloudroscdkcore.IResource
	// Attribute EventBusName: The name of the event bus.
	AttrEventBusName() interface{}
	// Attribute RuleARN: The Alibaba Cloud Resource Name (ARN) of the event rule.
	//
	// The ARN is used for authorization.
	AttrRuleArn() interface{}
	// Attribute RuleName: The name of the event rule.
	AttrRuleName() interface{}
	Props() *RuleProps
}

Represents a `Rule`.

type RosRule 

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

This class is a base encapsulation around the ROS resource type `ALIYUN::EventBridge::Rule`, which is used to create an event rule for an event bus.

func NewRosRule 

func NewRosRule(scope alicloudroscdkcore.Construct, id *string, props *RosRuleProps, enableResourcePropertyConstraint *bool) RosRule

type RosRuleProps 

type RosRuleProps struct {
	EventBusName  interface{} `field:"required" json:"eventBusName" yaml:"eventBusName"`
	FilterPattern interface{} `field:"required" json:"filterPattern" yaml:"filterPattern"`
	RuleName      interface{} `field:"required" json:"ruleName" yaml:"ruleName"`
	Targets       interface{} `field:"required" json:"targets" yaml:"targets"`
	Description   interface{} `field:"optional" json:"description" yaml:"description"`
	Status        interface{} `field:"optional" json:"status" yaml:"status"`
}

Properties for defining a `RosRule`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-eventbridge-rule

type RosRule_ParamListProperty 

type RosRule_ParamListProperty struct {
	Form        interface{} `field:"required" json:"form" yaml:"form"`
	ResourceKey interface{} `field:"required" json:"resourceKey" yaml:"resourceKey"`
	Value       interface{} `field:"required" json:"value" yaml:"value"`
	Template    interface{} `field:"optional" json:"template" yaml:"template"`
}

type RosRule_TargetsProperty 

type RosRule_TargetsProperty struct {
	Endpoint          interface{} `field:"required" json:"endpoint" yaml:"endpoint"`
	Identity          interface{} `field:"required" json:"identity" yaml:"identity"`
	ParamList         interface{} `field:"required" json:"paramList" yaml:"paramList"`
	Type              interface{} `field:"required" json:"type" yaml:"type"`
	PushRetryStrategy interface{} `field:"optional" json:"pushRetryStrategy" yaml:"pushRetryStrategy"`
}

type Rule 

type Rule interface {
	alicloudroscdkcore.Resource
	IRule
	// Attribute EventBusName: The name of the event bus.
	AttrEventBusName() interface{}
	// Attribute RuleARN: The Alibaba Cloud Resource Name (ARN) of the event rule.
	//
	// The ARN is used for authorization.
	AttrRuleArn() interface{}
	// Attribute RuleName: The name of the event rule.
	AttrRuleName() 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() *RuleProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::EventBridge::Rule`, which is used to create an event rule for an event bus.

func NewRule 

func NewRule(scope alicloudroscdkcore.Construct, id *string, props *RuleProps, enableResourcePropertyConstraint *bool) Rule

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

type RuleProps 

type RuleProps struct {
	// Property eventBusName: The name of the event bus.
	EventBusName interface{} `field:"required" json:"eventBusName" yaml:"eventBusName"`
	// Property filterPattern: The event pattern, in the JSON format.
	FilterPattern interface{} `field:"required" json:"filterPattern" yaml:"filterPattern"`
	// Property ruleName: The name of the event rule.
	RuleName interface{} `field:"required" json:"ruleName" yaml:"ruleName"`
	// Property targets: The event target to which events are delivered.
	Targets interface{} `field:"required" json:"targets" yaml:"targets"`
	// Property description: The description of the event rule.
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	// Property status: The status of the event rule.
	//
	// Valid values:
	// ENABLE: The event rule is enabled. It is the default state of the event rule.
	// DISABLE: The event rule is disabled.
	Status interface{} `field:"optional" json:"status" yaml:"status"`
}

Properties for defining a `Rule`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-eventbridge-rule

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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