Exemples d’utilisation de l’AWS CLI avec Application Auto Scaling

Pour supprimer une stratégie de mise à l’échelle

Cet exemple supprime une stratégie de mise à l’échelle pour l’application Web du service Amazon ECS exécutée dans le cluster par défaut.

Commande :

aws application-autoscaling delete-scaling-policy --policy-name web-app-cpu-lt-25 --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app --service-namespace ecs

Pour supprimer une action planifiée

L’exemple delete-scheduled-action suivant supprime l’action planifiée spécifiée de la flotte Amazon AppStream 2.0 spécifiée :

aws application-autoscaling delete-scheduled-action \
    --service-namespace appstream \
    --scalable-dimension appstream:fleet:DesiredCapacity \
    --resource-id fleet/sample-fleet \
    --scheduled-action-name my-recurring-action

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Mise à l’échelle planifiée dans le Guide de l’utilisateur Application Auto Scaling.

Pour annuler l’enregistrement d’une cible évolutive

Cet exemple annule l’enregistrement d’une cible évolutive pour un service Amazon ECS appelé web-app qui s’exécute dans le cluster par défaut.

Commande :

aws application-autoscaling deregister-scalable-target --service-namespace ecs --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app

Cet exemple annule l’enregistrement d’une cible évolutive pour une ressource personnalisée. Le fichier custom-resource-id.txt contient une chaîne qui identifie l’ID de ressource, qui représente le chemin d’accès à la ressource personnalisée via votre point de terminaison Amazon API Gateway.

Commande :

aws application-autoscaling deregister-scalable-target --service-namespace custom-resource --scalable-dimension custom-resource:ResourceType:Property --resource-id file://~/custom-resource-id.txt

Contenu du fichier custom-resource-id.txt :

https://example.execute-api.us-west-2.amazonaws.com/prod/scalableTargetDimensions/1-23456789

Pour décrire des cibles évolutives

L’exemple describe-scalable-targets suivant décrit les cibles évolutives pour l’espace de noms de service ecs.

aws application-autoscaling describe-scalable-targets \
    --service-namespace ecs

Sortie :

{
    "ScalableTargets": [
        {
            "ServiceNamespace": "ecs",
            "ScalableDimension": "ecs:service:DesiredCount",
            "ResourceId": "service/default/web-app",
            "MinCapacity": 1,
            "MaxCapacity": 10,
            "RoleARN": "arn:aws:iam::123456789012:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService",
            "CreationTime": 1462558906.199,
            "SuspendedState": {
                "DynamicScalingOutSuspended": false,
                "ScheduledScalingSuspended": false,
                "DynamicScalingInSuspended": false
            },
            "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
        }
    ]
}

Pour plus d’informations, consultez Services AWS que vous pouvez utiliser avec Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.

Exemple 1 : pour décrire les activités de mise à l’échelle pour le service Amazon ECS spécifié

L’exemple describe-scaling-activities suivant décrit les activités de mise à l’échelle d’un service Amazon ECS appelé web-app qui s’exécute dans le cluster default. La sortie montre une activité de mise à l’échelle initiée par une stratégie de mise à l’échelle.

aws application-autoscaling describe-scaling-activities \
    --service-namespace ecs \
    --resource-id service/default/web-app

Sortie :

{
    "ScalingActivities": [
        {
            "ScalableDimension": "ecs:service:DesiredCount",
            "Description": "Setting desired count to 1.",
            "ResourceId": "service/default/web-app",
            "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399",
            "StartTime": 1462575838.171,
            "ServiceNamespace": "ecs",
            "EndTime": 1462575872.111,
            "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25",
            "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.",
            "StatusCode": "Successful"
        }
    ]
}

Pour plus d’informations, consultez Activités de mise à l’échelle pour Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.

Exemple 2 : pour décrire les activités de mise à l’échelle pour la table DynamoDB spécifiée

L’exemple describe-scaling-activities suivant décrit les activités de mise à l’échelle pour une table DynamoDB appelée TestTable. La sortie montre les activités de mise à l’échelle initiées par deux actions planifiées différentes.

aws application-autoscaling describe-scaling-activities \
    --service-namespace dynamodb \
    --resource-id table/TestTable

Sortie :

