1.. _community.aws.rds_module: 2 3 4***************** 5community.aws.rds 6***************** 7 8**create, delete, or modify Amazon rds instances, rds snapshots, and related facts** 9 10 11Version added: 1.0.0 12 13.. contents:: 14 :local: 15 :depth: 1 16 17 18Synopsis 19-------- 20- Creates, deletes, or modifies rds resources. 21- When creating an instance it can be either a new instance or a read-only replica of an existing instance. 22- This module has a dependency on python-boto >= 2.5 and will soon be deprecated. 23- The 'promote' command requires boto >= 2.18.0. Certain features such as tags rely on boto.rds2 (boto >= 2.26.0). 24- Please use boto3 based :ref:`community.aws.rds_instance <community.aws.rds_instance_module>` instead. 25 26 27 28Requirements 29------------ 30The below requirements are needed on the host that executes this module. 31 32- boto 33- python >= 2.6 34 35 36Parameters 37---------- 38 39.. raw:: html 40 41 <table border=0 cellpadding=0 class="documentation-table"> 42 <tr> 43 <th colspan="1">Parameter</th> 44 <th>Choices/<font color="blue">Defaults</font></th> 45 <th width="100%">Comments</th> 46 </tr> 47 <tr> 48 <td colspan="1"> 49 <div class="ansibleOptionAnchor" id="parameter-"></div> 50 <b>apply_immediately</b> 51 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 52 <div style="font-size: small"> 53 <span style="color: purple">boolean</span> 54 </div> 55 </td> 56 <td> 57 <ul style="margin: 0; padding: 0"><b>Choices:</b> 58 <li><div style="color: blue"><b>no</b> ←</div></li> 59 <li>yes</li> 60 </ul> 61 </td> 62 <td> 63 <div>When <em>apply_immediately=true</em>, the modifications will be applied as soon as possible rather than waiting for the next preferred maintenance window.</div> 64 <div>Used only when <em>command=modify</em>.</div> 65 </td> 66 </tr> 67 <tr> 68 <td colspan="1"> 69 <div class="ansibleOptionAnchor" id="parameter-"></div> 70 <b>aws_access_key</b> 71 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 72 <div style="font-size: small"> 73 <span style="color: purple">string</span> 74 </div> 75 </td> 76 <td> 77 </td> 78 <td> 79 <div>AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.</div> 80 <div>If <em>profile</em> is set this parameter is ignored.</div> 81 <div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div> 82 <div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div> 83 </td> 84 </tr> 85 <tr> 86 <td colspan="1"> 87 <div class="ansibleOptionAnchor" id="parameter-"></div> 88 <b>aws_ca_bundle</b> 89 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 90 <div style="font-size: small"> 91 <span style="color: purple">path</span> 92 </div> 93 </td> 94 <td> 95 </td> 96 <td> 97 <div>The location of a CA Bundle to use when validating SSL certificates.</div> 98 <div>Only used for boto3 based modules.</div> 99 <div>Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.</div> 100 </td> 101 </tr> 102 <tr> 103 <td colspan="1"> 104 <div class="ansibleOptionAnchor" id="parameter-"></div> 105 <b>aws_config</b> 106 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 107 <div style="font-size: small"> 108 <span style="color: purple">dictionary</span> 109 </div> 110 </td> 111 <td> 112 </td> 113 <td> 114 <div>A dictionary to modify the botocore configuration.</div> 115 <div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div> 116 <div>Only the 'user_agent' key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div> 117 </td> 118 </tr> 119 <tr> 120 <td colspan="1"> 121 <div class="ansibleOptionAnchor" id="parameter-"></div> 122 <b>aws_secret_key</b> 123 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 124 <div style="font-size: small"> 125 <span style="color: purple">string</span> 126 </div> 127 </td> 128 <td> 129 </td> 130 <td> 131 <div>AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.</div> 132 <div>If <em>profile</em> is set this parameter is ignored.</div> 133 <div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div> 134 <div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div> 135 </td> 136 </tr> 137 <tr> 138 <td colspan="1"> 139 <div class="ansibleOptionAnchor" id="parameter-"></div> 140 <b>backup_retention</b> 141 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 142 <div style="font-size: small"> 143 <span style="color: purple">string</span> 144 </div> 145 </td> 146 <td> 147 </td> 148 <td> 149 <div>Number of days backups are retained.</div> 150 <div>Set to 0 to disable backups.</div> 151 <div>Default is 1 day.</div> 152 <div>Valid range: 0-35.</div> 153 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 154 </td> 155 </tr> 156 <tr> 157 <td colspan="1"> 158 <div class="ansibleOptionAnchor" id="parameter-"></div> 159 <b>backup_window</b> 160 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 161 <div style="font-size: small"> 162 <span style="color: purple">string</span> 163 </div> 164 </td> 165 <td> 166 </td> 167 <td> 168 <div>Backup window in format of <code>hh24:mi-hh24:mi</code>. (Example: <code>18:00-20:30</code>)</div> 169 <div>Times are specified in UTC.</div> 170 <div>If not specified then a random backup window is assigned.</div> 171 <div>Used only when command=create or command=modify.</div> 172 </td> 173 </tr> 174 <tr> 175 <td colspan="1"> 176 <div class="ansibleOptionAnchor" id="parameter-"></div> 177 <b>character_set_name</b> 178 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 179 <div style="font-size: small"> 180 <span style="color: purple">string</span> 181 </div> 182 </td> 183 <td> 184 </td> 185 <td> 186 <div>Associate the DB instance with a specified character set.</div> 187 <div>Used with <em>command=create</em>.</div> 188 </td> 189 </tr> 190 <tr> 191 <td colspan="1"> 192 <div class="ansibleOptionAnchor" id="parameter-"></div> 193 <b>command</b> 194 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 195 <div style="font-size: small"> 196 <span style="color: purple">string</span> 197 / <span style="color: red">required</span> 198 </div> 199 </td> 200 <td> 201 <ul style="margin: 0; padding: 0"><b>Choices:</b> 202 <li>create</li> 203 <li>replicate</li> 204 <li>delete</li> 205 <li>facts</li> 206 <li>modify</li> 207 <li>promote</li> 208 <li>snapshot</li> 209 <li>reboot</li> 210 <li>restore</li> 211 </ul> 212 </td> 213 <td> 214 <div>Specifies the action to take. The 'reboot' option is available starting at version 2.0.</div> 215 </td> 216 </tr> 217 <tr> 218 <td colspan="1"> 219 <div class="ansibleOptionAnchor" id="parameter-"></div> 220 <b>db_engine</b> 221 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 222 <div style="font-size: small"> 223 <span style="color: purple">string</span> 224 </div> 225 </td> 226 <td> 227 <ul style="margin: 0; padding: 0"><b>Choices:</b> 228 <li>mariadb</li> 229 <li>MySQL</li> 230 <li>oracle-se1</li> 231 <li>oracle-se2</li> 232 <li>oracle-se</li> 233 <li>oracle-ee</li> 234 <li>sqlserver-ee</li> 235 <li>sqlserver-se</li> 236 <li>sqlserver-ex</li> 237 <li>sqlserver-web</li> 238 <li>postgres</li> 239 <li>aurora</li> 240 </ul> 241 </td> 242 <td> 243 <div>The type of database.</div> 244 <div>Used only when <em>command=create</em>.</div> 245 <div>mariadb was added in version 2.2.</div> 246 </td> 247 </tr> 248 <tr> 249 <td colspan="1"> 250 <div class="ansibleOptionAnchor" id="parameter-"></div> 251 <b>db_name</b> 252 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 253 <div style="font-size: small"> 254 <span style="color: purple">string</span> 255 </div> 256 </td> 257 <td> 258 </td> 259 <td> 260 <div>Name of a database to create within the instance.</div> 261 <div>If not specified then no database is created.</div> 262 <div>Used only when <em>command=create</em>.</div> 263 </td> 264 </tr> 265 <tr> 266 <td colspan="1"> 267 <div class="ansibleOptionAnchor" id="parameter-"></div> 268 <b>debug_botocore_endpoint_logs</b> 269 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 270 <div style="font-size: small"> 271 <span style="color: purple">boolean</span> 272 </div> 273 </td> 274 <td> 275 <ul style="margin: 0; padding: 0"><b>Choices:</b> 276 <li><div style="color: blue"><b>no</b> ←</div></li> 277 <li>yes</li> 278 </ul> 279 </td> 280 <td> 281 <div>Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.</div> 282 </td> 283 </tr> 284 <tr> 285 <td colspan="1"> 286 <div class="ansibleOptionAnchor" id="parameter-"></div> 287 <b>ec2_url</b> 288 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 289 <div style="font-size: small"> 290 <span style="color: purple">string</span> 291 </div> 292 </td> 293 <td> 294 </td> 295 <td> 296 <div>Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.</div> 297 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_endpoint_url, endpoint_url</div> 298 </td> 299 </tr> 300 <tr> 301 <td colspan="1"> 302 <div class="ansibleOptionAnchor" id="parameter-"></div> 303 <b>engine_version</b> 304 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 305 <div style="font-size: small"> 306 <span style="color: purple">string</span> 307 </div> 308 </td> 309 <td> 310 </td> 311 <td> 312 <div>Version number of the database engine to use.</div> 313 <div>If not specified then the current Amazon RDS default engine version is used</div> 314 <div>Used only when <em>command=create</em>.</div> 315 </td> 316 </tr> 317 <tr> 318 <td colspan="1"> 319 <div class="ansibleOptionAnchor" id="parameter-"></div> 320 <b>force_failover</b> 321 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 322 <div style="font-size: small"> 323 <span style="color: purple">boolean</span> 324 </div> 325 </td> 326 <td> 327 <ul style="margin: 0; padding: 0"><b>Choices:</b> 328 <li><div style="color: blue"><b>no</b> ←</div></li> 329 <li>yes</li> 330 </ul> 331 </td> 332 <td> 333 <div>If enabled, the reboot is done using a MultiAZ failover.</div> 334 <div>Used only when <em>command=reboot</em>.</div> 335 </td> 336 </tr> 337 <tr> 338 <td colspan="1"> 339 <div class="ansibleOptionAnchor" id="parameter-"></div> 340 <b>instance_name</b> 341 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 342 <div style="font-size: small"> 343 <span style="color: purple">string</span> 344 </div> 345 </td> 346 <td> 347 </td> 348 <td> 349 <div>Database instance identifier.</div> 350 <div>Required except when using <em>command=facts</em> or <em>command=delete</em> on just a snapshot.</div> 351 </td> 352 </tr> 353 <tr> 354 <td colspan="1"> 355 <div class="ansibleOptionAnchor" id="parameter-"></div> 356 <b>instance_type</b> 357 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 358 <div style="font-size: small"> 359 <span style="color: purple">string</span> 360 </div> 361 </td> 362 <td> 363 </td> 364 <td> 365 <div>The instance type of the database.</div> 366 <div>If not specified then the replica inherits the same instance type as the source instance.</div> 367 <div>Required when <em>command=create</em>.</div> 368 <div>Optional when <em>command=replicate</em>, <em>command=modify</em> or <em>command=restore</em>.</div> 369 <div style="font-size: small; color: darkgreen"><br/>aliases: type</div> 370 </td> 371 </tr> 372 <tr> 373 <td colspan="1"> 374 <div class="ansibleOptionAnchor" id="parameter-"></div> 375 <b>iops</b> 376 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 377 <div style="font-size: small"> 378 <span style="color: purple">string</span> 379 </div> 380 </td> 381 <td> 382 </td> 383 <td> 384 <div>Specifies the number of IOPS for the instance.</div> 385 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 386 <div>Must be an integer greater than 1000.</div> 387 </td> 388 </tr> 389 <tr> 390 <td colspan="1"> 391 <div class="ansibleOptionAnchor" id="parameter-"></div> 392 <b>license_model</b> 393 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 394 <div style="font-size: small"> 395 <span style="color: purple">string</span> 396 </div> 397 </td> 398 <td> 399 <ul style="margin: 0; padding: 0"><b>Choices:</b> 400 <li>license-included</li> 401 <li>bring-your-own-license</li> 402 <li>general-public-license</li> 403 <li>postgresql-license</li> 404 </ul> 405 </td> 406 <td> 407 <div>The license model for this DB instance.</div> 408 <div>Used only when <em>command=create</em> or <em>command=restore</em>.</div> 409 </td> 410 </tr> 411 <tr> 412 <td colspan="1"> 413 <div class="ansibleOptionAnchor" id="parameter-"></div> 414 <b>maint_window</b> 415 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 416 <div style="font-size: small"> 417 <span style="color: purple">string</span> 418 </div> 419 </td> 420 <td> 421 </td> 422 <td> 423 <div>Maintenance window in format of <code>ddd:hh24:mi-ddd:hh24:mi</code>. (Example: <code>Mon:22:00-Mon:23:15</code>)</div> 424 <div>Times are specified in UTC.</div> 425 <div>If not specified then a random maintenance window is assigned.</div> 426 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 427 </td> 428 </tr> 429 <tr> 430 <td colspan="1"> 431 <div class="ansibleOptionAnchor" id="parameter-"></div> 432 <b>multi_zone</b> 433 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 434 <div style="font-size: small"> 435 <span style="color: purple">boolean</span> 436 </div> 437 </td> 438 <td> 439 <ul style="margin: 0; padding: 0"><b>Choices:</b> 440 <li>no</li> 441 <li>yes</li> 442 </ul> 443 </td> 444 <td> 445 <div>Specifies if this is a Multi-availability-zone deployment.</div> 446 <div>Can not be used in conjunction with <em>zone</em> parameter.</div> 447 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 448 </td> 449 </tr> 450 <tr> 451 <td colspan="1"> 452 <div class="ansibleOptionAnchor" id="parameter-"></div> 453 <b>new_instance_name</b> 454 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 455 <div style="font-size: small"> 456 <span style="color: purple">string</span> 457 </div> 458 </td> 459 <td> 460 </td> 461 <td> 462 <div>Name to rename an instance to.</div> 463 <div>Used only when <em>command=modify</em>.</div> 464 </td> 465 </tr> 466 <tr> 467 <td colspan="1"> 468 <div class="ansibleOptionAnchor" id="parameter-"></div> 469 <b>option_group</b> 470 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 471 <div style="font-size: small"> 472 <span style="color: purple">string</span> 473 </div> 474 </td> 475 <td> 476 </td> 477 <td> 478 <div>The name of the option group to use.</div> 479 <div>If not specified then the default option group is used.</div> 480 <div>Used only when <em>command=create</em>.</div> 481 </td> 482 </tr> 483 <tr> 484 <td colspan="1"> 485 <div class="ansibleOptionAnchor" id="parameter-"></div> 486 <b>parameter_group</b> 487 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 488 <div style="font-size: small"> 489 <span style="color: purple">string</span> 490 </div> 491 </td> 492 <td> 493 </td> 494 <td> 495 <div>Name of the DB parameter group to associate with this instance.</div> 496 <div>If omitted then the RDS default DBParameterGroup will be used.</div> 497 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 498 </td> 499 </tr> 500 <tr> 501 <td colspan="1"> 502 <div class="ansibleOptionAnchor" id="parameter-"></div> 503 <b>password</b> 504 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 505 <div style="font-size: small"> 506 <span style="color: purple">string</span> 507 </div> 508 </td> 509 <td> 510 </td> 511 <td> 512 <div>Password for the master database username.</div> 513 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 514 </td> 515 </tr> 516 <tr> 517 <td colspan="1"> 518 <div class="ansibleOptionAnchor" id="parameter-"></div> 519 <b>port</b> 520 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 521 <div style="font-size: small"> 522 <span style="color: purple">integer</span> 523 </div> 524 </td> 525 <td> 526 </td> 527 <td> 528 <div>Port number that the DB instance uses for connections.</div> 529 <div>Used only when <em>command=create</em> or <em>command=replicate</em>.</div> 530 <div>Defaults to the standard ports for each <em>db_engine</em>: <code>3306</code> for MySQL and MariaDB, <code>1521</code> for Oracle <code>1433</code> for SQL Server, <code>5432</code> for PostgreSQL.</div> 531 </td> 532 </tr> 533 <tr> 534 <td colspan="1"> 535 <div class="ansibleOptionAnchor" id="parameter-"></div> 536 <b>profile</b> 537 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 538 <div style="font-size: small"> 539 <span style="color: purple">string</span> 540 </div> 541 </td> 542 <td> 543 </td> 544 <td> 545 <div>Uses a boto profile. Only works with boto >= 2.24.0.</div> 546 <div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div> 547 <div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div> 548 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div> 549 </td> 550 </tr> 551 <tr> 552 <td colspan="1"> 553 <div class="ansibleOptionAnchor" id="parameter-"></div> 554 <b>publicly_accessible</b> 555 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 556 <div style="font-size: small"> 557 <span style="color: purple">string</span> 558 </div> 559 </td> 560 <td> 561 </td> 562 <td> 563 <div>Explicitly set whether the resource should be publicly accessible or not.</div> 564 <div>Used with <em>command=create</em>, <em>command=replicate</em>.</div> 565 <div>Requires boto >= 2.26.0</div> 566 </td> 567 </tr> 568 <tr> 569 <td colspan="1"> 570 <div class="ansibleOptionAnchor" id="parameter-"></div> 571 <b>region</b> 572 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 573 <div style="font-size: small"> 574 <span style="color: purple">string</span> 575 </div> 576 </td> 577 <td> 578 </td> 579 <td> 580 <div>The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See <a href='http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region'>http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region</a></div> 581 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_region, ec2_region</div> 582 </td> 583 </tr> 584 <tr> 585 <td colspan="1"> 586 <div class="ansibleOptionAnchor" id="parameter-"></div> 587 <b>security_groups</b> 588 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 589 <div style="font-size: small"> 590 <span style="color: purple">string</span> 591 </div> 592 </td> 593 <td> 594 </td> 595 <td> 596 <div>Comma separated list of one or more security groups.</div> 597 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 598 </td> 599 </tr> 600 <tr> 601 <td colspan="1"> 602 <div class="ansibleOptionAnchor" id="parameter-"></div> 603 <b>security_token</b> 604 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 605 <div style="font-size: small"> 606 <span style="color: purple">string</span> 607 </div> 608 </td> 609 <td> 610 </td> 611 <td> 612 <div>AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.</div> 613 <div>If <em>profile</em> is set this parameter is ignored.</div> 614 <div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div> 615 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div> 616 </td> 617 </tr> 618 <tr> 619 <td colspan="1"> 620 <div class="ansibleOptionAnchor" id="parameter-"></div> 621 <b>size</b> 622 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 623 <div style="font-size: small"> 624 <span style="color: purple">string</span> 625 </div> 626 </td> 627 <td> 628 </td> 629 <td> 630 <div>Size in gigabytes of the initial storage for the DB instance.</div> 631 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 632 </td> 633 </tr> 634 <tr> 635 <td colspan="1"> 636 <div class="ansibleOptionAnchor" id="parameter-"></div> 637 <b>snapshot</b> 638 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 639 <div style="font-size: small"> 640 <span style="color: purple">string</span> 641 </div> 642 </td> 643 <td> 644 </td> 645 <td> 646 <div>Name of snapshot to take.</div> 647 <div>When <em>command=delete</em>, if no <em>snapshot</em> name is provided then no snapshot is taken.</div> 648 <div>When <em>command=delete</em>, if no <em>instance_name</em> is provided the snapshot is deleted.</div> 649 <div>Used with <em>command=facts</em>, <em>command=delete</em> or <em>command=snapshot</em>.</div> 650 </td> 651 </tr> 652 <tr> 653 <td colspan="1"> 654 <div class="ansibleOptionAnchor" id="parameter-"></div> 655 <b>source_instance</b> 656 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 657 <div style="font-size: small"> 658 <span style="color: purple">string</span> 659 </div> 660 </td> 661 <td> 662 </td> 663 <td> 664 <div>Name of the database to replicate.</div> 665 <div>Used only when <em>command=replicate</em>.</div> 666 </td> 667 </tr> 668 <tr> 669 <td colspan="1"> 670 <div class="ansibleOptionAnchor" id="parameter-"></div> 671 <b>subnet</b> 672 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 673 <div style="font-size: small"> 674 <span style="color: purple">string</span> 675 </div> 676 </td> 677 <td> 678 </td> 679 <td> 680 <div>VPC subnet group.</div> 681 <div>If specified then a VPC instance is created.</div> 682 <div>Used only when <em>command=create</em>.</div> 683 </td> 684 </tr> 685 <tr> 686 <td colspan="1"> 687 <div class="ansibleOptionAnchor" id="parameter-"></div> 688 <b>tags</b> 689 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 690 <div style="font-size: small"> 691 <span style="color: purple">dictionary</span> 692 </div> 693 </td> 694 <td> 695 </td> 696 <td> 697 <div>tags dict to apply to a resource.</div> 698 <div>Used with <em>command=create</em>, <em>command=replicate</em>, <em>command=restore</em>.</div> 699 <div>Requires boto >= 2.26.0</div> 700 </td> 701 </tr> 702 <tr> 703 <td colspan="1"> 704 <div class="ansibleOptionAnchor" id="parameter-"></div> 705 <b>upgrade</b> 706 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 707 <div style="font-size: small"> 708 <span style="color: purple">boolean</span> 709 </div> 710 </td> 711 <td> 712 <ul style="margin: 0; padding: 0"><b>Choices:</b> 713 <li><div style="color: blue"><b>no</b> ←</div></li> 714 <li>yes</li> 715 </ul> 716 </td> 717 <td> 718 <div>Indicates that minor version upgrades should be applied automatically.</div> 719 <div>Used only when <em>command=create</em> or <em>command=modify</em> or <em>command=restore</em> or <em>command=replicate</em>.</div> 720 </td> 721 </tr> 722 <tr> 723 <td colspan="1"> 724 <div class="ansibleOptionAnchor" id="parameter-"></div> 725 <b>username</b> 726 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 727 <div style="font-size: small"> 728 <span style="color: purple">string</span> 729 </div> 730 </td> 731 <td> 732 </td> 733 <td> 734 <div>Master database username.</div> 735 <div>Used only when <em>command=create</em>.</div> 736 </td> 737 </tr> 738 <tr> 739 <td colspan="1"> 740 <div class="ansibleOptionAnchor" id="parameter-"></div> 741 <b>validate_certs</b> 742 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 743 <div style="font-size: small"> 744 <span style="color: purple">boolean</span> 745 </div> 746 </td> 747 <td> 748 <ul style="margin: 0; padding: 0"><b>Choices:</b> 749 <li>no</li> 750 <li><div style="color: blue"><b>yes</b> ←</div></li> 751 </ul> 752 </td> 753 <td> 754 <div>When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.</div> 755 </td> 756 </tr> 757 <tr> 758 <td colspan="1"> 759 <div class="ansibleOptionAnchor" id="parameter-"></div> 760 <b>vpc_security_groups</b> 761 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 762 <div style="font-size: small"> 763 <span style="color: purple">list</span> 764 / <span style="color: purple">elements=string</span> 765 </div> 766 </td> 767 <td> 768 </td> 769 <td> 770 <div>Comma separated list of one or more vpc security group ids.</div> 771 <div>Also requires <em>subnet</em> to be specified.</div> 772 <div>Used only when <em>command=create</em> or <em>command=modify</em>.</div> 773 </td> 774 </tr> 775 <tr> 776 <td colspan="1"> 777 <div class="ansibleOptionAnchor" id="parameter-"></div> 778 <b>wait</b> 779 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 780 <div style="font-size: small"> 781 <span style="color: purple">boolean</span> 782 </div> 783 </td> 784 <td> 785 <ul style="margin: 0; padding: 0"><b>Choices:</b> 786 <li><div style="color: blue"><b>no</b> ←</div></li> 787 <li>yes</li> 788 </ul> 789 </td> 790 <td> 791 <div>When <em>command=create</em>, replicate, modify or restore then wait for the database to enter the 'available' state.</div> 792 <div>When <em>command=delete</em>, wait for the database to be terminated.</div> 793 </td> 794 </tr> 795 <tr> 796 <td colspan="1"> 797 <div class="ansibleOptionAnchor" id="parameter-"></div> 798 <b>wait_timeout</b> 799 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 800 <div style="font-size: small"> 801 <span style="color: purple">integer</span> 802 </div> 803 </td> 804 <td> 805 <b>Default:</b><br/><div style="color: blue">300</div> 806 </td> 807 <td> 808 <div>How long before wait gives up, in seconds.</div> 809 <div>Used when <em>wait=true</em>.</div> 810 </td> 811 </tr> 812 <tr> 813 <td colspan="1"> 814 <div class="ansibleOptionAnchor" id="parameter-"></div> 815 <b>zone</b> 816 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 817 <div style="font-size: small"> 818 <span style="color: purple">string</span> 819 </div> 820 </td> 821 <td> 822 </td> 823 <td> 824 <div>availability zone in which to launch the instance.</div> 825 <div>Used only when <em>command=create</em>, <em>command=replicate</em> or <em>command=restore</em>.</div> 826 <div>Can not be used in conjunction with <em>multi_zone</em> parameter.</div> 827 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_zone, ec2_zone</div> 828 </td> 829 </tr> 830 </table> 831 <br/> 832 833 834Notes 835----- 836 837.. note:: 838 - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` 839 - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html 840 - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file 841 842 843 844Examples 845-------- 846 847.. code-block:: yaml 848 849 - name: Basic mysql provisioning example 850 community.aws.rds: 851 command: create 852 instance_name: new-database 853 db_engine: MySQL 854 size: 10 855 instance_type: db.m1.small 856 username: mysql_admin 857 password: 1nsecure 858 tags: 859 Environment: testing 860 Application: cms 861 862 - name: Create a read-only replica and wait for it to become available 863 community.aws.rds: 864 command: replicate 865 instance_name: new-database-replica 866 source_instance: new_database 867 wait: yes 868 wait_timeout: 600 869 870 - name: Delete an instance, but create a snapshot before doing so 871 community.aws.rds: 872 command: delete 873 instance_name: new-database 874 snapshot: new_database_snapshot 875 876 - name: Get facts about an instance 877 community.aws.rds: 878 command: facts 879 instance_name: new-database 880 register: new_database_facts 881 882 - name: Rename an instance and wait for the change to take effect 883 community.aws.rds: 884 command: modify 885 instance_name: new-database 886 new_instance_name: renamed-database 887 wait: yes 888 889 - name: Reboot an instance and wait for it to become available again 890 community.aws.rds: 891 command: reboot 892 instance_name: database 893 wait: yes 894 895 # Restore a Postgres db instance from a snapshot, wait for it to become available again, and 896 # then modify it to add your security group. Also, display the new endpoint. 897 # Note that the "publicly_accessible" option is allowed here just as it is in the AWS CLI 898 - community.aws.rds: 899 command: restore 900 snapshot: mypostgres-snapshot 901 instance_name: MyNewInstanceName 902 region: us-west-2 903 zone: us-west-2b 904 subnet: default-vpc-xx441xxx 905 publicly_accessible: yes 906 wait: yes 907 wait_timeout: 600 908 tags: 909 Name: pg1_test_name_tag 910 register: rds 911 912 - community.aws.rds: 913 command: modify 914 instance_name: MyNewInstanceName 915 region: us-west-2 916 vpc_security_groups: sg-xxx945xx 917 918 - ansible.builtin.debug: 919 msg: "The new db endpoint is {{ rds.instance.endpoint }}" 920 921 922 923Return Values 924------------- 925Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: 926 927.. raw:: html 928 929 <table border=0 cellpadding=0 class="documentation-table"> 930 <tr> 931 <th colspan="5">Key</th> 932 <th>Returned</th> 933 <th width="100%">Description</th> 934 </tr> 935 <tr> 936 <td colspan="5"> 937 <div class="ansibleOptionAnchor" id="return-"></div> 938 <b>instance</b> 939 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 940 <div style="font-size: small"> 941 <span style="color: purple">complex</span> 942 </div> 943 </td> 944 <td>always</td> 945 <td> 946 <div>the rds instance</div> 947 <br/> 948 </td> 949 </tr> 950 <tr> 951 <td class="elbow-placeholder"> </td> 952 <td colspan="4"> 953 <div class="ansibleOptionAnchor" id="return-"></div> 954 <b>allocated_storage</b> 955 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 956 <div style="font-size: small"> 957 <span style="color: purple">string</span> 958 </div> 959 </td> 960 <td>when RDS instance exists</td> 961 <td> 962 <div>the allocated storage size in gigabytes (GB)</div> 963 <br/> 964 <div style="font-size: smaller"><b>Sample:</b></div> 965 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">100</div> 966 </td> 967 </tr> 968 <tr> 969 <td class="elbow-placeholder"> </td> 970 <td colspan="4"> 971 <div class="ansibleOptionAnchor" id="return-"></div> 972 <b>auto_minor_version_upgrade</b> 973 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 974 <div style="font-size: small"> 975 <span style="color: purple">boolean</span> 976 </div> 977 </td> 978 <td>when RDS instance exists</td> 979 <td> 980 <div>indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window</div> 981 <br/> 982 <div style="font-size: smaller"><b>Sample:</b></div> 983 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">true</div> 984 </td> 985 </tr> 986 <tr> 987 <td class="elbow-placeholder"> </td> 988 <td colspan="4"> 989 <div class="ansibleOptionAnchor" id="return-"></div> 990 <b>backup_window</b> 991 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 992 <div style="font-size: small"> 993 <span style="color: purple">string</span> 994 </div> 995 </td> 996 <td>when RDS instance exists and automated backups are enabled</td> 997 <td> 998 <div>the daily time range during which automated backups are created if automated backups are enabled</div> 999 <br/> 1000 <div style="font-size: smaller"><b>Sample:</b></div> 1001 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">03:00-03:30</div> 1002 </td> 1003 </tr> 1004 <tr> 1005 <td class="elbow-placeholder"> </td> 1006 <td colspan="4"> 1007 <div class="ansibleOptionAnchor" id="return-"></div> 1008 <b>character_set_name</b> 1009 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1010 <div style="font-size: small"> 1011 <span style="color: purple">string</span> 1012 </div> 1013 </td> 1014 <td>when RDS instance exists</td> 1015 <td> 1016 <div>the name of the character set that this instance is associated with</div> 1017 <br/> 1018 <div style="font-size: smaller"><b>Sample:</b></div> 1019 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">AL32UTF8</div> 1020 </td> 1021 </tr> 1022 <tr> 1023 <td class="elbow-placeholder"> </td> 1024 <td colspan="4"> 1025 <div class="ansibleOptionAnchor" id="return-"></div> 1026 <b>db_name</b> 1027 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1028 <div style="font-size: small"> 1029 <span style="color: purple">string</span> 1030 </div> 1031 </td> 1032 <td>when RDS instance exists</td> 1033 <td> 1034 <div>the name of the database to create when the DB instance is created</div> 1035 <br/> 1036 <div style="font-size: smaller"><b>Sample:</b></div> 1037 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ASERTG</div> 1038 </td> 1039 </tr> 1040 <tr> 1041 <td class="elbow-placeholder"> </td> 1042 <td colspan="4"> 1043 <div class="ansibleOptionAnchor" id="return-"></div> 1044 <b>db_subnet_groups</b> 1045 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1046 <div style="font-size: small"> 1047 <span style="color: purple">complex</span> 1048 </div> 1049 </td> 1050 <td>when RDS instance exists</td> 1051 <td> 1052 <div>information on the subnet group associated with this RDS instance</div> 1053 <br/> 1054 </td> 1055 </tr> 1056 <tr> 1057 <td class="elbow-placeholder"> </td> 1058 <td class="elbow-placeholder"> </td> 1059 <td colspan="3"> 1060 <div class="ansibleOptionAnchor" id="return-"></div> 1061 <b>description</b> 1062 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1063 <div style="font-size: small"> 1064 <span style="color: purple">string</span> 1065 </div> 1066 </td> 1067 <td>when RDS instance exists</td> 1068 <td> 1069 <div>the subnet group associated with the DB instance</div> 1070 <br/> 1071 <div style="font-size: smaller"><b>Sample:</b></div> 1072 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Subnets for the UAT RDS SQL DB Instance</div> 1073 </td> 1074 </tr> 1075 <tr> 1076 <td class="elbow-placeholder"> </td> 1077 <td class="elbow-placeholder"> </td> 1078 <td colspan="3"> 1079 <div class="ansibleOptionAnchor" id="return-"></div> 1080 <b>name</b> 1081 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1082 <div style="font-size: small"> 1083 <span style="color: purple">string</span> 1084 </div> 1085 </td> 1086 <td>when RDS instance exists</td> 1087 <td> 1088 <div>the name of the DB subnet group</div> 1089 <br/> 1090 <div style="font-size: smaller"><b>Sample:</b></div> 1091 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">samplesubnetgrouprds-j6paiqkxqp4z</div> 1092 </td> 1093 </tr> 1094 <tr> 1095 <td class="elbow-placeholder"> </td> 1096 <td class="elbow-placeholder"> </td> 1097 <td colspan="3"> 1098 <div class="ansibleOptionAnchor" id="return-"></div> 1099 <b>status</b> 1100 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1101 <div style="font-size: small"> 1102 <span style="color: purple">string</span> 1103 </div> 1104 </td> 1105 <td>when RDS instance exists</td> 1106 <td> 1107 <div>the status of the DB subnet group</div> 1108 <br/> 1109 <div style="font-size: smaller"><b>Sample:</b></div> 1110 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">complete</div> 1111 </td> 1112 </tr> 1113 <tr> 1114 <td class="elbow-placeholder"> </td> 1115 <td class="elbow-placeholder"> </td> 1116 <td colspan="3"> 1117 <div class="ansibleOptionAnchor" id="return-"></div> 1118 <b>subnets</b> 1119 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1120 <div style="font-size: small"> 1121 <span style="color: purple">complex</span> 1122 </div> 1123 </td> 1124 <td>when RDS instance exists</td> 1125 <td> 1126 <div>the description of the DB subnet group</div> 1127 <br/> 1128 </td> 1129 </tr> 1130 <tr> 1131 <td class="elbow-placeholder"> </td> 1132 <td class="elbow-placeholder"> </td> 1133 <td class="elbow-placeholder"> </td> 1134 <td colspan="2"> 1135 <div class="ansibleOptionAnchor" id="return-"></div> 1136 <b>availability_zone</b> 1137 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1138 <div style="font-size: small"> 1139 <span style="color: purple">complex</span> 1140 </div> 1141 </td> 1142 <td>when RDS instance exists</td> 1143 <td> 1144 <div>subnet availability zone information</div> 1145 <br/> 1146 </td> 1147 </tr> 1148 <tr> 1149 <td class="elbow-placeholder"> </td> 1150 <td class="elbow-placeholder"> </td> 1151 <td class="elbow-placeholder"> </td> 1152 <td class="elbow-placeholder"> </td> 1153 <td colspan="1"> 1154 <div class="ansibleOptionAnchor" id="return-"></div> 1155 <b>name</b> 1156 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1157 <div style="font-size: small"> 1158 <span style="color: purple">string</span> 1159 </div> 1160 </td> 1161 <td>when RDS instance exists</td> 1162 <td> 1163 <div>availability zone</div> 1164 <br/> 1165 <div style="font-size: smaller"><b>Sample:</b></div> 1166 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">eu-west-1b</div> 1167 </td> 1168 </tr> 1169 <tr> 1170 <td class="elbow-placeholder"> </td> 1171 <td class="elbow-placeholder"> </td> 1172 <td class="elbow-placeholder"> </td> 1173 <td class="elbow-placeholder"> </td> 1174 <td colspan="1"> 1175 <div class="ansibleOptionAnchor" id="return-"></div> 1176 <b>provisioned_iops_capable</b> 1177 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1178 <div style="font-size: small"> 1179 <span style="color: purple">boolean</span> 1180 </div> 1181 </td> 1182 <td>when RDS instance exists</td> 1183 <td> 1184 <div>whether provisioned iops are available in AZ subnet</div> 1185 <br/> 1186 <div style="font-size: smaller"><b>Sample:</b></div> 1187 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">false</div> 1188 </td> 1189 </tr> 1190 1191 <tr> 1192 <td class="elbow-placeholder"> </td> 1193 <td class="elbow-placeholder"> </td> 1194 <td class="elbow-placeholder"> </td> 1195 <td colspan="2"> 1196 <div class="ansibleOptionAnchor" id="return-"></div> 1197 <b>identifier</b> 1198 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1199 <div style="font-size: small"> 1200 <span style="color: purple">string</span> 1201 </div> 1202 </td> 1203 <td>when RDS instance exists</td> 1204 <td> 1205 <div>the identifier of the subnet</div> 1206 <br/> 1207 <div style="font-size: smaller"><b>Sample:</b></div> 1208 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">subnet-3fdba63e</div> 1209 </td> 1210 </tr> 1211 <tr> 1212 <td class="elbow-placeholder"> </td> 1213 <td class="elbow-placeholder"> </td> 1214 <td class="elbow-placeholder"> </td> 1215 <td colspan="2"> 1216 <div class="ansibleOptionAnchor" id="return-"></div> 1217 <b>status</b> 1218 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1219 <div style="font-size: small"> 1220 <span style="color: purple">string</span> 1221 </div> 1222 </td> 1223 <td>when RDS instance exists</td> 1224 <td> 1225 <div>the status of the subnet</div> 1226 <br/> 1227 <div style="font-size: smaller"><b>Sample:</b></div> 1228 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">active</div> 1229 </td> 1230 </tr> 1231 1232 1233 <tr> 1234 <td class="elbow-placeholder"> </td> 1235 <td colspan="4"> 1236 <div class="ansibleOptionAnchor" id="return-"></div> 1237 <b>endpoint</b> 1238 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1239 <div style="font-size: small"> 1240 <span style="color: purple">string</span> 1241 </div> 1242 </td> 1243 <td>when RDS instance exists</td> 1244 <td> 1245 <div>the endpoint uri of the database instance</div> 1246 <br/> 1247 <div style="font-size: smaller"><b>Sample:</b></div> 1248 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">my-ansible-database.asdfaosdgih.us-east-1.rds.amazonaws.com</div> 1249 </td> 1250 </tr> 1251 <tr> 1252 <td class="elbow-placeholder"> </td> 1253 <td colspan="4"> 1254 <div class="ansibleOptionAnchor" id="return-"></div> 1255 <b>engine</b> 1256 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1257 <div style="font-size: small"> 1258 <span style="color: purple">string</span> 1259 </div> 1260 </td> 1261 <td>when RDS instance exists</td> 1262 <td> 1263 <div>the name of the database engine</div> 1264 <br/> 1265 <div style="font-size: smaller"><b>Sample:</b></div> 1266 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">oracle-se</div> 1267 </td> 1268 </tr> 1269 <tr> 1270 <td class="elbow-placeholder"> </td> 1271 <td colspan="4"> 1272 <div class="ansibleOptionAnchor" id="return-"></div> 1273 <b>engine_version</b> 1274 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1275 <div style="font-size: small"> 1276 <span style="color: purple">string</span> 1277 </div> 1278 </td> 1279 <td>when RDS instance exists</td> 1280 <td> 1281 <div>the version of the database engine</div> 1282 <br/> 1283 <div style="font-size: smaller"><b>Sample:</b></div> 1284 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">11.2.0.4.v6</div> 1285 </td> 1286 </tr> 1287 <tr> 1288 <td class="elbow-placeholder"> </td> 1289 <td colspan="4"> 1290 <div class="ansibleOptionAnchor" id="return-"></div> 1291 <b>latest_restorable_time</b> 1292 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1293 <div style="font-size: small"> 1294 <span style="color: purple">string</span> 1295 </div> 1296 </td> 1297 <td>when RDS instance exists</td> 1298 <td> 1299 <div>the latest time to which a database can be restored with point-in-time restore</div> 1300 <br/> 1301 <div style="font-size: smaller"><b>Sample:</b></div> 1302 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">1489707802.0</div> 1303 </td> 1304 </tr> 1305 <tr> 1306 <td class="elbow-placeholder"> </td> 1307 <td colspan="4"> 1308 <div class="ansibleOptionAnchor" id="return-"></div> 1309 <b>license_model</b> 1310 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1311 <div style="font-size: small"> 1312 <span style="color: purple">string</span> 1313 </div> 1314 </td> 1315 <td>when RDS instance exists</td> 1316 <td> 1317 <div>the license model information</div> 1318 <br/> 1319 <div style="font-size: smaller"><b>Sample:</b></div> 1320 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">bring-your-own-license</div> 1321 </td> 1322 </tr> 1323 <tr> 1324 <td class="elbow-placeholder"> </td> 1325 <td colspan="4"> 1326 <div class="ansibleOptionAnchor" id="return-"></div> 1327 <b>option_groups</b> 1328 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1329 <div style="font-size: small"> 1330 <span style="color: purple">complex</span> 1331 </div> 1332 </td> 1333 <td>when RDS instance exists</td> 1334 <td> 1335 <div>the list of option group memberships for this RDS instance</div> 1336 <br/> 1337 </td> 1338 </tr> 1339 <tr> 1340 <td class="elbow-placeholder"> </td> 1341 <td class="elbow-placeholder"> </td> 1342 <td colspan="3"> 1343 <div class="ansibleOptionAnchor" id="return-"></div> 1344 <b>option_group_name</b> 1345 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1346 <div style="font-size: small"> 1347 <span style="color: purple">string</span> 1348 </div> 1349 </td> 1350 <td>when RDS instance exists</td> 1351 <td> 1352 <div>the option group name for this RDS instance</div> 1353 <br/> 1354 <div style="font-size: smaller"><b>Sample:</b></div> 1355 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">default:oracle-se-11-2</div> 1356 </td> 1357 </tr> 1358 <tr> 1359 <td class="elbow-placeholder"> </td> 1360 <td class="elbow-placeholder"> </td> 1361 <td colspan="3"> 1362 <div class="ansibleOptionAnchor" id="return-"></div> 1363 <b>status</b> 1364 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1365 <div style="font-size: small"> 1366 <span style="color: purple">string</span> 1367 </div> 1368 </td> 1369 <td>when RDS instance exists</td> 1370 <td> 1371 <div>the status of the RDS instance's option group membership</div> 1372 <br/> 1373 <div style="font-size: smaller"><b>Sample:</b></div> 1374 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">in-sync</div> 1375 </td> 1376 </tr> 1377 1378 <tr> 1379 <td class="elbow-placeholder"> </td> 1380 <td colspan="4"> 1381 <div class="ansibleOptionAnchor" id="return-"></div> 1382 <b>parameter_groups</b> 1383 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1384 <div style="font-size: small"> 1385 <span style="color: purple">complex</span> 1386 </div> 1387 </td> 1388 <td>when RDS instance exists and parameter groups are defined</td> 1389 <td> 1390 <div>the list of DB parameter groups applied to this RDS instance</div> 1391 <br/> 1392 </td> 1393 </tr> 1394 <tr> 1395 <td class="elbow-placeholder"> </td> 1396 <td class="elbow-placeholder"> </td> 1397 <td colspan="3"> 1398 <div class="ansibleOptionAnchor" id="return-"></div> 1399 <b>parameter_apply_status</b> 1400 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1401 <div style="font-size: small"> 1402 <span style="color: purple">string</span> 1403 </div> 1404 </td> 1405 <td>when RDS instance exists</td> 1406 <td> 1407 <div>the status of parameter updates</div> 1408 <br/> 1409 <div style="font-size: smaller"><b>Sample:</b></div> 1410 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">in-sync</div> 1411 </td> 1412 </tr> 1413 <tr> 1414 <td class="elbow-placeholder"> </td> 1415 <td class="elbow-placeholder"> </td> 1416 <td colspan="3"> 1417 <div class="ansibleOptionAnchor" id="return-"></div> 1418 <b>parameter_group_name</b> 1419 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1420 <div style="font-size: small"> 1421 <span style="color: purple">string</span> 1422 </div> 1423 </td> 1424 <td>when RDS instance exists</td> 1425 <td> 1426 <div>the name of the DP parameter group</div> 1427 <br/> 1428 <div style="font-size: smaller"><b>Sample:</b></div> 1429 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">testawsrpprodb01spfile-1ujg7nrs7sgyz</div> 1430 </td> 1431 </tr> 1432 1433 <tr> 1434 <td class="elbow-placeholder"> </td> 1435 <td colspan="4"> 1436 <div class="ansibleOptionAnchor" id="return-"></div> 1437 <b>pending_modified_values</b> 1438 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1439 <div style="font-size: small"> 1440 <span style="color: purple">complex</span> 1441 </div> 1442 </td> 1443 <td>when RDS instance exists</td> 1444 <td> 1445 <div>a dictionary of changes to the RDS instance that are pending</div> 1446 <br/> 1447 </td> 1448 </tr> 1449 <tr> 1450 <td class="elbow-placeholder"> </td> 1451 <td class="elbow-placeholder"> </td> 1452 <td colspan="3"> 1453 <div class="ansibleOptionAnchor" id="return-"></div> 1454 <b>allocated_storage</b> 1455 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1456 <div style="font-size: small"> 1457 <span style="color: purple">string</span> 1458 </div> 1459 </td> 1460 <td>when RDS instance exists</td> 1461 <td> 1462 <div>the new allocated storage size for this RDS instance that will be applied or is in progress</div> 1463 <br/> 1464 <div style="font-size: smaller"><b>Sample:</b></div> 1465 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1466 </td> 1467 </tr> 1468 <tr> 1469 <td class="elbow-placeholder"> </td> 1470 <td class="elbow-placeholder"> </td> 1471 <td colspan="3"> 1472 <div class="ansibleOptionAnchor" id="return-"></div> 1473 <b>backup_retention_period</b> 1474 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1475 <div style="font-size: small"> 1476 <span style="color: purple">string</span> 1477 </div> 1478 </td> 1479 <td>when RDS instance exists</td> 1480 <td> 1481 <div>the pending number of days for which automated backups are retained</div> 1482 <br/> 1483 <div style="font-size: smaller"><b>Sample:</b></div> 1484 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1485 </td> 1486 </tr> 1487 <tr> 1488 <td class="elbow-placeholder"> </td> 1489 <td class="elbow-placeholder"> </td> 1490 <td colspan="3"> 1491 <div class="ansibleOptionAnchor" id="return-"></div> 1492 <b>db_instance_class</b> 1493 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1494 <div style="font-size: small"> 1495 <span style="color: purple">string</span> 1496 </div> 1497 </td> 1498 <td>when RDS instance exists</td> 1499 <td> 1500 <div>the new DB instance class for this RDS instance that will be applied or is in progress</div> 1501 <br/> 1502 <div style="font-size: smaller"><b>Sample:</b></div> 1503 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1504 </td> 1505 </tr> 1506 <tr> 1507 <td class="elbow-placeholder"> </td> 1508 <td class="elbow-placeholder"> </td> 1509 <td colspan="3"> 1510 <div class="ansibleOptionAnchor" id="return-"></div> 1511 <b>db_instance_identifier</b> 1512 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1513 <div style="font-size: small"> 1514 <span style="color: purple">string</span> 1515 </div> 1516 </td> 1517 <td>when RDS instance exists</td> 1518 <td> 1519 <div>the new DB instance identifier this RDS instance that will be applied or is in progress</div> 1520 <br/> 1521 <div style="font-size: smaller"><b>Sample:</b></div> 1522 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1523 </td> 1524 </tr> 1525 <tr> 1526 <td class="elbow-placeholder"> </td> 1527 <td class="elbow-placeholder"> </td> 1528 <td colspan="3"> 1529 <div class="ansibleOptionAnchor" id="return-"></div> 1530 <b>engine_version</b> 1531 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1532 <div style="font-size: small"> 1533 <span style="color: purple">string</span> 1534 </div> 1535 </td> 1536 <td>when RDS instance exists</td> 1537 <td> 1538 <div>indicates the database engine version</div> 1539 <br/> 1540 <div style="font-size: smaller"><b>Sample:</b></div> 1541 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1542 </td> 1543 </tr> 1544 <tr> 1545 <td class="elbow-placeholder"> </td> 1546 <td class="elbow-placeholder"> </td> 1547 <td colspan="3"> 1548 <div class="ansibleOptionAnchor" id="return-"></div> 1549 <b>iops</b> 1550 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1551 <div style="font-size: small"> 1552 <span style="color: purple">string</span> 1553 </div> 1554 </td> 1555 <td>when RDS instance exists</td> 1556 <td> 1557 <div>the new provisioned IOPS value for this RDS instance that will be applied or is being applied</div> 1558 <br/> 1559 <div style="font-size: smaller"><b>Sample:</b></div> 1560 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1561 </td> 1562 </tr> 1563 <tr> 1564 <td class="elbow-placeholder"> </td> 1565 <td class="elbow-placeholder"> </td> 1566 <td colspan="3"> 1567 <div class="ansibleOptionAnchor" id="return-"></div> 1568 <b>master_user_password</b> 1569 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1570 <div style="font-size: small"> 1571 <span style="color: purple">string</span> 1572 </div> 1573 </td> 1574 <td>when RDS instance exists</td> 1575 <td> 1576 <div>the pending or in-progress change of the master credentials for this RDS instance</div> 1577 <br/> 1578 <div style="font-size: smaller"><b>Sample:</b></div> 1579 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1580 </td> 1581 </tr> 1582 <tr> 1583 <td class="elbow-placeholder"> </td> 1584 <td class="elbow-placeholder"> </td> 1585 <td colspan="3"> 1586 <div class="ansibleOptionAnchor" id="return-"></div> 1587 <b>multi_az</b> 1588 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1589 <div style="font-size: small"> 1590 <span style="color: purple">string</span> 1591 </div> 1592 </td> 1593 <td>when RDS instance exists</td> 1594 <td> 1595 <div>indicates that the single-AZ RDS instance is to change to a multi-AZ deployment</div> 1596 <br/> 1597 <div style="font-size: smaller"><b>Sample:</b></div> 1598 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1599 </td> 1600 </tr> 1601 <tr> 1602 <td class="elbow-placeholder"> </td> 1603 <td class="elbow-placeholder"> </td> 1604 <td colspan="3"> 1605 <div class="ansibleOptionAnchor" id="return-"></div> 1606 <b>port</b> 1607 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1608 <div style="font-size: small"> 1609 <span style="color: purple">string</span> 1610 </div> 1611 </td> 1612 <td>when RDS instance exists</td> 1613 <td> 1614 <div>specifies the pending port for this RDS instance</div> 1615 <br/> 1616 <div style="font-size: smaller"><b>Sample:</b></div> 1617 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1618 </td> 1619 </tr> 1620 1621 <tr> 1622 <td class="elbow-placeholder"> </td> 1623 <td colspan="4"> 1624 <div class="ansibleOptionAnchor" id="return-"></div> 1625 <b>port</b> 1626 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1627 <div style="font-size: small"> 1628 <span style="color: purple">integer</span> 1629 </div> 1630 </td> 1631 <td>when RDS instance exists</td> 1632 <td> 1633 <div>the listening port of the database instance</div> 1634 <br/> 1635 <div style="font-size: smaller"><b>Sample:</b></div> 1636 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">3306</div> 1637 </td> 1638 </tr> 1639 <tr> 1640 <td class="elbow-placeholder"> </td> 1641 <td colspan="4"> 1642 <div class="ansibleOptionAnchor" id="return-"></div> 1643 <b>publicly_accessible</b> 1644 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1645 <div style="font-size: small"> 1646 <span style="color: purple">boolean</span> 1647 </div> 1648 </td> 1649 <td>when RDS instance exists</td> 1650 <td> 1651 <div>the accessibility options for the DB instance</div> 1652 <br/> 1653 <div style="font-size: smaller"><b>Sample:</b></div> 1654 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">true</div> 1655 </td> 1656 </tr> 1657 <tr> 1658 <td class="elbow-placeholder"> </td> 1659 <td colspan="4"> 1660 <div class="ansibleOptionAnchor" id="return-"></div> 1661 <b>read_replica_source_dbinstance_identifier</b> 1662 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1663 <div style="font-size: small"> 1664 <span style="color: purple">string</span> 1665 </div> 1666 </td> 1667 <td>when read replica RDS instance exists</td> 1668 <td> 1669 <div>the identifier of the source DB instance if this RDS instance is a read replica</div> 1670 <br/> 1671 <div style="font-size: smaller"><b>Sample:</b></div> 1672 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">null</div> 1673 </td> 1674 </tr> 1675 <tr> 1676 <td class="elbow-placeholder"> </td> 1677 <td colspan="4"> 1678 <div class="ansibleOptionAnchor" id="return-"></div> 1679 <b>secondary_availability_zone</b> 1680 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1681 <div style="font-size: small"> 1682 <span style="color: purple">string</span> 1683 </div> 1684 </td> 1685 <td>when RDS instance exists and is multi-AZ</td> 1686 <td> 1687 <div>the name of the secondary AZ for a DB instance with multi-AZ support</div> 1688 <br/> 1689 <div style="font-size: smaller"><b>Sample:</b></div> 1690 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">eu-west-1b</div> 1691 </td> 1692 </tr> 1693 1694 </table> 1695 <br/><br/> 1696 1697 1698Status 1699------ 1700 1701 1702Authors 1703~~~~~~~ 1704 1705- Bruce Pennypacker (@bpennypacker) 1706- Will Thames (@willthames) 1707