• /
  • EnglishEspañolFrançais日本語한국어Português
  • Se connecterDémarrer

Cette traduction automatique est fournie pour votre commodité.

En cas d'incohérence entre la version anglaise et la version traduite, la version anglaise prévaudra. Veuillez visiter cette page pour plus d'informations.

Créer un problème

Actions AWS Auto Scaling

|View as Markdown (English)

Cette page fournit une référence pour les actions AWS Auto Scaling disponibles dans le catalogue des actions d’automatisation workflow. Utilisez ces actions pour gérer les groupes Auto Scaling (ASG) : attacher et détacher des instances, ajuster la capacité, exécuter des politiques de mise à l’échelle, gérer les actualisations d’instance, contrôler les processus de mise à l’échelle et interroger l’état des ASG.

Prérequis

Pour les prérequis et la configuration des identifiants, consultez Configurer les identifiants AWS.

Attacher des instances

L’identifiant de l’action est aws.autoscaling.attachInstances.

Attachez une ou plusieurs instances EC2 à un groupe Auto Scaling existant. L’attachement d’instances augmente la capacité souhaitée du nombre attaché. Vous pouvez attacher jusqu’à 20 instances par appel. Les instances doivent être à l’état en cours d’exécution ou arrêté, et l’attachement ne doit pas dépasser la taille maximale du groupe.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

instanceIds

List

Obligatoire.

ID d’instance EC2 à attacher.

["i-0123456789abcdef0", "i-0fedcba9876543210"]

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "success", "expression": ".success"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

attach_instances — Boto3 documentation

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant attache une instance EC2 à un groupe Auto Scaling.

Exemple de workflow

name: asg-attach-instances
workflowInputs:
  arnRole:
    type: String
  asgName:
    type: String
steps:
  - name: attachInstances
    type: action
    action: aws.autoscaling.attachInstances
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: ${{ .workflowInputs.asgName }}
      instanceIds:
        - i-0123456789abcdef0
    next: end

Détacher des instances

L’identifiant de l’action est aws.autoscaling.detachInstances.

Détachez une ou plusieurs instances EC2 d'un groupe Auto Scaling. Vous pouvez détacher jusqu'à 20 instances par appel. Les instances doivent être à l'état InService ou Standby. Si shouldDecrementDesiredCapacity est false, l'ASG procède au lancement d'instances de remplacement pour maintenir la capacité souhaitée.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

instanceIds

List

Obligatoire.

ID d’instance EC2 à détacher.

["i-0123456789abcdef0"]

shouldDecrementDesiredCapacity

Booléen

Obligatoire.

Si

true

, réduit la capacité souhaitée du nombre d’instances détachées. Si

false

, l’ASG procède au lancement de remplacements.

true

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "activities", "expression": ".response.Activities"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

detach_instances — Documentation Boto3

pour obtenir la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant détache une instance et décrémente la capacité souhaitée.

Exemple de workflow

name: asg-detach-instances
workflowInputs:
  arnRole:
    type: String
steps:
  - name: detachInstances
    type: action
    action: aws.autoscaling.detachInstances
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      instanceIds:
        - i-0123456789abcdef0
      shouldDecrementDesiredCapacity: true
    next: end

Définir la capacité souhaitée

L’identifiant de l’action est aws.autoscaling.setDesiredCapacity.

Mettre à jour le nombre d’instances souhaité d’un groupe Auto Scaling. La nouvelle valeur doit être comprise entre MinSize et MaxSize du groupe. Si honorCooldown est true, la demande est rejetée lorsque l’ASG est dans sa période de refroidissement.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

desiredCapacity

Int

Obligatoire.

Nombre cible d’instances. Doit être compris entre

MinSize

et

MaxSize

du groupe.

3

honorCooldown

Booléen

Facultatif.

Si

true

, rejette la demande lorsque l’ASG est dans une période de refroidissement. La valeur par défaut est

false

.

false

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "success", "expression": ".success"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

set_desired_capacity — Boto3 documentation

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant définit la capacité souhaitée à 5 instances.

Exemple de workflow

name: asg-set-capacity
workflowInputs:
  arnRole:
    type: String
steps:
  - name: setDesiredCapacity
    type: action
    action: aws.autoscaling.setDesiredCapacity
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      desiredCapacity: 5
      honorCooldown: false
    next: end

Exécuter une politique de mise à l'échelle