{
    "ScalingActivities": [
        {
            "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
            "Description": "Setting write capacity units to 10.",
            "ResourceId": "table/my-table",
            "ActivityId": "4d1308c0-bbcf-4514-a673-b0220ae38547",
            "StartTime": 1561574415.086,
            "ServiceNamespace": "dynamodb",
            "EndTime": 1561574449.51,
            "Cause": "maximum capacity was set to 10",
            "StatusMessage": "Successfully set write capacity units to 10. Change successfully fulfilled by dynamodb.",
            "StatusCode": "Successful"
        },
        {
            "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
            "Description": "Setting min capacity to 5 and max capacity to 10",
            "ResourceId": "table/my-table",
            "ActivityId": "f2b7847b-721d-4e01-8ef0-0c8d3bacc1c7",
            "StartTime": 1561574414.644,
            "ServiceNamespace": "dynamodb",
            "Cause": "scheduled action name my-second-scheduled-action was triggered",
            "StatusMessage": "Successfully set min capacity to 5 and max capacity to 10",
            "StatusCode": "Successful"
        },
        {
            "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
            "Description": "Setting write capacity units to 15.",
            "ResourceId": "table/my-table",
            "ActivityId": "d8ea4de6-9eaa-499f-b466-2cc5e681ba8b",
            "StartTime": 1561574108.904,
            "ServiceNamespace": "dynamodb",
            "EndTime": 1561574140.255,
            "Cause": "minimum capacity was set to 15",
            "StatusMessage": "Successfully set write capacity units to 15. Change successfully fulfilled by dynamodb.",
            "StatusCode": "Successful"
        },
        {
            "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
            "Description": "Setting min capacity to 15 and max capacity to 20",
            "ResourceId": "table/my-table",
            "ActivityId": "3250fd06-6940-4e8e-bb1f-d494db7554d2",
            "StartTime": 1561574108.512,
            "ServiceNamespace": "dynamodb",
            "Cause": "scheduled action name my-first-scheduled-action was triggered",
            "StatusMessage": "Successfully set min capacity to 15 and max capacity to 20",
            "StatusCode": "Successful"
        }
    ]
}

Pour plus d’informations, consultez Activités de mise à l’échelle pour Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.

Pour décrire les stratégies de mise à l’échelle

Cet exemple de commande décrit les stratégies de mise à l’échelle pour l’espace de noms du service ecs.

Commande :

aws application-autoscaling describe-scaling-policies --service-namespace ecs

Sortie :

{
    "ScalingPolicies": [
        {
            "PolicyName": "web-app-cpu-gt-75",
            "ScalableDimension": "ecs:service:DesiredCount",
            "ResourceId": "service/default/web-app",
            "CreationTime": 1462561899.23,
            "StepScalingPolicyConfiguration": {
                "Cooldown": 60,
                "StepAdjustments": [
                    {
                        "ScalingAdjustment": 200,
                        "MetricIntervalLowerBound": 0.0
                    }
                ],
                "AdjustmentType": "PercentChangeInCapacity"
            },
            "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75",
            "PolicyType": "StepScaling",
            "Alarms": [
                {
                    "AlarmName": "web-app-cpu-gt-75",
                    "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75"
                }
            ],
            "ServiceNamespace": "ecs"
        },
        {
            "PolicyName": "web-app-cpu-lt-25",
            "ScalableDimension": "ecs:service:DesiredCount",
            "ResourceId": "service/default/web-app",
            "CreationTime": 1462562575.099,
            "StepScalingPolicyConfiguration": {
                "Cooldown": 1,
                "StepAdjustments": [
                    {
                        "ScalingAdjustment": -50,
                        "MetricIntervalUpperBound": 0.0
                    }
                ],
                "AdjustmentType": "PercentChangeInCapacity"
            },
            "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-lt-25",
            "PolicyType": "StepScaling",
            "Alarms": [
                {
                    "AlarmName": "web-app-cpu-lt-25",
                    "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-lt-25"
                }
            ],
            "ServiceNamespace": "ecs"
        }
    ]
}

Pour décrire des actions planifiées

L’exemple describe-scheduled-actions suivant affiche les informations des actions planifiées pour l’espace de noms de service spécifié :

aws application-autoscaling describe-scheduled-actions \
    --service-namespace dynamodb

Sortie :

{
    "ScheduledActions": [
        {
            "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
            "Schedule": "at(2019-05-20T18:35:00)",
            "ResourceId": "table/my-table",
            "CreationTime": 1561571888.361,
            "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action",
            "ScalableTargetAction": {
                "MinCapacity": 15,
                "MaxCapacity": 20
            },
            "ScheduledActionName": "my-first-scheduled-action",
            "ServiceNamespace": "dynamodb"
        },
        {
            "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
            "Schedule": "at(2019-05-20T18:40:00)",
            "ResourceId": "table/my-table",
            "CreationTime": 1561571946.021,
            "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action",
            "ScalableTargetAction": {
                "MinCapacity": 5,
                "MaxCapacity": 10
            },
            "ScheduledActionName": "my-second-scheduled-action",
            "ServiceNamespace": "dynamodb"
        }
    ]
}

