Skip to content

ScalingGroupEnable

This class encapsulates and extends the ROS resource type ALIYUN::ESS::ScalingGroupEnable.

Initializers

import com.aliyun.ros.cdk.ess.ScalingGroupEnable;
ScalingGroupEnable.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .scalingGroupId(java.lang.String)
    .scalingGroupId(IResolvable)
//  .attachOptions(IResolvable)
//  .attachOptions(AttachOptionsProperty)
//  .detachOptions(IResolvable)
//  .detachOptions(DetachOptionsProperty)
//  .instanceIds(IResolvable)
//  .instanceIds(java.util.List<java.lang.String)
//  .instanceIds(IResolvable>)
//  .removeInstanceIds(IResolvable)
//  .removeInstanceIds(java.util.List<java.lang.String)
//  .removeInstanceIds(IResolvable>)
//  .scalingConfigurationId(java.lang.String)
//  .scalingConfigurationId(IResolvable)
//  .scalingRuleAris(IResolvable)
//  .scalingRuleAris(java.util.List<java.lang.String)
//  .scalingRuleAris(IResolvable>)
//  .scalingRuleArisExecuteVersion(java.lang.Number)
//  .scalingRuleArisExecuteVersion(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
scalingGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scalingGroupId: The id of operated scaling group.
attachOptions com.aliyun.ros.cdk.core.IResolvable OR AttachOptionsProperty Property attachOptions: Options for attaching instances.
detachOptions com.aliyun.ros.cdk.core.IResolvable OR DetachOptionsProperty Property detachOptions: Options for detaching instances.
instanceIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property instanceIds: The id list of ECS instance which will be attached.
removeInstanceIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property removeInstanceIds: The id list of ECS instance which will be removed.
scalingConfigurationId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scalingConfigurationId: The id of scaling configuration which will be activate.
scalingRuleAris com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property scalingRuleAris: A list of scaling rule aris which will be executed.
scalingRuleArisExecuteVersion java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property scalingRuleArisExecuteVersion: The change of the property leads to the execution of all the scaling rule aris in ScalingRuleAris.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

scalingGroupIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property scalingGroupId: The id of operated scaling group.


attachOptionsOptional

Property attachOptions: Options for attaching instances.


detachOptionsOptional

Property detachOptions: Options for detaching instances.


instanceIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property instanceIds: The id list of ECS instance which will be attached.

Max support 1000 instances.


removeInstanceIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property removeInstanceIds: The id list of ECS instance which will be removed.

Max support 1000 instances.


scalingConfigurationIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property scalingConfigurationId: The id of scaling configuration which will be activate.


scalingRuleArisOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property scalingRuleAris: A list of scaling rule aris which will be executed.

Max support 10 scaling rule aris. When creating the resource, all the scaling rule aris in the list will be executed. When updating the resource, none of scaling rule aris in the list will be executed, unless ScalingRuleArisExecuteVersion is changed.


scalingRuleArisExecuteVersionOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property scalingRuleArisExecuteVersion: The change of the property leads to the execution of all the scaling rule aris in ScalingRuleAris.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public 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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.ess.ScalingGroupEnable;
ScalingGroupEnable.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrLifecycleState java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LifecycleState: The scaling group status.
attrScalingGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ScalingGroupId: The scaling group id.
attrScalingInstanceDetails java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ScalingInstanceDetails: Detail information of auto created scaling instances.
attrScalingInstances java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ScalingInstances: The auto created scaling instances.
attrScalingRuleArisExecuteErrorInfo java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ScalingRuleArisExecuteErrorInfo: The error info of the execution of scaling rule aris.
attrScalingRuleArisExecuteResultInstancesAdded java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ScalingRuleArisExecuteResultInstancesAdded: Instances added via the execution of scaling rule aris.
attrScalingRuleArisExecuteResultInstancesRemoved java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ScalingRuleArisExecuteResultInstancesRemoved: Instances removed via the execution of scaling rule aris.
attrScalingRuleArisExecuteResultNumberOfAddedInstances java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ScalingRuleArisExecuteResultNumberOfAddedInstances: The number of added vm via the execution of scaling rule aris.
props ScalingGroupEnableProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrLifecycleStateRequired

public java.lang.Object getAttrLifecycleState();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LifecycleState: The scaling group status.


attrScalingGroupIdRequired

public java.lang.Object getAttrScalingGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ScalingGroupId: The scaling group id.


attrScalingInstanceDetailsRequired

public java.lang.Object getAttrScalingInstanceDetails();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ScalingInstanceDetails: Detail information of auto created scaling instances.


attrScalingInstancesRequired

public java.lang.Object getAttrScalingInstances();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ScalingInstances: The auto created scaling instances.


attrScalingRuleArisExecuteErrorInfoRequired

public java.lang.Object getAttrScalingRuleArisExecuteErrorInfo();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ScalingRuleArisExecuteErrorInfo: The error info of the execution of scaling rule aris.


attrScalingRuleArisExecuteResultInstancesAddedRequired

public java.lang.Object getAttrScalingRuleArisExecuteResultInstancesAdded();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ScalingRuleArisExecuteResultInstancesAdded: Instances added via the execution of scaling rule aris.


attrScalingRuleArisExecuteResultInstancesRemovedRequired

public java.lang.Object getAttrScalingRuleArisExecuteResultInstancesRemoved();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ScalingRuleArisExecuteResultInstancesRemoved: Instances removed via the execution of scaling rule aris.


attrScalingRuleArisExecuteResultNumberOfAddedInstancesRequired

public java.lang.Object getAttrScalingRuleArisExecuteResultNumberOfAddedInstances();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ScalingRuleArisExecuteResultNumberOfAddedInstances: The number of added vm via the execution of scaling rule aris.


propsRequired

public ScalingGroupEnableProps getProps();