L’identifiant de l’action est aws.autoscaling.executePolicy.

Exécuter une politique de dimensionnement nommée sur un groupe Auto Scaling. La politique doit déjà exister sur le groupe. Pour les politiques de dimensionnement par étapes, metricValue et breachThreshold peuvent remplacer le seuil de la politique. Si honorCooldown est true et que l’ASG est en période de refroidissement, l’appel réussit, mais aucune activité de dimensionnement n’est déclenchée.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

policyName

Chaîne

Obligatoire.

Nom ou ARN de la politique de mise à l’échelle à exécuter.

"my-scale-out-policy"

honorCooldown

Booléen

Facultatif.

Si

true

et que l’ASG est en période de refroidissement, l’appel réussit mais aucune activité de mise à l’échelle n’est déclenchée.

false

metricValue

Chaîne

Facultatif.

Remplacement de la valeur de la métrique pour les politiques de mise à l’échelle par étapes.

"50.0"

breachThreshold

Chaîne

Facultatif.

Remplacement du seuil de dépassement pour les politiques de mise à l’échelle par étapes.

"70.0"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "success", "expression": ".success"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

execute_policy - Documentation Boto3

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant exécute une politique de dimensionnement horizontal nommée.

Exemple de workflow

name: asg-execute-policy
workflowInputs:
  arnRole:
    type: String
steps:
  - name: executePolicy
    type: action
    action: aws.autoscaling.executePolicy
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      policyName: my-scale-out-policy
      honorCooldown: false
    next: end

Démarrer une actualisation d'instance

L’identifiant de l’action est aws.autoscaling.startInstanceRefresh.

Initiez un remplacement par roulement des instances à l’aide du dernier modèle de lancement ou de la dernière configuration. Une seule actualisation peut être active par groupe à la fois ; si une actualisation est déjà en cours, l’appel échoue avec InstanceRefreshInProgress. Utilisez aws.autoscaling.describeInstanceRefreshes pour interroger le statut.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

stratégie

Chaîne

Facultatif.

Stratégie d’actualisation.

"Rolling"

est la seule valeur prise en charge.

"Rolling"

préférences

Carte

Facultatif.

Préférences d’actualisation.

MinHealthyPercentage

contrôle combien d’instances restent saines pendant le remplacement (par défaut 90 %).

InstanceWarmup

définit le temps d’attente après qu’une instance a atteint

InService

avant de remplacer le lot suivant.

{"MinHealthyPercentage": 90, "InstanceWarmup": 300}

desiredConfiguration

Carte

Facultatif.

Remplacez le modèle de lancement ou la configuration pour cette actualisation.

{"LaunchTemplate": {"LaunchTemplateId": "lt-0123456789abcdef0", "Version": "2"}}

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "instanceRefreshId", "expression": ".response.InstanceRefreshId"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient

InstanceRefreshId

(chaîne UUID) identifiant l’actualisation. Consultez

start_instance_refresh — Documentation Boto3

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant démarre une actualisation continue d’instance avec un minimum de 90 % d’instances saines.

Exemple de workflow

name: asg-start-refresh
workflowInputs:
  arnRole:
    type: String
steps:
  - name: startInstanceRefresh
    type: action
    action: aws.autoscaling.startInstanceRefresh
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      strategy: Rolling
      preferences:
        MinHealthyPercentage: 90
        InstanceWarmup: 300
      selectors:
        - name: instanceRefreshId
          expression: '.response.InstanceRefreshId'
    next: end

Annuler une actualisation d'instance

L’identifiant de l’action est aws.autoscaling.cancelInstanceRefresh.

Annulez une actualisation d’instance en cours. Seule une actualisation en cours peut être annulée : l’appel de cette action lorsqu’aucune actualisation n’est active échoue avec ActiveInstanceRefreshNotFound. Les instances déjà remplacées ne sont pas rétablies ; utilisez aws.autoscaling.rollbackInstanceRefresh pour rétablir les instances remplacées.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "instanceRefreshId", "expression": ".response.InstanceRefreshId"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient

InstanceRefreshId

de l’actualisation annulée. Consultez

cancel_instance_refresh — documentation Boto3

pour obtenir la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant annule une actualisation d’instance en cours.

Exemple de workflow

name: asg-cancel-refresh
workflowInputs:
  arnRole:
    type: String
