Skip to content

RosCluster

This class is a base encapsulation around the ROS resource type ALIYUN::EMR::Cluster, which is used to create an E-MapReduce (EMR) cluster.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Emr;
new RosCluster(Construct Scope, string Id, RosClusterProps Props, bool EnableResourcePropertyConstraint);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.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: AlibabaCloud.SDK.ROS.CDK.Core.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

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired

  • Type: string

The new logical ID to use for this stack element.


AddCondition

private void AddCondition(RosCondition Con)

ConRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

PathRequired

  • Type: string

The path of the value to delete.


AddDependsOn

private void AddDependsOn(RosResource Target)

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: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AddDesc

private void AddDesc(string Desc)

DescRequired

  • Type: string

AddMetaData

private void AddMetaData(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

AddOverride

private void AddOverride(string Path, object Value)

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: object

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

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

PropertyPathRequired

  • Type: string

The path to the property.


AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

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

PropertyPathRequired

  • Type: string

The path of the property.


ValueRequired

  • Type: object

The value.


AddRosDependency

private void AddRosDependency(string Target)

TargetRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

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

PolicyOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

OptionsOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

GetAtt

private Reference GetAtt(string AttributeName)

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

using AlibabaCloud.SDK.ROS.CDK.Emr;
RosCluster.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Emr;
RosCluster.IsRosElement(object X);

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: object

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Emr;
RosCluster.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

ConstructRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
CreationStack string[] No description.
LogicalId string The logical ID for this stack element.
Stack AlibabaCloud.SDK.ROS.CDK.Core.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 AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType string ROS resource type.
AttrClusterId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrHostGroups AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrMasterNodeInnerIps AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrMasterNodePubIps AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
ChargeType object No description.
ClusterType object No description.
EmrVer object No description.
EnableResourcePropertyConstraint bool No description.
HostGroup object No description.
Name object No description.
NetType object No description.
UseLocalMetaDb object No description.
ZoneId object No description.
AuthorizeContent object No description.
AutoRenew object No description.
BootstrapAction object No description.
ClickHouseConf object No description.
Config object No description.
Configurations object No description.
DepositType object No description.
EasEnable object No description.
HighAvailabilityEnable object No description.
InitCustomHiveMetaDb object No description.
InstanceGeneration object No description.
IoOptimized object No description.
IsOpenPublicIp object No description.
KeyPairName object No description.
LogPath object No description.
MachineType object No description.
MasterPwd object No description.
MetaStoreConf object No description.
MetaStoreType object No description.
OptionSoftWareList object No description.
Period object No description.
RelatedClusterId object No description.
ResourceGroupId object No description.
SecurityGroupId object No description.
SecurityGroupName object No description.
SshEnable object No description.
Tags TagsProperty[] No description.
UseCustomHiveMetaDb object No description.
UserDefinedEmrEcsRole object No description.
UserInfo object No description.
VpcId object No description.
VSwitchId object No description.
WhiteListType object No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

public string[] CreationStack { get; }
  • Type: string[]

LogicalIdRequired

public string LogicalId { get; }
  • 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

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this element is defined.

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


RefRequired

public string Ref { get; }
  • 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

public IRosResourceOptions RosOptions { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

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


RosResourceTypeRequired

public string RosResourceType { get; }
  • Type: string

ROS resource type.


AttrClusterIdRequired

public IResolvable AttrClusterId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrHostGroupsRequired

public IResolvable AttrHostGroups { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrMasterNodeInnerIpsRequired

public IResolvable AttrMasterNodeInnerIps { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrMasterNodePubIpsRequired

public IResolvable AttrMasterNodePubIps { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

ChargeTypeRequired

public object ChargeType { get; }
  • Type: object

ClusterTypeRequired

public object ClusterType { get; }
  • Type: object

EmrVerRequired

public object EmrVer { get; }
  • Type: object

EnableResourcePropertyConstraintRequired

public bool EnableResourcePropertyConstraint { get; }
  • Type: bool

HostGroupRequired

public object HostGroup { get; }
  • Type: object

NameRequired

public object Name { get; }
  • Type: object

NetTypeRequired

public object NetType { get; }
  • Type: object

UseLocalMetaDbRequired

public object UseLocalMetaDb { get; }
  • Type: object

ZoneIdRequired

public object ZoneId { get; }
  • Type: object

AuthorizeContentOptional

public object AuthorizeContent { get; }
  • Type: object

AutoRenewOptional

public object AutoRenew { get; }
  • Type: object

BootstrapActionOptional

public object BootstrapAction { get; }
  • Type: object

ClickHouseConfOptional

public object ClickHouseConf { get; }
  • Type: object

ConfigOptional

public object Config { get; }
  • Type: object

ConfigurationsOptional

public object Configurations { get; }
  • Type: object

DepositTypeOptional

public object DepositType { get; }
  • Type: object

EasEnableOptional

public object EasEnable { get; }
  • Type: object

HighAvailabilityEnableOptional

public object HighAvailabilityEnable { get; }
  • Type: object

InitCustomHiveMetaDbOptional

public object InitCustomHiveMetaDb { get; }
  • Type: object

InstanceGenerationOptional

public object InstanceGeneration { get; }
  • Type: object

IoOptimizedOptional

public object IoOptimized { get; }
  • Type: object

IsOpenPublicIpOptional

public object IsOpenPublicIp { get; }
  • Type: object

KeyPairNameOptional

public object KeyPairName { get; }
  • Type: object

LogPathOptional

public object LogPath { get; }
  • Type: object

MachineTypeOptional

public object MachineType { get; }
  • Type: object

MasterPwdOptional

public object MasterPwd { get; }
  • Type: object

MetaStoreConfOptional

public object MetaStoreConf { get; }
  • Type: object

MetaStoreTypeOptional

public object MetaStoreType { get; }
  • Type: object

OptionSoftWareListOptional

public object OptionSoftWareList { get; }
  • Type: object

PeriodOptional

public object Period { get; }
  • Type: object

RelatedClusterIdOptional

public object RelatedClusterId { get; }
  • Type: object

ResourceGroupIdOptional

public object ResourceGroupId { get; }
  • Type: object

SecurityGroupIdOptional

public object SecurityGroupId { get; }
  • Type: object

SecurityGroupNameOptional

public object SecurityGroupName { get; }
  • Type: object

SshEnableOptional

public object SshEnable { get; }
  • Type: object

TagsOptional

public TagsProperty[] Tags { get; }

UseCustomHiveMetaDbOptional

public object UseCustomHiveMetaDb { get; }
  • Type: object

UserDefinedEmrEcsRoleOptional

public object UserDefinedEmrEcsRole { get; }
  • Type: object

UserInfoOptional

public object UserInfo { get; }
  • Type: object

VpcIdOptional

public object VpcId { get; }
  • Type: object

VSwitchIdOptional

public object VSwitchId { get; }
  • Type: object

WhiteListTypeOptional

public object WhiteListType { get; }
  • Type: object

Constants

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

RosResourceTypeNameRequired

public string RosResourceTypeName { get; }
  • Type: string

The resource type name for this resource class.