Skip to content

RosManagedKubernetesCluster

This class is a base encapsulation around the ROS resource type ALIYUN::CS::ManagedKubernetesCluster, which is used to create a Container Service for Kubernetes (ACK) managed cluster.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Cs;
new RosManagedKubernetesCluster(Construct Scope, string Id, RosManagedKubernetesClusterProps 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 RosManagedKubernetesClusterProps - 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.Cs;
RosManagedKubernetesCluster.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Cs;
RosManagedKubernetesCluster.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.Cs;
RosManagedKubernetesCluster.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.
AttrApiServerSlbId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrClusterId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDefaultUserKubeConfig AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrIngressSlbId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrNodes AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrPrivateUserKubConfig AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrScalingConfigurationId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrScalingGroupId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrScalingRuleId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrTaskId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrWorkerRamRoleName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
EnableResourcePropertyConstraint bool No description.
Name object No description.
VpcId object No description.
VSwitchIds object No description.
Addons object No description.
AutoRenew object No description.
AutoRenewPeriod object No description.
ChargeType object No description.
CloudMonitorFlags object No description.
ClusterSpec object No description.
ContainerCidr object No description.
DeleteOptions object No description.
DeletionProtection object No description.
DisableRollback object No description.
EncryptionProviderKey object No description.
EndpointPublicAccess object No description.
FormatDisk object No description.
IsEnterpriseSecurityGroup object No description.
KeepInstanceName object No description.
KeyPair object No description.
KubernetesVersion object No description.
LoadBalancerSpec object No description.
LoginPassword object No description.
NodeCidrMask object No description.
NodeNameMode object No description.
NodePools object No description.
NumOfNodes object No description.
OsType object No description.
Period object No description.
PeriodUnit object No description.
Platform object No description.
PodVswitchIds object No description.
ProxyMode object No description.
ResourceGroupId object No description.
Runtime object No description.
SecurityGroupId object No description.
SecurityHardeningOs object No description.
ServiceCidr object No description.
SnatEntry object No description.
SocEnabled object No description.
Tags TagsProperty[] No description.
Taint object No description.
TimeoutMins object No description.
UserData object No description.
WorkerDataDisk object No description.
WorkerDataDisks object No description.
WorkerInstanceTypes object No description.
WorkerSystemDiskCategory object No description.
WorkerSystemDiskPerformanceLevel object No description.
WorkerSystemDiskSize object No description.
ZoneIds 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.


AttrApiServerSlbIdRequired

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

AttrClusterIdRequired

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

AttrDefaultUserKubeConfigRequired

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

AttrIngressSlbIdRequired

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

AttrNodesRequired

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

AttrPrivateUserKubConfigRequired

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

AttrScalingConfigurationIdRequired

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

AttrScalingGroupIdRequired

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

AttrScalingRuleIdRequired

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

AttrTaskIdRequired

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

AttrWorkerRamRoleNameRequired

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

EnableResourcePropertyConstraintRequired

public bool EnableResourcePropertyConstraint { get; }
  • Type: bool

NameRequired

public object Name { get; }
  • Type: object

VpcIdRequired

public object VpcId { get; }
  • Type: object

VSwitchIdsRequired

public object VSwitchIds { get; }
  • Type: object

AddonsOptional

public object Addons { get; }
  • Type: object

AutoRenewOptional

public object AutoRenew { get; }
  • Type: object

AutoRenewPeriodOptional

public object AutoRenewPeriod { get; }
  • Type: object

ChargeTypeOptional

public object ChargeType { get; }
  • Type: object

CloudMonitorFlagsOptional

public object CloudMonitorFlags { get; }
  • Type: object

ClusterSpecOptional

public object ClusterSpec { get; }
  • Type: object

ContainerCidrOptional

public object ContainerCidr { get; }
  • Type: object

DeleteOptionsOptional

public object DeleteOptions { get; }
  • Type: object

DeletionProtectionOptional

public object DeletionProtection { get; }
  • Type: object

DisableRollbackOptional

public object DisableRollback { get; }
  • Type: object

EncryptionProviderKeyOptional

public object EncryptionProviderKey { get; }
  • Type: object

EndpointPublicAccessOptional

public object EndpointPublicAccess { get; }
  • Type: object

FormatDiskOptional

public object FormatDisk { get; }
  • Type: object

IsEnterpriseSecurityGroupOptional

public object IsEnterpriseSecurityGroup { get; }
  • Type: object

KeepInstanceNameOptional

public object KeepInstanceName { get; }
  • Type: object

KeyPairOptional

public object KeyPair { get; }
  • Type: object

KubernetesVersionOptional

public object KubernetesVersion { get; }
  • Type: object

LoadBalancerSpecOptional

public object LoadBalancerSpec { get; }
  • Type: object

LoginPasswordOptional

public object LoginPassword { get; }
  • Type: object

NodeCidrMaskOptional

public object NodeCidrMask { get; }
  • Type: object

NodeNameModeOptional

public object NodeNameMode { get; }
  • Type: object

NodePoolsOptional

public object NodePools { get; }
  • Type: object

NumOfNodesOptional

public object NumOfNodes { get; }
  • Type: object

OsTypeOptional

public object OsType { get; }
  • Type: object

PeriodOptional

public object Period { get; }
  • Type: object

PeriodUnitOptional

public object PeriodUnit { get; }
  • Type: object

PlatformOptional

public object Platform { get; }
  • Type: object

PodVswitchIdsOptional

public object PodVswitchIds { get; }
  • Type: object

ProxyModeOptional

public object ProxyMode { get; }
  • Type: object

ResourceGroupIdOptional

public object ResourceGroupId { get; }
  • Type: object

RuntimeOptional

public object Runtime { get; }
  • Type: object

SecurityGroupIdOptional

public object SecurityGroupId { get; }
  • Type: object

SecurityHardeningOsOptional

public object SecurityHardeningOs { get; }
  • Type: object

ServiceCidrOptional

public object ServiceCidr { get; }
  • Type: object

SnatEntryOptional

public object SnatEntry { get; }
  • Type: object

SocEnabledOptional

public object SocEnabled { get; }
  • Type: object

TagsOptional

public TagsProperty[] Tags { get; }

TaintOptional

public object Taint { get; }
  • Type: object

TimeoutMinsOptional

public object TimeoutMins { get; }
  • Type: object

UserDataOptional

public object UserData { get; }
  • Type: object

WorkerDataDiskOptional

public object WorkerDataDisk { get; }
  • Type: object

WorkerDataDisksOptional

public object WorkerDataDisks { get; }
  • Type: object

WorkerInstanceTypesOptional

public object WorkerInstanceTypes { get; }
  • Type: object

WorkerSystemDiskCategoryOptional

public object WorkerSystemDiskCategory { get; }
  • Type: object

WorkerSystemDiskPerformanceLevelOptional

public object WorkerSystemDiskPerformanceLevel { get; }
  • Type: object

WorkerSystemDiskSizeOptional

public object WorkerSystemDiskSize { get; }
  • Type: object

ZoneIdsOptional

public object ZoneIds { 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.


Structs