Skip to content

RosCluster

This class is a base encapsulation around the ROS resource type ALIYUN::EHPC::Cluster, which is used to create an Elastic High Performance Computing (E-HPC) cluster.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkehpc"
alicloudroscdkehpc.NewRosCluster(scope Construct, id *string, props RosClusterProps, enableResourcePropertyConstraint *bool) RosCluster
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct - scope in which this resource is defined.
id *string - scoped id of the resource.
props RosClusterProps - resource properties.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

scope in which this resource is defined.


idRequired

  • Type: *string

scoped id of the resource.


propsRequired

resource properties.


enableResourcePropertyConstraintRequired

  • Type: *bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
AddCondition No description.
AddCount No description.
AddDeletionOverride Syntactic sugar for addOverride(path, undefined).
AddDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc No description.
AddMetaData No description.
AddOverride Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride Adds an override to a resource property.
AddRosDependency No description.
ApplyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
GetAtt Returns a token for an runtime attribute of this resource.

ToString

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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.

sessionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.


OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: *string

The new logical ID to use for this stack element.


AddCondition

func AddCondition(con RosCondition)

conRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: *string

The path of the value to delete.


AddDependsOn

func AddDependsOn(target RosResource)

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.

targetRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AddDesc

func AddDesc(desc *string)

descRequired

  • Type: *string

AddMetaData

func AddMetaData(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

AddOverride

func AddOverride(path *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,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: *string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


valueRequired

  • Type: interface{}

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

Adds an override that deletes the value of a property from the resource definition.

propertyPathRequired

  • Type: *string

The path to the property.


AddPropertyOverride

func AddPropertyOverride(propertyPath *string, value interface{})

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: *string

The path of the property.


valueRequired

  • Type: interface{}

The value.


AddRosDependency

func AddRosDependency(target *string)

targetRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

optionsOptional

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicyOptions

GetAtt

func GetAtt(attributeName *string) Reference

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.

attributeNameRequired

  • Type: *string

The name of the attribute.


Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.
IsRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource Check whether the given construct is a RosResource.

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkehpc"
alicloudroscdkehpc.RosCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkehpc"
alicloudroscdkehpc.RosCluster_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.

xRequired

  • Type: interface{}

IsRosResource

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkehpc"
alicloudroscdkehpc.RosCluster_IsRosResource(construct IConstruct) *bool

Check whether the given construct is a RosResource.

constructRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IConstruct

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
CreationStack []string No description.
LogicalId *string The logical ID for this stack element.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this element is defined.
Ref *string Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType *string ROS resource type.
AttrClusterId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrEcsInfo github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
AttrSecurityGroupId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable No description.
EcsOrderComputeCount interface{} No description.
EcsOrderComputeInstanceType interface{} No description.
EcsOrderLoginCount interface{} No description.
EcsOrderLoginInstanceType interface{} No description.
EcsOrderManagerInstanceType interface{} No description.
EnableResourcePropertyConstraint *bool No description.
Name interface{} No description.
OsTag interface{} No description.
VSwitchId interface{} No description.
AccountType interface{} No description.
AdditionalVolumes interface{} No description.
Application interface{} No description.
AutoRenew interface{} No description.
AutoRenewPeriod interface{} No description.
ClientVersion interface{} No description.
ComputeEnableHt interface{} No description.
ComputeSpotPriceLimit interface{} No description.
ComputeSpotStrategy interface{} No description.
DeployMode interface{} No description.
Description interface{} No description.
EcsChargeType interface{} No description.
EcsOrderManagerCount interface{} No description.
EhpcVersion interface{} No description.
HaEnable interface{} No description.
ImageId interface{} No description.
ImageOwnerAlias interface{} No description.
InputFileUrl interface{} No description.
IsComputeEss interface{} No description.
JobQueue interface{} No description.
KeyPairName interface{} No description.
NetworkInterfaceTrafficMode interface{} No description.
Password interface{} No description.
Period interface{} No description.
PeriodUnit interface{} No description.
PostInstallScript interface{} No description.
RamNodeTypes interface{} No description.
RamRoleName interface{} No description.
RemoteDirectory interface{} No description.
RemoteVisEnable interface{} No description.
ResourceGroupId interface{} No description.
SccClusterId interface{} No description.
SchedulerType interface{} No description.
SecurityGroupId interface{} No description.
SecurityGroupName interface{} No description.
SystemDiskLevel interface{} No description.
SystemDiskSize interface{} No description.
SystemDiskType interface{} No description.
VolumeId interface{} No description.
VolumeMountpoint interface{} No description.
VolumeProtocol interface{} No description.
VolumeType interface{} No description.
VpcId interface{} No description.
WithoutElasticIp interface{} No description.
ZoneId interface{} No description.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

func CreationStack() *[]*string
  • Type: []string

LogicalIdRequired

func LogicalId() *string
  • Type: *string

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).


StackRequired

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


RefRequired

func Ref() *string
  • Type: *string

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 }).


RosOptionsRequired

func RosOptions() IRosResourceOptions
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


RosResourceTypeRequired

func RosResourceType() *string
  • Type: *string

ROS resource type.


AttrClusterIdRequired

func AttrClusterId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrEcsInfoRequired

func AttrEcsInfo() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrNameRequired

