autoscaling-2011-01-01.examples.json (43442B)
1 { 2 "version": "1.0", 3 "examples": { 4 "AttachInstances": [ 5 { 6 "input": { 7 "AutoScalingGroupName": "my-auto-scaling-group", 8 "InstanceIds": [ 9 "i-93633f9b" 10 ] 11 }, 12 "comments": { 13 "input": { 14 }, 15 "output": { 16 } 17 }, 18 "description": "This example attaches the specified instance to the specified Auto Scaling group.", 19 "id": "autoscaling-attach-instances-1", 20 "title": "To attach an instance to an Auto Scaling group" 21 } 22 ], 23 "AttachLoadBalancerTargetGroups": [ 24 { 25 "input": { 26 "AutoScalingGroupName": "my-auto-scaling-group", 27 "TargetGroupARNs": [ 28 "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" 29 ] 30 }, 31 "comments": { 32 "input": { 33 }, 34 "output": { 35 } 36 }, 37 "description": "This example attaches the specified target group to the specified Auto Scaling group.", 38 "id": "autoscaling-attach-load-balancer-target-groups-1", 39 "title": "To attach a target group to an Auto Scaling group" 40 } 41 ], 42 "AttachLoadBalancers": [ 43 { 44 "input": { 45 "AutoScalingGroupName": "my-auto-scaling-group", 46 "LoadBalancerNames": [ 47 "my-load-balancer" 48 ] 49 }, 50 "comments": { 51 "input": { 52 }, 53 "output": { 54 } 55 }, 56 "description": "This example attaches the specified load balancer to the specified Auto Scaling group.", 57 "id": "autoscaling-attach-load-balancers-1", 58 "title": "To attach a load balancer to an Auto Scaling group" 59 } 60 ], 61 "CompleteLifecycleAction": [ 62 { 63 "input": { 64 "AutoScalingGroupName": "my-auto-scaling-group", 65 "LifecycleActionResult": "CONTINUE", 66 "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", 67 "LifecycleHookName": "my-lifecycle-hook" 68 }, 69 "comments": { 70 "input": { 71 }, 72 "output": { 73 } 74 }, 75 "description": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.", 76 "id": "autoscaling-complete-lifecycle-action-1", 77 "title": "To complete the lifecycle action" 78 } 79 ], 80 "CreateAutoScalingGroup": [ 81 { 82 "input": { 83 "AutoScalingGroupName": "my-auto-scaling-group", 84 "LaunchConfigurationName": "my-launch-config", 85 "MaxSize": 3, 86 "MinSize": 1, 87 "VPCZoneIdentifier": "subnet-4176792c" 88 }, 89 "comments": { 90 "input": { 91 }, 92 "output": { 93 } 94 }, 95 "description": "This example creates an Auto Scaling group.", 96 "id": "autoscaling-create-auto-scaling-group-1", 97 "title": "To create an Auto Scaling group" 98 }, 99 { 100 "input": { 101 "AutoScalingGroupName": "my-auto-scaling-group", 102 "AvailabilityZones": [ 103 "us-west-2c" 104 ], 105 "HealthCheckGracePeriod": 120, 106 "HealthCheckType": "ELB", 107 "LaunchConfigurationName": "my-launch-config", 108 "LoadBalancerNames": [ 109 "my-load-balancer" 110 ], 111 "MaxSize": 3, 112 "MinSize": 1 113 }, 114 "comments": { 115 "input": { 116 }, 117 "output": { 118 } 119 }, 120 "description": "This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.", 121 "id": "autoscaling-create-auto-scaling-group-2", 122 "title": "To create an Auto Scaling group with an attached load balancer" 123 }, 124 { 125 "input": { 126 "AutoScalingGroupName": "my-auto-scaling-group", 127 "HealthCheckGracePeriod": 120, 128 "HealthCheckType": "ELB", 129 "LaunchConfigurationName": "my-launch-config", 130 "MaxSize": 3, 131 "MinSize": 1, 132 "TargetGroupARNs": [ 133 "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" 134 ], 135 "VPCZoneIdentifier": "subnet-4176792c, subnet-65ea5f08" 136 }, 137 "comments": { 138 "input": { 139 }, 140 "output": { 141 } 142 }, 143 "description": "This example creates an Auto Scaling group and attaches the specified target group.", 144 "id": "autoscaling-create-auto-scaling-group-3", 145 "title": "To create an Auto Scaling group with an attached target group" 146 } 147 ], 148 "CreateLaunchConfiguration": [ 149 { 150 "input": { 151 "IamInstanceProfile": "my-iam-role", 152 "ImageId": "ami-12345678", 153 "InstanceType": "m3.medium", 154 "LaunchConfigurationName": "my-launch-config", 155 "SecurityGroups": [ 156 "sg-eb2af88e" 157 ] 158 }, 159 "comments": { 160 "input": { 161 }, 162 "output": { 163 } 164 }, 165 "description": "This example creates a launch configuration.", 166 "id": "autoscaling-create-launch-configuration-1", 167 "title": "To create a launch configuration" 168 } 169 ], 170 "CreateOrUpdateTags": [ 171 { 172 "input": { 173 "Tags": [ 174 { 175 "Key": "Role", 176 "PropagateAtLaunch": true, 177 "ResourceId": "my-auto-scaling-group", 178 "ResourceType": "auto-scaling-group", 179 "Value": "WebServer" 180 }, 181 { 182 "Key": "Dept", 183 "PropagateAtLaunch": true, 184 "ResourceId": "my-auto-scaling-group", 185 "ResourceType": "auto-scaling-group", 186 "Value": "Research" 187 } 188 ] 189 }, 190 "comments": { 191 "input": { 192 }, 193 "output": { 194 } 195 }, 196 "description": "This example adds two tags to the specified Auto Scaling group.", 197 "id": "autoscaling-create-or-update-tags-1", 198 "title": "To create or update tags for an Auto Scaling group" 199 } 200 ], 201 "DeleteAutoScalingGroup": [ 202 { 203 "input": { 204 "AutoScalingGroupName": "my-auto-scaling-group" 205 }, 206 "comments": { 207 "input": { 208 }, 209 "output": { 210 } 211 }, 212 "description": "This example deletes the specified Auto Scaling group.", 213 "id": "autoscaling-delete-auto-scaling-group-1", 214 "title": "To delete an Auto Scaling group" 215 }, 216 { 217 "input": { 218 "AutoScalingGroupName": "my-auto-scaling-group", 219 "ForceDelete": true 220 }, 221 "comments": { 222 "input": { 223 }, 224 "output": { 225 } 226 }, 227 "description": "This example deletes the specified Auto Scaling group and all its instances.", 228 "id": "autoscaling-delete-auto-scaling-group-2", 229 "title": "To delete an Auto Scaling group and all its instances" 230 } 231 ], 232 "DeleteLaunchConfiguration": [ 233 { 234 "input": { 235 "LaunchConfigurationName": "my-launch-config" 236 }, 237 "comments": { 238 "input": { 239 }, 240 "output": { 241 } 242 }, 243 "description": "This example deletes the specified launch configuration.", 244 "id": "autoscaling-delete-launch-configuration-1", 245 "title": "To delete a launch configuration" 246 } 247 ], 248 "DeleteLifecycleHook": [ 249 { 250 "input": { 251 "AutoScalingGroupName": "my-auto-scaling-group", 252 "LifecycleHookName": "my-lifecycle-hook" 253 }, 254 "comments": { 255 "input": { 256 }, 257 "output": { 258 } 259 }, 260 "description": "This example deletes the specified lifecycle hook.", 261 "id": "autoscaling-delete-lifecycle-hook-1", 262 "title": "To delete a lifecycle hook" 263 } 264 ], 265 "DeleteNotificationConfiguration": [ 266 { 267 "input": { 268 "AutoScalingGroupName": "my-auto-scaling-group", 269 "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" 270 }, 271 "comments": { 272 "input": { 273 }, 274 "output": { 275 } 276 }, 277 "description": "This example deletes the specified notification from the specified Auto Scaling group.", 278 "id": "autoscaling-delete-notification-configuration-1", 279 "title": "To delete an Auto Scaling notification" 280 } 281 ], 282 "DeletePolicy": [ 283 { 284 "input": { 285 "AutoScalingGroupName": "my-auto-scaling-group", 286 "PolicyName": "ScaleIn" 287 }, 288 "comments": { 289 "input": { 290 }, 291 "output": { 292 } 293 }, 294 "description": "This example deletes the specified Auto Scaling policy.", 295 "id": "autoscaling-delete-policy-1", 296 "title": "To delete an Auto Scaling policy" 297 } 298 ], 299 "DeleteScheduledAction": [ 300 { 301 "input": { 302 "AutoScalingGroupName": "my-auto-scaling-group", 303 "ScheduledActionName": "my-scheduled-action" 304 }, 305 "comments": { 306 "input": { 307 }, 308 "output": { 309 } 310 }, 311 "description": "This example deletes the specified scheduled action from the specified Auto Scaling group.", 312 "id": "autoscaling-delete-scheduled-action-1", 313 "title": "To delete a scheduled action from an Auto Scaling group" 314 } 315 ], 316 "DeleteTags": [ 317 { 318 "input": { 319 "Tags": [ 320 { 321 "Key": "Dept", 322 "ResourceId": "my-auto-scaling-group", 323 "ResourceType": "auto-scaling-group", 324 "Value": "Research" 325 } 326 ] 327 }, 328 "comments": { 329 "input": { 330 }, 331 "output": { 332 } 333 }, 334 "description": "This example deletes the specified tag from the specified Auto Scaling group.", 335 "id": "autoscaling-delete-tags-1", 336 "title": "To delete a tag from an Auto Scaling group" 337 } 338 ], 339 "DescribeAccountLimits": [ 340 { 341 "output": { 342 "MaxNumberOfAutoScalingGroups": 20, 343 "MaxNumberOfLaunchConfigurations": 100, 344 "NumberOfAutoScalingGroups": 3, 345 "NumberOfLaunchConfigurations": 5 346 }, 347 "comments": { 348 "input": { 349 }, 350 "output": { 351 } 352 }, 353 "description": "This example describes the Auto Scaling limits for your AWS account.", 354 "id": "autoscaling-describe-account-limits-1", 355 "title": "To describe your Auto Scaling account limits" 356 } 357 ], 358 "DescribeAdjustmentTypes": [ 359 { 360 "output": { 361 "AdjustmentTypes": [ 362 { 363 "AdjustmentType": "ChangeInCapacity" 364 }, 365 { 366 "AdjustmentType": "ExactCapcity" 367 }, 368 { 369 "AdjustmentType": "PercentChangeInCapacity" 370 } 371 ] 372 }, 373 "comments": { 374 "input": { 375 }, 376 "output": { 377 } 378 }, 379 "description": "This example describes the available adjustment types.", 380 "id": "autoscaling-describe-adjustment-types-1", 381 "title": "To describe the Auto Scaling adjustment types" 382 } 383 ], 384 "DescribeAutoScalingGroups": [ 385 { 386 "input": { 387 "AutoScalingGroupNames": [ 388 "my-auto-scaling-group" 389 ] 390 }, 391 "output": { 392 "AutoScalingGroups": [ 393 { 394 "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group", 395 "AutoScalingGroupName": "my-auto-scaling-group", 396 "AvailabilityZones": [ 397 "us-west-2c" 398 ], 399 "CreatedTime": "2013-08-19T20:53:25.584Z", 400 "DefaultCooldown": 300, 401 "DesiredCapacity": 1, 402 "EnabledMetrics": [ 403 404 ], 405 "HealthCheckGracePeriod": 300, 406 "HealthCheckType": "EC2", 407 "Instances": [ 408 { 409 "AvailabilityZone": "us-west-2c", 410 "HealthStatus": "Healthy", 411 "InstanceId": "i-4ba0837f", 412 "LaunchConfigurationName": "my-launch-config", 413 "LifecycleState": "InService" 414 } 415 ], 416 "LaunchConfigurationName": "my-launch-config", 417 "LoadBalancerNames": [ 418 419 ], 420 "MaxSize": 1, 421 "MinSize": 0, 422 "NewInstancesProtectedFromScaleIn": false, 423 "SuspendedProcesses": [ 424 425 ], 426 "Tags": [ 427 428 ], 429 "TerminationPolicies": [ 430 "Default" 431 ], 432 "VPCZoneIdentifier": "subnet-12345678" 433 } 434 ] 435 }, 436 "comments": { 437 "input": { 438 }, 439 "output": { 440 } 441 }, 442 "description": "This example describes the specified Auto Scaling group.", 443 "id": "autoscaling-describe-auto-scaling-groups-1", 444 "title": "To describe an Auto Scaling group" 445 } 446 ], 447 "DescribeAutoScalingInstances": [ 448 { 449 "input": { 450 "InstanceIds": [ 451 "i-4ba0837f" 452 ] 453 }, 454 "output": { 455 "AutoScalingInstances": [ 456 { 457 "AutoScalingGroupName": "my-auto-scaling-group", 458 "AvailabilityZone": "us-west-2c", 459 "HealthStatus": "HEALTHY", 460 "InstanceId": "i-4ba0837f", 461 "LaunchConfigurationName": "my-launch-config", 462 "LifecycleState": "InService", 463 "ProtectedFromScaleIn": false 464 } 465 ] 466 }, 467 "comments": { 468 "input": { 469 }, 470 "output": { 471 } 472 }, 473 "description": "This example describes the specified Auto Scaling instance.", 474 "id": "autoscaling-describe-auto-scaling-instances-1", 475 "title": "To describe one or more Auto Scaling instances" 476 } 477 ], 478 "DescribeAutoScalingNotificationTypes": [ 479 { 480 "output": { 481 "AutoScalingNotificationTypes": [ 482 "autoscaling:EC2_INSTANCE_LAUNCH", 483 "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", 484 "autoscaling:EC2_INSTANCE_TERMINATE", 485 "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", 486 "autoscaling:TEST_NOTIFICATION" 487 ] 488 }, 489 "comments": { 490 "input": { 491 }, 492 "output": { 493 } 494 }, 495 "description": "This example describes the available notification types.", 496 "id": "autoscaling-describe-auto-scaling-notification-types-1", 497 "title": "To describe the Auto Scaling notification types" 498 } 499 ], 500 "DescribeLaunchConfigurations": [ 501 { 502 "input": { 503 "LaunchConfigurationNames": [ 504 "my-launch-config" 505 ] 506 }, 507 "output": { 508 "LaunchConfigurations": [ 509 { 510 "AssociatePublicIpAddress": true, 511 "BlockDeviceMappings": [ 512 513 ], 514 "CreatedTime": "2014-05-07T17:39:28.599Z", 515 "EbsOptimized": false, 516 "ImageId": "ami-043a5034", 517 "InstanceMonitoring": { 518 "Enabled": true 519 }, 520 "InstanceType": "t1.micro", 521 "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", 522 "LaunchConfigurationName": "my-launch-config", 523 "SecurityGroups": [ 524 "sg-67ef0308" 525 ] 526 } 527 ] 528 }, 529 "comments": { 530 "input": { 531 }, 532 "output": { 533 } 534 }, 535 "description": "This example describes the specified launch configuration.", 536 "id": "autoscaling-describe-launch-configurations-1", 537 "title": "To describe Auto Scaling launch configurations" 538 } 539 ], 540 "DescribeLifecycleHookTypes": [ 541 { 542 "output": { 543 "LifecycleHookTypes": [ 544 "autoscaling:EC2_INSTANCE_LAUNCHING", 545 "autoscaling:EC2_INSTANCE_TERMINATING" 546 ] 547 }, 548 "comments": { 549 "input": { 550 }, 551 "output": { 552 } 553 }, 554 "description": "This example describes the available lifecycle hook types.", 555 "id": "autoscaling-describe-lifecycle-hook-types-1", 556 "title": "To describe the available types of lifecycle hooks" 557 } 558 ], 559 "DescribeLifecycleHooks": [ 560 { 561 "input": { 562 "AutoScalingGroupName": "my-auto-scaling-group" 563 }, 564 "output": { 565 "LifecycleHooks": [ 566 { 567 "AutoScalingGroupName": "my-auto-scaling-group", 568 "DefaultResult": "ABANDON", 569 "GlobalTimeout": 172800, 570 "HeartbeatTimeout": 3600, 571 "LifecycleHookName": "my-lifecycle-hook", 572 "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", 573 "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", 574 "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role" 575 } 576 ] 577 }, 578 "comments": { 579 "input": { 580 }, 581 "output": { 582 } 583 }, 584 "description": "This example describes the lifecycle hooks for the specified Auto Scaling group.", 585 "id": "autoscaling-describe-lifecycle-hooks-1", 586 "title": "To describe your lifecycle hooks" 587 } 588 ], 589 "DescribeLoadBalancerTargetGroups": [ 590 { 591 "input": { 592 "AutoScalingGroupName": "my-auto-scaling-group" 593 }, 594 "output": { 595 "LoadBalancerTargetGroups": [ 596 { 597 "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 598 "State": "Added" 599 } 600 ] 601 }, 602 "comments": { 603 "input": { 604 }, 605 "output": { 606 } 607 }, 608 "description": "This example describes the target groups attached to the specified Auto Scaling group.", 609 "id": "autoscaling-describe-load-balancer-target-groups-1", 610 "title": "To describe the target groups for an Auto Scaling group" 611 } 612 ], 613 "DescribeLoadBalancers": [ 614 { 615 "input": { 616 "AutoScalingGroupName": "my-auto-scaling-group" 617 }, 618 "output": { 619 "LoadBalancers": [ 620 { 621 "LoadBalancerName": "my-load-balancer", 622 "State": "Added" 623 } 624 ] 625 }, 626 "comments": { 627 "input": { 628 }, 629 "output": { 630 } 631 }, 632 "description": "This example describes the load balancers attached to the specified Auto Scaling group.", 633 "id": "autoscaling-describe-load-balancers-1", 634 "title": "To describe the load balancers for an Auto Scaling group" 635 } 636 ], 637 "DescribeMetricCollectionTypes": [ 638 { 639 "output": { 640 "Granularities": [ 641 { 642 "Granularity": "1Minute" 643 } 644 ], 645 "Metrics": [ 646 { 647 "Metric": "GroupMinSize" 648 }, 649 { 650 "Metric": "GroupMaxSize" 651 }, 652 { 653 "Metric": "GroupDesiredCapacity" 654 }, 655 { 656 "Metric": "GroupInServiceInstances" 657 }, 658 { 659 "Metric": "GroupPendingInstances" 660 }, 661 { 662 "Metric": "GroupTerminatingInstances" 663 }, 664 { 665 "Metric": "GroupStandbyInstances" 666 }, 667 { 668 "Metric": "GroupTotalInstances" 669 } 670 ] 671 }, 672 "comments": { 673 "input": { 674 }, 675 "output": { 676 } 677 }, 678 "description": "This example describes the available metric collection types.", 679 "id": "autoscaling-describe-metric-collection-types-1", 680 "title": "To describe the Auto Scaling metric collection types" 681 } 682 ], 683 "DescribeNotificationConfigurations": [ 684 { 685 "input": { 686 "AutoScalingGroupNames": [ 687 "my-auto-scaling-group" 688 ] 689 }, 690 "output": { 691 "NotificationConfigurations": [ 692 { 693 "AutoScalingGroupName": "my-auto-scaling-group", 694 "NotificationType": "autoscaling:TEST_NOTIFICATION", 695 "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" 696 }, 697 { 698 "AutoScalingGroupName": "my-auto-scaling-group", 699 "NotificationType": "autoscaling:TEST_NOTIFICATION", 700 "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" 701 } 702 ] 703 }, 704 "comments": { 705 "input": { 706 }, 707 "output": { 708 } 709 }, 710 "description": "This example describes the notification configurations for the specified Auto Scaling group.", 711 "id": "autoscaling-describe-notification-configurations-1", 712 "title": "To describe Auto Scaling notification configurations" 713 } 714 ], 715 "DescribePolicies": [ 716 { 717 "input": { 718 "AutoScalingGroupName": "my-auto-scaling-group" 719 }, 720 "output": { 721 "ScalingPolicies": [ 722 { 723 "AdjustmentType": "ChangeInCapacity", 724 "Alarms": [ 725 726 ], 727 "AutoScalingGroupName": "my-auto-scaling-group", 728 "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", 729 "PolicyName": "ScaleIn", 730 "ScalingAdjustment": -1 731 }, 732 { 733 "AdjustmentType": "PercentChangeInCapacity", 734 "Alarms": [ 735 736 ], 737 "AutoScalingGroupName": "my-auto-scaling-group", 738 "Cooldown": 60, 739 "MinAdjustmentStep": 2, 740 "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", 741 "PolicyName": "ScalePercentChange", 742 "ScalingAdjustment": 25 743 } 744 ] 745 }, 746 "comments": { 747 "input": { 748 }, 749 "output": { 750 } 751 }, 752 "description": "This example describes the policies for the specified Auto Scaling group.", 753 "id": "autoscaling-describe-policies-1", 754 "title": "To describe Auto Scaling policies" 755 } 756 ], 757 "DescribeScalingActivities": [ 758 { 759 "input": { 760 "AutoScalingGroupName": "my-auto-scaling-group" 761 }, 762 "output": { 763 "Activities": [ 764 { 765 "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", 766 "AutoScalingGroupName": "my-auto-scaling-group", 767 "Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.", 768 "Description": "Launching a new EC2 instance: i-4ba0837f", 769 "Details": "details", 770 "EndTime": "2013-08-19T20:54:02Z", 771 "Progress": 100, 772 "StartTime": "2013-08-19T20:53:29.930Z", 773 "StatusCode": "Successful" 774 } 775 ] 776 }, 777 "comments": { 778 "input": { 779 }, 780 "output": { 781 } 782 }, 783 "description": "This example describes the scaling activities for the specified Auto Scaling group.", 784 "id": "autoscaling-describe-scaling-activities-1", 785 "title": "To describe the scaling activities for an Auto Scaling group" 786 } 787 ], 788 "DescribeScalingProcessTypes": [ 789 { 790 "output": { 791 "Processes": [ 792 { 793 "ProcessName": "AZRebalance" 794 }, 795 { 796 "ProcessName": "AddToLoadBalancer" 797 }, 798 { 799 "ProcessName": "AlarmNotification" 800 }, 801 { 802 "ProcessName": "HealthCheck" 803 }, 804 { 805 "ProcessName": "Launch" 806 }, 807 { 808 "ProcessName": "ReplaceUnhealthy" 809 }, 810 { 811 "ProcessName": "ScheduledActions" 812 }, 813 { 814 "ProcessName": "Terminate" 815 } 816 ] 817 }, 818 "comments": { 819 "input": { 820 }, 821 "output": { 822 } 823 }, 824 "description": "This example describes the Auto Scaling process types.", 825 "id": "autoscaling-describe-scaling-process-types-1", 826 "title": "To describe the Auto Scaling process types" 827 } 828 ], 829 "DescribeScheduledActions": [ 830 { 831 "input": { 832 "AutoScalingGroupName": "my-auto-scaling-group" 833 }, 834 "output": { 835 "ScheduledUpdateGroupActions": [ 836 { 837 "AutoScalingGroupName": "my-auto-scaling-group", 838 "DesiredCapacity": 4, 839 "MaxSize": 6, 840 "MinSize": 2, 841 "Recurrence": "30 0 1 12 0", 842 "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", 843 "ScheduledActionName": "my-scheduled-action", 844 "StartTime": "2016-12-01T00:30:00Z", 845 "Time": "2016-12-01T00:30:00Z" 846 } 847 ] 848 }, 849 "comments": { 850 "input": { 851 }, 852 "output": { 853 } 854 }, 855 "description": "This example describes the scheduled actions for the specified Auto Scaling group.", 856 "id": "autoscaling-describe-scheduled-actions-1", 857 "title": "To describe scheduled actions" 858 } 859 ], 860 "DescribeTags": [ 861 { 862 "input": { 863 "Filters": [ 864 { 865 "Name": "auto-scaling-group", 866 "Values": [ 867 "my-auto-scaling-group" 868 ] 869 } 870 ] 871 }, 872 "output": { 873 "Tags": [ 874 { 875 "Key": "Dept", 876 "PropagateAtLaunch": true, 877 "ResourceId": "my-auto-scaling-group", 878 "ResourceType": "auto-scaling-group", 879 "Value": "Research" 880 }, 881 { 882 "Key": "Role", 883 "PropagateAtLaunch": true, 884 "ResourceId": "my-auto-scaling-group", 885 "ResourceType": "auto-scaling-group", 886 "Value": "WebServer" 887 } 888 ] 889 }, 890 "comments": { 891 "input": { 892 }, 893 "output": { 894 } 895 }, 896 "description": "This example describes the tags for the specified Auto Scaling group.", 897 "id": "autoscaling-describe-tags-1", 898 "title": "To describe tags" 899 } 900 ], 901 "DescribeTerminationPolicyTypes": [ 902 { 903 "output": { 904 "TerminationPolicyTypes": [ 905 "ClosestToNextInstanceHour", 906 "Default", 907 "NewestInstance", 908 "OldestInstance", 909 "OldestLaunchConfiguration" 910 ] 911 }, 912 "comments": { 913 "input": { 914 }, 915 "output": { 916 } 917 }, 918 "description": "This example describes the available termination policy types.", 919 "id": "autoscaling-describe-termination-policy-types-1", 920 "title": "To describe termination policy types" 921 } 922 ], 923 "DetachInstances": [ 924 { 925 "input": { 926 "AutoScalingGroupName": "my-auto-scaling-group", 927 "InstanceIds": [ 928 "i-93633f9b" 929 ], 930 "ShouldDecrementDesiredCapacity": true 931 }, 932 "output": { 933 "Activities": [ 934 { 935 "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", 936 "AutoScalingGroupName": "my-auto-scaling-group", 937 "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", 938 "Description": "Detaching EC2 instance: i-93633f9b", 939 "Details": "details", 940 "Progress": 50, 941 "StartTime": "2015-04-12T15:02:16.179Z", 942 "StatusCode": "InProgress" 943 } 944 ] 945 }, 946 "comments": { 947 "input": { 948 }, 949 "output": { 950 } 951 }, 952 "description": "This example detaches the specified instance from the specified Auto Scaling group.", 953 "id": "autoscaling-detach-instances-1", 954 "title": "To detach an instance from an Auto Scaling group" 955 } 956 ], 957 "DetachLoadBalancerTargetGroups": [ 958 { 959 "input": { 960 "AutoScalingGroupName": "my-auto-scaling-group", 961 "TargetGroupARNs": [ 962 "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" 963 ] 964 }, 965 "comments": { 966 "input": { 967 }, 968 "output": { 969 } 970 }, 971 "description": "This example detaches the specified target group from the specified Auto Scaling group", 972 "id": "autoscaling-detach-load-balancer-target-groups-1", 973 "title": "To detach a target group from an Auto Scaling group" 974 } 975 ], 976 "DetachLoadBalancers": [ 977 { 978 "input": { 979 "AutoScalingGroupName": "my-auto-scaling-group", 980 "LoadBalancerNames": [ 981 "my-load-balancer" 982 ] 983 }, 984 "comments": { 985 "input": { 986 }, 987 "output": { 988 } 989 }, 990 "description": "This example detaches the specified load balancer from the specified Auto Scaling group.", 991 "id": "autoscaling-detach-load-balancers-1", 992 "title": "To detach a load balancer from an Auto Scaling group" 993 } 994 ], 995 "DisableMetricsCollection": [ 996 { 997 "input": { 998 "AutoScalingGroupName": "my-auto-scaling-group", 999 "Metrics": [ 1000 "GroupDesiredCapacity" 1001 ] 1002 }, 1003 "comments": { 1004 "input": { 1005 }, 1006 "output": { 1007 } 1008 }, 1009 "description": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.", 1010 "id": "autoscaling-disable-metrics-collection-1", 1011 "title": "To disable metrics collection for an Auto Scaling group" 1012 } 1013 ], 1014 "EnableMetricsCollection": [ 1015 { 1016 "input": { 1017 "AutoScalingGroupName": "my-auto-scaling-group", 1018 "Granularity": "1Minute" 1019 }, 1020 "comments": { 1021 "input": { 1022 }, 1023 "output": { 1024 } 1025 }, 1026 "description": "This example enables data collection for the specified Auto Scaling group.", 1027 "id": "autoscaling-enable-metrics-collection-1", 1028 "title": "To enable metrics collection for an Auto Scaling group" 1029 } 1030 ], 1031 "EnterStandby": [ 1032 { 1033 "input": { 1034 "AutoScalingGroupName": "my-auto-scaling-group", 1035 "InstanceIds": [ 1036 "i-93633f9b" 1037 ], 1038 "ShouldDecrementDesiredCapacity": true 1039 }, 1040 "output": { 1041 "Activities": [ 1042 { 1043 "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", 1044 "AutoScalingGroupName": "my-auto-scaling-group", 1045 "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", 1046 "Description": "Moving EC2 instance to Standby: i-93633f9b", 1047 "Details": "details", 1048 "Progress": 50, 1049 "StartTime": "2015-04-12T15:10:23.640Z", 1050 "StatusCode": "InProgress" 1051 } 1052 ] 1053 }, 1054 "comments": { 1055 "input": { 1056 }, 1057 "output": { 1058 } 1059 }, 1060 "description": "This example puts the specified instance into standby mode.", 1061 "id": "autoscaling-enter-standby-1", 1062 "title": "To move instances into standby mode" 1063 } 1064 ], 1065 "ExecutePolicy": [ 1066 { 1067 "input": { 1068 "AutoScalingGroupName": "my-auto-scaling-group", 1069 "HonorCooldown": true, 1070 "PolicyName": "ScaleIn" 1071 }, 1072 "comments": { 1073 "input": { 1074 }, 1075 "output": { 1076 } 1077 }, 1078 "description": "This example executes the specified Auto Scaling policy for the specified Auto Scaling group.", 1079 "id": "autoscaling-execute-policy-1", 1080 "title": "To execute an Auto Scaling policy" 1081 } 1082 ], 1083 "ExitStandby": [ 1084 { 1085 "input": { 1086 "AutoScalingGroupName": "my-auto-scaling-group", 1087 "InstanceIds": [ 1088 "i-93633f9b" 1089 ] 1090 }, 1091 "output": { 1092 "Activities": [ 1093 { 1094 "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", 1095 "AutoScalingGroupName": "my-auto-scaling-group", 1096 "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", 1097 "Description": "Moving EC2 instance out of Standby: i-93633f9b", 1098 "Details": "details", 1099 "Progress": 30, 1100 "StartTime": "2015-04-12T15:14:29.886Z", 1101 "StatusCode": "PreInService" 1102 } 1103 ] 1104 }, 1105 "comments": { 1106 "input": { 1107 }, 1108 "output": { 1109 } 1110 }, 1111 "description": "This example moves the specified instance out of standby mode.", 1112 "id": "autoscaling-exit-standby-1", 1113 "title": "To move instances out of standby mode" 1114 } 1115 ], 1116 "PutLifecycleHook": [ 1117 { 1118 "input": { 1119 "AutoScalingGroupName": "my-auto-scaling-group", 1120 "LifecycleHookName": "my-lifecycle-hook", 1121 "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", 1122 "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn", 1123 "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role" 1124 }, 1125 "comments": { 1126 "input": { 1127 }, 1128 "output": { 1129 } 1130 }, 1131 "description": "This example creates a lifecycle hook.", 1132 "id": "autoscaling-put-lifecycle-hook-1", 1133 "title": "To create a lifecycle hook" 1134 } 1135 ], 1136 "PutNotificationConfiguration": [ 1137 { 1138 "input": { 1139 "AutoScalingGroupName": "my-auto-scaling-group", 1140 "NotificationTypes": [ 1141 "autoscaling:TEST_NOTIFICATION" 1142 ], 1143 "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" 1144 }, 1145 "comments": { 1146 "input": { 1147 }, 1148 "output": { 1149 } 1150 }, 1151 "description": "This example adds the specified notification to the specified Auto Scaling group.", 1152 "id": "autoscaling-put-notification-configuration-1", 1153 "title": "To add an Auto Scaling notification" 1154 } 1155 ], 1156 "PutScalingPolicy": [ 1157 { 1158 "input": { 1159 "AdjustmentType": "ChangeInCapacity", 1160 "AutoScalingGroupName": "my-auto-scaling-group", 1161 "PolicyName": "ScaleIn", 1162 "ScalingAdjustment": -1 1163 }, 1164 "output": { 1165 "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn" 1166 }, 1167 "comments": { 1168 "input": { 1169 }, 1170 "output": { 1171 } 1172 }, 1173 "description": "This example adds the specified policy to the specified Auto Scaling group.", 1174 "id": "autoscaling-put-scaling-policy-1", 1175 "title": "To add a scaling policy to an Auto Scaling group" 1176 } 1177 ], 1178 "PutScheduledUpdateGroupAction": [ 1179 { 1180 "input": { 1181 "AutoScalingGroupName": "my-auto-scaling-group", 1182 "DesiredCapacity": 4, 1183 "EndTime": "2014-05-12T08:00:00Z", 1184 "MaxSize": 6, 1185 "MinSize": 2, 1186 "ScheduledActionName": "my-scheduled-action", 1187 "StartTime": "2014-05-12T08:00:00Z" 1188 }, 1189 "comments": { 1190 "input": { 1191 }, 1192 "output": { 1193 } 1194 }, 1195 "description": "This example adds the specified scheduled action to the specified Auto Scaling group.", 1196 "id": "autoscaling-put-scheduled-update-group-action-1", 1197 "title": "To add a scheduled action to an Auto Scaling group" 1198 } 1199 ], 1200 "RecordLifecycleActionHeartbeat": [ 1201 { 1202 "input": { 1203 "AutoScalingGroupName": "my-auto-scaling-group", 1204 "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", 1205 "LifecycleHookName": "my-lifecycle-hook" 1206 }, 1207 "comments": { 1208 "input": { 1209 }, 1210 "output": { 1211 } 1212 }, 1213 "description": "This example records a lifecycle action heartbeat to keep the instance in a pending state.", 1214 "id": "autoscaling-record-lifecycle-action-heartbeat-1", 1215 "title": "To record a lifecycle action heartbeat" 1216 } 1217 ], 1218 "ResumeProcesses": [ 1219 { 1220 "input": { 1221 "AutoScalingGroupName": "my-auto-scaling-group", 1222 "ScalingProcesses": [ 1223 "AlarmNotification" 1224 ] 1225 }, 1226 "comments": { 1227 "input": { 1228 }, 1229 "output": { 1230 } 1231 }, 1232 "description": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.", 1233 "id": "autoscaling-resume-processes-1", 1234 "title": "To resume Auto Scaling processes" 1235 } 1236 ], 1237 "SetDesiredCapacity": [ 1238 { 1239 "input": { 1240 "AutoScalingGroupName": "my-auto-scaling-group", 1241 "DesiredCapacity": 2, 1242 "HonorCooldown": true 1243 }, 1244 "comments": { 1245 "input": { 1246 }, 1247 "output": { 1248 } 1249 }, 1250 "description": "This example sets the desired capacity for the specified Auto Scaling group.", 1251 "id": "autoscaling-set-desired-capacity-1", 1252 "title": "To set the desired capacity for an Auto Scaling group" 1253 } 1254 ], 1255 "SetInstanceHealth": [ 1256 { 1257 "input": { 1258 "HealthStatus": "Unhealthy", 1259 "InstanceId": "i-93633f9b" 1260 }, 1261 "comments": { 1262 "input": { 1263 }, 1264 "output": { 1265 } 1266 }, 1267 "description": "This example sets the health status of the specified instance to Unhealthy.", 1268 "id": "autoscaling-set-instance-health-1", 1269 "title": "To set the health status of an instance" 1270 } 1271 ], 1272 "SetInstanceProtection": [ 1273 { 1274 "input": { 1275 "AutoScalingGroupName": "my-auto-scaling-group", 1276 "InstanceIds": [ 1277 "i-93633f9b" 1278 ], 1279 "ProtectedFromScaleIn": true 1280 }, 1281 "comments": { 1282 "input": { 1283 }, 1284 "output": { 1285 } 1286 }, 1287 "description": "This example enables instance protection for the specified instance.", 1288 "id": "autoscaling-set-instance-protection-1", 1289 "title": "To enable instance protection for an instance" 1290 }, 1291 { 1292 "input": { 1293 "AutoScalingGroupName": "my-auto-scaling-group", 1294 "InstanceIds": [ 1295 "i-93633f9b" 1296 ], 1297 "ProtectedFromScaleIn": false 1298 }, 1299 "comments": { 1300 "input": { 1301 }, 1302 "output": { 1303 } 1304 }, 1305 "description": "This example disables instance protection for the specified instance.", 1306 "id": "autoscaling-set-instance-protection-2", 1307 "title": "To disable instance protection for an instance" 1308 } 1309 ], 1310 "SuspendProcesses": [ 1311 { 1312 "input": { 1313 "AutoScalingGroupName": "my-auto-scaling-group", 1314 "ScalingProcesses": [ 1315 "AlarmNotification" 1316 ] 1317 }, 1318 "comments": { 1319 "input": { 1320 }, 1321 "output": { 1322 } 1323 }, 1324 "description": "This example suspends the specified scaling process for the specified Auto Scaling group.", 1325 "id": "autoscaling-suspend-processes-1", 1326 "title": "To suspend Auto Scaling processes" 1327 } 1328 ], 1329 "TerminateInstanceInAutoScalingGroup": [ 1330 { 1331 "input": { 1332 "InstanceId": "i-93633f9b", 1333 "ShouldDecrementDesiredCapacity": false 1334 }, 1335 "comments": { 1336 "input": { 1337 }, 1338 "output": { 1339 } 1340 }, 1341 "description": "This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.", 1342 "id": "autoscaling-terminate-instance-in-auto-scaling-group-1", 1343 "title": "To terminate an instance in an Auto Scaling group" 1344 } 1345 ], 1346 "UpdateAutoScalingGroup": [ 1347 { 1348 "input": { 1349 "AutoScalingGroupName": "my-auto-scaling-group", 1350 "LaunchConfigurationName": "new-launch-config" 1351 }, 1352 "comments": { 1353 "input": { 1354 }, 1355 "output": { 1356 } 1357 }, 1358 "description": "This example updates the launch configuration of the specified Auto Scaling group.", 1359 "id": "autoscaling-update-auto-scaling-group-1", 1360 "title": "To update the launch configuration" 1361 }, 1362 { 1363 "input": { 1364 "AutoScalingGroupName": "my-auto-scaling-group", 1365 "MaxSize": 3, 1366 "MinSize": 1 1367 }, 1368 "comments": { 1369 "input": { 1370 }, 1371 "output": { 1372 } 1373 }, 1374 "description": "This example updates the minimum size and maximum size of the specified Auto Scaling group.", 1375 "id": "autoscaling-update-auto-scaling-group-2", 1376 "title": "To update the minimum and maximum size" 1377 }, 1378 { 1379 "input": { 1380 "AutoScalingGroupName": "my-auto-scaling-group", 1381 "NewInstancesProtectedFromScaleIn": true 1382 }, 1383 "comments": { 1384 "input": { 1385 }, 1386 "output": { 1387 } 1388 }, 1389 "description": "This example enables instance protection for the specified Auto Scaling group.", 1390 "id": "autoscaling-update-auto-scaling-group-3", 1391 "title": "To enable instance protection" 1392 } 1393 ] 1394 } 1395 }