steps:
  - name: cancelRefresh
    type: action
    action: aws.autoscaling.cancelInstanceRefresh
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      selectors:
        - name: instanceRefreshId
          expression: '.response.InstanceRefreshId'
    next: end

Effectuer un retour arrière d'une actualisation d'instance

L’identifiant de l’action est aws.autoscaling.rollbackInstanceRefresh.

Annulez une actualisation d’instance en cours, en restaurant les instances remplacées à leur modèle de lancement, ou configuration précédents. Le groupe doit avoir un point de contrôle activé pour prendre en charge l’annulation. Si aucune actualisation n’est éligible pour l’annulation, l’appel échoue avec ActiveInstanceRefreshNotFound.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "instanceRefreshId", "expression": ".response.InstanceRefreshId"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient

InstanceRefreshId

de l’actualisation annulée. Consultez

rollback_instance_refresh — Documentation Boto3

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant annule une actualisation d’instance en cours.

Exemple de workflow

name: asg-rollback-refresh
workflowInputs:
  arnRole:
    type: String
steps:
  - name: rollbackRefresh
    type: action
    action: aws.autoscaling.rollbackInstanceRefresh
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      selectors:
        - name: instanceRefreshId
          expression: '.response.InstanceRefreshId'
    next: end

Suspendre les processus de mise à l'échelle

L’identifiant de l’action est aws.autoscaling.suspendProcesses.

Suspendre un ou plusieurs processus de mise à l’échelle pour un groupe Auto Scaling. Utilisez cette option pendant les déploiements ou les fenêtres de maintenance pour éviter toute activité de mise à l’échelle indésirable. Si vous omettez scalingProcesses, tous les processus sont suspendus. Les processus suspendus le restent jusqu’à ce qu’ils soient explicitement repris avec aws.autoscaling.resumeProcesses.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

scalingProcesses

List

Facultatif.

Processus à suspendre. Omettez pour suspendre tous les processus. Valeurs valides :

Launch

,

Terminate

,

HealthCheck

,

ReplaceUnhealthy

,

AZRebalance

,

AlarmNotification

,

ScheduledActions

,

AddToLoadBalancer

,

InstanceRefresh

.

["Launch", "Terminate", "HealthCheck"]

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "success", "expression": ".success"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

suspend_processes — Boto3 documentation

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant suspend les processus de lancement, Terminate, et HealthCheck avant un déploiement.

Exemple de workflow

name: asg-suspend-for-deploy
workflowInputs:
  arnRole:
    type: String
steps:
  - name: suspendProcesses
    type: action
    action: aws.autoscaling.suspendProcesses
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      scalingProcesses:
        - Launch
        - Terminate
        - HealthCheck
    next: end

Reprendre les processus de mise à l'échelle

L’identifiant de l’action est aws.autoscaling.resumeProcesses.

Reprenez un ou plusieurs processus de mise à l’échelle suspendus. Utilisez après des déploiements ou des fenêtres de maintenance pour restaurer le comportement de mise à l’échelle normal. Si vous omettez scalingProcesses, tous les processus suspendus sont repris. Si aucun processus n’est actuellement suspendu, l’appel réussit sans effet.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

scalingProcesses

List

Facultatif.

Processus à reprendre. Omettez pour reprendre tous les processus suspendus.

["Launch", "Terminate", "HealthCheck"]

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "success", "expression": ".success"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

resume_processes — Documentation Boto3

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant reprend les processus de mise à l’échelle après un déploiement.

Exemple de workflow

name: asg-resume-after-deploy
workflowInputs:
  arnRole:
    type: String
steps:
  - name: resumeProcesses
    type: action
    action: aws.autoscaling.resumeProcesses
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      scalingProcesses:
        - Launch
        - Terminate
        - HealthCheck
    next: end

Terminer une instance dans un groupe

L’identifiant de l’action est aws.autoscaling.terminateInstanceInAutoScalingGroup.

Mettez fin à une instance spécifique dans un groupe Auto Scaling tout en respectant les crochets de cycle de vie. Définissez shouldDecrementDesiredCapacity sur false pour remplacer l'instance automatiquement, ou sur true pour réduire le groupe.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

instanceId

Chaîne

Obligatoire.

ID de l’instance EC2 à résilier.

"i-0123456789abcdef0"

shouldDecrementDesiredCapacity

Booléen

Obligatoire.

Si

true

, réduit la capacité souhaitée de 1. Si

