Skip to content

RosScalingConfiguration

This class is a base encapsulation around the ROS resource type ALIYUN::ESS::ScalingConfiguration, which is used to create a scaling configuration for a scaling group.

Initializers

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

Return whether the given object is a Construct.

XRequired

  • Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Ess;
RosScalingConfiguration.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.Ess;
RosScalingConfiguration.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.
AttrScalingConfigurationId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrScalingGroupId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
EnableResourcePropertyConstraint bool No description.
ScalingGroupId object No description.
Affinity object No description.
Cpu object No description.
CreditSpecification object No description.
DedicatedHostId object No description.
DeploymentSetId object No description.
DiskMappings object No description.
HostName object No description.
HpcClusterId object No description.
ImageFamily object No description.
ImageId object No description.
ImageName object No description.
ImageOptionsLoginAsNonRoot object No description.
InstanceDescription object No description.
InstanceId object No description.
InstanceName object No description.
InstancePatternInfos object No description.
InstanceType object No description.
InstanceTypeOverrides object No description.
InstanceTypes object No description.
InternetChargeType object No description.
InternetMaxBandwidthIn object No description.
InternetMaxBandwidthOut object No description.
IoOptimized object No description.
Ipv6AddressCount object No description.
KeyPairName object No description.
LoadBalancerWeight object No description.
Memory object No description.
Password object No description.
PasswordInherit object No description.
PrivatePoolOptions object No description.
RamRoleName object No description.
ResourceGroupId object No description.
ScalingConfigurationName object No description.
SecurityEnhancementStrategy object No description.
SecurityGroupId object No description.
SecurityGroupIds object No description.
SpotDuration object No description.
SpotInterruptionBehavior object No description.
SpotPriceLimit object No description.
SpotPriceLimitForInstanceType object No description.
SpotStrategy object No description.
SystemDiskAutoSnapshotPolicyId object No description.
SystemDiskBurstingEnabled object No description.
SystemDiskCategories object No description.
SystemDiskCategory object No description.
SystemDiskDescription object No description.
SystemDiskDiskName object No description.
SystemDiskEncryptAlgorithm object No description.
SystemDiskEncrypted object No description.
SystemDiskKmsKeyId object No description.
SystemDiskPerformanceLevel object No description.
SystemDiskProvisionedIops object No description.
SystemDiskSize object No description.
TagList object No description.
Tenancy object No description.
UserData object No description.
ZoneId 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.


AttrScalingConfigurationIdRequired

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

AttrScalingGroupIdRequired

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

EnableResourcePropertyConstraintRequired

public bool EnableResourcePropertyConstraint { get; }
  • Type: bool

ScalingGroupIdRequired

public object ScalingGroupId { get; }
  • Type: object

AffinityOptional

public object Affinity { get; }
  • Type: object

CpuOptional

public object Cpu { get; }
  • Type: object

CreditSpecificationOptional

public object CreditSpecification { get; }
  • Type: object

DedicatedHostIdOptional

public object DedicatedHostId { get; }
  • Type: object

DeploymentSetIdOptional

public object DeploymentSetId { get; }
  • Type: object

DiskMappingsOptional

public object DiskMappings { get; }
  • Type: object

HostNameOptional

public object HostName { get; }
  • Type: object

HpcClusterIdOptional

public object HpcClusterId { get; }
  • Type: object

ImageFamilyOptional

public object ImageFamily { get; }
  • Type: object

ImageIdOptional

public object ImageId { get; }
  • Type: object

ImageNameOptional

public object ImageName { get; }
  • Type: object

ImageOptionsLoginAsNonRootOptional

public object ImageOptionsLoginAsNonRoot { get; }
  • Type: object

InstanceDescriptionOptional

public object InstanceDescription { get; }
  • Type: object

InstanceIdOptional

public object InstanceId { get; }
  • Type: object

InstanceNameOptional

public object InstanceName { get; }
  • Type: object

