UNPKG

43.5 kBJSONView Raw
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 "ProtectedFromScaleIn": false
415 }
416 ],
417 "LaunchConfigurationName": "my-launch-config",
418 "LoadBalancerNames": [
419
420 ],
421 "MaxSize": 1,
422 "MinSize": 0,
423 "NewInstancesProtectedFromScaleIn": false,
424 "SuspendedProcesses": [
425
426 ],
427 "Tags": [
428
429 ],
430 "TerminationPolicies": [
431 "Default"
432 ],
433 "VPCZoneIdentifier": "subnet-12345678"
434 }
435 ]
436 },
437 "comments": {
438 "input": {
439 },
440 "output": {
441 }
442 },
443 "description": "This example describes the specified Auto Scaling group.",
444 "id": "autoscaling-describe-auto-scaling-groups-1",
445 "title": "To describe an Auto Scaling group"
446 }
447 ],
448 "DescribeAutoScalingInstances": [
449 {
450 "input": {
451 "InstanceIds": [
452 "i-4ba0837f"
453 ]
454 },
455 "output": {
456 "AutoScalingInstances": [
457 {
458 "AutoScalingGroupName": "my-auto-scaling-group",
459 "AvailabilityZone": "us-west-2c",
460 "HealthStatus": "HEALTHY",
461 "InstanceId": "i-4ba0837f",
462 "LaunchConfigurationName": "my-launch-config",
463 "LifecycleState": "InService",
464 "ProtectedFromScaleIn": false
465 }
466 ]
467 },
468 "comments": {
469 "input": {
470 },
471 "output": {
472 }
473 },
474 "description": "This example describes the specified Auto Scaling instance.",
475 "id": "autoscaling-describe-auto-scaling-instances-1",
476 "title": "To describe one or more Auto Scaling instances"
477 }
478 ],
479 "DescribeAutoScalingNotificationTypes": [
480 {
481 "output": {
482 "AutoScalingNotificationTypes": [
483 "autoscaling:EC2_INSTANCE_LAUNCH",
484 "autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
485 "autoscaling:EC2_INSTANCE_TERMINATE",
486 "autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
487 "autoscaling:TEST_NOTIFICATION"
488 ]
489 },
490 "comments": {
491 "input": {
492 },
493 "output": {
494 }
495 },
496 "description": "This example describes the available notification types.",
497 "id": "autoscaling-describe-auto-scaling-notification-types-1",
498 "title": "To describe the Auto Scaling notification types"
499 }
500 ],
501 "DescribeLaunchConfigurations": [
502 {
503 "input": {
504 "LaunchConfigurationNames": [
505 "my-launch-config"
506 ]
507 },
508 "output": {
509 "LaunchConfigurations": [
510 {
511 "AssociatePublicIpAddress": true,
512 "BlockDeviceMappings": [
513
514 ],
515 "CreatedTime": "2014-05-07T17:39:28.599Z",
516 "EbsOptimized": false,
517 "ImageId": "ami-043a5034",
518 "InstanceMonitoring": {
519 "Enabled": true
520 },
521 "InstanceType": "t1.micro",
522 "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config",
523 "LaunchConfigurationName": "my-launch-config",
524 "SecurityGroups": [
525 "sg-67ef0308"
526 ]
527 }
528 ]
529 },
530 "comments": {
531 "input": {
532 },
533 "output": {
534 }
535 },
536 "description": "This example describes the specified launch configuration.",
537 "id": "autoscaling-describe-launch-configurations-1",
538 "title": "To describe Auto Scaling launch configurations"
539 }
540 ],
541 "DescribeLifecycleHookTypes": [
542 {
543 "output": {
544 "LifecycleHookTypes": [
545 "autoscaling:EC2_INSTANCE_LAUNCHING",
546 "autoscaling:EC2_INSTANCE_TERMINATING"
547 ]
548 },
549 "comments": {
550 "input": {
551 },
552 "output": {
553 }
554 },
555 "description": "This example describes the available lifecycle hook types.",
556 "id": "autoscaling-describe-lifecycle-hook-types-1",
557 "title": "To describe the available types of lifecycle hooks"
558 }
559 ],
560 "DescribeLifecycleHooks": [
561 {
562 "input": {
563 "AutoScalingGroupName": "my-auto-scaling-group"
564 },
565 "output": {
566 "LifecycleHooks": [
567 {
568 "AutoScalingGroupName": "my-auto-scaling-group",
569 "DefaultResult": "ABANDON",
570 "GlobalTimeout": 172800,
571 "HeartbeatTimeout": 3600,
572 "LifecycleHookName": "my-lifecycle-hook",
573 "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING",
574 "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic",
575 "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role"
576 }
577 ]
578 },
579 "comments": {
580 "input": {
581 },
582 "output": {
583 }
584 },
585 "description": "This example describes the lifecycle hooks for the specified Auto Scaling group.",
586 "id": "autoscaling-describe-lifecycle-hooks-1",
587 "title": "To describe your lifecycle hooks"
588 }
589 ],
590 "DescribeLoadBalancerTargetGroups": [
591 {
592 "input": {
593 "AutoScalingGroupName": "my-auto-scaling-group"
594 },
595 "output": {
596 "LoadBalancerTargetGroups": [
597 {
598 "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
599 "State": "Added"
600 }
601 ]
602 },
603 "comments": {
604 "input": {
605 },
606 "output": {
607 }
608 },
609 "description": "This example describes the target groups attached to the specified Auto Scaling group.",
610 "id": "autoscaling-describe-load-balancer-target-groups-1",
611 "title": "To describe the target groups for an Auto Scaling group"
612 }
613 ],
614 "DescribeLoadBalancers": [
615 {
616 "input": {
617 "AutoScalingGroupName": "my-auto-scaling-group"
618 },
619 "output": {
620 "LoadBalancers": [
621 {
622 "LoadBalancerName": "my-load-balancer",
623 "State": "Added"
624 }
625 ]
626 },
627 "comments": {
628 "input": {
629 },
630 "output": {
631 }
632 },
633 "description": "This example describes the load balancers attached to the specified Auto Scaling group.",
634 "id": "autoscaling-describe-load-balancers-1",
635 "title": "To describe the load balancers for an Auto Scaling group"
636 }
637 ],
638 "DescribeMetricCollectionTypes": [
639 {
640 "output": {
641 "Granularities": [
642 {
643 "Granularity": "1Minute"
644 }
645 ],
646 "Metrics": [
647 {
648 "Metric": "GroupMinSize"
649 },
650 {
651 "Metric": "GroupMaxSize"
652 },
653 {
654 "Metric": "GroupDesiredCapacity"
655 },
656 {
657 "Metric": "GroupInServiceInstances"
658 },
659 {
660 "Metric": "GroupPendingInstances"
661 },
662 {
663 "Metric": "GroupTerminatingInstances"
664 },
665 {
666 "Metric": "GroupStandbyInstances"
667 },
668 {
669 "Metric": "GroupTotalInstances"
670 }
671 ]
672 },
673 "comments": {
674 "input": {
675 },
676 "output": {
677 }
678 },
679 "description": "This example describes the available metric collection types.",
680 "id": "autoscaling-describe-metric-collection-types-1",
681 "title": "To describe the Auto Scaling metric collection types"
682 }
683 ],
684 "DescribeNotificationConfigurations": [
685 {
686 "input": {
687 "AutoScalingGroupNames": [
688 "my-auto-scaling-group"
689 ]
690 },
691 "output": {
692 "NotificationConfigurations": [
693 {
694 "AutoScalingGroupName": "my-auto-scaling-group",
695 "NotificationType": "autoscaling:TEST_NOTIFICATION",
696 "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2"
697 },
698 {
699 "AutoScalingGroupName": "my-auto-scaling-group",
700 "NotificationType": "autoscaling:TEST_NOTIFICATION",
701 "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
702 }
703 ]
704 },
705 "comments": {
706 "input": {
707 },
708 "output": {
709 }
710 },
711 "description": "This example describes the notification configurations for the specified Auto Scaling group.",
712 "id": "autoscaling-describe-notification-configurations-1",
713 "title": "To describe Auto Scaling notification configurations"
714 }
715 ],
716 "DescribePolicies": [
717 {
718 "input": {
719 "AutoScalingGroupName": "my-auto-scaling-group"
720 },
721 "output": {
722 "ScalingPolicies": [
723 {
724 "AdjustmentType": "ChangeInCapacity",
725 "Alarms": [
726
727 ],
728 "AutoScalingGroupName": "my-auto-scaling-group",
729 "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn",
730 "PolicyName": "ScaleIn",
731 "ScalingAdjustment": -1
732 },
733 {
734 "AdjustmentType": "PercentChangeInCapacity",
735 "Alarms": [
736
737 ],
738 "AutoScalingGroupName": "my-auto-scaling-group",
739 "Cooldown": 60,
740 "MinAdjustmentStep": 2,
741 "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange",
742 "PolicyName": "ScalePercentChange",
743 "ScalingAdjustment": 25
744 }
745 ]
746 },
747 "comments": {
748 "input": {
749 },
750 "output": {
751 }
752 },
753 "description": "This example describes the policies for the specified Auto Scaling group.",
754 "id": "autoscaling-describe-policies-1",
755 "title": "To describe Auto Scaling policies"
756 }
757 ],
758 "DescribeScalingActivities": [
759 {
760 "input": {
761 "AutoScalingGroupName": "my-auto-scaling-group"
762 },
763 "output": {
764 "Activities": [
765 {
766 "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699",
767 "AutoScalingGroupName": "my-auto-scaling-group",
768 "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.",
769 "Description": "Launching a new EC2 instance: i-4ba0837f",
770 "Details": "details",
771 "EndTime": "2013-08-19T20:54:02Z",
772 "Progress": 100,
773 "StartTime": "2013-08-19T20:53:29.930Z",
774 "StatusCode": "Successful"
775 }
776 ]
777 },
778 "comments": {
779 "input": {
780 },
781 "output": {
782 }
783 },
784 "description": "This example describes the scaling activities for the specified Auto Scaling group.",
785 "id": "autoscaling-describe-scaling-activities-1",
786 "title": "To describe the scaling activities for an Auto Scaling group"
787 }
788 ],
789 "DescribeScalingProcessTypes": [
790 {
791 "output": {
792 "Processes": [
793 {
794 "ProcessName": "AZRebalance"
795 },
796 {
797 "ProcessName": "AddToLoadBalancer"
798 },
799 {
800 "ProcessName": "AlarmNotification"
801 },
802 {
803 "ProcessName": "HealthCheck"
804 },
805 {
806 "ProcessName": "Launch"
807 },
808 {
809 "ProcessName": "ReplaceUnhealthy"
810 },
811 {
812 "ProcessName": "ScheduledActions"
813 },
814 {
815 "ProcessName": "Terminate"
816 }
817 ]
818 },
819 "comments": {
820 "input": {
821 },
822 "output": {
823 }
824 },
825 "description": "This example describes the Auto Scaling process types.",
826 "id": "autoscaling-describe-scaling-process-types-1",
827 "title": "To describe the Auto Scaling process types"
828 }
829 ],
830 "DescribeScheduledActions": [
831 {
832 "input": {
833 "AutoScalingGroupName": "my-auto-scaling-group"
834 },
835 "output": {
836 "ScheduledUpdateGroupActions": [
837 {
838 "AutoScalingGroupName": "my-auto-scaling-group",
839 "DesiredCapacity": 4,
840 "MaxSize": 6,
841 "MinSize": 2,
842 "Recurrence": "30 0 1 12 0",
843 "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action",
844 "ScheduledActionName": "my-scheduled-action",
845 "StartTime": "2016-12-01T00:30:00Z",
846 "Time": "2016-12-01T00:30:00Z"
847 }
848 ]
849 },
850 "comments": {
851 "input": {
852 },
853 "output": {
854 }
855 },
856 "description": "This example describes the scheduled actions for the specified Auto Scaling group.",
857 "id": "autoscaling-describe-scheduled-actions-1",
858 "title": "To describe scheduled actions"
859 }
860 ],
861 "DescribeTags": [
862 {
863 "input": {
864 "Filters": [
865 {
866 "Name": "auto-scaling-group",
867 "Values": [
868 "my-auto-scaling-group"
869 ]
870 }
871 ]
872 },
873 "output": {
874 "Tags": [
875 {
876 "Key": "Dept",
877 "PropagateAtLaunch": true,
878 "ResourceId": "my-auto-scaling-group",
879 "ResourceType": "auto-scaling-group",
880 "Value": "Research"
881 },
882 {
883 "Key": "Role",
884 "PropagateAtLaunch": true,
885 "ResourceId": "my-auto-scaling-group",
886 "ResourceType": "auto-scaling-group",
887 "Value": "WebServer"
888 }
889 ]
890 },
891 "comments": {
892 "input": {
893 },
894 "output": {
895 }
896 },
897 "description": "This example describes the tags for the specified Auto Scaling group.",
898 "id": "autoscaling-describe-tags-1",
899 "title": "To describe tags"
900 }
901 ],
902 "DescribeTerminationPolicyTypes": [
903 {
904 "output": {
905 "TerminationPolicyTypes": [
906 "ClosestToNextInstanceHour",
907 "Default",
908 "NewestInstance",
909 "OldestInstance",
910 "OldestLaunchConfiguration"
911 ]
912 },
913 "comments": {
914 "input": {
915 },
916 "output": {
917 }
918 },
919 "description": "This example describes the available termination policy types.",
920 "id": "autoscaling-describe-termination-policy-types-1",
921 "title": "To describe termination policy types"
922 }
923 ],
924 "DetachInstances": [
925 {
926 "input": {
927 "AutoScalingGroupName": "my-auto-scaling-group",
928 "InstanceIds": [
929 "i-93633f9b"
930 ],
931 "ShouldDecrementDesiredCapacity": true
932 },
933 "output": {
934 "Activities": [
935 {
936 "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9",
937 "AutoScalingGroupName": "my-auto-scaling-group",
938 "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.",
939 "Description": "Detaching EC2 instance: i-93633f9b",
940 "Details": "details",
941 "Progress": 50,
942 "StartTime": "2015-04-12T15:02:16.179Z",
943 "StatusCode": "InProgress"
944 }
945 ]
946 },
947 "comments": {
948 "input": {
949 },
950 "output": {
951 }
952 },
953 "description": "This example detaches the specified instance from the specified Auto Scaling group.",
954 "id": "autoscaling-detach-instances-1",
955 "title": "To detach an instance from an Auto Scaling group"
956 }
957 ],
958 "DetachLoadBalancerTargetGroups": [
959 {
960 "input": {
961 "AutoScalingGroupName": "my-auto-scaling-group",
962 "TargetGroupARNs": [
963 "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
964 ]
965 },
966 "comments": {
967 "input": {
968 },
969 "output": {
970 }
971 },
972 "description": "This example detaches the specified target group from the specified Auto Scaling group",
973 "id": "autoscaling-detach-load-balancer-target-groups-1",
974 "title": "To detach a target group from an Auto Scaling group"
975 }
976 ],
977 "DetachLoadBalancers": [
978 {
979 "input": {
980 "AutoScalingGroupName": "my-auto-scaling-group",
981 "LoadBalancerNames": [
982 "my-load-balancer"
983 ]
984 },
985 "comments": {
986 "input": {
987 },
988 "output": {
989 }
990 },
991 "description": "This example detaches the specified load balancer from the specified Auto Scaling group.",
992 "id": "autoscaling-detach-load-balancers-1",
993 "title": "To detach a load balancer from an Auto Scaling group"
994 }
995 ],
996 "DisableMetricsCollection": [
997 {
998 "input": {
999 "AutoScalingGroupName": "my-auto-scaling-group",
1000 "Metrics": [
1001 "GroupDesiredCapacity"
1002 ]
1003 },
1004 "comments": {
1005 "input": {
1006 },
1007 "output": {
1008 }
1009 },
1010 "description": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.",
1011 "id": "autoscaling-disable-metrics-collection-1",
1012 "title": "To disable metrics collection for an Auto Scaling group"
1013 }
1014 ],
1015 "EnableMetricsCollection": [
1016 {
1017 "input": {
1018 "AutoScalingGroupName": "my-auto-scaling-group",
1019 "Granularity": "1Minute"
1020 },
1021 "comments": {
1022 "input": {
1023 },
1024 "output": {
1025 }
1026 },
1027 "description": "This example enables data collection for the specified Auto Scaling group.",
1028 "id": "autoscaling-enable-metrics-collection-1",
1029 "title": "To enable metrics collection for an Auto Scaling group"
1030 }
1031 ],
1032 "EnterStandby": [
1033 {
1034 "input": {
1035 "AutoScalingGroupName": "my-auto-scaling-group",
1036 "InstanceIds": [
1037 "i-93633f9b"
1038 ],
1039 "ShouldDecrementDesiredCapacity": true
1040 },
1041 "output": {
1042 "Activities": [
1043 {
1044 "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1",
1045 "AutoScalingGroupName": "my-auto-scaling-group",
1046 "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.",
1047 "Description": "Moving EC2 instance to Standby: i-93633f9b",
1048 "Details": "details",
1049 "Progress": 50,
1050 "StartTime": "2015-04-12T15:10:23.640Z",
1051 "StatusCode": "InProgress"
1052 }
1053 ]
1054 },
1055 "comments": {
1056 "input": {
1057 },
1058 "output": {
1059 }
1060 },
1061 "description": "This example puts the specified instance into standby mode.",
1062 "id": "autoscaling-enter-standby-1",
1063 "title": "To move instances into standby mode"
1064 }
1065 ],
1066 "ExecutePolicy": [
1067 {
1068 "input": {
1069 "AutoScalingGroupName": "my-auto-scaling-group",
1070 "HonorCooldown": true,
1071 "PolicyName": "ScaleIn"
1072 },
1073 "comments": {
1074 "input": {
1075 },
1076 "output": {
1077 }
1078 },
1079 "description": "This example executes the specified Auto Scaling policy for the specified Auto Scaling group.",
1080 "id": "autoscaling-execute-policy-1",
1081 "title": "To execute an Auto Scaling policy"
1082 }
1083 ],
1084 "ExitStandby": [
1085 {
1086 "input": {
1087 "AutoScalingGroupName": "my-auto-scaling-group",
1088 "InstanceIds": [
1089 "i-93633f9b"
1090 ]
1091 },
1092 "output": {
1093 "Activities": [
1094 {
1095 "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928",
1096 "AutoScalingGroupName": "my-auto-scaling-group",
1097 "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.",
1098 "Description": "Moving EC2 instance out of Standby: i-93633f9b",
1099 "Details": "details",
1100 "Progress": 30,
1101 "StartTime": "2015-04-12T15:14:29.886Z",
1102 "StatusCode": "PreInService"
1103 }
1104 ]
1105 },
1106 "comments": {
1107 "input": {
1108 },
1109 "output": {
1110 }
1111 },
1112 "description": "This example moves the specified instance out of standby mode.",
1113 "id": "autoscaling-exit-standby-1",
1114 "title": "To move instances out of standby mode"
1115 }
1116 ],
1117 "PutLifecycleHook": [
1118 {
1119 "input": {
1120 "AutoScalingGroupName": "my-auto-scaling-group",
1121 "LifecycleHookName": "my-lifecycle-hook",
1122 "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING",
1123 "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn",
1124 "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role"
1125 },
1126 "comments": {
1127 "input": {
1128 },
1129 "output": {
1130 }
1131 },
1132 "description": "This example creates a lifecycle hook.",
1133 "id": "autoscaling-put-lifecycle-hook-1",
1134 "title": "To create a lifecycle hook"
1135 }
1136 ],
1137 "PutNotificationConfiguration": [
1138 {
1139 "input": {
1140 "AutoScalingGroupName": "my-auto-scaling-group",
1141 "NotificationTypes": [
1142 "autoscaling:TEST_NOTIFICATION"
1143 ],
1144 "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
1145 },
1146 "comments": {
1147 "input": {
1148 },
1149 "output": {
1150 }
1151 },
1152 "description": "This example adds the specified notification to the specified Auto Scaling group.",
1153 "id": "autoscaling-put-notification-configuration-1",
1154 "title": "To add an Auto Scaling notification"
1155 }
1156 ],
1157 "PutScalingPolicy": [
1158 {
1159 "input": {
1160 "AdjustmentType": "ChangeInCapacity",
1161 "AutoScalingGroupName": "my-auto-scaling-group",
1162 "PolicyName": "ScaleIn",
1163 "ScalingAdjustment": -1
1164 },
1165 "output": {
1166 "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn"
1167 },
1168 "comments": {
1169 "input": {
1170 },
1171 "output": {
1172 }
1173 },
1174 "description": "This example adds the specified policy to the specified Auto Scaling group.",
1175 "id": "autoscaling-put-scaling-policy-1",
1176 "title": "To add a scaling policy to an Auto Scaling group"
1177 }
1178 ],
1179 "PutScheduledUpdateGroupAction": [
1180 {
1181 "input": {
1182 "AutoScalingGroupName": "my-auto-scaling-group",
1183 "DesiredCapacity": 4,
1184 "EndTime": "2014-05-12T08:00:00Z",
1185 "MaxSize": 6,
1186 "MinSize": 2,
1187 "ScheduledActionName": "my-scheduled-action",
1188 "StartTime": "2014-05-12T08:00:00Z"
1189 },
1190 "comments": {
1191 "input": {
1192 },
1193 "output": {
1194 }
1195 },
1196 "description": "This example adds the specified scheduled action to the specified Auto Scaling group.",
1197 "id": "autoscaling-put-scheduled-update-group-action-1",
1198 "title": "To add a scheduled action to an Auto Scaling group"
1199 }
1200 ],
1201 "RecordLifecycleActionHeartbeat": [
1202 {
1203 "input": {
1204 "AutoScalingGroupName": "my-auto-scaling-group",
1205 "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635",
1206 "LifecycleHookName": "my-lifecycle-hook"
1207 },
1208 "comments": {
1209 "input": {
1210 },
1211 "output": {
1212 }
1213 },
1214 "description": "This example records a lifecycle action heartbeat to keep the instance in a pending state.",
1215 "id": "autoscaling-record-lifecycle-action-heartbeat-1",
1216 "title": "To record a lifecycle action heartbeat"
1217 }
1218 ],
1219 "ResumeProcesses": [
1220 {
1221 "input": {
1222 "AutoScalingGroupName": "my-auto-scaling-group",
1223 "ScalingProcesses": [
1224 "AlarmNotification"
1225 ]
1226 },
1227 "comments": {
1228 "input": {
1229 },
1230 "output": {
1231 }
1232 },
1233 "description": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.",
1234 "id": "autoscaling-resume-processes-1",
1235 "title": "To resume Auto Scaling processes"
1236 }
1237 ],
1238 "SetDesiredCapacity": [
1239 {
1240 "input": {
1241 "AutoScalingGroupName": "my-auto-scaling-group",
1242 "DesiredCapacity": 2,
1243 "HonorCooldown": true
1244 },
1245 "comments": {
1246 "input": {
1247 },
1248 "output": {
1249 }
1250 },
1251 "description": "This example sets the desired capacity for the specified Auto Scaling group.",
1252 "id": "autoscaling-set-desired-capacity-1",
1253 "title": "To set the desired capacity for an Auto Scaling group"
1254 }
1255 ],
1256 "SetInstanceHealth": [
1257 {
1258 "input": {
1259 "HealthStatus": "Unhealthy",
1260 "InstanceId": "i-93633f9b"
1261 },
1262 "comments": {
1263 "input": {
1264 },
1265 "output": {
1266 }
1267 },
1268 "description": "This example sets the health status of the specified instance to Unhealthy.",
1269 "id": "autoscaling-set-instance-health-1",
1270 "title": "To set the health status of an instance"
1271 }
1272 ],
1273 "SetInstanceProtection": [
1274 {
1275 "input": {
1276 "AutoScalingGroupName": "my-auto-scaling-group",
1277 "InstanceIds": [
1278 "i-93633f9b"
1279 ],
1280 "ProtectedFromScaleIn": true
1281 },
1282 "comments": {
1283 "input": {
1284 },
1285 "output": {
1286 }
1287 },
1288 "description": "This example enables instance protection for the specified instance.",
1289 "id": "autoscaling-set-instance-protection-1",
1290 "title": "To enable instance protection for an instance"
1291 },
1292 {
1293 "input": {
1294 "AutoScalingGroupName": "my-auto-scaling-group",
1295 "InstanceIds": [
1296 "i-93633f9b"
1297 ],
1298 "ProtectedFromScaleIn": false
1299 },
1300 "comments": {
1301 "input": {
1302 },
1303 "output": {
1304 }
1305 },
1306 "description": "This example disables instance protection for the specified instance.",
1307 "id": "autoscaling-set-instance-protection-2",
1308 "title": "To disable instance protection for an instance"
1309 }
1310 ],
1311 "SuspendProcesses": [
1312 {
1313 "input": {
1314 "AutoScalingGroupName": "my-auto-scaling-group",
1315 "ScalingProcesses": [
1316 "AlarmNotification"
1317 ]
1318 },
1319 "comments": {
1320 "input": {
1321 },
1322 "output": {
1323 }
1324 },
1325 "description": "This example suspends the specified scaling process for the specified Auto Scaling group.",
1326 "id": "autoscaling-suspend-processes-1",
1327 "title": "To suspend Auto Scaling processes"
1328 }
1329 ],
1330 "TerminateInstanceInAutoScalingGroup": [
1331 {
1332 "input": {
1333 "InstanceId": "i-93633f9b",
1334 "ShouldDecrementDesiredCapacity": false
1335 },
1336 "comments": {
1337 "input": {
1338 },
1339 "output": {
1340 }
1341 },
1342 "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.",
1343 "id": "autoscaling-terminate-instance-in-auto-scaling-group-1",
1344 "title": "To terminate an instance in an Auto Scaling group"
1345 }
1346 ],
1347 "UpdateAutoScalingGroup": [
1348 {
1349 "input": {
1350 "AutoScalingGroupName": "my-auto-scaling-group",
1351 "LaunchConfigurationName": "new-launch-config"
1352 },
1353 "comments": {
1354 "input": {
1355 },
1356 "output": {
1357 }
1358 },
1359 "description": "This example updates the launch configuration of the specified Auto Scaling group.",
1360 "id": "autoscaling-update-auto-scaling-group-1",
1361 "title": "To update the launch configuration"
1362 },
1363 {
1364 "input": {
1365 "AutoScalingGroupName": "my-auto-scaling-group",
1366 "MaxSize": 3,
1367 "MinSize": 1
1368 },
1369 "comments": {
1370 "input": {
1371 },
1372 "output": {
1373 }
1374 },
1375 "description": "This example updates the minimum size and maximum size of the specified Auto Scaling group.",
1376 "id": "autoscaling-update-auto-scaling-group-2",
1377 "title": "To update the minimum and maximum size"
1378 },
1379 {
1380 "input": {
1381 "AutoScalingGroupName": "my-auto-scaling-group",
1382 "NewInstancesProtectedFromScaleIn": true
1383 },
1384 "comments": {
1385 "input": {
1386 },
1387 "output": {
1388 }
1389 },
1390 "description": "This example enables instance protection for the specified Auto Scaling group.",
1391 "id": "autoscaling-update-auto-scaling-group-3",
1392 "title": "To enable instance protection"
1393 }
1394 ]
1395 }
1396}