false

, un lancement d’instance de remplacement est effectué automatiquement.

false

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "activityStatus", "expression": ".response.Activity.StatusCode"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient un objet

Activity

avec

ActivityId

,

StatusCode

, et

Progress

. Consultez

terminate_instance_in_auto_scaling_group — Documentation Boto3

pour connaître la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant met fin à une instance défectueuse, et effectue un lancement de remplacement.

Exemple de workflow

name: asg-terminate-unhealthy-instance
workflowInputs:
  arnRole:
    type: String
steps:
  - name: terminateInstance
    type: action
    action: aws.autoscaling.terminateInstanceInAutoScalingGroup
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      instanceId: i-0123456789abcdef0
      shouldDecrementDesiredCapacity: false
      selectors:
        - name: activityStatus
          expression: '.response.Activity.StatusCode'
    next: end

Mettre des instances en veille

L’identifiant de l’action est aws.autoscaling.enterStandby.

Passez une ou plusieurs instances en mode veille, en les retirant de la rotation active sans y mettre fin. Utilisez cette option pour la maintenance sur des instances spécifiques. Associez-le à aws.autoscaling.exitStandby pour remettre les instances en service.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

instanceIds

List

Facultatif.

ID d’instance à passer en mode veille. Omettre pour déplacer toutes les instances.

["i-0123456789abcdef0"]

shouldDecrementDesiredCapacity

Booléen

Obligatoire.

Si

true

, réduit la capacité souhaitée du nombre d’instances entrant en veille.

true

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "activities", "expression": ".response.Activities"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient un éventail

Activities

décrivant la transition en veille de chaque instance. Consultez

enter_standby — documentation Boto3

pour obtenir la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L'exemple suivant place une instance en attente pour la maintenance.

Exemple de workflow

name: asg-enter-standby
workflowInputs:
  arnRole:
    type: String
steps:
  - name: enterStandby
    type: action
    action: aws.autoscaling.enterStandby
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      instanceIds:
        - i-0123456789abcdef0
      shouldDecrementDesiredCapacity: true
    next: end

Quitter le mode veille

L’identifiant de l’action est aws.autoscaling.exitStandby.

Remettre une ou plusieurs instances du mode veille en rotation active. Associez à aws.autoscaling.enterStandby une fois la maintenance terminée. Si vous omettez instanceIds, toutes les instances en veille sont remises en service.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

instanceIds

List

Facultatif.

ID d’instance à remettre en rotation active. Omettez pour faire sortir toutes les instances en veille.

["i-0123456789abcdef0"]

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "activities", "expression": ".response.Activities"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient un éventail

Activities

décrivant le retour en service de chaque instance. Consultez

exit_standby — Boto3 documentation

pour obtenir la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant remet une instance en service à partir du mode veille après une maintenance.

Exemple de workflow

name: asg-exit-standby
workflowInputs:
  arnRole:
    type: String
steps:
  - name: exitStandby
    type: action
    action: aws.autoscaling.exitStandby
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      instanceIds:
        - i-0123456789abcdef0
    next: end

Créer ou mettre à jour une action planifiée

L’identifiant de l’action est aws.autoscaling.putScheduledUpdateGroupAction.

Créez ou mettez à jour une action de mise à l’échelle planifiée pour un groupe Auto Scaling. Utilisez recurrence pour les planifications basées sur cron ou startTime pour les modifications ponctuelles. Associez avec aws.autoscaling.deleteScheduledAction pour supprimer des actions.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

scheduledActionName

Chaîne

Obligatoire.

Nom de l’action planifiée à créer ou à mettre à jour.

"scale-down-nights"

startTime

Chaîne

Facultatif.

Horodatage UTC ISO 8601 du moment où l’action prend effet.

"2024-06-01T20:00:00Z"

endTime

Chaîne

Facultatif.

Horodatage UTC ISO 8601 du moment où l’action récurrente s’arrête.

"2024-12-31T23:59:59Z"

récurrence

Chaîne

Facultatif.

Expression Cron pour les planifications récurrentes.

"0 20 * * *"

timeZone

Chaîne

Facultatif.

Fuseau horaire IANA pour l’expression cron de récurrence.

"America/New_York"

minSize

Int

Facultatif.

Taille minimale du groupe à appliquer à l’heure prévue.

1

maxSize

Int

Facultatif.