Pour plus d’informations, consultez Mise à l’échelle planifiée dans le Guide de l’utilisateur Application Auto Scaling.

Pour répertorier les balises pour une cible évolutive

L’exemple list-tags-for-resource suivant répertorie les noms et les valeurs des clés de balise associées à la cible évolutive spécifiée par son ARN.

aws application-autoscaling list-tags-for-resource \
    --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123

Sortie :

{
    "Tags": {
        "environment": "production"
    }
}

Pour plus d’informations, consultez Prise en charge du balisage pour Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.

Exemple 1 : pour appliquer une stratégie de mise à l’échelle de suivi de la cible avec une spécification de métrique prédéfinie

L’exemple put-scaling-policy suivant applique une stratégie de mise à l’échelle de suivi de la cible avec une spécification de métrique prédéfinie à un service Amazon ECS appelé web-app dans le cluster par défaut. Cette stratégie maintient l’utilisation moyenne du processeur à 75 %, avec des temps de stabilisation de 60 secondes pour la réduction et l’augmentation horizontales. La sortie contient l’ARN et le nom des deux alarmes CloudWatch créées en votre nom.

aws application-autoscaling put-scaling-policy --service-namespace ecs \
--scalable-dimension ecs:service:DesiredCount \
--resource-id service/default/web-app \
--policy-name cpu75-target-tracking-scaling-policy --policy-type TargetTrackingScaling \
--target-tracking-scaling-policy-configuration file://config.json

Cet exemple suppose que le répertoire en cours contient un fichier config.json dont le contenu est le suivant :

{
     "TargetValue": 75.0,
     "PredefinedMetricSpecification": {
         "PredefinedMetricType": "ECSServiceAverageCPUUtilization"
     },
     "ScaleOutCooldown": 60,
    "ScaleInCooldown": 60
}

Sortie :

{
    "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy",
    "Alarms": [
        {
            "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca",
            "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca"
        },
        {
            "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d",
            "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d"
        }
    ]
}

Exemple 2 : pour appliquer une stratégie de mise à l’échelle de suivi de la cible avec une spécification de métrique personnalisée

L’exemple put-scaling-policy suivant applique une stratégie de mise à l’échelle de suivi de la cible avec une spécification de métrique personnalisée à un service Amazon ECS appelé web-app dans le cluster par défaut. Cette stratégie maintient l’utilisation moyenne du service à 75 %, avec des temps de stabilisation de 60 secondes pour la réduction et l’augmentation horizontales. La sortie contient l’ARN et le nom des deux alarmes CloudWatch créées en votre nom.

aws application-autoscaling put-scaling-policy --service-namespace ecs \
--scalable-dimension ecs:service:DesiredCount \
--resource-id service/default/web-app \
--policy-name cms75-target-tracking-scaling-policy
--policy-type TargetTrackingScaling \
--target-tracking-scaling-policy-configuration file://config.json

Cet exemple suppose que le répertoire en cours contient un fichier config.json dont le contenu est le suivant :

{
    "TargetValue":75.0,
    "CustomizedMetricSpecification":{
        "MetricName":"MyUtilizationMetric",
        "Namespace":"MyNamespace",
        "Dimensions": [
            {
                "Name":"MyOptionalMetricDimensionName",
                "Value":"MyOptionalMetricDimensionValue"
            }
        ],
        "Statistic":"Average",
        "Unit":"Percent"
    },
    "ScaleOutCooldown": 60,
    "ScaleInCooldown": 60
}

Sortie :

{
    "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy: 8784a896-b2ba-47a1-b08c-27301cc499a1:resource/ecs/service/default/web-app:policyName/cms75-target-tracking-scaling-policy",
    "Alarms": [
        {
            "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0",
            "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0"
        },
        {
            "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4",
            "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4"
        }
    ]
}

Exemple 3 : pour appliquer une stratégie de mise à l’échelle de suivi de la cible uniquement en vue d’une augmentation horizontale

L’exemple put-scaling-policy suivant applique une stratégie de mise à l’échelle de suivi de la cible sur un service Amazon ECS appelé web-app dans le cluster par défaut. Cette stratégie est utilisée pour augmenter horizontalement le service ECS lorsque la métrique RequestCountPerTarget de l’Application Load Balancer dépasse le seuil. La sortie contient l’ARN et le nom de l’alarme CloudWatch créés en votre nom.

