├── LICENSE ├── README.md └── banner.png /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AWS CLI Cheat Sheet 2 | 3 | * [Volumes](#volumes) 4 | * [Describing volumes](#describing-volumes) 5 | * [Describing volumes using a different aws user profile](#describing-volumes-using-a-different-aws-user-profile) 6 | * [Listing Available Volumes IDs](#listing-available-volumes-ids) 7 | * [Deleting a Volume](#deleting-a-volume) 8 | * [Deleting Unused Volumes.. Think Before You Type :-)](#deleting-unused-volumes-think-before-you-type--) 9 | * [Creating a Snapshot](#creating-a-snapshot) 10 | * [Creating an Image (AMI)](#creating-an-image-ami) 11 | * [Creating AMI Without Rebooting the Machine](#creating-ami-without-rebooting-the-machine) 12 | * [AMIs](#amis) 13 | * [Listing AMI(s)](#listing-amis) 14 | * [Describing AMI(s)](#describing-amis) 15 | * [Listing Amazon AMIs](#listing-amazon-amis) 16 | * [Using Filters](#using-filters) 17 | * [Lambda](#lambda) 18 | * [List Functions](#list-functions) 19 | * [Describe a Function](#describe-a-function) 20 | * [Invoke a Function](#invoke-a-function) 21 | * [Update a Function Code](#update-a-function-code) 22 | * [Publish a Version](#publish-a-version) 23 | * [List Layers](#list-layers) 24 | * [List Aliases of a Function](#list-aliases-of-a-function) 25 | * [Describe an Alias](#describe-an-alias) 26 | * [Create an Alias](#create-an-alias) 27 | * [Delete an Alias](#delete-an-alias) 28 | * [List Function Tags](#list-function-tags) 29 | * [Delete a Function](#delete-a-function) 30 | * [Using AWS Lambda with Scheduled Events](#using-aws-lambda-with-scheduled-events) 31 | * [IAM](#iam) 32 | * [List Users](#list-users) 33 | * [List Policies](#list-policies) 34 | * [List Groups](#list-groups) 35 | * [Get Users in a Group](#get-users-in-a--group) 36 | * [Describing a Policy](#describing-a-policy) 37 | * [List Access Keys](#list-access-keys) 38 | * [List Keys](#list-keys) 39 | * [List the Access Key IDs for an IAM User](#list-the-access-key-ids-for-an-iam-user) 40 | * [List the SSH Public Keys for a User](#list-the-ssh-public-keys-for-a-user) 41 | * [S3 API](#s3-api) 42 | * [Listing Buckets](#listing-buckets) 43 | * [Listing Only Bucket Names](#listing-only-bucket-names) 44 | * [Getting a Bucket Region](#getting-a-bucket-region) 45 | * [Listing the Content of a Bucket](#listing-the-content-of-a-bucket) 46 | * [Syncing a Local Folder with a Bucket](#syncing-a-local-folder-with-a-bucket) 47 | * [Copying Files](#copying-files) 48 | * [Copying Folders](#copying-folders) 49 | * [Removing a File from a Bucket](#removing-a-file-from-a-bucket) 50 | * [Deleting a Bucket](#deleting-a-bucket) 51 | * [Emptying a Bucket](#emptying-a-bucket) 52 | * [VPC](#vpc) 53 | * [Creating A VPC](#creating-a-vpc) 54 | * [Allowing DNS hostnames](#allowing-dns-hostnames) 55 | * [Subnets](#subnets) 56 | * [Creating A Subnet](#creating-a-subnet) 57 | * [Auto Assigning Public IPs To Instances In A Public Subnet](#auto-assigning-public-ips-to-instances-in-a-public-subnet) 58 | * [Internet Gateway](#internet-gateway) 59 | * [Creating An IGW](#creating-an-igw) 60 | * [Attaching An IGW to A VPC](#attaching-an-igw-to-a-vpc) 61 | * [NAT](#nat) 62 | * [Setting Up A NAT Gateway](#setting-up-a-nat-gateway) 63 | * [Route Tables](#route-tables) 64 | * [Creating A Public Route Table](#creating-a-public-route-table) 65 | * [Creating A Private Route Tables](#creating-a-private-route-tables) 66 | * [CloudFront](#cloudfront) 67 | * [Listing Distributions](#listing-distributions) 68 | * [Invalidating Files From a Distribution](#invalidating-files-from-a-distribution) 69 | * [Sync a Local Folder with a CLoudFront Distribution](#sync-a-local-folder-with-a-cloudfront-distribution) 70 | * [Sync and Invalidate at the Same Time:](#sync-and-invalidate-at-the-same-time) 71 | * [RDS](#rds) 72 | * [List Databases](#list-databases) 73 | * [List Public Databases](#list-public-databases) 74 | * [List Non Protected Databases (DeletionProtection)](#list-non-protected-databases-deletionprotection) 75 | * [Describe the Automated Backups for a DB Instance](#describe-the-automated-backups-for-a-db-instance) 76 | * [Create a DB Cluster](#create-a-db-cluster) 77 | * [Create a DB Instance](#create-a-db-instance) 78 | * [Create a DB Security Group](#create-a-db-security-group) 79 | * [Create a Read Replica](#create-a-read-replica) 80 | * [Create a Custom DB Cluster Endpoint](#create-a-custom-db-cluster-endpoint) 81 | * [Apply Tag to a DB](#apply-tag-to-a-db) 82 | * [Create a Cluster Snapshot](#create-a-cluster-snapshot) 83 | * [Create a CloudWatch Alarm for a DB Instance](#create-a-cloudwatch-alarm-for-a-db-instance) 84 | * [Connect Deeper](#connect-deeper) 85 | 86 | 87 | 88 | # Volumes 89 | 90 | 91 | 92 | ## Describing volumes 93 | 94 | ``` 95 | aws ec2 describe-volumes 96 | ``` 97 | 98 | Describing filtered volumes: 99 | 100 | ``` 101 | aws ec2 describe-volumes --filters Name=status,Values=creating | available | in-use | deleting | deleted | error 102 | ``` 103 | 104 | 105 | e.g, describing all deleted volumes: 106 | 107 | ``` 108 | aws ec2 describe-volumes --filters Name=status,Values=deleted 109 | ``` 110 | 111 | Filters can be applied to the attachment status: 112 | 113 | ``` 114 | aws ec2 describe-volumes --filters Name=attachment.status,Values=attaching | attached | detaching | detached 115 | ``` 116 | 117 | e.g: describing all volumes with the status "attaching": 118 | 119 | 120 | ``` 121 | aws ec2 describe-volumes --filters Name=attachment.status,Values=attaching 122 | ``` 123 | 124 | 125 | This is the generic form. Use --profile ``` ```, if you have multiple AWS profiles or accounts. 126 | 127 | 128 | ``` 129 | aws ec2 describe-volumes --filters Name:'tag:Name',Values: ['some_values'] --profile 130 | ``` 131 | 132 | 133 | 134 | ## Describing volumes using a different aws user profile 135 | 136 | ``` 137 | aws ec2 describe-volumes --filters Name=status,Values=in-use --profile 138 | ``` 139 | 140 | 141 | 142 | ## Listing Available Volumes IDs 143 | 144 | 145 | ``` 146 | aws ec2 describe-volumes --filters Name=status,Values=available |grep VolumeId|awk '{print $2}' | tr '\n|,|"' ' ' 147 | ``` 148 | 149 | With "profile": 150 | 151 | ``` 152 | aws ec2 describe-volumes --filters Name=status,Values=available --profile |grep VolumeId|awk '{print $2}' | tr '\n|,|"' ' ' 153 | ``` 154 | 155 | 156 | 157 | ## Deleting a Volume 158 | 159 | ``` 160 | aws ec2 delete-volume --region --volume-id 161 | ``` 162 | 163 | 164 | 165 | ## Deleting Unused Volumes.. Think Before You Type :-) 166 | 167 | 168 | ``` 169 | for x in $(aws ec2 describe-volumes --filters Name=status,Values=available --profile |grep VolumeId|awk '{print $2}' | tr ',|"' ' '); do aws ec2 delete-volume --region --volume-id $x; done 170 | ``` 171 | 172 | With "profile": 173 | 174 | ``` 175 | for x in $(aws ec2 describe-volumes --filters Name=status,Values=available --profile |grep VolumeId|awk '{print $2}' | tr ',|"' ' '); do aws ec2 delete-volume --region --volume-id $x --profile ; done 176 | ``` 177 | 178 | 179 | 180 | ## Creating a Snapshot 181 | 182 | ``` 183 | aws ec2 create-snapshot --volume-id 184 | ``` 185 | 186 | ``` 187 | aws ec2 create-snapshot --volume-id --description "snapshot-$(date +'%Y-%m-%d_%H-%M-%S')" 188 | ``` 189 | 190 | 191 | 192 | ## Creating an Image (AMI) 193 | 194 | ``` 195 | aws ec2 create-image --instance-id --name "image-$(date +'%Y-%m-%d_%H-%M-%S')" --description "image-$(date +'%Y-%m-%d_%H-%M-%S')" 196 | ``` 197 | 198 | 199 | 200 | ## Creating AMI Without Rebooting the Machine 201 | 202 | ``` 203 | aws ec2 create-image --instance-id --name "image-$(date +'%Y-%m-%d_%H-%M-%S')" --description "image-$(date +'%Y-%m-%d_%H-%M-%S')" --no-reboot 204 | ``` 205 | 206 | You are free to change the AMI name ``` image-$(date +'%Y-%m-%d_%H-%M-%S') ``` to a name of your choice. 207 | 208 | 209 | # AMIs 210 | 211 | 212 | 213 | ## Listing AMI(s) 214 | 215 | ``` 216 | aws ec2 describe-images 217 | ``` 218 | 219 | 220 | 221 | ## Describing AMI(s) 222 | 223 | ``` 224 | aws ec2 describe-images --image-ids --profile --region 225 | ``` 226 | 227 | e.g: 228 | 229 | ``` 230 | aws ec2 describe-images --image-ids ami-e24dfa9f --profile terraform --region eu-west-3 231 | ``` 232 | 233 | 234 | 235 | ## Listing Amazon AMIs 236 | 237 | ``` 238 | aws ec2 describe-images --owners amazon 239 | ``` 240 | 241 | 242 | 243 | ## Using Filters 244 | 245 | e.g: Describing Windows AMIs that are backed by Amazon EBS. 246 | 247 | ``` 248 | aws ec2 describe-images --filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs" 249 | ``` 250 | 251 | e.g: Describing Ubuntu AMIs 252 | 253 | ``` 254 | aws ec2 describe-images --filters "Name=name,Values=ubuntu*" 255 | ``` 256 | 257 | # Lambda 258 | 259 | 260 | 261 | ## List Functions 262 | 263 | ``` 264 | aws lambda list-functions 265 | ``` 266 | 267 | 268 | 269 | ## Describe a Function 270 | 271 | ``` 272 | aws lambda get-function --function-name my-function 273 | ``` 274 | 275 | 276 | 277 | ## Invoke a Function 278 | 279 | ``` 280 | aws lambda invoke --function-name my-function --payload '{ "name": "Bob" }' response.json 281 | ``` 282 | 283 | 284 | 285 | ## Update a Function Code 286 | 287 | ```` 288 | aws lambda update-function-code --function-name my-function --zip-file fileb://my-function.zip 289 | ```` 290 | 291 | 292 | 293 | ## Publish a Version 294 | 295 | ``` 296 | aws lambda publish-version --function-name my-function 297 | ``` 298 | 299 | 300 | 301 | ## List Layers 302 | 303 | Let's take this example in which we want to list information of layers that are compatible with Python 3.7 runtime. 304 | 305 | ``` 306 | aws lambda list-layers --compatible-runtime python3.7 307 | ``` 308 | 309 | Possible layers runtime: 310 | 311 | ``` 312 | nodejs 313 | nodejs4.3 314 | nodejs6.10 315 | nodejs8.10 316 | nodejs10.x 317 | nodejs12.x 318 | java8 319 | java8.al2 320 | java11 321 | python2.7 322 | python3.6 323 | python3.7 324 | python3.8 325 | dotnetcore1.0 326 | dotnetcore2.0 327 | dotnetcore2.1 328 | dotnetcore3.1 329 | nodejs4.3-edge 330 | go1.x 331 | ruby2.5 332 | ruby2.7 333 | provided 334 | provided.al2 335 | ``` 336 | 337 | 338 | 339 | ## List Aliases of a Function 340 | 341 | ``` 342 | aws lambda list-aliases --function-name my-function 343 | ``` 344 | 345 | 346 | 347 | ## Describe an Alias 348 | 349 | ``` 350 | aws lambda get-alias --function-name my-function --name LIVE 351 | ``` 352 | 353 | 354 | 355 | ## Create an Alias 356 | 357 | ``` 358 | aws lambda create-alias --function-name my-function --description "alias description goes here" --function-version 1 --name LIVE 359 | ``` 360 | 361 | 362 | 363 | ## Delete an Alias 364 | 365 | ``` 366 | aws lambda delete-alias --function-name my-function --name LIVE 367 | ``` 368 | 369 | 370 | 371 | ## List Function Tags 372 | 373 | ``` 374 | aws lambda list-tags --resource arn:aws:lambda:eu-west-1:xxxxxxxxxxx:function:my-function 375 | ``` 376 | 377 | 378 | 379 | ## Delete a Function 380 | 381 | ```` 382 | aws lambda delete-function --function-name my-function 383 | ```` 384 | 385 | 386 | 387 | ## Using AWS Lambda with Scheduled Events 388 | 389 | ``` 390 | sid=Sid$(date +%Y%m%d%H%M%S); aws lambda add-permission --statement-id $sid --action 'lambda:InvokeFunction' --principal events.amazonaws.com --source-arn arn:aws:events:::rule/AWSLambdaBasicExecutionRole --function-name function: --region 391 | ``` 392 | 393 | ## 394 | 395 | # IAM 396 | 397 | 398 | 399 | ## List Users 400 | 401 | ``` 402 | aws iam list-users 403 | ``` 404 | 405 | 406 | 407 | ## List Policies 408 | 409 | ``` 410 | aws iam list-policies 411 | ``` 412 | 413 | 414 | 415 | ## List Groups 416 | 417 | ``` 418 | aws iam list-groups 419 | ``` 420 | 421 | 422 | 423 | ## Get Users in a Group 424 | 425 | ``` 426 | aws iam get-group --group-name 427 | ``` 428 | 429 | 430 | 431 | ## Describing a Policy 432 | 433 | ``` 434 | aws iam get-policy --policy-arn arn:aws:iam::aws:policy/ 435 | ``` 436 | 437 | 438 | 439 | ## List Access Keys 440 | 441 | ``` 442 | aws iam list-access-keys 443 | ``` 444 | 445 | 446 | 447 | ## List Keys 448 | 449 | ``` 450 | aws iam list-access-keys 451 | ``` 452 | 453 | 454 | 455 | ## List the Access Key IDs for an IAM User 456 | 457 | ``` 458 | aws iam list-access-keys --user-name 459 | ``` 460 | 461 | 462 | 463 | ## List the SSH Public Keys for a User 464 | 465 | ``` 466 | aws iam list-ssh-public-keys --user-name 467 | ``` 468 | 469 | 470 | # S3 API 471 | 472 | 473 | 474 | ## Listing Buckets 475 | 476 | ``` 477 | aws s3api list-buckets 478 | ``` 479 | 480 | Or 481 | 482 | ``` 483 | aws s3 ls 484 | ``` 485 | 486 | 487 | e.g 488 | 489 | ``` 490 | aws s3 ls --profile eon01 491 | ``` 492 | 493 | 494 | 495 | ## Listing Only Bucket Names 496 | 497 | ``` 498 | aws s3api list-buckets --query 'Buckets[].Name' 499 | ``` 500 | 501 | 502 | 503 | ## Getting a Bucket Region 504 | 505 | ``` 506 | aws s3api get-bucket-location --bucket 507 | ``` 508 | 509 | e.g 510 | 511 | ``` 512 | aws s3api get-bucket-location --bucket practicalaws.com 513 | ``` 514 | 515 | 516 | 517 | ## Listing the Content of a Bucket 518 | 519 | ``` 520 | aws s3 ls s3:// --region 521 | ``` 522 | 523 | e.g 524 | 525 | ``` 526 | aws s3 ls s3://practicalaws.com 527 | 528 | aws s3 ls s3://practicalaws.com --region eu-west-1 529 | 530 | aws s3 ls s3://practicalaws.com --region eu-west-1 --profile eon01 531 | ``` 532 | 533 | 534 | 535 | ## Syncing a Local Folder with a Bucket 536 | 537 | ``` 538 | aws s3 sync s3:// 539 | ``` 540 | 541 | e.g 542 | 543 | ``` 544 | aws s3 sync . s3://practicalaws.com --region eu-west-1 545 | ``` 546 | 547 | 548 | 549 | ## Copying Files 550 | 551 | ``` 552 | aws s3 cp s3:// 553 | ``` 554 | 555 | Or: 556 | 557 | ``` 558 | aws s3 cp s3://// 559 | ``` 560 | 561 | To copy all files from a filder, look at "Copying Folders". Or use the following example, where I copy the content of the folder "images (contains images) in the remote folder "images". 562 | 563 | ``` 564 | cd images 565 | aws s3 cp . s3://saltstackfordevops.com/images --recursive --region us-east-2 566 | ``` 567 | 568 | 569 | 570 | ## Copying Folders 571 | 572 | ``` 573 | aws s3 cp / s3:/// --recursive 574 | ``` 575 | 576 | To exclude files: 577 | 578 | ``` 579 | aws s3 cp / s3:/// --recursive --exclude "" 580 | ``` 581 | 582 | e.g: To only include a certain type of files (PNG) and exclude others (JPG) 583 | 584 | ``` 585 | aws s3 cp practicalaws.com/ s3://practicalaws-backup/ --recursive --exclude "*.jpg" --include "*.png" 586 | ``` 587 | 588 | e.g: To exclude a folder 589 | 590 | ``` 591 | aws s3 cp practicalaws.com/ s3://practicalaws-backup/ --recursive --exclude ".git/*" 592 | ``` 593 | 594 | 595 | 596 | ## Removing a File from a Bucket 597 | 598 | ``` 599 | aws s3 rm s3:/// 600 | ``` 601 | 602 | e.g 603 | 604 | ``` 605 | aws s3 rm s3://practicalaws.com/temp.txt 606 | ``` 607 | 608 | 609 | 610 | ## Deleting a Bucket 611 | 612 | ``` 613 | aws s3 rb s3:// --force 614 | ``` 615 | 616 | If the bucket is not empty, use --force. 617 | 618 | e.g 619 | 620 | ``` 621 | aws s3 rb s3://practicalaws.com --force 622 | ``` 623 | 624 | 625 | 626 | ## Emptying a Bucket 627 | 628 | ``` 629 | aws s3 rm s3:/// --recursive 630 | ``` 631 | 632 | e.g 633 | 634 | In order to remove tempfiles/file1.txt and tempfiles/file2.txt from practicalaws.com bucket, use: 635 | 636 | ``` 637 | aws s3 rm s3://practicalaws.com/tempfiles --recursive 638 | ``` 639 | 640 | Remove all objects using: 641 | 642 | ``` 643 | aws s3 rm s3://practicalaws.com/tempfiles 644 | ``` 645 | 646 | ## Making a Public File Private 647 | 648 | ``` 649 | aws s3api put-object-acl --acl private --bucket --key 650 | ``` 651 | 652 | e.g: 653 | 654 | ``` 655 | aws s3api put-object-acl --acl private --bucket practicalaws.com --key image/logo.png 656 | ``` 657 | 658 | ## Making a Public bucket Private 659 | 660 | ``` 661 | aws s3 ls --recursive s3:// | cut -d' ' -f5- | awk '{print $NF}' | while read line; do 662 | echo "$line" 663 | aws s3api put-object-acl --acl private --bucket --key "$line" 664 | done 665 | ``` 666 | 667 | 668 | 669 | # VPC 670 | 671 | 672 | 673 | ## Creating A VPC 674 | 675 | ``` 676 | aws ec2 create-vpc --cidr-block --regiosn 677 | ``` 678 | 679 | e.g 680 | 681 | ``` 682 | aws ec2 create-vpc --cidr-block 10.0.0.0/16 --region eu-west-1 683 | ``` 684 | 685 | 686 | 687 | ## Allowing DNS hostnames 688 | 689 | ``` 690 | aws ec2 modify-vpc-attribute --vpc-id --enable-dns-hostnames "{\"Value\":true}" --region 691 | ``` 692 | 693 | # Subnets 694 | 695 | 696 | 697 | ## Creating A Subnet 698 | 699 | ``` 700 | aws ec2 create-subnet --vpc-id --cidr-block --availability-zone --region 701 | ``` 702 | 703 | 704 | 705 | ## Auto Assigning Public IPs To Instances In A Public Subnet 706 | 707 | ``` 708 | aws ec2 modify-subnet-attribute --subnet-id --map-public-ip-on-launch --region 709 | ``` 710 | 711 | # Internet Gateway 712 | 713 | 714 | 715 | ## Creating An IGW 716 | 717 | ``` 718 | aws ec2 create-internet-gateway --region 719 | ``` 720 | 721 | 722 | 723 | ## Attaching An IGW to A VPC 724 | 725 | ``` 726 | aws ec2 attach-internet-gateway --internet-gateway-id --vpc-id --region 727 | ``` 728 | 729 | # NAT 730 | 731 | 732 | 733 | ## Setting Up A NAT Gateway 734 | 735 | Allocate Elastic IP 736 | 737 | ``` 738 | aws ec2 allocate-address --domain vpc --region 739 | ``` 740 | 741 | then use the AllocationId to create the NAT Gateway for the public zone in 742 | 743 | ``` 744 | aws ec2 create-nat-gateway --subnet-id --allocation-id --region 745 | ``` 746 | 747 | # Route Tables 748 | 749 | 750 | 751 | ## Creating A Public Route Table 752 | 753 | Create the Route Table: 754 | 755 | ``` 756 | aws ec2 create-route-table --vpc-id --region 757 | ``` 758 | 759 | then create a route for an Internet Gateway. 760 | 761 | Now, use the outputted Route Table ID: 762 | 763 | ``` 764 | aws ec2 create-route --route-table-id --destination-cidr-block 0.0.0.0/0 --gateway-id --region 765 | ``` 766 | 767 | Finally, associate the public subnet with the Route Table 768 | 769 | ``` 770 | aws ec2 associate-route-table --route-table-id --subnet-id --region 771 | ``` 772 | 773 | 774 | 775 | ## Creating A Private Route Tables 776 | 777 | Create the Route Table 778 | 779 | ``` 780 | aws ec2 create-route-table --vpc-id --region 781 | ``` 782 | 783 | then create a route that points to a NAT Gateway 784 | 785 | ``` 786 | aws ec2 create-route --route-table-id --destination-cidr-block 0.0.0.0/0 --nat-gateway-id --region 787 | ``` 788 | 789 | Finally, associate the subnet 790 | 791 | ``` 792 | aws ec2 associate-route-table --route-table-id --subnet-id --region 793 | ``` 794 | 795 | # CloudFront 796 | 797 | 798 | 799 | ## Listing Distributions 800 | 801 | In some cases, you need to setup this first: 802 | 803 | ``` 804 | aws configure set preview.cloudfront true 805 | ``` 806 | 807 | Then: 808 | 809 | ``` 810 | aws cloudfront list-distributions 811 | ``` 812 | 813 | 814 | 815 | ## Invalidating Files From a Distribution 816 | 817 | To invalidate index and error HTML files from the distribution with the ID Z2W2LX9VBMAPRX: 818 | 819 | ``` 820 | aws cloudfront create-invalidation --distribution-id Z2W2LX9VBMAPRX --paths /index.html /error.html 821 | ``` 822 | 823 | To invalidate everything in the distribution: 824 | 825 | ``` 826 | aws cloudfront create-invalidation --distribution-id Z2W2LX9VBMAPRX --paths '/*' 827 | ``` 828 | 829 | 830 | 831 | ## Sync a Local Folder with a CLoudFront Distribution 832 | 833 | CloudFront is "attached" to a bucket, you need to upload your files to the bucket. 834 | 835 | e.g.: 836 | 837 | ``` 838 | aws s3 sync . s3://my-bucket.com 839 | ``` 840 | 841 | If you should keep the files public: 842 | 843 | ``` 844 | aws s3 sync . s3://my-bucket.com --acl public-read 845 | ``` 846 | 847 | To copy a single file, you need to: 848 | 849 | ``` 850 | aws s3 cp file1 s3://my-bucket.com/sub-folder/ --acl 851 | ``` 852 | 853 | 854 | 855 | ## Sync and Invalidate at the Same Time: 856 | 857 | ``` 858 | aws s3 sync . s3://my-bucket.com --acl public-read && aws cloudfront create-invalidation --distribution-id Z2W2LX9VBMAPRX --paths '/*' 859 | ``` 860 | 861 | or in case you want to update a single file: 862 | 863 | ``` 864 | aws s3 cp file1 s3://my-bucket.com/sub-folder/ --acl public-read && aws cloudfront create-invalidation --distribution-id Z2W2LX9VBMAPRX --paths '/sub-folder/file1' 865 | ``` 866 | 867 | 868 | 869 | # RDS 870 | 871 | 872 | 873 | ## List Databases 874 | 875 | ``` 876 | aws rds describe-db-instances 877 | ``` 878 | 879 | or: 880 | 881 | ``` 882 | aws rds describe-db-instances --query 'DBInstances[].DBInstanceIdentifier' 883 | ``` 884 | 885 | 886 | 887 | ## List Public Databases 888 | 889 | ``` 890 | aws rds describe-db-instances --query 'DBInstances[?PubliclyAccessible=="true"].[DBInstanceIdentifier,Endpoint.Address]' 891 | ``` 892 | 893 | 894 | 895 | ## List Non Protected Databases (DeletionProtection) 896 | 897 | ``` 898 | aws rds describe-db-instances \ 899 | --query 'DBInstances[*].[DBInstanceIdentifier]' \ 900 | --output text \ 901 | | xargs -I {} bash -c 'if [[ $(aws rds describe-db-instances --db-instance-identifier {} --query '"'"'DBInstances[*].DeletionProtection'"'"' --output text) == False ]]; then echo {} ; fi' 902 | ``` 903 | 904 | 905 | 906 | ## Describe the Automated Backups for a DB Instance 907 | 908 | ``` 909 | aws rds describe-db-instance-automated-backups --db-instance-identifier database-mysql 910 | ``` 911 | 912 | 913 | 914 | ## Create a DB Cluster 915 | 916 | ```` 917 | aws rds create-db-cluster \ 918 | --db-cluster-identifier mysql-cluster \ 919 | --engine aurora-mysql \ 920 | --engine-version 5.7.12 \ 921 | --master-username master \ 922 | --master-user-password xxxxxx \ 923 | --db-subnet-group-name default \ 924 | --vpc-security-group-ids sg-0130572b9daf3dc16 925 | ```` 926 | 927 | 928 | 929 | ## Create a DB Instance 930 | 931 | ``` 932 | aws rds create-db-instance \ 933 | --db-instance-identifier mysql-instance \ 934 | --db-instance-class db.t3.micro \ 935 | --engine mysql \ 936 | --master-username admin \ 937 | --master-user-password xxxxx \ 938 | --allocated-storage 40 939 | ``` 940 | 941 | 942 | 943 | ## Create a DB Security Group 944 | 945 | ``` 946 | aws rds create-db-security-group --db-security-group-name my-security-group --db-security-group-description "My Security Group" 947 | ``` 948 | 949 | 950 | 951 | ## Create a Read Replica 952 | 953 | ```` 954 | aws rds create-db-instance-read-replica \ 955 | --db-instance-identifier test-instance-repl \ 956 | --source-db-instance-identifier test-instance 957 | ```` 958 | 959 | 960 | 961 | ## Create a Custom DB Cluster Endpoint 962 | 963 | ``` 964 | aws rds create-db-cluster-endpoint \ 965 | --db-cluster-endpoint-identifier mycustomendpoint \ 966 | --endpoint-type reader \ 967 | --db-cluster-identifier mydbcluster \ 968 | --static-members dbinstance1 dbinstance2 969 | ``` 970 | 971 | 972 | 973 | ## Apply Tag to a DB 974 | 975 | ``` 976 | aws rds add-tags-to-resource \ 977 | --resource-name arn:aws:rds:us-east-1:123456789012:db:database-mysql \ 978 | --tags "[{\"Key\": \"Name\",\"Value\": \"MyDatabase\"},{\"Key\": \"Environment\",\"Value\": \"test\"}]" 979 | ``` 980 | 981 | 982 | 983 | ## Create a Cluster Snapshot 984 | 985 | ``` 986 | aws rds create-db-cluster-snapshot --db-cluster-identifier my-db-cluster --db-cluster-snapshot-identifier my-db-cluster-snapshot 987 | ``` 988 | 989 | 990 | 991 | ## Create a CloudWatch Alarm for a DB Instance 992 | 993 | e.g.: When **average CPU for latest 15 minutes is above 90%** 994 | 995 | ``` 996 | aws cloudwatch put-metric-alarm \ 997 | --alarm-name "my-alarm" \ 998 | --metric-name "CPUUtilization" \ 999 | --namespace "AWS/RDS" \ 1000 | --statistic "Average" \ 1001 | --period 300 \ 1002 | --evaluation-periods 3 \ 1003 | --threshold 90.0 \ 1004 | --comparison-operator "GreaterThanOrEqualToThreshold" \ 1005 | --dimensions "Name=DBInstanceIdentifier,Value=my-db-instance" \ 1006 | --alarm-actions "" 1007 | ``` 1008 | 1009 | This will monitor the DB instance during a period of 300 seconds (5 minutes) during 3 evaluation periods: 5*3 = 15 minutes. 1010 | 1011 | If in the three periods, the average is equal or more than 90%, then the alarm will trigger the SNS resource. 1012 | 1013 | You should subscribe to the SNS resource you create by email or SMS. 1014 | 1015 | # Connect Deeper 1016 | 1017 | Join FAUN developer community [FAUN](https://faun.dev/join) 1018 | -------------------------------------------------------------------------------- /banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eon01/AWS-CheatSheet/c49ea326a0502533d37b56fcd1a38c77f51fed42/banner.png --------------------------------------------------------------------------------