ALIYUN::ESS::ScalingGroupEnable - Enable a scaling group - Resource Orchestration Service

Syntaxe

{
  "Type": "ALIYUN::ESS::ScalingGroupEnable",
  "Properties": {
    "ScalingConfigurationId": String,
    "ScalingRuleArisExecuteVersion": Integer,
    "ScalingRuleAris": List,
    "ScalingGroupId": String,
    "RemoveInstanceIds": List,
    "InstanceIds": List,
    "DetachOptions": Map,
    "AttachOptions": Map
  }
}

Propriétés

Propriété

Type

Obligatoire

Modifiable

Description

Contrainte

ScalingGroupId

String

Oui

Non

ID du groupe de mise à l'échelle.

Aucune.

ScalingConfigurationId

String

Non

ID de la configuration de mise à l'échelle à activer dans le groupe.

Aucune.

InstanceIds

List

Non

Oui

ID des instances ECS à ajouter au groupe après son activation.

Maximum : 20 ID d'instance.

ScalingRuleArisExecuteVersion

Integer

Non

Oui

Version d'exécution de l'identifiant de règle de mise à l'échelle. La modification de cette valeur déclenche une exécution unique de toutes les règles spécifiées par ScalingRuleAris.

Valeur minimale : 0.

ScalingRuleAris

List

Non

Oui

Identifiants uniques des règles de mise à l'échelle à exécuter. Les règles inactives sont ignorées.

Maximum : 10.

RemoveInstanceIds

List

Non

Oui

ID des instances ECS à supprimer du groupe de mise à l'échelle.

Maximum : 1 000 ID d'instance.

DetachOptions

Map

Non

Oui

Options de suppression des instances du groupe de mise à l'échelle.

Propriétés DetachOptions

AttachOptions

Map

Non

Oui

Options d'ajout d'instances au groupe de mise à l'échelle.

Propriétés AttachOptions

Syntaxe AttachOptions

{
    "LifecycleHook": Boolean,
    "Entrusted": Boolean
}

Propriétés AttachOptions

Propriété

Type

Obligatoire

Modifiable

Description

Contrainte

LifecycleHook

Boolean

Non

Oui

Indique s'il faut déclencher un hook de cycle de vie lors du scale-out (augmentation de capacité).

Valeur par défaut : false. Valeurs valides :

true
false

Entrusted

Boolean

Non

Oui

Indique si le groupe de mise à l'échelle gère le cycle de vie des instances ajoutées manuellement.

Valeur par défaut : false. Valeurs valides :

true : Le groupe gère les instances ajoutées manuellement et celles créées automatiquement de la même manière.

Les instances supprimées via DetachInstances ne sont pas libérées. Dans les autres cas, les instances sont libérées lors de leur suppression.
false : Le groupe ne gère pas les instances ajoutées manuellement. Ces instances ne sont pas libérées lors de leur suppression.

Remarque

Ne s'applique pas aux instances avec abonnement.

Syntaxe DetachOptions

{
    "LifecycleHook": Boolean,
    "DecreaseDesiredCapacity": Boolean,
    "DetachOption": "String"
}

Propriétés DetachOptions

Propriété	Type	Obligatoire	Modifiable	Description	Contrainte
LifecycleHook	Boolean	Non	Oui	Indique s'il faut déclencher un hook de cycle de vie lors du scale-in (réduction de capacité).	Valeur par défaut : false. Valeurs valides : true false
DecreaseDesiredCapacity	Boolean	Non	Oui	Indique s'il faut modifier le nombre souhaité d'instances dans le groupe de mise à l'échelle.	Valeur par défaut : true. Valeurs valides : true : La capacité souhaitée diminue lorsque des instances sont supprimées. false : La capacité souhaitée reste inchangée lorsque des instances sont supprimées.
DetachOption	String	Non	Oui	Indique s'il faut supprimer les instances du groupe de serveurs par défaut SLB associé et des groupes vServer, ainsi que leurs adresses IP de la liste d'autorisation ApsaraDB RDS associée.	Définissez cette option sur les deux valeurs pour supprimer les instances du groupe de serveurs par défaut et des groupes vServer de l'instance SLB associée, et pour supprimer leurs adresses IP de la liste d'autorisation ApsaraDB RDS.

Valeurs de retour

Fn::GetAtt

LifecycleState : état du groupe de mise à l'échelle.
ScalingInstances : instances créées automatiquement dans le groupe de mise à l'échelle.
ScalingGroupId : ID du groupe de mise à l'échelle.
ScalingRuleArisExecuteResultInstancesRemoved : instances supprimées par l'exécution des règles de mise à l'échelle ScalingRuleAris.
ScalingRuleArisExecuteResultNumberOfAddedInstances : nombre d'instances ajoutées par l'exécution des règles de mise à l'échelle ScalingRuleAris.
ScalingInstanceDetails : détails des instances impliquées dans les activités de mise à l'échelle.
ScalingRuleArisExecuteErrorInfo : détails des erreurs survenues lors de l'exécution des règles de mise à l'échelle ScalingRuleAris.
ScalingRuleArisExecuteResultInstancesAdded : instances ajoutées par l'exécution des règles de mise à l'échelle ScalingRuleAris.

Exemples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ECSInstanceIds:
    Type: CommaDelimitedList
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
  AutoScalingGroupId:
    Type: String
    AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
  ScalingConfigurationId:
    Type: String
    AssociationProperty: ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId
Resources:
  ScalingGroupEnable:
    Type: ALIYUN::ESS::ScalingGroupEnable
    Properties:
      ScalingGroupId:
        Ref: AutoScalingGroupId
      ScalingConfigurationId:
        Ref: ScalingConfigurationId
      InstanceIds:
        Ref: InstanceIds
Outputs:
  ScalingGroupEnable:
    Value:
      Fn::GetAtt:
        - ScalingGroupEnable
        - LifecycleState

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ECSInstanceIds": {
      "Type": "CommaDelimitedList",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId"
    },
    "AutoScalingGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId"
    },
    "ScalingConfigurationId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId"
    }
  },
  "Resources": {
    "ScalingGroupEnable": {
      "Type": "ALIYUN::ESS::ScalingGroupEnable",
      "Properties": {
        "ScalingGroupId": {
          "Ref": "AutoScalingGroupId"
        },
        "ScalingConfigurationId": {
          "Ref": "ScalingConfigurationId"
        },
        "InstanceIds": {
          "Ref": "InstanceIds"
        }
      }
    }
  },
  "Outputs": {
    "ScalingGroupEnable": {
      "Value": {
        "Fn::GetAtt": [
          "ScalingGroupEnable",
          "LifecycleState"
        ]
      }
    }
  }
}