aws application-autoscaling put-scaling-policy \
    --service-namespace ecs \
    --scalable-dimension ecs:service:DesiredCount \
    --resource-id service/default/web-app \
    --policy-name alb-scale-out-target-tracking-scaling-policy \
    --policy-type TargetTrackingScaling \
    --target-tracking-scaling-policy-configuration file://config.json

Contenu de config.json :

{
     "TargetValue": 1000.0,
     "PredefinedMetricSpecification": {
         "PredefinedMetricType": "ALBRequestCountPerTarget",
         "ResourceLabel": "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d"
     },
     "ScaleOutCooldown": 60,
    "ScaleInCooldown": 60,
    "DisableScaleIn": true
}

Sortie :

{
    "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/alb-scale-out-target-tracking-scaling-policy",
    "Alarms": [
        {
            "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca",
            "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca"
        }
    ]
}

Pour plus d’informations, consultez Stratégies de mise à l’échelle Suivi de la cible pour Application Auto Scaling dans le Guide de l’utilisateur AWS Application Auto Scaling.

Pour ajouter une action planifiée à une table DynamoDB

Cet exemple ajoute une action planifiée à une table DynamoDB appelée TestTable pour augmenter horizontalement la capacité selon un calendrier récurrent. Selon la planification spécifiée (tous les jours à 12 h 15 UTC), si la capacité actuelle est inférieure à la valeur spécifiée pour MinCapacity, Application Auto Scaling augmente horizontalement la valeur spécifiée pour qu’elle corresponde à MinCapacity.

Commande :

aws application-autoscaling put-scheduled-action --service-namespace dynamodb --scheduled-action-name my-recurring-action --schedule "cron(15 12 * * ? *)" --resource-id table/TestTable --scalable-dimension dynamodb:table:WriteCapacityUnits --scalable-target-action MinCapacity=6

Pour plus d’informations, consultez Mise à l’échelle planifiée dans le Guide de l’utilisateur Application Auto Scaling.

Exemple 1 : pour enregistrer un service ECS en tant que cible évolutive

L’exemple register-scalable-target suivant enregistre un service Amazon ECS avec Application Auto Scaling. Il ajoute également une balise avec le nom de la clé environment et la valeur production à la cible évolutive.

aws application-autoscaling register-scalable-target \
    --service-namespace ecs \
    --scalable-dimension ecs:service:DesiredCount \
    --resource-id service/default/web-app \
    --min-capacity 1 --max-capacity 10 \
    --tags environment=production

Sortie :

{
    "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}

Pour des exemples d’autres services AWS et ressources personnalisées, consultez les rubriques dans Services AWS que vous pouvez utiliser avec Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.

Exemple 2 : pour suspendre les activités de mise à l’échelle pour une cible évolutive

L’exemple register-scalable-target suivant suspend les activités de mise à l’échelle pour une cible évolutive existante.

aws application-autoscaling register-scalable-target \
    --service-namespace dynamodb \
    --scalable-dimension dynamodb:table:ReadCapacityUnits \
    --resource-id table/my-table \
    --suspended-state DynamicScalingInSuspended=true,DynamicScalingOutSuspended=true,ScheduledScalingSuspended=true

Sortie :

{
    "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}

Pour plus d’informations, consultez Suspension et reprise de la mise à l’échelle pour Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.

Exemple 3 : pour reprendre les activités de mise à l’échelle pour une cible évolutive

L’exemple register-scalable-target suivant reprend les activités de mise à l’échelle pour une cible évolutive existante.

aws application-autoscaling register-scalable-target \
    --service-namespace dynamodb \
    --scalable-dimension dynamodb:table:ReadCapacityUnits \
    --resource-id table/my-table \
    --suspended-state DynamicScalingInSuspended=false,DynamicScalingOutSuspended=false,ScheduledScalingSuspended=false

Sortie :

{
    "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}

Pour plus d’informations, consultez Suspension et reprise de la mise à l’échelle pour Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.

Pour ajouter une balise à une cible évolutive

L’exemple tag-resource suivant ajoute une balise avec le nom de clé environment et la valeur production à la cible évolutive spécifiée par son ARN.

aws application-autoscaling tag-resource \
    --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 \
    --tags environment=production

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Prise en charge du balisage pour Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.

Pour supprimer une balise d’une cible évolutive

L’exemple untag-resource suivant supprime la paire de balises avec le nom de clé environment de la cible évolutive spécifiée par son ARN.

aws application-autoscaling untag-resource \
    --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 \
    --tag-keys "environment"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Prise en charge du balisage pour Application Auto Scaling dans le Guide de l’utilisateur Application Auto Scaling.