InstancePatternInfosOptional

public object InstancePatternInfos { get; }
  • Type: object

InstanceTypeOptional

public object InstanceType { get; }
  • Type: object

InstanceTypeOverridesOptional

public object InstanceTypeOverrides { get; }
  • Type: object

InstanceTypesOptional

public object InstanceTypes { get; }
  • Type: object

InternetChargeTypeOptional

public object InternetChargeType { get; }
  • Type: object

InternetMaxBandwidthInOptional

public object InternetMaxBandwidthIn { get; }
  • Type: object

InternetMaxBandwidthOutOptional

public object InternetMaxBandwidthOut { get; }
  • Type: object

IoOptimizedOptional

public object IoOptimized { get; }
  • Type: object

Ipv6AddressCountOptional

public object Ipv6AddressCount { get; }
  • Type: object

KeyPairNameOptional

public object KeyPairName { get; }
  • Type: object

LoadBalancerWeightOptional

public object LoadBalancerWeight { get; }
  • Type: object

MemoryOptional

public object Memory { get; }
  • Type: object

PasswordOptional

public object Password { get; }
  • Type: object

PasswordInheritOptional

public object PasswordInherit { get; }
  • Type: object

PrivatePoolOptionsOptional

public object PrivatePoolOptions { get; }
  • Type: object

RamRoleNameOptional

public object RamRoleName { get; }
  • Type: object

ResourceGroupIdOptional

public object ResourceGroupId { get; }
  • Type: object

ScalingConfigurationNameOptional

public object ScalingConfigurationName { get; }
  • Type: object

SecurityEnhancementStrategyOptional

public object SecurityEnhancementStrategy { get; }
  • Type: object

SecurityGroupIdOptional

public object SecurityGroupId { get; }
  • Type: object

SecurityGroupIdsOptional

public object SecurityGroupIds { get; }
  • Type: object

SpotDurationOptional

public object SpotDuration { get; }
  • Type: object

SpotInterruptionBehaviorOptional

public object SpotInterruptionBehavior { get; }
  • Type: object

SpotPriceLimitOptional

public object SpotPriceLimit { get; }
  • Type: object

SpotPriceLimitForInstanceTypeOptional

public object SpotPriceLimitForInstanceType { get; }
  • Type: object

SpotStrategyOptional

public object SpotStrategy { get; }
  • Type: object

SystemDiskAutoSnapshotPolicyIdOptional

public object SystemDiskAutoSnapshotPolicyId { get; }
  • Type: object

SystemDiskBurstingEnabledOptional

public object SystemDiskBurstingEnabled { get; }
  • Type: object

SystemDiskCategoriesOptional

public object SystemDiskCategories { get; }
  • Type: object

SystemDiskCategoryOptional

public object SystemDiskCategory { get; }
  • Type: object

SystemDiskDescriptionOptional

public object SystemDiskDescription { get; }
  • Type: object

SystemDiskDiskNameOptional

public object SystemDiskDiskName { get; }
  • Type: object

SystemDiskEncryptAlgorithmOptional

public object SystemDiskEncryptAlgorithm { get; }
  • Type: object

SystemDiskEncryptedOptional

public object SystemDiskEncrypted { get; }
  • Type: object

SystemDiskKmsKeyIdOptional

public object SystemDiskKmsKeyId { get; }
  • Type: object

SystemDiskPerformanceLevelOptional

public object SystemDiskPerformanceLevel { get; }
  • Type: object

SystemDiskProvisionedIopsOptional

public object SystemDiskProvisionedIops { get; }
  • Type: object

SystemDiskSizeOptional

public object SystemDiskSize { get; }
  • Type: object

TagListOptional

public object TagList { get; }
  • Type: object

TenancyOptional

public object Tenancy { get; }
  • Type: object

UserDataOptional

public object UserData { get; }
  • Type: object

ZoneIdOptional

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