alicloudroscdkvs

package module
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: Oct 8, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

Aliyun ROS VS Construct Library

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

import * as VS from '@alicloud/ros-cdk-vs';

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 Group_IsConstruct 

func Group_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewGroup_Override 

func NewGroup_Override(g Group, scope alicloudroscdkcore.Construct, id *string, props *GroupProps, enableResourcePropertyConstraint *bool)

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

func NewRosGroup_Override 

func NewRosGroup_Override(r RosGroup, scope alicloudroscdkcore.Construct, id *string, props *RosGroupProps, enableResourcePropertyConstraint *bool)

func RosGroup_IsConstruct 

func RosGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosGroup_IsRosElement 

func RosGroup_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 RosGroup_IsRosResource 

func RosGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosGroup_ROS_RESOURCE_TYPE_NAME 

func RosGroup_ROS_RESOURCE_TYPE_NAME() *string

Types

type Group 

type Group interface {
	alicloudroscdkcore.Resource
	// Attribute GbId: GB ID space provided.
	//
	// (Applies only to access the space marked States).
	AttrGbId() alicloudroscdkcore.IResolvable
	// Attribute GbIp: GB signaling server address space provided.
	//
	// (Applies only to access the space marked States).
	AttrGbIp() alicloudroscdkcore.IResolvable
	// Attribute GbPort: GB Port space provided.
	//
	// (Applies only to access the space marked States).
	AttrGbPort() alicloudroscdkcore.IResolvable
	// Attribute Id: Space ID.
	AttrId() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	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() *GroupProps
	SetProps(val *GroupProps)
	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)
	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::VS::Group`, which is used to create a group.

func NewGroup 

func NewGroup(scope alicloudroscdkcore.Construct, id *string, props *GroupProps, enableResourcePropertyConstraint *bool) Group

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

type GroupProps 

type GroupProps struct {
	// Property inProtocol: Access protocol used by the space.
	//
	// Value: gb28181, rtmp.
	InProtocol interface{} `field:"required" json:"inProtocol" yaml:"inProtocol"`
	// Property name: Space name.
	Name interface{} `field:"required" json:"name" yaml:"name"`
	// Property outProtocol: Play protocol used by the space, multivalued separated by commas.
	//
	// Value: flv, hls, rtmp.
	OutProtocol interface{} `field:"required" json:"outProtocol" yaml:"outProtocol"`
	// Property playDomain: Use of the domain name space broadcast stream.
	PlayDomain interface{} `field:"required" json:"playDomain" yaml:"playDomain"`
	// Property pushDomain: Plug flow domain name space to use.
	//
	// (Only access to the space rtmp).
	PushDomain interface{} `field:"required" json:"pushDomain" yaml:"pushDomain"`
	// Property region: Space belongs to the region, as a service center.
	Region interface{} `field:"required" json:"region" yaml:"region"`
	// Property app: Application name space used, the default live.
	App interface{} `field:"optional" json:"app" yaml:"app"`
	// Property callback: Updating the space callback device \/ flow state.
	Callback interface{} `field:"optional" json:"callback" yaml:"callback"`
	// Property description: Space description.
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	// Property enabled: Space is enabled.
	Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
	// Property lazyPull: Whether to enable on-demand pull flow, default false.
	LazyPull interface{} `field:"optional" json:"lazyPull" yaml:"lazyPull"`
}

Properties for defining a `Group`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vs-group

type RosGroup 

type RosGroup interface {
	alicloudroscdkcore.RosResource
	App() interface{}
	SetApp(val interface{})
	AttrGbId() alicloudroscdkcore.IResolvable
	AttrGbIp() alicloudroscdkcore.IResolvable
	AttrGbPort() alicloudroscdkcore.IResolvable
	AttrId() alicloudroscdkcore.IResolvable
	Callback() interface{}
	SetCallback(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	Description() interface{}
	SetDescription(val interface{})
	Enabled() interface{}
	SetEnabled(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	InProtocol() interface{}
	SetInProtocol(val interface{})
	LazyPull() interface{}
	SetLazyPull(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
	Name() interface{}
	SetName(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	OutProtocol() interface{}
	SetOutProtocol(val interface{})
	PlayDomain() interface{}
	SetPlayDomain(val interface{})
	PushDomain() interface{}
	SetPushDomain(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	Region() interface{}
	SetRegion(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)
	// 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::VS::Group`, which is used to create a group.

func NewRosGroup 

func NewRosGroup(scope alicloudroscdkcore.Construct, id *string, props *RosGroupProps, enableResourcePropertyConstraint *bool) RosGroup

type RosGroupProps 

type RosGroupProps struct {
	InProtocol  interface{} `field:"required" json:"inProtocol" yaml:"inProtocol"`
	Name        interface{} `field:"required" json:"name" yaml:"name"`
	OutProtocol interface{} `field:"required" json:"outProtocol" yaml:"outProtocol"`
	PlayDomain  interface{} `field:"required" json:"playDomain" yaml:"playDomain"`
	PushDomain  interface{} `field:"required" json:"pushDomain" yaml:"pushDomain"`
	Region      interface{} `field:"required" json:"region" yaml:"region"`
	App         interface{} `field:"optional" json:"app" yaml:"app"`
	Callback    interface{} `field:"optional" json:"callback" yaml:"callback"`
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	Enabled     interface{} `field:"optional" json:"enabled" yaml:"enabled"`
	LazyPull    interface{} `field:"optional" json:"lazyPull" yaml:"lazyPull"`
}

Properties for defining a `RosGroup`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vs-group

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.