datasource

Documentation

Index

• func NewNodes_Override(n Nodes, scope alicloudroscdkcore.Construct, id *string, props *NodesProps, ...)
• func NewRosNodes_Override(r RosNodes, scope alicloudroscdkcore.Construct, id *string, ...)
• func Nodes_IsConstruct(x interface{}) *bool
• func RosNodes_IsConstruct(x interface{}) *bool
• func RosNodes_IsRosElement(x interface{}) *bool
• func RosNodes_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
• func RosNodes_ROS_RESOURCE_TYPE_NAME() *string
• type INodes
• type Nodes
  • func NewNodes(scope alicloudroscdkcore.Construct, id *string, props *NodesProps, ...) Nodes
• type NodesProps
• type RosNodes
  • func NewRosNodes(scope alicloudroscdkcore.Construct, id *string, props *RosNodesProps, ...) RosNodes
• type RosNodesProps

Functions

func NewNodes_Override

func NewNodes_Override(n Nodes, scope alicloudroscdkcore.Construct, id *string, props *NodesProps, enableResourcePropertyConstraint *bool)

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

func NewRosNodes_Override

func NewRosNodes_Override(r RosNodes, scope alicloudroscdkcore.Construct, id *string, props *RosNodesProps, enableResourcePropertyConstraint *bool)

func Nodes_IsConstruct

func Nodes_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosNodes_IsConstruct

func RosNodes_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosNodes_IsRosElement

func RosNodes_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 RosNodes_IsRosResource

func RosNodes_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosNodes_ROS_RESOURCE_TYPE_NAME

func RosNodes_ROS_RESOURCE_TYPE_NAME() *string

Types

type INodes

type INodes interface {
	alicloudroscdkcore.IResource
	// Attribute NodeIds: The list of node IDs.
	AttrNodeIds() interface{}
	// Attribute Nodes: The list of nodes.
	AttrNodes() interface{}
	Props() *NodesProps
}

Represents a `Nodes`.

type Nodes

type Nodes interface {
	alicloudroscdkcore.Resource
	INodes
	// Attribute NodeIds: The list of node IDs.
	AttrNodeIds() interface{}
	// Attribute Nodes: The list of nodes.
	AttrNodes() 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() *NodesProps
	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::EHPC::Nodes`, which is used to query nodes in an Elastic High Performance Computing (E-HPC) cluster.

func NewNodes

func NewNodes(scope alicloudroscdkcore.Construct, id *string, props *NodesProps, enableResourcePropertyConstraint *bool) Nodes

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

type NodesProps

type NodesProps struct {
	// Property clusterId: The ID of the cluster.
	ClusterId interface{} `field:"required" json:"clusterId" yaml:"clusterId"`
	// Property hostName: The name of the node.
	//
	// You can perform a fuzzy search. MySQL regular expressions are supported.
	HostName interface{} `field:"optional" json:"hostName" yaml:"hostName"`
	// Property hostNamePrefix: The prefix of the hostname.
	//
	// You can query nodes that have a specified prefix.
	HostNamePrefix interface{} `field:"optional" json:"hostNamePrefix" yaml:"hostNamePrefix"`
	// Property hostNameSuffix: The suffix of the hostname.
	//
	// You can query nodes that have a specified suffix.
	HostNameSuffix interface{} `field:"optional" json:"hostNameSuffix" yaml:"hostNameSuffix"`
	// Property privateIpAddress: The private IP address of the node.
	PrivateIpAddress interface{} `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
	// 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 role: The type of the node.
	//
	// Valid values:
	// Manager: management node
	// Login: logon node
	// Compute: compute node.
	Role interface{} `field:"optional" json:"role" yaml:"role"`
}

Properties for defining a `Nodes`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-ehpc-nodes

type RosNodes

type RosNodes interface {
	alicloudroscdkcore.RosResource
	AttrNodeIds() alicloudroscdkcore.IResolvable
	AttrNodes() alicloudroscdkcore.IResolvable
	ClusterId() interface{}
	SetClusterId(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	HostName() interface{}
	SetHostName(val interface{})
	HostNamePrefix() interface{}
	SetHostNamePrefix(val interface{})
	HostNameSuffix() interface{}
	SetHostNameSuffix(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
	PrivateIpAddress() interface{}
	SetPrivateIpAddress(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
	RefreshOptions() interface{}
	SetRefreshOptions(val interface{})
	Role() interface{}
	SetRole(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::EHPC::Nodes`, which is used to query nodes in an Elastic High Performance Computing (E-HPC) cluster.

func NewRosNodes

func NewRosNodes(scope alicloudroscdkcore.Construct, id *string, props *RosNodesProps, enableResourcePropertyConstraint *bool) RosNodes

type RosNodesProps

type RosNodesProps struct {
	ClusterId        interface{} `field:"required" json:"clusterId" yaml:"clusterId"`
	HostName         interface{} `field:"optional" json:"hostName" yaml:"hostName"`
	HostNamePrefix   interface{} `field:"optional" json:"hostNamePrefix" yaml:"hostNamePrefix"`
	HostNameSuffix   interface{} `field:"optional" json:"hostNameSuffix" yaml:"hostNameSuffix"`
	PrivateIpAddress interface{} `field:"optional" json:"privateIpAddress" yaml:"privateIpAddress"`
	RefreshOptions   interface{} `field:"optional" json:"refreshOptions" yaml:"refreshOptions"`
	Role             interface{} `field:"optional" json:"role" yaml:"role"`
}

Properties for defining a `RosNodes`.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-ehpc-nodes