func AttrName() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrSecurityGroupIdRequired

func AttrSecurityGroupId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

EcsOrderComputeCountRequired

func EcsOrderComputeCount() interface{}
  • Type: interface{}

EcsOrderComputeInstanceTypeRequired

func EcsOrderComputeInstanceType() interface{}
  • Type: interface{}

EcsOrderLoginCountRequired

func EcsOrderLoginCount() interface{}
  • Type: interface{}

EcsOrderLoginInstanceTypeRequired

func EcsOrderLoginInstanceType() interface{}
  • Type: interface{}

EcsOrderManagerInstanceTypeRequired

func EcsOrderManagerInstanceType() interface{}
  • Type: interface{}

EnableResourcePropertyConstraintRequired

func EnableResourcePropertyConstraint() *bool
  • Type: *bool

NameRequired

func Name() interface{}
  • Type: interface{}

OsTagRequired

func OsTag() interface{}
  • Type: interface{}

VSwitchIdRequired

func VSwitchId() interface{}
  • Type: interface{}

AccountTypeOptional

func AccountType() interface{}
  • Type: interface{}

AdditionalVolumesOptional

func AdditionalVolumes() interface{}
  • Type: interface{}

ApplicationOptional

func Application() interface{}
  • Type: interface{}

AutoRenewOptional

func AutoRenew() interface{}
  • Type: interface{}

AutoRenewPeriodOptional

func AutoRenewPeriod() interface{}
  • Type: interface{}

ClientVersionOptional

func ClientVersion() interface{}
  • Type: interface{}

ComputeEnableHtOptional

func ComputeEnableHt() interface{}
  • Type: interface{}

ComputeSpotPriceLimitOptional

func ComputeSpotPriceLimit() interface{}
  • Type: interface{}

ComputeSpotStrategyOptional

func ComputeSpotStrategy() interface{}
  • Type: interface{}

DeployModeOptional

func DeployMode() interface{}
  • Type: interface{}

DescriptionOptional

func Description() interface{}
  • Type: interface{}

EcsChargeTypeOptional

func EcsChargeType() interface{}
  • Type: interface{}

EcsOrderManagerCountOptional

func EcsOrderManagerCount() interface{}
  • Type: interface{}

EhpcVersionOptional

func EhpcVersion() interface{}
  • Type: interface{}

HaEnableOptional

func HaEnable() interface{}
  • Type: interface{}

ImageIdOptional

func ImageId() interface{}
  • Type: interface{}

ImageOwnerAliasOptional

func ImageOwnerAlias() interface{}
  • Type: interface{}

InputFileUrlOptional

func InputFileUrl() interface{}
  • Type: interface{}

IsComputeEssOptional

func IsComputeEss() interface{}
  • Type: interface{}

JobQueueOptional

func JobQueue() interface{}
  • Type: interface{}

KeyPairNameOptional

func KeyPairName() interface{}
  • Type: interface{}

NetworkInterfaceTrafficModeOptional

func NetworkInterfaceTrafficMode() interface{}
  • Type: interface{}

PasswordOptional

func Password() interface{}
  • Type: interface{}

PeriodOptional

func Period() interface{}
  • Type: interface{}

PeriodUnitOptional

func PeriodUnit() interface{}
  • Type: interface{}

PostInstallScriptOptional

func PostInstallScript() interface{}
  • Type: interface{}

RamNodeTypesOptional

func RamNodeTypes() interface{}
  • Type: interface{}

RamRoleNameOptional

func RamRoleName() interface{}
  • Type: interface{}

RemoteDirectoryOptional

func RemoteDirectory() interface{}
  • Type: interface{}

RemoteVisEnableOptional

func RemoteVisEnable() interface{}
  • Type: interface{}

ResourceGroupIdOptional

func ResourceGroupId() interface{}
  • Type: interface{}

SccClusterIdOptional

func SccClusterId() interface{}
  • Type: interface{}

SchedulerTypeOptional

func SchedulerType() interface{}
  • Type: interface{}

SecurityGroupIdOptional

func SecurityGroupId() interface{}
  • Type: interface{}

SecurityGroupNameOptional

func SecurityGroupName() interface{}
  • Type: interface{}

SystemDiskLevelOptional

func SystemDiskLevel() interface{}
  • Type: interface{}

SystemDiskSizeOptional

func SystemDiskSize() interface{}
  • Type: interface{}

SystemDiskTypeOptional

func SystemDiskType() interface{}
  • Type: interface{}

VolumeIdOptional

func VolumeId() interface{}
  • Type: interface{}

VolumeMountpointOptional

func VolumeMountpoint() interface{}
  • Type: interface{}

VolumeProtocolOptional

func VolumeProtocol() interface{}
  • Type: interface{}

VolumeTypeOptional

func VolumeType() interface{}
  • Type: interface{}

VpcIdOptional

func VpcId() interface{}
  • Type: interface{}

WithoutElasticIpOptional

func WithoutElasticIp() interface{}
  • Type: interface{}

ZoneIdOptional

func ZoneId() interface{}
  • Type: interface{}

Constants

Name Type Description
RosResourceTypeName *string The resource type name for this resource class.

RosResourceTypeNameRequired

func RosResourceTypeName() *string
  • Type: *string

The resource type name for this resource class.