Taille maximale du groupe à appliquer à l’heure prévue.

10

desiredCapacity

Int

Facultatif.

Capacité souhaitée à appliquer à l’heure prévue.

2

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "success", "expression": ".success"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

put_scheduled_update_group_action - Documentation Boto3

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant crée une action de réduction nocturne.

Exemple de workflow

name: asg-create-scheduled-action
workflowInputs:
  arnRole:
    type: String
steps:
  - name: putScheduledAction
    type: action
    action: aws.autoscaling.putScheduledUpdateGroupAction
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      scheduledActionName: scale-down-nights
      recurrence: "0 20 * * *"
      timeZone: America/New_York
      desiredCapacity: 2
      minSize: 1
    next: end

Supprimer une action planifiée

L’identifiant de l’action est aws.autoscaling.deleteScheduledAction.

Supprimez une action de mise à l’échelle planifiée d’un groupe Auto Scaling. Une seule action peut être supprimée par appel. Si le nom de l’action n’existe pas, l’appel échoue avec ValidationError. La suppression d’une action n’affecte aucune activité de mise à l’échelle déjà en cours.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

scheduledActionName

Chaîne

Obligatoire.

Nom de l’action planifiée à supprimer.

"scale-down-nights"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "success", "expression": ".success"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

delete_scheduled_action — Documentation Boto3

pour obtenir la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant supprime une action de mise à l’échelle planifiée.

Exemple de workflow

name: asg-delete-scheduled-action
workflowInputs:
  arnRole:
    type: String
steps:
  - name: deleteScheduledAction
    type: action
    action: aws.autoscaling.deleteScheduledAction
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      scheduledActionName: scale-down-nights
    next: end

Mettre à jour un groupe Auto Scaling

L’identifiant de l’action est aws.autoscaling.updateAutoScalingGroup.

Mettez à jour la configuration d’un groupe Auto Scaling existant : taille min/max, capacité souhaitée, paramètres de vérification de l’état, modèle de lancement, et plus. Utilisez le mappage parameters pour transmettre tout champ supplémentaire de l’ API boto3 update_auto_scaling_group non répertorié ci-dessous.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling à mettre à jour.

"my-asg"

minSize

Int

Facultatif.

Nouvelle taille minimale du groupe.

1

maxSize

Int

Facultatif.

Nouvelle taille maximale du groupe.

10

desiredCapacity

Int

Facultatif.

Nouveau nombre d’instances souhaité.

3

defaultCooldown

Int

Facultatif.

Délai de refroidissement par défaut en secondes.

300

healthCheckType

Chaîne

Facultatif.

Type de vérification de l'état. Valeurs autorisées :

EC2

,

ELB

.

"ELB"

healthCheckGracePeriod

Int

Facultatif.

Secondes après le lancement de l'instance avant le début des contrôles d'état.

300

paramètres

Carte

Facultatif.

Tous les champs boto3

update_auto_scaling_group

supplémentaires non répertoriés ci-dessus.

{"LaunchTemplate": {"LaunchTemplateId": "lt-0123456789abcdef0", "Version": "$Latest"}, "TerminationPolicies": ["OldestInstance"]}

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "success", "expression": ".success"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Objet de réponse de l’API AWS. Consultez

update_auto_scaling_group — Documentation Boto3

pour obtenir la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant met à jour les limites min/max, le type de vérification de l’état, et le modèle de lancement.

Exemple de workflow

name: asg-update-group
workflowInputs:
  arnRole:
    type: String
steps:
  - name: updateAutoScalingGroup
    type: action
    action: aws.autoscaling.updateAutoScalingGroup
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      minSize: 2
      maxSize: 20
      desiredCapacity: 5
      healthCheckType: ELB
      healthCheckGracePeriod: 300
      parameters:
        LaunchTemplate:
          LaunchTemplateId: lt-0123456789abcdef0
          Version: $Latest
        TerminationPolicies:
          - OldestInstance
    next: end

Décrire les groupes Auto Scaling

L’identifiant de l’action est aws.autoscaling.describeAutoScalingGroups.

Décrit un ou plusieurs groupes Auto Scaling, en renvoyant la configuration et l’état de l’instance. Si vous omettez autoScalingGroupNames, tous les groupes de la région sont renvoyés. Utilisez maxRecords et nextToken pour paginer les grands ensembles de résultats.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupNames

List

Facultatif.

