1.. _community.aws.rds_snapshot_module: 2 3 4************************** 5community.aws.rds_snapshot 6************************** 7 8**manage Amazon RDS snapshots.** 9 10 11Version added: 1.0.0 12 13.. contents:: 14 :local: 15 :depth: 1 16 17 18Synopsis 19-------- 20- Creates or deletes RDS snapshots. 21 22 23 24Requirements 25------------ 26The below requirements are needed on the host that executes this module. 27 28- boto 29- boto3 30- python >= 2.6 31 32 33Parameters 34---------- 35 36.. raw:: html 37 38 <table border=0 cellpadding=0 class="documentation-table"> 39 <tr> 40 <th colspan="1">Parameter</th> 41 <th>Choices/<font color="blue">Defaults</font></th> 42 <th width="100%">Comments</th> 43 </tr> 44 <tr> 45 <td colspan="1"> 46 <div class="ansibleOptionAnchor" id="parameter-"></div> 47 <b>aws_access_key</b> 48 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 49 <div style="font-size: small"> 50 <span style="color: purple">string</span> 51 </div> 52 </td> 53 <td> 54 </td> 55 <td> 56 <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> 57 <div>If <em>profile</em> is set this parameter is ignored.</div> 58 <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> 59 <div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div> 60 </td> 61 </tr> 62 <tr> 63 <td colspan="1"> 64 <div class="ansibleOptionAnchor" id="parameter-"></div> 65 <b>aws_ca_bundle</b> 66 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 67 <div style="font-size: small"> 68 <span style="color: purple">path</span> 69 </div> 70 </td> 71 <td> 72 </td> 73 <td> 74 <div>The location of a CA Bundle to use when validating SSL certificates.</div> 75 <div>Only used for boto3 based modules.</div> 76 <div>Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.</div> 77 </td> 78 </tr> 79 <tr> 80 <td colspan="1"> 81 <div class="ansibleOptionAnchor" id="parameter-"></div> 82 <b>aws_config</b> 83 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 84 <div style="font-size: small"> 85 <span style="color: purple">dictionary</span> 86 </div> 87 </td> 88 <td> 89 </td> 90 <td> 91 <div>A dictionary to modify the botocore configuration.</div> 92 <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> 93 <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> 94 </td> 95 </tr> 96 <tr> 97 <td colspan="1"> 98 <div class="ansibleOptionAnchor" id="parameter-"></div> 99 <b>aws_secret_key</b> 100 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 101 <div style="font-size: small"> 102 <span style="color: purple">string</span> 103 </div> 104 </td> 105 <td> 106 </td> 107 <td> 108 <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> 109 <div>If <em>profile</em> is set this parameter is ignored.</div> 110 <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> 111 <div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div> 112 </td> 113 </tr> 114 <tr> 115 <td colspan="1"> 116 <div class="ansibleOptionAnchor" id="parameter-"></div> 117 <b>db_instance_identifier</b> 118 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 119 <div style="font-size: small"> 120 <span style="color: purple">string</span> 121 </div> 122 </td> 123 <td> 124 </td> 125 <td> 126 <div>Database instance identifier. Required when state is present.</div> 127 <div style="font-size: small; color: darkgreen"><br/>aliases: instance_id</div> 128 </td> 129 </tr> 130 <tr> 131 <td colspan="1"> 132 <div class="ansibleOptionAnchor" id="parameter-"></div> 133 <b>db_snapshot_identifier</b> 134 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 135 <div style="font-size: small"> 136 <span style="color: purple">string</span> 137 / <span style="color: red">required</span> 138 </div> 139 </td> 140 <td> 141 </td> 142 <td> 143 <div>The snapshot to manage.</div> 144 <div style="font-size: small; color: darkgreen"><br/>aliases: id, snapshot_id</div> 145 </td> 146 </tr> 147 <tr> 148 <td colspan="1"> 149 <div class="ansibleOptionAnchor" id="parameter-"></div> 150 <b>debug_botocore_endpoint_logs</b> 151 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 152 <div style="font-size: small"> 153 <span style="color: purple">boolean</span> 154 </div> 155 </td> 156 <td> 157 <ul style="margin: 0; padding: 0"><b>Choices:</b> 158 <li><div style="color: blue"><b>no</b> ←</div></li> 159 <li>yes</li> 160 </ul> 161 </td> 162 <td> 163 <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> 164 </td> 165 </tr> 166 <tr> 167 <td colspan="1"> 168 <div class="ansibleOptionAnchor" id="parameter-"></div> 169 <b>ec2_url</b> 170 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 171 <div style="font-size: small"> 172 <span style="color: purple">string</span> 173 </div> 174 </td> 175 <td> 176 </td> 177 <td> 178 <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> 179 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_endpoint_url, endpoint_url</div> 180 </td> 181 </tr> 182 <tr> 183 <td colspan="1"> 184 <div class="ansibleOptionAnchor" id="parameter-"></div> 185 <b>profile</b> 186 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 187 <div style="font-size: small"> 188 <span style="color: purple">string</span> 189 </div> 190 </td> 191 <td> 192 </td> 193 <td> 194 <div>Uses a boto profile. Only works with boto >= 2.24.0.</div> 195 <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> 196 <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> 197 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div> 198 </td> 199 </tr> 200 <tr> 201 <td colspan="1"> 202 <div class="ansibleOptionAnchor" id="parameter-"></div> 203 <b>purge_tags</b> 204 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 205 <div style="font-size: small"> 206 <span style="color: purple">boolean</span> 207 </div> 208 </td> 209 <td> 210 <ul style="margin: 0; padding: 0"><b>Choices:</b> 211 <li>no</li> 212 <li><div style="color: blue"><b>yes</b> ←</div></li> 213 </ul> 214 </td> 215 <td> 216 <div>whether to remove tags not present in the <code>tags</code> parameter.</div> 217 </td> 218 </tr> 219 <tr> 220 <td colspan="1"> 221 <div class="ansibleOptionAnchor" id="parameter-"></div> 222 <b>region</b> 223 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 224 <div style="font-size: small"> 225 <span style="color: purple">string</span> 226 </div> 227 </td> 228 <td> 229 </td> 230 <td> 231 <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> 232 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_region, ec2_region</div> 233 </td> 234 </tr> 235 <tr> 236 <td colspan="1"> 237 <div class="ansibleOptionAnchor" id="parameter-"></div> 238 <b>security_token</b> 239 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 240 <div style="font-size: small"> 241 <span style="color: purple">string</span> 242 </div> 243 </td> 244 <td> 245 </td> 246 <td> 247 <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> 248 <div>If <em>profile</em> is set this parameter is ignored.</div> 249 <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> 250 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div> 251 </td> 252 </tr> 253 <tr> 254 <td colspan="1"> 255 <div class="ansibleOptionAnchor" id="parameter-"></div> 256 <b>state</b> 257 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 258 <div style="font-size: small"> 259 <span style="color: purple">string</span> 260 </div> 261 </td> 262 <td> 263 <ul style="margin: 0; padding: 0"><b>Choices:</b> 264 <li><div style="color: blue"><b>present</b> ←</div></li> 265 <li>absent</li> 266 </ul> 267 </td> 268 <td> 269 <div>Specify the desired state of the snapshot.</div> 270 </td> 271 </tr> 272 <tr> 273 <td colspan="1"> 274 <div class="ansibleOptionAnchor" id="parameter-"></div> 275 <b>tags</b> 276 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 277 <div style="font-size: small"> 278 <span style="color: purple">dictionary</span> 279 </div> 280 </td> 281 <td> 282 </td> 283 <td> 284 <div>tags dict to apply to a snapshot.</div> 285 </td> 286 </tr> 287 <tr> 288 <td colspan="1"> 289 <div class="ansibleOptionAnchor" id="parameter-"></div> 290 <b>validate_certs</b> 291 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 292 <div style="font-size: small"> 293 <span style="color: purple">boolean</span> 294 </div> 295 </td> 296 <td> 297 <ul style="margin: 0; padding: 0"><b>Choices:</b> 298 <li>no</li> 299 <li><div style="color: blue"><b>yes</b> ←</div></li> 300 </ul> 301 </td> 302 <td> 303 <div>When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.</div> 304 </td> 305 </tr> 306 <tr> 307 <td colspan="1"> 308 <div class="ansibleOptionAnchor" id="parameter-"></div> 309 <b>wait</b> 310 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 311 <div style="font-size: small"> 312 <span style="color: purple">boolean</span> 313 </div> 314 </td> 315 <td> 316 <ul style="margin: 0; padding: 0"><b>Choices:</b> 317 <li><div style="color: blue"><b>no</b> ←</div></li> 318 <li>yes</li> 319 </ul> 320 </td> 321 <td> 322 <div>Whether or not to wait for snapshot creation or deletion.</div> 323 </td> 324 </tr> 325 <tr> 326 <td colspan="1"> 327 <div class="ansibleOptionAnchor" id="parameter-"></div> 328 <b>wait_timeout</b> 329 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 330 <div style="font-size: small"> 331 <span style="color: purple">integer</span> 332 </div> 333 </td> 334 <td> 335 <b>Default:</b><br/><div style="color: blue">300</div> 336 </td> 337 <td> 338 <div>how long before wait gives up, in seconds.</div> 339 </td> 340 </tr> 341 </table> 342 <br/> 343 344 345Notes 346----- 347 348.. note:: 349 - 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`` 350 - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html 351 - ``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 352 353 354 355Examples 356-------- 357 358.. code-block:: yaml 359 360 - name: Create snapshot 361 community.aws.rds_snapshot: 362 db_instance_identifier: new-database 363 db_snapshot_identifier: new-database-snapshot 364 365 - name: Delete snapshot 366 community.aws.rds_snapshot: 367 db_snapshot_identifier: new-database-snapshot 368 state: absent 369 370 371 372Return Values 373------------- 374Common 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: 375 376.. raw:: html 377 378 <table border=0 cellpadding=0 class="documentation-table"> 379 <tr> 380 <th colspan="1">Key</th> 381 <th>Returned</th> 382 <th width="100%">Description</th> 383 </tr> 384 <tr> 385 <td colspan="1"> 386 <div class="ansibleOptionAnchor" id="return-"></div> 387 <b>allocated_storage</b> 388 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 389 <div style="font-size: small"> 390 <span style="color: purple">integer</span> 391 </div> 392 </td> 393 <td>always</td> 394 <td> 395 <div>How much storage is allocated in GB.</div> 396 <br/> 397 <div style="font-size: smaller"><b>Sample:</b></div> 398 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">20</div> 399 </td> 400 </tr> 401 <tr> 402 <td colspan="1"> 403 <div class="ansibleOptionAnchor" id="return-"></div> 404 <b>availability_zone</b> 405 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 406 <div style="font-size: small"> 407 <span style="color: purple">string</span> 408 </div> 409 </td> 410 <td>always</td> 411 <td> 412 <div>Availability zone of the database from which the snapshot was created.</div> 413 <br/> 414 <div style="font-size: smaller"><b>Sample:</b></div> 415 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">us-west-2a</div> 416 </td> 417 </tr> 418 <tr> 419 <td colspan="1"> 420 <div class="ansibleOptionAnchor" id="return-"></div> 421 <b>db_instance_identifier</b> 422 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 423 <div style="font-size: small"> 424 <span style="color: purple">string</span> 425 </div> 426 </td> 427 <td>always</td> 428 <td> 429 <div>Database from which the snapshot was created.</div> 430 <br/> 431 <div style="font-size: smaller"><b>Sample:</b></div> 432 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ansible-test-16638696</div> 433 </td> 434 </tr> 435 <tr> 436 <td colspan="1"> 437 <div class="ansibleOptionAnchor" id="return-"></div> 438 <b>db_snapshot_arn</b> 439 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 440 <div style="font-size: small"> 441 <span style="color: purple">string</span> 442 </div> 443 </td> 444 <td>always</td> 445 <td> 446 <div>Amazon Resource Name for the snapshot.</div> 447 <br/> 448 <div style="font-size: smaller"><b>Sample:</b></div> 449 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot</div> 450 </td> 451 </tr> 452 <tr> 453 <td colspan="1"> 454 <div class="ansibleOptionAnchor" id="return-"></div> 455 <b>db_snapshot_identifier</b> 456 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 457 <div style="font-size: small"> 458 <span style="color: purple">string</span> 459 </div> 460 </td> 461 <td>always</td> 462 <td> 463 <div>Name of the snapshot.</div> 464 <br/> 465 <div style="font-size: smaller"><b>Sample:</b></div> 466 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ansible-test-16638696-test-snapshot</div> 467 </td> 468 </tr> 469 <tr> 470 <td colspan="1"> 471 <div class="ansibleOptionAnchor" id="return-"></div> 472 <b>dbi_resource_id</b> 473 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 474 <div style="font-size: small"> 475 <span style="color: purple">string</span> 476 </div> 477 </td> 478 <td>always</td> 479 <td> 480 <div>The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.</div> 481 <br/> 482 <div style="font-size: smaller"><b>Sample:</b></div> 483 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">db-MM4P2U35RQRAMWD3QDOXWPZP4U</div> 484 </td> 485 </tr> 486 <tr> 487 <td colspan="1"> 488 <div class="ansibleOptionAnchor" id="return-"></div> 489 <b>encrypted</b> 490 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 491 <div style="font-size: small"> 492 <span style="color: purple">boolean</span> 493 </div> 494 </td> 495 <td>always</td> 496 <td> 497 <div>Whether the snapshot is encrypted.</div> 498 <br/> 499 </td> 500 </tr> 501 <tr> 502 <td colspan="1"> 503 <div class="ansibleOptionAnchor" id="return-"></div> 504 <b>engine</b> 505 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 506 <div style="font-size: small"> 507 <span style="color: purple">string</span> 508 </div> 509 </td> 510 <td>always</td> 511 <td> 512 <div>Engine of the database from which the snapshot was created.</div> 513 <br/> 514 <div style="font-size: smaller"><b>Sample:</b></div> 515 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">mariadb</div> 516 </td> 517 </tr> 518 <tr> 519 <td colspan="1"> 520 <div class="ansibleOptionAnchor" id="return-"></div> 521 <b>engine_version</b> 522 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 523 <div style="font-size: small"> 524 <span style="color: purple">string</span> 525 </div> 526 </td> 527 <td>always</td> 528 <td> 529 <div>Version of the database from which the snapshot was created.</div> 530 <br/> 531 <div style="font-size: smaller"><b>Sample:</b></div> 532 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">10.2.21</div> 533 </td> 534 </tr> 535 <tr> 536 <td colspan="1"> 537 <div class="ansibleOptionAnchor" id="return-"></div> 538 <b>iam_database_authentication_enabled</b> 539 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 540 <div style="font-size: small"> 541 <span style="color: purple">boolean</span> 542 </div> 543 </td> 544 <td>always</td> 545 <td> 546 <div>Whether IAM database authentication is enabled.</div> 547 <br/> 548 </td> 549 </tr> 550 <tr> 551 <td colspan="1"> 552 <div class="ansibleOptionAnchor" id="return-"></div> 553 <b>instance_create_time</b> 554 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 555 <div style="font-size: small"> 556 <span style="color: purple">string</span> 557 </div> 558 </td> 559 <td>always</td> 560 <td> 561 <div>Creation time of the instance from which the snapshot was created.</div> 562 <br/> 563 <div style="font-size: smaller"><b>Sample:</b></div> 564 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">2019-06-15T10:15:56.221000+00:00</div> 565 </td> 566 </tr> 567 <tr> 568 <td colspan="1"> 569 <div class="ansibleOptionAnchor" id="return-"></div> 570 <b>license_model</b> 571 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 572 <div style="font-size: small"> 573 <span style="color: purple">string</span> 574 </div> 575 </td> 576 <td>always</td> 577 <td> 578 <div>License model of the database.</div> 579 <br/> 580 <div style="font-size: smaller"><b>Sample:</b></div> 581 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">general-public-license</div> 582 </td> 583 </tr> 584 <tr> 585 <td colspan="1"> 586 <div class="ansibleOptionAnchor" id="return-"></div> 587 <b>master_username</b> 588 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 589 <div style="font-size: small"> 590 <span style="color: purple">string</span> 591 </div> 592 </td> 593 <td>always</td> 594 <td> 595 <div>Master username of the database.</div> 596 <br/> 597 <div style="font-size: smaller"><b>Sample:</b></div> 598 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">test</div> 599 </td> 600 </tr> 601 <tr> 602 <td colspan="1"> 603 <div class="ansibleOptionAnchor" id="return-"></div> 604 <b>option_group_name</b> 605 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 606 <div style="font-size: small"> 607 <span style="color: purple">string</span> 608 </div> 609 </td> 610 <td>always</td> 611 <td> 612 <div>Option group of the database.</div> 613 <br/> 614 <div style="font-size: smaller"><b>Sample:</b></div> 615 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">default:mariadb-10-2</div> 616 </td> 617 </tr> 618 <tr> 619 <td colspan="1"> 620 <div class="ansibleOptionAnchor" id="return-"></div> 621 <b>percent_progress</b> 622 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 623 <div style="font-size: small"> 624 <span style="color: purple">integer</span> 625 </div> 626 </td> 627 <td>always</td> 628 <td> 629 <div>How much progress has been made taking the snapshot. Will be 100 for an available snapshot.</div> 630 <br/> 631 <div style="font-size: smaller"><b>Sample:</b></div> 632 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">100</div> 633 </td> 634 </tr> 635 <tr> 636 <td colspan="1"> 637 <div class="ansibleOptionAnchor" id="return-"></div> 638 <b>port</b> 639 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 640 <div style="font-size: small"> 641 <span style="color: purple">integer</span> 642 </div> 643 </td> 644 <td>always</td> 645 <td> 646 <div>Port on which the database is listening.</div> 647 <br/> 648 <div style="font-size: smaller"><b>Sample:</b></div> 649 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">3306</div> 650 </td> 651 </tr> 652 <tr> 653 <td colspan="1"> 654 <div class="ansibleOptionAnchor" id="return-"></div> 655 <b>processor_features</b> 656 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 657 <div style="font-size: small"> 658 <span style="color: purple">list</span> 659 </div> 660 </td> 661 <td>always</td> 662 <td> 663 <div>List of processor features of the database.</div> 664 <br/> 665 </td> 666 </tr> 667 <tr> 668 <td colspan="1"> 669 <div class="ansibleOptionAnchor" id="return-"></div> 670 <b>snapshot_create_time</b> 671 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 672 <div style="font-size: small"> 673 <span style="color: purple">string</span> 674 </div> 675 </td> 676 <td>always</td> 677 <td> 678 <div>Creation time of the snapshot.</div> 679 <br/> 680 <div style="font-size: smaller"><b>Sample:</b></div> 681 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">2019-06-15T10:46:23.776000+00:00</div> 682 </td> 683 </tr> 684 <tr> 685 <td colspan="1"> 686 <div class="ansibleOptionAnchor" id="return-"></div> 687 <b>snapshot_type</b> 688 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 689 <div style="font-size: small"> 690 <span style="color: purple">string</span> 691 </div> 692 </td> 693 <td>always</td> 694 <td> 695 <div>How the snapshot was created (always manual for this module!).</div> 696 <br/> 697 <div style="font-size: smaller"><b>Sample:</b></div> 698 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">manual</div> 699 </td> 700 </tr> 701 <tr> 702 <td colspan="1"> 703 <div class="ansibleOptionAnchor" id="return-"></div> 704 <b>status</b> 705 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 706 <div style="font-size: small"> 707 <span style="color: purple">string</span> 708 </div> 709 </td> 710 <td>always</td> 711 <td> 712 <div>Status of the snapshot.</div> 713 <br/> 714 <div style="font-size: smaller"><b>Sample:</b></div> 715 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">available</div> 716 </td> 717 </tr> 718 <tr> 719 <td colspan="1"> 720 <div class="ansibleOptionAnchor" id="return-"></div> 721 <b>storage_type</b> 722 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 723 <div style="font-size: small"> 724 <span style="color: purple">string</span> 725 </div> 726 </td> 727 <td>always</td> 728 <td> 729 <div>Storage type of the database.</div> 730 <br/> 731 <div style="font-size: smaller"><b>Sample:</b></div> 732 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">gp2</div> 733 </td> 734 </tr> 735 <tr> 736 <td colspan="1"> 737 <div class="ansibleOptionAnchor" id="return-"></div> 738 <b>tags</b> 739 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 740 <div style="font-size: small"> 741 <span style="color: purple">complex</span> 742 </div> 743 </td> 744 <td>always</td> 745 <td> 746 <div>Tags applied to the snapshot.</div> 747 <br/> 748 </td> 749 </tr> 750 <tr> 751 <td colspan="1"> 752 <div class="ansibleOptionAnchor" id="return-"></div> 753 <b>vpc_id</b> 754 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 755 <div style="font-size: small"> 756 <span style="color: purple">string</span> 757 </div> 758 </td> 759 <td>always</td> 760 <td> 761 <div>ID of the VPC in which the DB lives.</div> 762 <br/> 763 <div style="font-size: smaller"><b>Sample:</b></div> 764 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">vpc-09ff232e222710ae0</div> 765 </td> 766 </tr> 767 </table> 768 <br/><br/> 769 770 771Status 772------ 773 774 775Authors 776~~~~~~~ 777 778- Will Thames (@willthames) 779- Michael De La Rue (@mikedlr) 780