autoscaling-2011-01-01.examples.json 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699
  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. "AttachTrafficSources": [
  62. {
  63. "input": {
  64. "AutoScalingGroupName": "my-auto-scaling-group",
  65. "TrafficSources": [
  66. {
  67. "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
  68. }
  69. ]
  70. },
  71. "output": {
  72. },
  73. "comments": {
  74. "input": {
  75. },
  76. "output": {
  77. }
  78. },
  79. "description": "This example attaches the specified target group to the specified Auto Scaling group.",
  80. "id": "to-attach-a-target-group-to-an-auto-scaling-group-1680036570089",
  81. "title": "To attach a target group to an Auto Scaling group"
  82. }
  83. ],
  84. "CancelInstanceRefresh": [
  85. {
  86. "input": {
  87. "AutoScalingGroupName": "my-auto-scaling-group"
  88. },
  89. "output": {
  90. "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"
  91. },
  92. "comments": {
  93. "input": {
  94. },
  95. "output": {
  96. }
  97. },
  98. "description": "This example cancels an instance refresh operation in progress.",
  99. "id": "to-cancel-an-instance-refresh-1592960979817",
  100. "title": "To cancel an instance refresh"
  101. }
  102. ],
  103. "CompleteLifecycleAction": [
  104. {
  105. "input": {
  106. "AutoScalingGroupName": "my-auto-scaling-group",
  107. "LifecycleActionResult": "CONTINUE",
  108. "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635",
  109. "LifecycleHookName": "my-lifecycle-hook"
  110. },
  111. "comments": {
  112. "input": {
  113. },
  114. "output": {
  115. }
  116. },
  117. "description": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.",
  118. "id": "autoscaling-complete-lifecycle-action-1",
  119. "title": "To complete the lifecycle action"
  120. }
  121. ],
  122. "CreateAutoScalingGroup": [
  123. {
  124. "input": {
  125. "AutoScalingGroupName": "my-auto-scaling-group",
  126. "DefaultInstanceWarmup": 120,
  127. "LaunchTemplate": {
  128. "LaunchTemplateName": "my-template-for-auto-scaling",
  129. "Version": "$Default"
  130. },
  131. "MaxInstanceLifetime": 2592000,
  132. "MaxSize": 3,
  133. "MinSize": 1,
  134. "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE"
  135. },
  136. "comments": {
  137. "input": {
  138. },
  139. "output": {
  140. }
  141. },
  142. "description": "This example creates an Auto Scaling group.",
  143. "id": "autoscaling-create-auto-scaling-group-1",
  144. "title": "To create an Auto Scaling group"
  145. },
  146. {
  147. "input": {
  148. "AutoScalingGroupName": "my-auto-scaling-group",
  149. "HealthCheckGracePeriod": 300,
  150. "HealthCheckType": "ELB",
  151. "LaunchTemplate": {
  152. "LaunchTemplateName": "my-template-for-auto-scaling",
  153. "Version": "$Default"
  154. },
  155. "MaxSize": 3,
  156. "MinSize": 1,
  157. "TargetGroupARNs": [
  158. "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
  159. ],
  160. "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
  161. },
  162. "comments": {
  163. "input": {
  164. },
  165. "output": {
  166. }
  167. },
  168. "description": "This example creates an Auto Scaling group and attaches the specified target group.",
  169. "id": "autoscaling-create-auto-scaling-group-2",
  170. "title": "To create an Auto Scaling group with an attached target group"
  171. },
  172. {
  173. "input": {
  174. "AutoScalingGroupName": "my-asg",
  175. "DesiredCapacity": 3,
  176. "MaxSize": 5,
  177. "MinSize": 1,
  178. "MixedInstancesPolicy": {
  179. "InstancesDistribution": {
  180. "OnDemandBaseCapacity": 1,
  181. "OnDemandPercentageAboveBaseCapacity": 50,
  182. "SpotAllocationStrategy": "price-capacity-optimized"
  183. },
  184. "LaunchTemplate": {
  185. "LaunchTemplateSpecification": {
  186. "LaunchTemplateName": "my-launch-template-for-x86",
  187. "Version": "$Default"
  188. },
  189. "Overrides": [
  190. {
  191. "InstanceType": "c6g.large",
  192. "LaunchTemplateSpecification": {
  193. "LaunchTemplateName": "my-launch-template-for-arm",
  194. "Version": "$Default"
  195. }
  196. },
  197. {
  198. "InstanceType": "c5.large"
  199. },
  200. {
  201. "InstanceType": "c5a.large"
  202. }
  203. ]
  204. }
  205. },
  206. "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
  207. },
  208. "comments": {
  209. "input": {
  210. },
  211. "output": {
  212. }
  213. },
  214. "description": "This example creates an Auto Scaling group with a mixed instances policy. It specifies the c5.large, c5a.large, and c6g.large instance types and defines a different launch template for the c6g.large instance type.",
  215. "id": "autoscaling-create-auto-scaling-group-3",
  216. "title": "To create an Auto Scaling group with a mixed instances policy"
  217. },
  218. {
  219. "input": {
  220. "AutoScalingGroupName": "my-asg",
  221. "DesiredCapacity": 4,
  222. "DesiredCapacityType": "units",
  223. "MaxSize": 100,
  224. "MinSize": 0,
  225. "MixedInstancesPolicy": {
  226. "InstancesDistribution": {
  227. "OnDemandPercentageAboveBaseCapacity": 50,
  228. "SpotAllocationStrategy": "price-capacity-optimized"
  229. },
  230. "LaunchTemplate": {
  231. "LaunchTemplateSpecification": {
  232. "LaunchTemplateName": "my-template-for-auto-scaling",
  233. "Version": "$Default"
  234. },
  235. "Overrides": [
  236. {
  237. "InstanceRequirements": {
  238. "CpuManufacturers": [
  239. "intel"
  240. ],
  241. "MemoryMiB": {
  242. "Min": 16384
  243. },
  244. "VCpuCount": {
  245. "Max": 8,
  246. "Min": 4
  247. }
  248. }
  249. }
  250. ]
  251. }
  252. },
  253. "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
  254. },
  255. "comments": {
  256. "input": {
  257. },
  258. "output": {
  259. }
  260. },
  261. "description": "This example creates an Auto Scaling group using attribute-based instance type selection. It requires the instance types to have a minimum of four vCPUs and a maximum of eight vCPUs, a minimum of 16,384 MiB of memory, and an Intel manufactured CPU.",
  262. "id": "autoscaling-create-auto-scaling-group-4",
  263. "title": "To create an Auto Scaling group using attribute-based instance type selection"
  264. }
  265. ],
  266. "CreateLaunchConfiguration": [
  267. {
  268. "input": {
  269. "IamInstanceProfile": "my-iam-role",
  270. "ImageId": "ami-12345678",
  271. "InstanceType": "m3.medium",
  272. "LaunchConfigurationName": "my-launch-config",
  273. "SecurityGroups": [
  274. "sg-eb2af88e"
  275. ]
  276. },
  277. "comments": {
  278. "input": {
  279. },
  280. "output": {
  281. }
  282. },
  283. "description": "This example creates a launch configuration.",
  284. "id": "autoscaling-create-launch-configuration-1",
  285. "title": "To create a launch configuration"
  286. }
  287. ],
  288. "CreateOrUpdateTags": [
  289. {
  290. "input": {
  291. "Tags": [
  292. {
  293. "Key": "Role",
  294. "PropagateAtLaunch": true,
  295. "ResourceId": "my-auto-scaling-group",
  296. "ResourceType": "auto-scaling-group",
  297. "Value": "WebServer"
  298. },
  299. {
  300. "Key": "Dept",
  301. "PropagateAtLaunch": true,
  302. "ResourceId": "my-auto-scaling-group",
  303. "ResourceType": "auto-scaling-group",
  304. "Value": "Research"
  305. }
  306. ]
  307. },
  308. "comments": {
  309. "input": {
  310. },
  311. "output": {
  312. }
  313. },
  314. "description": "This example adds two tags to the specified Auto Scaling group.",
  315. "id": "autoscaling-create-or-update-tags-1",
  316. "title": "To create or update tags for an Auto Scaling group"
  317. }
  318. ],
  319. "DeleteAutoScalingGroup": [
  320. {
  321. "input": {
  322. "AutoScalingGroupName": "my-auto-scaling-group"
  323. },
  324. "comments": {
  325. "input": {
  326. },
  327. "output": {
  328. }
  329. },
  330. "description": "This example deletes the specified Auto Scaling group.",
  331. "id": "autoscaling-delete-auto-scaling-group-1",
  332. "title": "To delete an Auto Scaling group"
  333. },
  334. {
  335. "input": {
  336. "AutoScalingGroupName": "my-auto-scaling-group",
  337. "ForceDelete": true
  338. },
  339. "comments": {
  340. "input": {
  341. },
  342. "output": {
  343. }
  344. },
  345. "description": "This example deletes the specified Auto Scaling group and all its instances.",
  346. "id": "autoscaling-delete-auto-scaling-group-2",
  347. "title": "To delete an Auto Scaling group and all its instances"
  348. }
  349. ],
  350. "DeleteLaunchConfiguration": [
  351. {
  352. "input": {
  353. "LaunchConfigurationName": "my-launch-config"
  354. },
  355. "comments": {
  356. "input": {
  357. },
  358. "output": {
  359. }
  360. },
  361. "description": "This example deletes the specified launch configuration.",
  362. "id": "autoscaling-delete-launch-configuration-1",
  363. "title": "To delete a launch configuration"
  364. }
  365. ],
  366. "DeleteLifecycleHook": [
  367. {
  368. "input": {
  369. "AutoScalingGroupName": "my-auto-scaling-group",
  370. "LifecycleHookName": "my-lifecycle-hook"
  371. },
  372. "comments": {
  373. "input": {
  374. },
  375. "output": {
  376. }
  377. },
  378. "description": "This example deletes the specified lifecycle hook.",
  379. "id": "autoscaling-delete-lifecycle-hook-1",
  380. "title": "To delete a lifecycle hook"
  381. }
  382. ],
  383. "DeleteNotificationConfiguration": [
  384. {
  385. "input": {
  386. "AutoScalingGroupName": "my-auto-scaling-group",
  387. "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
  388. },
  389. "comments": {
  390. "input": {
  391. },
  392. "output": {
  393. }
  394. },
  395. "description": "This example deletes the specified notification from the specified Auto Scaling group.",
  396. "id": "autoscaling-delete-notification-configuration-1",
  397. "title": "To delete an Auto Scaling notification"
  398. }
  399. ],
  400. "DeletePolicy": [
  401. {
  402. "input": {
  403. "AutoScalingGroupName": "my-auto-scaling-group",
  404. "PolicyName": "my-step-scale-out-policy"
  405. },
  406. "comments": {
  407. "input": {
  408. },
  409. "output": {
  410. }
  411. },
  412. "description": "This example deletes the specified Auto Scaling policy.",
  413. "id": "autoscaling-delete-policy-1",
  414. "title": "To delete an Auto Scaling policy"
  415. }
  416. ],
  417. "DeleteScheduledAction": [
  418. {
  419. "input": {
  420. "AutoScalingGroupName": "my-auto-scaling-group",
  421. "ScheduledActionName": "my-scheduled-action"
  422. },
  423. "comments": {
  424. "input": {
  425. },
  426. "output": {
  427. }
  428. },
  429. "description": "This example deletes the specified scheduled action from the specified Auto Scaling group.",
  430. "id": "autoscaling-delete-scheduled-action-1",
  431. "title": "To delete a scheduled action from an Auto Scaling group"
  432. }
  433. ],
  434. "DeleteTags": [
  435. {
  436. "input": {
  437. "Tags": [
  438. {
  439. "Key": "Dept",
  440. "ResourceId": "my-auto-scaling-group",
  441. "ResourceType": "auto-scaling-group",
  442. "Value": "Research"
  443. }
  444. ]
  445. },
  446. "comments": {
  447. "input": {
  448. },
  449. "output": {
  450. }
  451. },
  452. "description": "This example deletes the specified tag from the specified Auto Scaling group.",
  453. "id": "autoscaling-delete-tags-1",
  454. "title": "To delete a tag from an Auto Scaling group"
  455. }
  456. ],
  457. "DescribeAccountLimits": [
  458. {
  459. "output": {
  460. "MaxNumberOfAutoScalingGroups": 20,
  461. "MaxNumberOfLaunchConfigurations": 100,
  462. "NumberOfAutoScalingGroups": 3,
  463. "NumberOfLaunchConfigurations": 5
  464. },
  465. "comments": {
  466. "input": {
  467. },
  468. "output": {
  469. }
  470. },
  471. "description": "This example describes the Amazon EC2 Auto Scaling service quotas for your account.",
  472. "id": "autoscaling-describe-account-limits-1",
  473. "title": "To describe your Auto Scaling account limits"
  474. }
  475. ],
  476. "DescribeAdjustmentTypes": [
  477. {
  478. "output": {
  479. "AdjustmentTypes": [
  480. {
  481. "AdjustmentType": "ChangeInCapacity"
  482. },
  483. {
  484. "AdjustmentType": "ExactCapcity"
  485. },
  486. {
  487. "AdjustmentType": "PercentChangeInCapacity"
  488. }
  489. ]
  490. },
  491. "comments": {
  492. "input": {
  493. },
  494. "output": {
  495. }
  496. },
  497. "description": "This example describes the available adjustment types.",
  498. "id": "autoscaling-describe-adjustment-types-1",
  499. "title": "To describe the Amazon EC2 Auto Scaling adjustment types"
  500. }
  501. ],
  502. "DescribeAutoScalingGroups": [
  503. {
  504. "input": {
  505. "AutoScalingGroupNames": [
  506. "my-auto-scaling-group"
  507. ]
  508. },
  509. "output": {
  510. "AutoScalingGroups": [
  511. {
  512. "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group",
  513. "AutoScalingGroupName": "my-auto-scaling-group",
  514. "AvailabilityZones": [
  515. "us-west-2a",
  516. "us-west-2b",
  517. "us-west-2c"
  518. ],
  519. "CreatedTime": "2023-03-09T22:15:11.611Z",
  520. "DefaultCooldown": 300,
  521. "DesiredCapacity": 2,
  522. "EnabledMetrics": [
  523. ],
  524. "HealthCheckGracePeriod": 300,
  525. "HealthCheckType": "EC2",
  526. "Instances": [
  527. {
  528. "AvailabilityZone": "us-west-2c",
  529. "HealthStatus": "Healthy",
  530. "InstanceId": "i-05b4f7d5be44822a6",
  531. "InstanceType": "t3.micro",
  532. "LaunchConfigurationName": "my-launch-config",
  533. "LifecycleState": "InService",
  534. "ProtectedFromScaleIn": false
  535. },
  536. {
  537. "AvailabilityZone": "us-west-2b",
  538. "HealthStatus": "Healthy",
  539. "InstanceId": "i-0c20ac468fa3049e8",
  540. "InstanceType": "t3.micro",
  541. "LaunchConfigurationName": "my-launch-config",
  542. "LifecycleState": "InService",
  543. "ProtectedFromScaleIn": false
  544. }
  545. ],
  546. "LaunchConfigurationName": "my-launch-config",
  547. "LoadBalancerNames": [
  548. ],
  549. "MaxSize": 5,
  550. "MinSize": 1,
  551. "NewInstancesProtectedFromScaleIn": false,
  552. "ServiceLinkedRoleARN": "arn:aws:iam::123456789012:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling",
  553. "SuspendedProcesses": [
  554. ],
  555. "Tags": [
  556. ],
  557. "TargetGroupARNs": [
  558. ],
  559. "TerminationPolicies": [
  560. "Default"
  561. ],
  562. "TrafficSources": [
  563. ],
  564. "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782"
  565. }
  566. ]
  567. },
  568. "comments": {
  569. "input": {
  570. },
  571. "output": {
  572. }
  573. },
  574. "description": "This example describes the specified Auto Scaling group.",
  575. "id": "autoscaling-describe-auto-scaling-groups-1",
  576. "title": "To describe an Auto Scaling group"
  577. }
  578. ],
  579. "DescribeAutoScalingInstances": [
  580. {
  581. "input": {
  582. "InstanceIds": [
  583. "i-05b4f7d5be44822a6"
  584. ]
  585. },
  586. "output": {
  587. "AutoScalingInstances": [
  588. {
  589. "AutoScalingGroupName": "my-auto-scaling-group",
  590. "AvailabilityZone": "us-west-2c",
  591. "HealthStatus": "HEALTHY",
  592. "InstanceId": "i-05b4f7d5be44822a6",
  593. "InstanceType": "t3.micro",
  594. "LaunchConfigurationName": "my-launch-config",
  595. "LifecycleState": "InService",
  596. "ProtectedFromScaleIn": false
  597. }
  598. ]
  599. },
  600. "comments": {
  601. "input": {
  602. },
  603. "output": {
  604. }
  605. },
  606. "description": "This example describes the specified Auto Scaling instance.",
  607. "id": "autoscaling-describe-auto-scaling-instances-1",
  608. "title": "To describe one or more Auto Scaling instances"
  609. }
  610. ],
  611. "DescribeAutoScalingNotificationTypes": [
  612. {
  613. "output": {
  614. "AutoScalingNotificationTypes": [
  615. "autoscaling:EC2_INSTANCE_LAUNCH",
  616. "autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
  617. "autoscaling:EC2_INSTANCE_TERMINATE",
  618. "autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
  619. "autoscaling:TEST_NOTIFICATION"
  620. ]
  621. },
  622. "comments": {
  623. "input": {
  624. },
  625. "output": {
  626. }
  627. },
  628. "description": "This example describes the available notification types.",
  629. "id": "autoscaling-describe-auto-scaling-notification-types-1",
  630. "title": "To describe the Auto Scaling notification types"
  631. }
  632. ],
  633. "DescribeInstanceRefreshes": [
  634. {
  635. "input": {
  636. "AutoScalingGroupName": "my-auto-scaling-group"
  637. },
  638. "output": {
  639. "InstanceRefreshes": [
  640. {
  641. "AutoScalingGroupName": "my-auto-scaling-group",
  642. "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b",
  643. "InstancesToUpdate": 0,
  644. "PercentageComplete": 50,
  645. "Preferences": {
  646. "AlarmSpecification": {
  647. "Alarms": [
  648. "my-alarm"
  649. ]
  650. },
  651. "AutoRollback": true,
  652. "InstanceWarmup": 200,
  653. "MaxHealthyPercentage": 120,
  654. "MinHealthyPercentage": 90,
  655. "ScaleInProtectedInstances": "Ignore",
  656. "SkipMatching": false,
  657. "StandbyInstances": "Ignore"
  658. },
  659. "StartTime": "2023-06-13T16:46:52+00:00",
  660. "Status": "InProgress",
  661. "StatusReason": "Waiting for instances to warm up before continuing. For example: i-0645704820a8e83ff is warming up."
  662. },
  663. {
  664. "AutoScalingGroupName": "my-auto-scaling-group",
  665. "EndTime": "2023-06-02T13:59:45+00:00",
  666. "InstanceRefreshId": "0e151305-1e57-4a32-a256-1fd14157c5ec",
  667. "InstancesToUpdate": 0,
  668. "PercentageComplete": 100,
  669. "Preferences": {
  670. "AlarmSpecification": {
  671. "Alarms": [
  672. "my-alarm"
  673. ]
  674. },
  675. "AutoRollback": true,
  676. "InstanceWarmup": 200,
  677. "MaxHealthyPercentage": 120,
  678. "MinHealthyPercentage": 90,
  679. "ScaleInProtectedInstances": "Ignore",
  680. "SkipMatching": false,
  681. "StandbyInstances": "Ignore"
  682. },
  683. "StartTime": "2023-06-02T13:53:37+00:00",
  684. "Status": "Successful"
  685. }
  686. ]
  687. },
  688. "comments": {
  689. "input": {
  690. },
  691. "output": {
  692. }
  693. },
  694. "description": "This example describes the instance refreshes for the specified Auto Scaling group.",
  695. "id": "to-list-instance-refreshes-1592959593746",
  696. "title": "To list instance refreshes"
  697. }
  698. ],
  699. "DescribeLaunchConfigurations": [
  700. {
  701. "input": {
  702. "LaunchConfigurationNames": [
  703. "my-launch-config"
  704. ]
  705. },
  706. "output": {
  707. "LaunchConfigurations": [
  708. {
  709. "AssociatePublicIpAddress": true,
  710. "BlockDeviceMappings": [
  711. ],
  712. "CreatedTime": "2014-05-07T17:39:28.599Z",
  713. "EbsOptimized": false,
  714. "ImageId": "ami-043a5034",
  715. "InstanceMonitoring": {
  716. "Enabled": true
  717. },
  718. "InstanceType": "t1.micro",
  719. "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config",
  720. "LaunchConfigurationName": "my-launch-config",
  721. "SecurityGroups": [
  722. "sg-67ef0308"
  723. ]
  724. }
  725. ]
  726. },
  727. "comments": {
  728. "input": {
  729. },
  730. "output": {
  731. }
  732. },
  733. "description": "This example describes the specified launch configuration.",
  734. "id": "autoscaling-describe-launch-configurations-1",
  735. "title": "To describe Auto Scaling launch configurations"
  736. }
  737. ],
  738. "DescribeLifecycleHookTypes": [
  739. {
  740. "output": {
  741. "LifecycleHookTypes": [
  742. "autoscaling:EC2_INSTANCE_LAUNCHING",
  743. "autoscaling:EC2_INSTANCE_TERMINATING"
  744. ]
  745. },
  746. "comments": {
  747. "input": {
  748. },
  749. "output": {
  750. }
  751. },
  752. "description": "This example describes the available lifecycle hook types.",
  753. "id": "autoscaling-describe-lifecycle-hook-types-1",
  754. "title": "To describe the available types of lifecycle hooks"
  755. }
  756. ],
  757. "DescribeLifecycleHooks": [
  758. {
  759. "input": {
  760. "AutoScalingGroupName": "my-auto-scaling-group"
  761. },
  762. "output": {
  763. "LifecycleHooks": [
  764. {
  765. "AutoScalingGroupName": "my-auto-scaling-group",
  766. "DefaultResult": "ABANDON",
  767. "GlobalTimeout": 172800,
  768. "HeartbeatTimeout": 3600,
  769. "LifecycleHookName": "my-lifecycle-hook",
  770. "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING",
  771. "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic",
  772. "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role"
  773. }
  774. ]
  775. },
  776. "comments": {
  777. "input": {
  778. },
  779. "output": {
  780. }
  781. },
  782. "description": "This example describes the lifecycle hooks for the specified Auto Scaling group.",
  783. "id": "autoscaling-describe-lifecycle-hooks-1",
  784. "title": "To describe your lifecycle hooks"
  785. }
  786. ],
  787. "DescribeLoadBalancerTargetGroups": [
  788. {
  789. "input": {
  790. "AutoScalingGroupName": "my-auto-scaling-group"
  791. },
  792. "output": {
  793. "LoadBalancerTargetGroups": [
  794. {
  795. "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
  796. "State": "Added"
  797. }
  798. ]
  799. },
  800. "comments": {
  801. "input": {
  802. },
  803. "output": {
  804. }
  805. },
  806. "description": "This example describes the target groups attached to the specified Auto Scaling group.",
  807. "id": "autoscaling-describe-load-balancer-target-groups-1",
  808. "title": "To describe the target groups for an Auto Scaling group"
  809. }
  810. ],
  811. "DescribeLoadBalancers": [
  812. {
  813. "input": {
  814. "AutoScalingGroupName": "my-auto-scaling-group"
  815. },
  816. "output": {
  817. "LoadBalancers": [
  818. {
  819. "LoadBalancerName": "my-load-balancer",
  820. "State": "Added"
  821. }
  822. ]
  823. },
  824. "comments": {
  825. "input": {
  826. },
  827. "output": {
  828. }
  829. },
  830. "description": "This example describes the load balancers attached to the specified Auto Scaling group.",
  831. "id": "autoscaling-describe-load-balancers-1",
  832. "title": "To describe the load balancers for an Auto Scaling group"
  833. }
  834. ],
  835. "DescribeMetricCollectionTypes": [
  836. {
  837. "output": {
  838. "Granularities": [
  839. {
  840. "Granularity": "1Minute"
  841. }
  842. ],
  843. "Metrics": [
  844. {
  845. "Metric": "GroupMinSize"
  846. },
  847. {
  848. "Metric": "GroupMaxSize"
  849. },
  850. {
  851. "Metric": "GroupDesiredCapacity"
  852. },
  853. {
  854. "Metric": "GroupInServiceInstances"
  855. },
  856. {
  857. "Metric": "GroupPendingInstances"
  858. },
  859. {
  860. "Metric": "GroupTerminatingInstances"
  861. },
  862. {
  863. "Metric": "GroupStandbyInstances"
  864. },
  865. {
  866. "Metric": "GroupTotalInstances"
  867. }
  868. ]
  869. },
  870. "comments": {
  871. "input": {
  872. },
  873. "output": {
  874. }
  875. },
  876. "description": "This example describes the available metric collection types.",
  877. "id": "autoscaling-describe-metric-collection-types-1",
  878. "title": "To describe the Auto Scaling metric collection types"
  879. }
  880. ],
  881. "DescribeNotificationConfigurations": [
  882. {
  883. "input": {
  884. "AutoScalingGroupNames": [
  885. "my-auto-scaling-group"
  886. ]
  887. },
  888. "output": {
  889. "NotificationConfigurations": [
  890. {
  891. "AutoScalingGroupName": "my-auto-scaling-group",
  892. "NotificationType": "autoscaling:TEST_NOTIFICATION",
  893. "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2"
  894. },
  895. {
  896. "AutoScalingGroupName": "my-auto-scaling-group",
  897. "NotificationType": "autoscaling:TEST_NOTIFICATION",
  898. "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
  899. }
  900. ]
  901. },
  902. "comments": {
  903. "input": {
  904. },
  905. "output": {
  906. }
  907. },
  908. "description": "This example describes the notification configurations for the specified Auto Scaling group.",
  909. "id": "autoscaling-describe-notification-configurations-1",
  910. "title": "To describe Auto Scaling notification configurations"
  911. }
  912. ],
  913. "DescribePolicies": [
  914. {
  915. "input": {
  916. "AutoScalingGroupName": "my-auto-scaling-group"
  917. },
  918. "output": {
  919. "ScalingPolicies": [
  920. {
  921. "AdjustmentType": "ChangeInCapacity",
  922. "Alarms": [
  923. ],
  924. "AutoScalingGroupName": "my-auto-scaling-group",
  925. "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn",
  926. "PolicyName": "ScaleIn",
  927. "ScalingAdjustment": -1
  928. },
  929. {
  930. "AdjustmentType": "PercentChangeInCapacity",
  931. "Alarms": [
  932. ],
  933. "AutoScalingGroupName": "my-auto-scaling-group",
  934. "Cooldown": 60,
  935. "MinAdjustmentStep": 2,
  936. "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange",
  937. "PolicyName": "ScalePercentChange",
  938. "ScalingAdjustment": 25
  939. }
  940. ]
  941. },
  942. "comments": {
  943. "input": {
  944. },
  945. "output": {
  946. }
  947. },
  948. "description": "This example describes the policies for the specified Auto Scaling group.",
  949. "id": "autoscaling-describe-policies-1",
  950. "title": "To describe scaling policies"
  951. }
  952. ],
  953. "DescribeScalingActivities": [
  954. {
  955. "input": {
  956. "AutoScalingGroupName": "my-auto-scaling-group"
  957. },
  958. "output": {
  959. "Activities": [
  960. {
  961. "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699",
  962. "AutoScalingGroupARN": "arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group",
  963. "AutoScalingGroupName": "my-auto-scaling-group",
  964. "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.",
  965. "Description": "Launching a new EC2 instance: i-4ba0837f",
  966. "Details": "details",
  967. "EndTime": "2013-08-19T20:54:02Z",
  968. "Progress": 100,
  969. "StartTime": "2013-08-19T20:53:29.930Z",
  970. "StatusCode": "Successful"
  971. }
  972. ]
  973. },
  974. "comments": {
  975. "input": {
  976. },
  977. "output": {
  978. }
  979. },
  980. "description": "This example describes the scaling activities for the specified Auto Scaling group.",
  981. "id": "autoscaling-describe-scaling-activities-1",
  982. "title": "To describe the scaling activities for an Auto Scaling group"
  983. }
  984. ],
  985. "DescribeScalingProcessTypes": [
  986. {
  987. "output": {
  988. "Processes": [
  989. {
  990. "ProcessName": "AZRebalance"
  991. },
  992. {
  993. "ProcessName": "AddToLoadBalancer"
  994. },
  995. {
  996. "ProcessName": "AlarmNotification"
  997. },
  998. {
  999. "ProcessName": "HealthCheck"
  1000. },
  1001. {
  1002. "ProcessName": "Launch"
  1003. },
  1004. {
  1005. "ProcessName": "ReplaceUnhealthy"
  1006. },
  1007. {
  1008. "ProcessName": "ScheduledActions"
  1009. },
  1010. {
  1011. "ProcessName": "Terminate"
  1012. }
  1013. ]
  1014. },
  1015. "comments": {
  1016. "input": {
  1017. },
  1018. "output": {
  1019. }
  1020. },
  1021. "description": "This example describes the Auto Scaling process types.",
  1022. "id": "autoscaling-describe-scaling-process-types-1",
  1023. "title": "To describe the Auto Scaling process types"
  1024. }
  1025. ],
  1026. "DescribeScheduledActions": [
  1027. {
  1028. "input": {
  1029. "AutoScalingGroupName": "my-auto-scaling-group"
  1030. },
  1031. "output": {
  1032. "ScheduledUpdateGroupActions": [
  1033. {
  1034. "AutoScalingGroupName": "my-auto-scaling-group",
  1035. "DesiredCapacity": 4,
  1036. "MaxSize": 6,
  1037. "MinSize": 2,
  1038. "Recurrence": "30 0 1 12 0",
  1039. "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action",
  1040. "ScheduledActionName": "my-scheduled-action",
  1041. "StartTime": "2016-12-01T00:30:00Z",
  1042. "Time": "2016-12-01T00:30:00Z"
  1043. }
  1044. ]
  1045. },
  1046. "comments": {
  1047. "input": {
  1048. },
  1049. "output": {
  1050. }
  1051. },
  1052. "description": "This example describes the scheduled actions for the specified Auto Scaling group.",
  1053. "id": "autoscaling-describe-scheduled-actions-1",
  1054. "title": "To describe scheduled actions"
  1055. }
  1056. ],
  1057. "DescribeTags": [
  1058. {
  1059. "input": {
  1060. "Filters": [
  1061. {
  1062. "Name": "auto-scaling-group",
  1063. "Values": [
  1064. "my-auto-scaling-group"
  1065. ]
  1066. }
  1067. ]
  1068. },
  1069. "output": {
  1070. "Tags": [
  1071. {
  1072. "Key": "Dept",
  1073. "PropagateAtLaunch": true,
  1074. "ResourceId": "my-auto-scaling-group",
  1075. "ResourceType": "auto-scaling-group",
  1076. "Value": "Research"
  1077. },
  1078. {
  1079. "Key": "Role",
  1080. "PropagateAtLaunch": true,
  1081. "ResourceId": "my-auto-scaling-group",
  1082. "ResourceType": "auto-scaling-group",
  1083. "Value": "WebServer"
  1084. }
  1085. ]
  1086. },
  1087. "comments": {
  1088. "input": {
  1089. },
  1090. "output": {
  1091. }
  1092. },
  1093. "description": "This example describes the tags for the specified Auto Scaling group.",
  1094. "id": "autoscaling-describe-tags-1",
  1095. "title": "To describe tags"
  1096. }
  1097. ],
  1098. "DescribeTerminationPolicyTypes": [
  1099. {
  1100. "output": {
  1101. "TerminationPolicyTypes": [
  1102. "ClosestToNextInstanceHour",
  1103. "Default",
  1104. "NewestInstance",
  1105. "OldestInstance",
  1106. "OldestLaunchConfiguration"
  1107. ]
  1108. },
  1109. "comments": {
  1110. "input": {
  1111. },
  1112. "output": {
  1113. }
  1114. },
  1115. "description": "This example describes the available termination policy types.",
  1116. "id": "autoscaling-describe-termination-policy-types-1",
  1117. "title": "To describe termination policy types"
  1118. }
  1119. ],
  1120. "DescribeTrafficSources": [
  1121. {
  1122. "input": {
  1123. "AutoScalingGroupName": "my-auto-scaling-group"
  1124. },
  1125. "output": {
  1126. "NextToken": "",
  1127. "TrafficSources": [
  1128. {
  1129. "Identifier": "arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE",
  1130. "State": "InService",
  1131. "Type": "vpc-lattice"
  1132. }
  1133. ]
  1134. },
  1135. "comments": {
  1136. "input": {
  1137. },
  1138. "output": {
  1139. }
  1140. },
  1141. "description": "This example describes the target groups attached to the specified Auto Scaling group.",
  1142. "id": "to-describe-the-target-groups-for-an-auto-scaling-group-1680040714521",
  1143. "title": "To describe the target groups for an Auto Scaling group"
  1144. }
  1145. ],
  1146. "DetachInstances": [
  1147. {
  1148. "input": {
  1149. "AutoScalingGroupName": "my-auto-scaling-group",
  1150. "InstanceIds": [
  1151. "i-93633f9b"
  1152. ],
  1153. "ShouldDecrementDesiredCapacity": true
  1154. },
  1155. "output": {
  1156. "Activities": [
  1157. {
  1158. "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9",
  1159. "AutoScalingGroupName": "my-auto-scaling-group",
  1160. "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.",
  1161. "Description": "Detaching EC2 instance: i-93633f9b",
  1162. "Details": "details",
  1163. "Progress": 50,
  1164. "StartTime": "2015-04-12T15:02:16.179Z",
  1165. "StatusCode": "InProgress"
  1166. }
  1167. ]
  1168. },
  1169. "comments": {
  1170. "input": {
  1171. },
  1172. "output": {
  1173. }
  1174. },
  1175. "description": "This example detaches the specified instance from the specified Auto Scaling group.",
  1176. "id": "autoscaling-detach-instances-1",
  1177. "title": "To detach an instance from an Auto Scaling group"
  1178. }
  1179. ],
  1180. "DetachLoadBalancerTargetGroups": [
  1181. {
  1182. "input": {
  1183. "AutoScalingGroupName": "my-auto-scaling-group",
  1184. "TargetGroupARNs": [
  1185. "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
  1186. ]
  1187. },
  1188. "comments": {
  1189. "input": {
  1190. },
  1191. "output": {
  1192. }
  1193. },
  1194. "description": "This example detaches the specified target group from the specified Auto Scaling group",
  1195. "id": "autoscaling-detach-load-balancer-target-groups-1",
  1196. "title": "To detach a target group from an Auto Scaling group"
  1197. }
  1198. ],
  1199. "DetachLoadBalancers": [
  1200. {
  1201. "input": {
  1202. "AutoScalingGroupName": "my-auto-scaling-group",
  1203. "LoadBalancerNames": [
  1204. "my-load-balancer"
  1205. ]
  1206. },
  1207. "comments": {
  1208. "input": {
  1209. },
  1210. "output": {
  1211. }
  1212. },
  1213. "description": "This example detaches the specified load balancer from the specified Auto Scaling group.",
  1214. "id": "autoscaling-detach-load-balancers-1",
  1215. "title": "To detach a load balancer from an Auto Scaling group"
  1216. }
  1217. ],
  1218. "DetachTrafficSources": [
  1219. {
  1220. "input": {
  1221. "AutoScalingGroupName": "my-auto-scaling-group",
  1222. "TrafficSources": [
  1223. {
  1224. "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
  1225. }
  1226. ]
  1227. },
  1228. "output": {
  1229. },
  1230. "comments": {
  1231. "input": {
  1232. },
  1233. "output": {
  1234. }
  1235. },
  1236. "description": "This example detaches the specified target group from the specified Auto Scaling group.",
  1237. "id": "to-detach-a-target-group-from-an-auto-scaling-group-1680040404169",
  1238. "title": "To detach a target group from an Auto Scaling group"
  1239. }
  1240. ],
  1241. "DisableMetricsCollection": [
  1242. {
  1243. "input": {
  1244. "AutoScalingGroupName": "my-auto-scaling-group",
  1245. "Metrics": [
  1246. "GroupDesiredCapacity"
  1247. ]
  1248. },
  1249. "comments": {
  1250. "input": {
  1251. },
  1252. "output": {
  1253. }
  1254. },
  1255. "description": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.",
  1256. "id": "autoscaling-disable-metrics-collection-1",
  1257. "title": "To disable metrics collection for an Auto Scaling group"
  1258. }
  1259. ],
  1260. "EnableMetricsCollection": [
  1261. {
  1262. "input": {
  1263. "AutoScalingGroupName": "my-auto-scaling-group",
  1264. "Granularity": "1Minute"
  1265. },
  1266. "comments": {
  1267. "input": {
  1268. },
  1269. "output": {
  1270. }
  1271. },
  1272. "description": "This example enables data collection for the specified Auto Scaling group.",
  1273. "id": "autoscaling-enable-metrics-collection-1",
  1274. "title": "To enable metrics collection for an Auto Scaling group"
  1275. }
  1276. ],
  1277. "EnterStandby": [
  1278. {
  1279. "input": {
  1280. "AutoScalingGroupName": "my-auto-scaling-group",
  1281. "InstanceIds": [
  1282. "i-93633f9b"
  1283. ],
  1284. "ShouldDecrementDesiredCapacity": true
  1285. },
  1286. "output": {
  1287. "Activities": [
  1288. {
  1289. "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1",
  1290. "AutoScalingGroupName": "my-auto-scaling-group",
  1291. "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.",
  1292. "Description": "Moving EC2 instance to Standby: i-93633f9b",
  1293. "Details": "details",
  1294. "Progress": 50,
  1295. "StartTime": "2015-04-12T15:10:23.640Z",
  1296. "StatusCode": "InProgress"
  1297. }
  1298. ]
  1299. },
  1300. "comments": {
  1301. "input": {
  1302. },
  1303. "output": {
  1304. }
  1305. },
  1306. "description": "This example puts the specified instance into standby mode.",
  1307. "id": "autoscaling-enter-standby-1",
  1308. "title": "To move instances into standby mode"
  1309. }
  1310. ],
  1311. "ExecutePolicy": [
  1312. {
  1313. "input": {
  1314. "AutoScalingGroupName": "my-auto-scaling-group",
  1315. "BreachThreshold": 50.0,
  1316. "MetricValue": 59.0,
  1317. "PolicyName": "my-step-scale-out-policy"
  1318. },
  1319. "comments": {
  1320. "input": {
  1321. },
  1322. "output": {
  1323. }
  1324. },
  1325. "description": "This example executes the specified policy.",
  1326. "id": "autoscaling-execute-policy-1",
  1327. "title": "To execute a scaling policy"
  1328. }
  1329. ],
  1330. "ExitStandby": [
  1331. {
  1332. "input": {
  1333. "AutoScalingGroupName": "my-auto-scaling-group",
  1334. "InstanceIds": [
  1335. "i-93633f9b"
  1336. ]
  1337. },
  1338. "output": {
  1339. "Activities": [
  1340. {
  1341. "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928",
  1342. "AutoScalingGroupName": "my-auto-scaling-group",
  1343. "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.",
  1344. "Description": "Moving EC2 instance out of Standby: i-93633f9b",
  1345. "Details": "details",
  1346. "Progress": 30,
  1347. "StartTime": "2015-04-12T15:14:29.886Z",
  1348. "StatusCode": "PreInService"
  1349. }
  1350. ]
  1351. },
  1352. "comments": {
  1353. "input": {
  1354. },
  1355. "output": {
  1356. }
  1357. },
  1358. "description": "This example moves the specified instance out of standby mode.",
  1359. "id": "autoscaling-exit-standby-1",
  1360. "title": "To move instances out of standby mode"
  1361. }
  1362. ],
  1363. "PutLifecycleHook": [
  1364. {
  1365. "input": {
  1366. "AutoScalingGroupName": "my-auto-scaling-group",
  1367. "DefaultResult": "CONTINUE",
  1368. "HeartbeatTimeout": 300,
  1369. "LifecycleHookName": "my-launch-lifecycle-hook",
  1370. "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING"
  1371. },
  1372. "comments": {
  1373. "input": {
  1374. },
  1375. "output": {
  1376. }
  1377. },
  1378. "description": "This example creates a lifecycle hook for instance launch.",
  1379. "id": "autoscaling-put-lifecycle-hook-1",
  1380. "title": "To create a launch lifecycle hook"
  1381. }
  1382. ],
  1383. "PutNotificationConfiguration": [
  1384. {
  1385. "input": {
  1386. "AutoScalingGroupName": "my-auto-scaling-group",
  1387. "NotificationTypes": [
  1388. "autoscaling:TEST_NOTIFICATION"
  1389. ],
  1390. "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
  1391. },
  1392. "comments": {
  1393. "input": {
  1394. },
  1395. "output": {
  1396. }
  1397. },
  1398. "description": "This example adds the specified notification to the specified Auto Scaling group.",
  1399. "id": "autoscaling-put-notification-configuration-1",
  1400. "title": "To add an Auto Scaling notification"
  1401. }
  1402. ],
  1403. "PutScalingPolicy": [
  1404. {
  1405. "input": {
  1406. "AutoScalingGroupName": "my-auto-scaling-group",
  1407. "PolicyName": "alb1000-target-tracking-scaling-policy",
  1408. "PolicyType": "TargetTrackingScaling",
  1409. "TargetTrackingConfiguration": {
  1410. "PredefinedMetricSpecification": {
  1411. "PredefinedMetricType": "ALBRequestCountPerTarget",
  1412. "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff"
  1413. },
  1414. "TargetValue": 1000.0
  1415. }
  1416. },
  1417. "output": {
  1418. "Alarms": [
  1419. {
  1420. "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e",
  1421. "AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e"
  1422. },
  1423. {
  1424. "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2",
  1425. "AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2"
  1426. }
  1427. ],
  1428. "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy"
  1429. },
  1430. "comments": {
  1431. "input": {
  1432. },
  1433. "output": {
  1434. }
  1435. },
  1436. "description": "This example adds the specified policy to the specified Auto Scaling group.",
  1437. "id": "autoscaling-put-scaling-policy-1",
  1438. "title": "To add a scaling policy to an Auto Scaling group"
  1439. }
  1440. ],
  1441. "PutScheduledUpdateGroupAction": [
  1442. {
  1443. "input": {
  1444. "AutoScalingGroupName": "my-auto-scaling-group",
  1445. "DesiredCapacity": 4,
  1446. "EndTime": "2014-05-12T08:00:00Z",
  1447. "MaxSize": 6,
  1448. "MinSize": 2,
  1449. "ScheduledActionName": "my-scheduled-action",
  1450. "StartTime": "2014-05-12T08:00:00Z"
  1451. },
  1452. "comments": {
  1453. "input": {
  1454. },
  1455. "output": {
  1456. }
  1457. },
  1458. "description": "This example adds the specified scheduled action to the specified Auto Scaling group.",
  1459. "id": "autoscaling-put-scheduled-update-group-action-1",
  1460. "title": "To add a scheduled action to an Auto Scaling group"
  1461. }
  1462. ],
  1463. "PutWarmPool": [
  1464. {
  1465. "input": {
  1466. "AutoScalingGroupName": "my-auto-scaling-group",
  1467. "InstanceReusePolicy": {
  1468. "ReuseOnScaleIn": true
  1469. },
  1470. "MinSize": 30,
  1471. "PoolState": "Hibernated"
  1472. },
  1473. "comments": {
  1474. "input": {
  1475. },
  1476. "output": {
  1477. }
  1478. },
  1479. "description": "This example creates a warm pool for the specified Auto Scaling group.",
  1480. "id": "to-add-a-warm-pool-to-an-auto-scaling-group-1617818810383",
  1481. "title": "To create a warm pool for an Auto Scaling group"
  1482. }
  1483. ],
  1484. "RecordLifecycleActionHeartbeat": [
  1485. {
  1486. "input": {
  1487. "AutoScalingGroupName": "my-auto-scaling-group",
  1488. "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635",
  1489. "LifecycleHookName": "my-lifecycle-hook"
  1490. },
  1491. "comments": {
  1492. "input": {
  1493. },
  1494. "output": {
  1495. }
  1496. },
  1497. "description": "This example records a lifecycle action heartbeat to keep the instance in a pending state.",
  1498. "id": "autoscaling-record-lifecycle-action-heartbeat-1",
  1499. "title": "To record a lifecycle action heartbeat"
  1500. }
  1501. ],
  1502. "ResumeProcesses": [
  1503. {
  1504. "input": {
  1505. "AutoScalingGroupName": "my-auto-scaling-group",
  1506. "ScalingProcesses": [
  1507. "AlarmNotification"
  1508. ]
  1509. },
  1510. "comments": {
  1511. "input": {
  1512. },
  1513. "output": {
  1514. }
  1515. },
  1516. "description": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.",
  1517. "id": "autoscaling-resume-processes-1",
  1518. "title": "To resume Auto Scaling processes"
  1519. }
  1520. ],
  1521. "SetDesiredCapacity": [
  1522. {
  1523. "input": {
  1524. "AutoScalingGroupName": "my-auto-scaling-group",
  1525. "DesiredCapacity": 2,
  1526. "HonorCooldown": true
  1527. },
  1528. "comments": {
  1529. "input": {
  1530. },
  1531. "output": {
  1532. }
  1533. },
  1534. "description": "This example sets the desired capacity for the specified Auto Scaling group.",
  1535. "id": "autoscaling-set-desired-capacity-1",
  1536. "title": "To set the desired capacity for an Auto Scaling group"
  1537. }
  1538. ],
  1539. "SetInstanceHealth": [
  1540. {
  1541. "input": {
  1542. "HealthStatus": "Unhealthy",
  1543. "InstanceId": "i-93633f9b"
  1544. },
  1545. "comments": {
  1546. "input": {
  1547. },
  1548. "output": {
  1549. }
  1550. },
  1551. "description": "This example sets the health status of the specified instance to Unhealthy.",
  1552. "id": "autoscaling-set-instance-health-1",
  1553. "title": "To set the health status of an instance"
  1554. }
  1555. ],
  1556. "SetInstanceProtection": [
  1557. {
  1558. "input": {
  1559. "AutoScalingGroupName": "my-auto-scaling-group",
  1560. "InstanceIds": [
  1561. "i-93633f9b"
  1562. ],
  1563. "ProtectedFromScaleIn": true
  1564. },
  1565. "comments": {
  1566. "input": {
  1567. },
  1568. "output": {
  1569. }
  1570. },
  1571. "description": "This example enables instance protection for the specified instance.",
  1572. "id": "autoscaling-set-instance-protection-1",
  1573. "title": "To enable instance protection for an instance"
  1574. },
  1575. {
  1576. "input": {
  1577. "AutoScalingGroupName": "my-auto-scaling-group",
  1578. "InstanceIds": [
  1579. "i-93633f9b"
  1580. ],
  1581. "ProtectedFromScaleIn": false
  1582. },
  1583. "comments": {
  1584. "input": {
  1585. },
  1586. "output": {
  1587. }
  1588. },
  1589. "description": "This example disables instance protection for the specified instance.",
  1590. "id": "autoscaling-set-instance-protection-2",
  1591. "title": "To disable instance protection for an instance"
  1592. }
  1593. ],
  1594. "StartInstanceRefresh": [
  1595. {
  1596. "input": {
  1597. "AutoScalingGroupName": "my-auto-scaling-group",
  1598. "DesiredConfiguration": {
  1599. "LaunchTemplate": {
  1600. "LaunchTemplateName": "my-template-for-auto-scaling",
  1601. "Version": "$Latest"
  1602. }
  1603. },
  1604. "Preferences": {
  1605. "AlarmSpecification": {
  1606. "Alarms": [
  1607. "my-alarm"
  1608. ]
  1609. },
  1610. "AutoRollback": true,
  1611. "InstanceWarmup": 200,
  1612. "MaxHealthyPercentage": 120,
  1613. "MinHealthyPercentage": 90
  1614. }
  1615. },
  1616. "output": {
  1617. "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"
  1618. },
  1619. "comments": {
  1620. "input": {
  1621. },
  1622. "output": {
  1623. }
  1624. },
  1625. "description": "This example starts an instance refresh for the specified Auto Scaling group.",
  1626. "id": "to-start-an-instance-refresh-1592957271522",
  1627. "title": "To start an instance refresh"
  1628. }
  1629. ],
  1630. "SuspendProcesses": [
  1631. {
  1632. "input": {
  1633. "AutoScalingGroupName": "my-auto-scaling-group",
  1634. "ScalingProcesses": [
  1635. "AlarmNotification"
  1636. ]
  1637. },
  1638. "comments": {
  1639. "input": {
  1640. },
  1641. "output": {
  1642. }
  1643. },
  1644. "description": "This example suspends the specified scaling process for the specified Auto Scaling group.",
  1645. "id": "autoscaling-suspend-processes-1",
  1646. "title": "To suspend Auto Scaling processes"
  1647. }
  1648. ],
  1649. "TerminateInstanceInAutoScalingGroup": [
  1650. {
  1651. "input": {
  1652. "InstanceId": "i-93633f9b",
  1653. "ShouldDecrementDesiredCapacity": false
  1654. },
  1655. "comments": {
  1656. "input": {
  1657. },
  1658. "output": {
  1659. }
  1660. },
  1661. "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.",
  1662. "id": "autoscaling-terminate-instance-in-auto-scaling-group-1",
  1663. "title": "To terminate an instance in an Auto Scaling group"
  1664. }
  1665. ],
  1666. "UpdateAutoScalingGroup": [
  1667. {
  1668. "input": {
  1669. "AutoScalingGroupName": "my-auto-scaling-group",
  1670. "LaunchTemplate": {
  1671. "LaunchTemplateName": "my-template-for-auto-scaling",
  1672. "Version": "2"
  1673. },
  1674. "MaxSize": 5,
  1675. "MinSize": 1,
  1676. "NewInstancesProtectedFromScaleIn": true
  1677. },
  1678. "comments": {
  1679. "input": {
  1680. },
  1681. "output": {
  1682. }
  1683. },
  1684. "description": "This example updates multiple properties at the same time.",
  1685. "id": "autoscaling-update-auto-scaling-group-1",
  1686. "title": "To update an Auto Scaling group"
  1687. }
  1688. ]
  1689. }
  1690. }