Noms des groupes à décrire. Omettez pour renvoyer tous les groupes de la région.

["my-asg", "my-other-asg"]

maxRecords

Int

Facultatif.

Nombre maximal de groupes à retourner. Max 100.

10

nextToken

Chaîne

Facultatif.

Jeton de pagination d’une réponse précédente.

"abcdefgh"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "desiredCapacity", "expression": ".response.AutoScalingGroups[0].DesiredCapacity"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient un éventail

AutoScalingGroups

avec la configuration et l’état de l’instance pour chaque groupe. Consultez

describe_auto_scaling_groups — Boto3 documentation

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L'exemple suivant récupère la capacité souhaitée, le min, le max, et le nombre d'instances pour un groupe.

Exemple de workflow

name: asg-describe-group
workflowInputs:
  arnRole:
    type: String
steps:
  - name: describeGroups
    type: action
    action: aws.autoscaling.describeAutoScalingGroups
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupNames:
        - my-asg
      selectors:
        - name: desiredCapacity
          expression: '.response.AutoScalingGroups[0].DesiredCapacity'
        - name: minSize
          expression: '.response.AutoScalingGroups[0].MinSize'
        - name: maxSize
          expression: '.response.AutoScalingGroups[0].MaxSize'
        - name: instanceCount
          expression: '.response.AutoScalingGroups[0].Instances | length'
    next: end

Décrire les actualisations d'instance

L’identifiant de l’action est aws.autoscaling.describeInstanceRefreshes.

Décrivez l’état d’une ou plusieurs actualisations d’instance pour un groupe Auto Scaling. Utilisez pour interroger une actualisation démarrée par aws.autoscaling.startInstanceRefresh. Si vous omettez instanceRefreshIds, toutes les actualisations pour le groupe sont renvoyées, les plus récentes en premier. Les actualisations terminées, annulées, et échouées sont conservées dans l’historique.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Obligatoire.

Nom du groupe Auto Scaling.

"my-asg"

instanceRefreshIds

List

Facultatif.

ID des actualisations spécifiques à décrire. Omettez pour obtenir toutes les actualisations du groupe.

["08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"]

maxRecords

Int

Facultatif.

Nombre maximal d'actualisations à renvoyer. Défaut 50, max 100.

10

nextToken

Chaîne

Facultatif.

Jeton de pagination d’une réponse précédente.

"abcdefgh"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "status", "expression": ".response.InstanceRefreshes[0].Status"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient un éventail

InstanceRefreshes

avec

Status

,

PercentageComplete

, et d’autres détails d’actualisation. Consultez

describe_instance_refreshes — Boto3 documentation

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant interroge le statut d’une actualisation démarrée lors d’une étape précédente.

Exemple de workflow

name: asg-poll-refresh
workflowInputs:
  arnRole:
    type: String
steps:
  - name: describeRefresh
    type: action
    action: aws.autoscaling.describeInstanceRefreshes
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      instanceRefreshIds:
        - ${{ .steps.startRefresh.outputs.instanceRefreshId }}
      selectors:
        - name: refreshStatus
          expression: '.response.InstanceRefreshes[0].Status'
        - name: percentComplete
          expression: '.response.InstanceRefreshes[0].PercentageComplete'
    next: end

Décrire les activités de mise à l'échelle

L’identifiant de l’action est aws.autoscaling.describeScalingActivities.

Décrit les activités de mise à l’échelle pour un groupe Auto Scaling, y compris les événements en cours et récemment terminés. Si vous omettez activityIds, toutes les activités du groupe sont renvoyées, les plus récentes en premier. Les activités incluent à la fois les événements de scale-in et de scale-out réussis et en échec.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Facultatif.

Nom du groupe pour la requête. Omettez pour renvoyer les activités de tous les groupes.

"my-asg"

activityIds

List

Facultatif.

ID des activités spécifiques à renvoyer.

["3b05db05-2f6e-4e86-af95-29f1f4c2a2b7"]

includeDeletedGroups

Booléen

Facultatif.

Si

true

, inclut les activités des groupes supprimés.

false

maxRecords

Int

Facultatif.

Nombre maximal d’activités à renvoyer. Maximum 100.

10

nextToken

Chaîne

Facultatif.

Jeton de pagination d’une réponse précédente.

"abcdefgh"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "latestStatus", "expression": ".response.Activities[0].StatusCode"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient un éventail

Activities

avec

ActivityId

,

StatusCode

,

Cause

, et des champs d’horodatage. Consultez

describe_scaling_activities — Boto3 documentation

pour obtenir la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant récupère les 5 activités de mise à l’échelle les plus récentes.

Exemple de workflow

name: asg-check-activities
workflowInputs:
  arnRole:
    type: String
steps:
  - name: describeActivities
    type: action
    action: aws.autoscaling.describeScalingActivities
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      maxRecords: 5
      selectors:
        - name: latestActivity
          expression: '.response.Activities[0].StatusCode'
    next: end

Décrire les actions planifiées

L’identifiant de l’action est aws.autoscaling.describeScheduledActions.

Décrit les actions de mise à l’échelle planifiées pour un groupe Auto Scaling. Si vous omettez scheduledActionNames, toutes les actions pour le groupe sont renvoyées. Filtrez par startTime et endTime pour restreindre les résultats à une fenêtre de temps : ces filtres sont ignorés lorsque scheduledActionNames est fourni.

Le tableau suivant décrit tous les champs de saisie disponibles pour cette action.

Saisir

Type

Description

Exemple

awsRoleArn

Chaîne

Facultatif.

ARN du rôle IAM. L’exécuteur assume ce rôle via STS pour s’authentifier auprès d’AWS. Recommandé par rapport aux identifiants statiques. Au moins un champ d’authentification est requis.

arn:aws:iam::123456789012:role/my-workflow-role

awsAccessKeyId

Chaîne

Facultatif.

ID de clé d’accès AWS. Doit être transmis en tant que référence de secret.

${{ :secrets:awsAccessKeyId }}

awsSecretAccessKey

Chaîne

Facultatif.

Clé d’accès secrète AWS. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSecretAccessKey }}

awsSessionToken

Chaîne

Facultatif.

Jeton de session AWS pour les identifiants temporaires. Doit être transmis en tant que référence secrète.

${{ :secrets:awsSessionToken }}

région

Chaîne

Obligatoire.

Région AWS où se trouve le groupe Auto Scaling.

"us-east-1"

autoScalingGroupName

Chaîne

Facultatif.

Nom du groupe pour la requête. Omettez pour lister les actions de tous les groupes.

"my-asg"

scheduledActionNames

List

Facultatif.

Noms des actions spécifiques à renvoyer. Les noms inconnus sont ignorés silencieusement.

["scale-down-nights", "scale-up-mornings"]

startTime

Chaîne

Facultatif.

Limite inférieure de l'horodatage UTC ISO 8601 pour le filtrage des résultats.

"2024-01-01T00:00:00Z"

endTime

Chaîne

Facultatif.

Limite supérieure de l'horodatage UTC ISO 8601 pour le filtrage des résultats.

"2024-12-31T23:59:59Z"

maxRecords

Int

Facultatif.

Nombre maximal d’actions à renvoyer. Maximum 100.

10

nextToken

Chaîne

Facultatif.

Jeton de pagination d’une réponse précédente.

"abcdefgh"

selectors

List

Facultatif.

Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.

[{"name": "scheduledActions", "expression": ".response.ScheduledUpdateGroupActions"}]

Le tableau suivant décrit tous les champs de sortie renvoyés par cette action.

Sortir

Type

Description

response

Objet

Contient un éventail

ScheduledUpdateGroupActions

avec les champs nom, récurrence, fuseau horaire, et capacité pour chaque action. Consultez

describe_scheduled_actions — Boto3 documentation

pour la syntaxe complète de la réponse.

success

Booléen

true

si l’action a réussi,

false

sinon.

errorMessage

Chaîne

Message d’erreur si l’action a échoué.

null

en cas de succès.

L’exemple suivant répertorie toutes les actions planifiées pour un groupe.

Exemple de workflow

name: asg-list-scheduled-actions
workflowInputs:
  arnRole:
    type: String
steps:
  - name: describeScheduledActions
    type: action
    action: aws.autoscaling.describeScheduledActions
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      autoScalingGroupName: my-asg
      selectors:
        - name: scheduledActions
          expression: '.response.ScheduledUpdateGroupActions'
    next: end
Droits d'auteur © 2026 New Relic Inc.
RecrutementConditions de servicePolitique DMCAAvis de confidentialitéWebsite TermsAvis de brevetLoi sur l'esclavage moderne

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.