1.. _community.aws.rds_instance_module: 2 3 4************************** 5community.aws.rds_instance 6************************** 7 8**Manage RDS instances** 9 10 11Version added: 1.0.0 12 13.. contents:: 14 :local: 15 :depth: 1 16 17 18Synopsis 19-------- 20- Create, modify, and delete RDS instances. 21 22 23 24Requirements 25------------ 26The below requirements are needed on the host that executes this module. 27 28- boto 29- boto3 >= 1.5.0 30- botocore 31- python >= 2.6 32 33 34Parameters 35---------- 36 37.. raw:: html 38 39 <table border=0 cellpadding=0 class="documentation-table"> 40 <tr> 41 <th colspan="2">Parameter</th> 42 <th>Choices/<font color="blue">Defaults</font></th> 43 <th width="100%">Comments</th> 44 </tr> 45 <tr> 46 <td colspan="2"> 47 <div class="ansibleOptionAnchor" id="parameter-"></div> 48 <b>allocated_storage</b> 49 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 50 <div style="font-size: small"> 51 <span style="color: purple">integer</span> 52 </div> 53 </td> 54 <td> 55 </td> 56 <td> 57 <div>The amount of storage (in gibibytes) to allocate for the DB instance.</div> 58 </td> 59 </tr> 60 <tr> 61 <td colspan="2"> 62 <div class="ansibleOptionAnchor" id="parameter-"></div> 63 <b>allow_major_version_upgrade</b> 64 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 65 <div style="font-size: small"> 66 <span style="color: purple">boolean</span> 67 </div> 68 </td> 69 <td> 70 <ul style="margin: 0; padding: 0"><b>Choices:</b> 71 <li>no</li> 72 <li>yes</li> 73 </ul> 74 </td> 75 <td> 76 <div>Whether to allow major version upgrades.</div> 77 </td> 78 </tr> 79 <tr> 80 <td colspan="2"> 81 <div class="ansibleOptionAnchor" id="parameter-"></div> 82 <b>apply_immediately</b> 83 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 84 <div style="font-size: small"> 85 <span style="color: purple">boolean</span> 86 </div> 87 </td> 88 <td> 89 <ul style="margin: 0; padding: 0"><b>Choices:</b> 90 <li><div style="color: blue"><b>no</b> ←</div></li> 91 <li>yes</li> 92 </ul> 93 </td> 94 <td> 95 <div>A value that specifies whether modifying a cluster with <em>new_db_instance_identifier</em> and <em>master_user_password</em> should be applied as soon as possible, regardless of the <em>preferred_maintenance_window</em> setting. If false, changes are applied during the next maintenance window.</div> 96 </td> 97 </tr> 98 <tr> 99 <td colspan="2"> 100 <div class="ansibleOptionAnchor" id="parameter-"></div> 101 <b>auto_minor_version_upgrade</b> 102 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 103 <div style="font-size: small"> 104 <span style="color: purple">boolean</span> 105 </div> 106 </td> 107 <td> 108 <ul style="margin: 0; padding: 0"><b>Choices:</b> 109 <li>no</li> 110 <li>yes</li> 111 </ul> 112 </td> 113 <td> 114 <div>Whether minor version upgrades are applied automatically to the DB instance during the maintenance window.</div> 115 </td> 116 </tr> 117 <tr> 118 <td colspan="2"> 119 <div class="ansibleOptionAnchor" id="parameter-"></div> 120 <b>availability_zone</b> 121 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 122 <div style="font-size: small"> 123 <span style="color: purple">string</span> 124 </div> 125 </td> 126 <td> 127 </td> 128 <td> 129 <div>A list of EC2 Availability Zones that instances in the DB cluster can be created in. May be used when creating a cluster or when restoring from S3 or a snapshot. Mutually exclusive with <em>multi_az</em>.</div> 130 <div style="font-size: small; color: darkgreen"><br/>aliases: az, zone</div> 131 </td> 132 </tr> 133 <tr> 134 <td colspan="2"> 135 <div class="ansibleOptionAnchor" id="parameter-"></div> 136 <b>aws_access_key</b> 137 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 138 <div style="font-size: small"> 139 <span style="color: purple">string</span> 140 </div> 141 </td> 142 <td> 143 </td> 144 <td> 145 <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> 146 <div>If <em>profile</em> is set this parameter is ignored.</div> 147 <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> 148 <div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div> 149 </td> 150 </tr> 151 <tr> 152 <td colspan="2"> 153 <div class="ansibleOptionAnchor" id="parameter-"></div> 154 <b>aws_ca_bundle</b> 155 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 156 <div style="font-size: small"> 157 <span style="color: purple">path</span> 158 </div> 159 </td> 160 <td> 161 </td> 162 <td> 163 <div>The location of a CA Bundle to use when validating SSL certificates.</div> 164 <div>Only used for boto3 based modules.</div> 165 <div>Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.</div> 166 </td> 167 </tr> 168 <tr> 169 <td colspan="2"> 170 <div class="ansibleOptionAnchor" id="parameter-"></div> 171 <b>aws_config</b> 172 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 173 <div style="font-size: small"> 174 <span style="color: purple">dictionary</span> 175 </div> 176 </td> 177 <td> 178 </td> 179 <td> 180 <div>A dictionary to modify the botocore configuration.</div> 181 <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> 182 <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> 183 </td> 184 </tr> 185 <tr> 186 <td colspan="2"> 187 <div class="ansibleOptionAnchor" id="parameter-"></div> 188 <b>aws_secret_key</b> 189 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 190 <div style="font-size: small"> 191 <span style="color: purple">string</span> 192 </div> 193 </td> 194 <td> 195 </td> 196 <td> 197 <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> 198 <div>If <em>profile</em> is set this parameter is ignored.</div> 199 <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> 200 <div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div> 201 </td> 202 </tr> 203 <tr> 204 <td colspan="2"> 205 <div class="ansibleOptionAnchor" id="parameter-"></div> 206 <b>backup_retention_period</b> 207 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 208 <div style="font-size: small"> 209 <span style="color: purple">integer</span> 210 </div> 211 </td> 212 <td> 213 </td> 214 <td> 215 <div>The number of days for which automated backups are retained.</div> 216 <div>When set to <code>0</code>, automated backups will be disabled. (Not applicable if the DB instance is a source to read replicas)</div> 217 <div>May be used when creating a new cluster, when restoring from S3, or when modifying a cluster.</div> 218 </td> 219 </tr> 220 <tr> 221 <td colspan="2"> 222 <div class="ansibleOptionAnchor" id="parameter-"></div> 223 <b>ca_certificate_identifier</b> 224 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 225 <div style="font-size: small"> 226 <span style="color: purple">string</span> 227 </div> 228 </td> 229 <td> 230 </td> 231 <td> 232 <div>The identifier of the CA certificate for the DB instance.</div> 233 </td> 234 </tr> 235 <tr> 236 <td colspan="2"> 237 <div class="ansibleOptionAnchor" id="parameter-"></div> 238 <b>character_set_name</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>The character set to associate with the DB cluster.</div> 248 </td> 249 </tr> 250 <tr> 251 <td colspan="2"> 252 <div class="ansibleOptionAnchor" id="parameter-"></div> 253 <b>copy_tags_to_snapshot</b> 254 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 255 <div style="font-size: small"> 256 <span style="color: purple">boolean</span> 257 </div> 258 </td> 259 <td> 260 <ul style="margin: 0; padding: 0"><b>Choices:</b> 261 <li>no</li> 262 <li>yes</li> 263 </ul> 264 </td> 265 <td> 266 <div>Whether or not to copy all tags from the DB instance to snapshots of the instance. When initially creating a DB instance the RDS API defaults this to false if unspecified.</div> 267 </td> 268 </tr> 269 <tr> 270 <td colspan="2"> 271 <div class="ansibleOptionAnchor" id="parameter-"></div> 272 <b>creation_source</b> 273 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 274 <div style="font-size: small"> 275 <span style="color: purple">string</span> 276 </div> 277 </td> 278 <td> 279 <ul style="margin: 0; padding: 0"><b>Choices:</b> 280 <li>snapshot</li> 281 <li>s3</li> 282 <li>instance</li> 283 </ul> 284 </td> 285 <td> 286 <div>Which source to use if restoring from a template (an existing instance, S3 bucket, or snapshot).</div> 287 </td> 288 </tr> 289 <tr> 290 <td colspan="2"> 291 <div class="ansibleOptionAnchor" id="parameter-"></div> 292 <b>db_cluster_identifier</b> 293 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 294 <div style="font-size: small"> 295 <span style="color: purple">string</span> 296 </div> 297 </td> 298 <td> 299 </td> 300 <td> 301 <div>The DB cluster (lowercase) identifier to add the aurora DB instance to. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens.</div> 302 <div style="font-size: small; color: darkgreen"><br/>aliases: cluster_id</div> 303 </td> 304 </tr> 305 <tr> 306 <td colspan="2"> 307 <div class="ansibleOptionAnchor" id="parameter-"></div> 308 <b>db_instance_class</b> 309 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 310 <div style="font-size: small"> 311 <span style="color: purple">string</span> 312 </div> 313 </td> 314 <td> 315 </td> 316 <td> 317 <div>The compute and memory capacity of the DB instance, for example db.t2.micro.</div> 318 <div style="font-size: small; color: darkgreen"><br/>aliases: class, instance_type</div> 319 </td> 320 </tr> 321 <tr> 322 <td colspan="2"> 323 <div class="ansibleOptionAnchor" id="parameter-"></div> 324 <b>db_instance_identifier</b> 325 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 326 <div style="font-size: small"> 327 <span style="color: purple">string</span> 328 / <span style="color: red">required</span> 329 </div> 330 </td> 331 <td> 332 </td> 333 <td> 334 <div>The DB instance (lowercase) identifier. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens.</div> 335 <div style="font-size: small; color: darkgreen"><br/>aliases: instance_id, id</div> 336 </td> 337 </tr> 338 <tr> 339 <td colspan="2"> 340 <div class="ansibleOptionAnchor" id="parameter-"></div> 341 <b>db_name</b> 342 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 343 <div style="font-size: small"> 344 <span style="color: purple">string</span> 345 </div> 346 </td> 347 <td> 348 </td> 349 <td> 350 <div>The name for your database. If a name is not provided Amazon RDS will not create a database.</div> 351 </td> 352 </tr> 353 <tr> 354 <td colspan="2"> 355 <div class="ansibleOptionAnchor" id="parameter-"></div> 356 <b>db_parameter_group_name</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 name of the DB parameter group to associate with this DB instance. When creating the DB instance if this argument is omitted the default DBParameterGroup for the specified engine is used.</div> 366 </td> 367 </tr> 368 <tr> 369 <td colspan="2"> 370 <div class="ansibleOptionAnchor" id="parameter-"></div> 371 <b>db_security_groups</b> 372 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 373 <div style="font-size: small"> 374 <span style="color: purple">list</span> 375 / <span style="color: purple">elements=string</span> 376 </div> 377 </td> 378 <td> 379 </td> 380 <td> 381 <div>(EC2-Classic platform) A list of DB security groups to associate with this DB instance.</div> 382 </td> 383 </tr> 384 <tr> 385 <td colspan="2"> 386 <div class="ansibleOptionAnchor" id="parameter-"></div> 387 <b>db_snapshot_identifier</b> 388 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 389 <div style="font-size: small"> 390 <span style="color: purple">string</span> 391 </div> 392 </td> 393 <td> 394 </td> 395 <td> 396 <div>The identifier for the DB snapshot to restore from if using <em>creation_source=snapshot</em>.</div> 397 </td> 398 </tr> 399 <tr> 400 <td colspan="2"> 401 <div class="ansibleOptionAnchor" id="parameter-"></div> 402 <b>db_subnet_group_name</b> 403 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 404 <div style="font-size: small"> 405 <span style="color: purple">string</span> 406 </div> 407 </td> 408 <td> 409 </td> 410 <td> 411 <div>The DB subnet group name to use for the DB instance.</div> 412 <div style="font-size: small; color: darkgreen"><br/>aliases: subnet_group</div> 413 </td> 414 </tr> 415 <tr> 416 <td colspan="2"> 417 <div class="ansibleOptionAnchor" id="parameter-"></div> 418 <b>debug_botocore_endpoint_logs</b> 419 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 420 <div style="font-size: small"> 421 <span style="color: purple">boolean</span> 422 </div> 423 </td> 424 <td> 425 <ul style="margin: 0; padding: 0"><b>Choices:</b> 426 <li><div style="color: blue"><b>no</b> ←</div></li> 427 <li>yes</li> 428 </ul> 429 </td> 430 <td> 431 <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> 432 </td> 433 </tr> 434 <tr> 435 <td colspan="2"> 436 <div class="ansibleOptionAnchor" id="parameter-"></div> 437 <b>domain</b> 438 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 439 <div style="font-size: small"> 440 <span style="color: purple">string</span> 441 </div> 442 </td> 443 <td> 444 </td> 445 <td> 446 <div>The Active Directory Domain to restore the instance in.</div> 447 </td> 448 </tr> 449 <tr> 450 <td colspan="2"> 451 <div class="ansibleOptionAnchor" id="parameter-"></div> 452 <b>domain_iam_role_name</b> 453 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 454 <div style="font-size: small"> 455 <span style="color: purple">string</span> 456 </div> 457 </td> 458 <td> 459 </td> 460 <td> 461 <div>The name of the IAM role to be used when making API calls to the Directory Service.</div> 462 </td> 463 </tr> 464 <tr> 465 <td colspan="2"> 466 <div class="ansibleOptionAnchor" id="parameter-"></div> 467 <b>ec2_url</b> 468 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 469 <div style="font-size: small"> 470 <span style="color: purple">string</span> 471 </div> 472 </td> 473 <td> 474 </td> 475 <td> 476 <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> 477 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_endpoint_url, endpoint_url</div> 478 </td> 479 </tr> 480 <tr> 481 <td colspan="2"> 482 <div class="ansibleOptionAnchor" id="parameter-"></div> 483 <b>enable_cloudwatch_logs_exports</b> 484 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 485 <div style="font-size: small"> 486 <span style="color: purple">list</span> 487 / <span style="color: purple">elements=string</span> 488 </div> 489 </td> 490 <td> 491 </td> 492 <td> 493 <div>A list of log types that need to be enabled for exporting to CloudWatch Logs.</div> 494 <div style="font-size: small; color: darkgreen"><br/>aliases: cloudwatch_log_exports</div> 495 </td> 496 </tr> 497 <tr> 498 <td colspan="2"> 499 <div class="ansibleOptionAnchor" id="parameter-"></div> 500 <b>enable_iam_database_authentication</b> 501 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 502 <div style="font-size: small"> 503 <span style="color: purple">boolean</span> 504 </div> 505 </td> 506 <td> 507 <ul style="margin: 0; padding: 0"><b>Choices:</b> 508 <li>no</li> 509 <li>yes</li> 510 </ul> 511 </td> 512 <td> 513 <div>Enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. If this option is omitted when creating the cluster, Amazon RDS sets this to False.</div> 514 </td> 515 </tr> 516 <tr> 517 <td colspan="2"> 518 <div class="ansibleOptionAnchor" id="parameter-"></div> 519 <b>enable_performance_insights</b> 520 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 521 <div style="font-size: small"> 522 <span style="color: purple">boolean</span> 523 </div> 524 </td> 525 <td> 526 <ul style="margin: 0; padding: 0"><b>Choices:</b> 527 <li>no</li> 528 <li>yes</li> 529 </ul> 530 </td> 531 <td> 532 <div>Whether to enable Performance Insights for the DB instance.</div> 533 </td> 534 </tr> 535 <tr> 536 <td colspan="2"> 537 <div class="ansibleOptionAnchor" id="parameter-"></div> 538 <b>engine</b> 539 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 540 <div style="font-size: small"> 541 <span style="color: purple">string</span> 542 </div> 543 </td> 544 <td> 545 </td> 546 <td> 547 <div>The name of the database engine to be used for this DB instance. This is required to create an instance. Valid choices are aurora | aurora-mysql | aurora-postgresql | mariadb | mysql | oracle-ee | oracle-se | oracle-se1 | oracle-se2 | postgres | sqlserver-ee | sqlserver-ex | sqlserver-se | sqlserver-web</div> 548 </td> 549 </tr> 550 <tr> 551 <td colspan="2"> 552 <div class="ansibleOptionAnchor" id="parameter-"></div> 553 <b>engine_version</b> 554 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 555 <div style="font-size: small"> 556 <span style="color: purple">string</span> 557 </div> 558 </td> 559 <td> 560 </td> 561 <td> 562 <div>The version number of the database engine to use. For Aurora MySQL that could be 5.6.10a , 5.7.12. Aurora PostgreSQL example, 9.6.3</div> 563 </td> 564 </tr> 565 <tr> 566 <td colspan="2"> 567 <div class="ansibleOptionAnchor" id="parameter-"></div> 568 <b>final_db_snapshot_identifier</b> 569 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 570 <div style="font-size: small"> 571 <span style="color: purple">string</span> 572 </div> 573 </td> 574 <td> 575 </td> 576 <td> 577 <div>The DB instance snapshot identifier of the new DB instance snapshot created when <em>skip_final_snapshot</em> is false.</div> 578 <div style="font-size: small; color: darkgreen"><br/>aliases: final_snapshot_identifier</div> 579 </td> 580 </tr> 581 <tr> 582 <td colspan="2"> 583 <div class="ansibleOptionAnchor" id="parameter-"></div> 584 <b>force_failover</b> 585 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 586 <div style="font-size: small"> 587 <span style="color: purple">boolean</span> 588 </div> 589 </td> 590 <td> 591 <ul style="margin: 0; padding: 0"><b>Choices:</b> 592 <li>no</li> 593 <li>yes</li> 594 </ul> 595 </td> 596 <td> 597 <div>Set to true to conduct the reboot through a MultiAZ failover.</div> 598 </td> 599 </tr> 600 <tr> 601 <td colspan="2"> 602 <div class="ansibleOptionAnchor" id="parameter-"></div> 603 <b>force_update_password</b> 604 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 605 <div style="font-size: small"> 606 <span style="color: purple">boolean</span> 607 </div> 608 </td> 609 <td> 610 <ul style="margin: 0; padding: 0"><b>Choices:</b> 611 <li><div style="color: blue"><b>no</b> ←</div></li> 612 <li>yes</li> 613 </ul> 614 </td> 615 <td> 616 <div>Set to True to update your cluster password with <em>master_user_password</em>. Since comparing passwords to determine if it needs to be updated is not possible this is set to False by default to allow idempotence.</div> 617 </td> 618 </tr> 619 <tr> 620 <td colspan="2"> 621 <div class="ansibleOptionAnchor" id="parameter-"></div> 622 <b>iops</b> 623 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 624 <div style="font-size: small"> 625 <span style="color: purple">integer</span> 626 </div> 627 </td> 628 <td> 629 </td> 630 <td> 631 <div>The Provisioned IOPS (I/O operations per second) value. Is only set when using <em>storage_type</em> is set to io1.</div> 632 </td> 633 </tr> 634 <tr> 635 <td colspan="2"> 636 <div class="ansibleOptionAnchor" id="parameter-"></div> 637 <b>kms_key_id</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>The ARN of the AWS KMS key identifier for an encrypted DB instance. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.</div> 647 <div>If <em>storage_encrypted</em> is true and and this option is not provided, the default encryption key is used.</div> 648 </td> 649 </tr> 650 <tr> 651 <td colspan="2"> 652 <div class="ansibleOptionAnchor" id="parameter-"></div> 653 <b>license_model</b> 654 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 655 <div style="font-size: small"> 656 <span style="color: purple">string</span> 657 </div> 658 </td> 659 <td> 660 </td> 661 <td> 662 <div>The license model for the DB instance.</div> 663 <div>Several options are license-included, bring-your-own-license, and general-public-license.</div> 664 <div>This option can also be omitted to default to an accepted value.</div> 665 </td> 666 </tr> 667 <tr> 668 <td colspan="2"> 669 <div class="ansibleOptionAnchor" id="parameter-"></div> 670 <b>master_user_password</b> 671 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 672 <div style="font-size: small"> 673 <span style="color: purple">string</span> 674 </div> 675 </td> 676 <td> 677 </td> 678 <td> 679 <div>An 8-41 character password for the master database user. The password can contain any printable ASCII character except "/", """, or "@". To modify the password use <em>force_password_update</em>. Use <em>apply immediately</em> to change the password immediately, otherwise it is updated during the next maintenance window.</div> 680 <div style="font-size: small; color: darkgreen"><br/>aliases: password</div> 681 </td> 682 </tr> 683 <tr> 684 <td colspan="2"> 685 <div class="ansibleOptionAnchor" id="parameter-"></div> 686 <b>master_username</b> 687 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 688 <div style="font-size: small"> 689 <span style="color: purple">string</span> 690 </div> 691 </td> 692 <td> 693 </td> 694 <td> 695 <div>The name of the master user for the DB cluster. Must be 1-16 letters or numbers and begin with a letter.</div> 696 <div style="font-size: small; color: darkgreen"><br/>aliases: username</div> 697 </td> 698 </tr> 699 <tr> 700 <td colspan="2"> 701 <div class="ansibleOptionAnchor" id="parameter-"></div> 702 <b>max_allocated_storage</b> 703 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 704 <div style="font-size: small"> 705 <span style="color: purple">integer</span> 706 </div> 707 </td> 708 <td> 709 </td> 710 <td> 711 <div>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</div> 712 </td> 713 </tr> 714 <tr> 715 <td colspan="2"> 716 <div class="ansibleOptionAnchor" id="parameter-"></div> 717 <b>monitoring_interval</b> 718 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 719 <div style="font-size: small"> 720 <span style="color: purple">integer</span> 721 </div> 722 </td> 723 <td> 724 </td> 725 <td> 726 <div>The interval, in seconds, when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting metrics, specify 0. Amazon RDS defaults this to 0 if omitted when initially creating a DB instance.</div> 727 </td> 728 </tr> 729 <tr> 730 <td colspan="2"> 731 <div class="ansibleOptionAnchor" id="parameter-"></div> 732 <b>monitoring_role_arn</b> 733 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 734 <div style="font-size: small"> 735 <span style="color: purple">string</span> 736 </div> 737 </td> 738 <td> 739 </td> 740 <td> 741 <div>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.</div> 742 </td> 743 </tr> 744 <tr> 745 <td colspan="2"> 746 <div class="ansibleOptionAnchor" id="parameter-"></div> 747 <b>multi_az</b> 748 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 749 <div style="font-size: small"> 750 <span style="color: purple">boolean</span> 751 </div> 752 </td> 753 <td> 754 <ul style="margin: 0; padding: 0"><b>Choices:</b> 755 <li>no</li> 756 <li>yes</li> 757 </ul> 758 </td> 759 <td> 760 <div>Specifies if the DB instance is a Multi-AZ deployment. Mutually exclusive with <em>availability_zone</em>.</div> 761 </td> 762 </tr> 763 <tr> 764 <td colspan="2"> 765 <div class="ansibleOptionAnchor" id="parameter-"></div> 766 <b>new_db_instance_identifier</b> 767 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 768 <div style="font-size: small"> 769 <span style="color: purple">string</span> 770 </div> 771 </td> 772 <td> 773 </td> 774 <td> 775 <div>The new DB cluster (lowercase) identifier for the DB cluster when renaming a DB instance. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens. Use <em>apply_immediately</em> to rename immediately, otherwise it is updated during the next maintenance window.</div> 776 <div style="font-size: small; color: darkgreen"><br/>aliases: new_instance_id, new_id</div> 777 </td> 778 </tr> 779 <tr> 780 <td colspan="2"> 781 <div class="ansibleOptionAnchor" id="parameter-"></div> 782 <b>option_group_name</b> 783 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 784 <div style="font-size: small"> 785 <span style="color: purple">string</span> 786 </div> 787 </td> 788 <td> 789 </td> 790 <td> 791 <div>The option group to associate with the DB instance.</div> 792 </td> 793 </tr> 794 <tr> 795 <td colspan="2"> 796 <div class="ansibleOptionAnchor" id="parameter-"></div> 797 <b>performance_insights_kms_key_id</b> 798 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 799 <div style="font-size: small"> 800 <span style="color: purple">string</span> 801 </div> 802 </td> 803 <td> 804 </td> 805 <td> 806 <div>The AWS KMS key identifier (ARN, name, or alias) for encryption of Performance Insights data.</div> 807 </td> 808 </tr> 809 <tr> 810 <td colspan="2"> 811 <div class="ansibleOptionAnchor" id="parameter-"></div> 812 <b>performance_insights_retention_period</b> 813 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 814 <div style="font-size: small"> 815 <span style="color: purple">integer</span> 816 </div> 817 </td> 818 <td> 819 </td> 820 <td> 821 <div>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731.</div> 822 </td> 823 </tr> 824 <tr> 825 <td colspan="2"> 826 <div class="ansibleOptionAnchor" id="parameter-"></div> 827 <b>port</b> 828 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 829 <div style="font-size: small"> 830 <span style="color: purple">integer</span> 831 </div> 832 </td> 833 <td> 834 </td> 835 <td> 836 <div>The port number on which the instances accept connections.</div> 837 </td> 838 </tr> 839 <tr> 840 <td colspan="2"> 841 <div class="ansibleOptionAnchor" id="parameter-"></div> 842 <b>preferred_backup_window</b> 843 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 844 <div style="font-size: small"> 845 <span style="color: purple">string</span> 846 </div> 847 </td> 848 <td> 849 </td> 850 <td> 851 <div>The daily time range (in UTC) of at least 30 minutes, during which automated backups are created if automated backups are enabled using <em>backup_retention_period</em>. The option must be in the format of "hh24:mi-hh24:mi" and not conflict with <em>preferred_maintenance_window</em>.</div> 852 <div style="font-size: small; color: darkgreen"><br/>aliases: backup_window</div> 853 </td> 854 </tr> 855 <tr> 856 <td colspan="2"> 857 <div class="ansibleOptionAnchor" id="parameter-"></div> 858 <b>preferred_maintenance_window</b> 859 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 860 <div style="font-size: small"> 861 <span style="color: purple">string</span> 862 </div> 863 </td> 864 <td> 865 </td> 866 <td> 867 <div>The weekly time range (in UTC) of at least 30 minutes, during which system maintenance can occur. The option must be in the format "ddd:hh24:mi-ddd:hh24:mi" where ddd is one of Mon, Tue, Wed, Thu, Fri, Sat, Sun.</div> 868 <div style="font-size: small; color: darkgreen"><br/>aliases: maintenance_window</div> 869 </td> 870 </tr> 871 <tr> 872 <td colspan="2"> 873 <div class="ansibleOptionAnchor" id="parameter-"></div> 874 <b>processor_features</b> 875 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 876 <div style="font-size: small"> 877 <span style="color: purple">dictionary</span> 878 </div> 879 </td> 880 <td> 881 </td> 882 <td> 883 <div>A dictionary of Name, Value pairs to indicate the number of CPU cores and the number of threads per core for the DB instance class of the DB instance. Names are threadsPerCore and coreCount. Set this option to an empty dictionary to use the default processor features.</div> 884 </td> 885 </tr> 886 <tr> 887 <td class="elbow-placeholder"></td> 888 <td colspan="1"> 889 <div class="ansibleOptionAnchor" id="parameter-"></div> 890 <b>coreCount</b> 891 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 892 <div style="font-size: small"> 893 <span style="color: purple">-</span> 894 </div> 895 </td> 896 <td> 897 </td> 898 <td> 899 <div>The number of CPU cores</div> 900 </td> 901 </tr> 902 <tr> 903 <td class="elbow-placeholder"></td> 904 <td colspan="1"> 905 <div class="ansibleOptionAnchor" id="parameter-"></div> 906 <b>threadsPerCore</b> 907 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 908 <div style="font-size: small"> 909 <span style="color: purple">-</span> 910 </div> 911 </td> 912 <td> 913 </td> 914 <td> 915 <div>The number of threads per core</div> 916 </td> 917 </tr> 918 919 <tr> 920 <td colspan="2"> 921 <div class="ansibleOptionAnchor" id="parameter-"></div> 922 <b>profile</b> 923 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 924 <div style="font-size: small"> 925 <span style="color: purple">string</span> 926 </div> 927 </td> 928 <td> 929 </td> 930 <td> 931 <div>Uses a boto profile. Only works with boto >= 2.24.0.</div> 932 <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> 933 <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> 934 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div> 935 </td> 936 </tr> 937 <tr> 938 <td colspan="2"> 939 <div class="ansibleOptionAnchor" id="parameter-"></div> 940 <b>promotion_tier</b> 941 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 942 <div style="font-size: small"> 943 <span style="color: purple">string</span> 944 </div> 945 </td> 946 <td> 947 </td> 948 <td> 949 <div>An integer that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.</div> 950 </td> 951 </tr> 952 <tr> 953 <td colspan="2"> 954 <div class="ansibleOptionAnchor" id="parameter-"></div> 955 <b>publicly_accessible</b> 956 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 957 <div style="font-size: small"> 958 <span style="color: purple">boolean</span> 959 </div> 960 </td> 961 <td> 962 <ul style="margin: 0; padding: 0"><b>Choices:</b> 963 <li>no</li> 964 <li>yes</li> 965 </ul> 966 </td> 967 <td> 968 <div>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.</div> 969 </td> 970 </tr> 971 <tr> 972 <td colspan="2"> 973 <div class="ansibleOptionAnchor" id="parameter-"></div> 974 <b>purge_cloudwatch_logs_exports</b> 975 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 976 <div style="font-size: small"> 977 <span style="color: purple">boolean</span> 978 </div> 979 </td> 980 <td> 981 <ul style="margin: 0; padding: 0"><b>Choices:</b> 982 <li>no</li> 983 <li><div style="color: blue"><b>yes</b> ←</div></li> 984 </ul> 985 </td> 986 <td> 987 <div>Set to False to retain any enabled cloudwatch logs that aren't specified in the task and are associated with the instance.</div> 988 </td> 989 </tr> 990 <tr> 991 <td colspan="2"> 992 <div class="ansibleOptionAnchor" id="parameter-"></div> 993 <b>purge_security_groups</b> 994 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 995 <div style="font-size: small"> 996 <span style="color: purple">boolean</span> 997 </div> 998 <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.5.0</div> 999 </td> 1000 <td> 1001 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1002 <li>no</li> 1003 <li><div style="color: blue"><b>yes</b> ←</div></li> 1004 </ul> 1005 </td> 1006 <td> 1007 <div>Set to False to retain any enabled security groups that aren't specified in the task and are associated with the instance.</div> 1008 <div>Can be applied to <em>vpc_security_group_ids</em> and <em>db_security_groups</em></div> 1009 </td> 1010 </tr> 1011 <tr> 1012 <td colspan="2"> 1013 <div class="ansibleOptionAnchor" id="parameter-"></div> 1014 <b>purge_tags</b> 1015 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1016 <div style="font-size: small"> 1017 <span style="color: purple">boolean</span> 1018 </div> 1019 </td> 1020 <td> 1021 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1022 <li>no</li> 1023 <li><div style="color: blue"><b>yes</b> ←</div></li> 1024 </ul> 1025 </td> 1026 <td> 1027 <div>Set to False to retain any tags that aren't specified in task and are associated with the instance.</div> 1028 </td> 1029 </tr> 1030 <tr> 1031 <td colspan="2"> 1032 <div class="ansibleOptionAnchor" id="parameter-"></div> 1033 <b>read_replica</b> 1034 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1035 <div style="font-size: small"> 1036 <span style="color: purple">boolean</span> 1037 </div> 1038 </td> 1039 <td> 1040 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1041 <li>no</li> 1042 <li>yes</li> 1043 </ul> 1044 </td> 1045 <td> 1046 <div>Set to False to promote a read replica cluster or true to create one. When creating a read replica <code>creation_source</code> should be set to 'instance' or not provided. <code>source_db_instance_identifier</code> must be provided with this option.</div> 1047 </td> 1048 </tr> 1049 <tr> 1050 <td colspan="2"> 1051 <div class="ansibleOptionAnchor" id="parameter-"></div> 1052 <b>region</b> 1053 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1054 <div style="font-size: small"> 1055 <span style="color: purple">string</span> 1056 </div> 1057 </td> 1058 <td> 1059 </td> 1060 <td> 1061 <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> 1062 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_region, ec2_region</div> 1063 </td> 1064 </tr> 1065 <tr> 1066 <td colspan="2"> 1067 <div class="ansibleOptionAnchor" id="parameter-"></div> 1068 <b>restore_time</b> 1069 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1070 <div style="font-size: small"> 1071 <span style="color: purple">string</span> 1072 </div> 1073 </td> 1074 <td> 1075 </td> 1076 <td> 1077 <div>If using <em>creation_source=instance</em> this indicates the UTC date and time to restore from the source instance. For example, "2009-09-07T23:45:00Z".</div> 1078 <div>May alternatively set <em>use_latest_restore_time=True</em>.</div> 1079 <div>Only one of <em>use_latest_restorable_time</em> and <em>restore_time</em> may be provided.</div> 1080 </td> 1081 </tr> 1082 <tr> 1083 <td colspan="2"> 1084 <div class="ansibleOptionAnchor" id="parameter-"></div> 1085 <b>s3_bucket_name</b> 1086 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1087 <div style="font-size: small"> 1088 <span style="color: purple">string</span> 1089 </div> 1090 </td> 1091 <td> 1092 </td> 1093 <td> 1094 <div>The name of the Amazon S3 bucket that contains the data used to create the Amazon DB instance.</div> 1095 </td> 1096 </tr> 1097 <tr> 1098 <td colspan="2"> 1099 <div class="ansibleOptionAnchor" id="parameter-"></div> 1100 <b>s3_ingestion_role_arn</b> 1101 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1102 <div style="font-size: small"> 1103 <span style="color: purple">string</span> 1104 </div> 1105 </td> 1106 <td> 1107 </td> 1108 <td> 1109 <div>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.</div> 1110 </td> 1111 </tr> 1112 <tr> 1113 <td colspan="2"> 1114 <div class="ansibleOptionAnchor" id="parameter-"></div> 1115 <b>s3_prefix</b> 1116 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1117 <div style="font-size: small"> 1118 <span style="color: purple">string</span> 1119 </div> 1120 </td> 1121 <td> 1122 </td> 1123 <td> 1124 <div>The prefix for all of the file names that contain the data used to create the Amazon DB instance. If you do not specify a SourceS3Prefix value, then the Amazon DB instance is created by using all of the files in the Amazon S3 bucket.</div> 1125 </td> 1126 </tr> 1127 <tr> 1128 <td colspan="2"> 1129 <div class="ansibleOptionAnchor" id="parameter-"></div> 1130 <b>security_token</b> 1131 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1132 <div style="font-size: small"> 1133 <span style="color: purple">string</span> 1134 </div> 1135 </td> 1136 <td> 1137 </td> 1138 <td> 1139 <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> 1140 <div>If <em>profile</em> is set this parameter is ignored.</div> 1141 <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> 1142 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div> 1143 </td> 1144 </tr> 1145 <tr> 1146 <td colspan="2"> 1147 <div class="ansibleOptionAnchor" id="parameter-"></div> 1148 <b>skip_final_snapshot</b> 1149 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1150 <div style="font-size: small"> 1151 <span style="color: purple">boolean</span> 1152 </div> 1153 </td> 1154 <td> 1155 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1156 <li><div style="color: blue"><b>no</b> ←</div></li> 1157 <li>yes</li> 1158 </ul> 1159 </td> 1160 <td> 1161 <div>Whether a final DB cluster snapshot is created before the DB cluster is deleted. If this is false <em>final_db_snapshot_identifier</em> must be provided.</div> 1162 </td> 1163 </tr> 1164 <tr> 1165 <td colspan="2"> 1166 <div class="ansibleOptionAnchor" id="parameter-"></div> 1167 <b>snapshot_identifier</b> 1168 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1169 <div style="font-size: small"> 1170 <span style="color: purple">string</span> 1171 </div> 1172 </td> 1173 <td> 1174 </td> 1175 <td> 1176 <div>The ARN of the DB snapshot to restore from when using <em>creation_source=snapshot</em>.</div> 1177 </td> 1178 </tr> 1179 <tr> 1180 <td colspan="2"> 1181 <div class="ansibleOptionAnchor" id="parameter-"></div> 1182 <b>source_db_instance_identifier</b> 1183 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1184 <div style="font-size: small"> 1185 <span style="color: purple">string</span> 1186 </div> 1187 </td> 1188 <td> 1189 </td> 1190 <td> 1191 <div>The identifier or ARN of the source DB instance from which to restore when creating a read replica or spinning up a point-in-time DB instance using <em>creation_source=instance</em>. If the source DB is not in the same region this should be an ARN.</div> 1192 </td> 1193 </tr> 1194 <tr> 1195 <td colspan="2"> 1196 <div class="ansibleOptionAnchor" id="parameter-"></div> 1197 <b>source_engine</b> 1198 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1199 <div style="font-size: small"> 1200 <span style="color: purple">string</span> 1201 </div> 1202 </td> 1203 <td> 1204 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1205 <li>mysql</li> 1206 </ul> 1207 </td> 1208 <td> 1209 <div>The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.</div> 1210 </td> 1211 </tr> 1212 <tr> 1213 <td colspan="2"> 1214 <div class="ansibleOptionAnchor" id="parameter-"></div> 1215 <b>source_engine_version</b> 1216 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1217 <div style="font-size: small"> 1218 <span style="color: purple">string</span> 1219 </div> 1220 </td> 1221 <td> 1222 </td> 1223 <td> 1224 <div>The version of the database that the backup files were created from.</div> 1225 </td> 1226 </tr> 1227 <tr> 1228 <td colspan="2"> 1229 <div class="ansibleOptionAnchor" id="parameter-"></div> 1230 <b>source_region</b> 1231 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1232 <div style="font-size: small"> 1233 <span style="color: purple">string</span> 1234 </div> 1235 </td> 1236 <td> 1237 </td> 1238 <td> 1239 <div>The region of the DB instance from which the replica is created.</div> 1240 </td> 1241 </tr> 1242 <tr> 1243 <td colspan="2"> 1244 <div class="ansibleOptionAnchor" id="parameter-"></div> 1245 <b>state</b> 1246 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1247 <div style="font-size: small"> 1248 <span style="color: purple">string</span> 1249 </div> 1250 </td> 1251 <td> 1252 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1253 <li><div style="color: blue"><b>present</b> ←</div></li> 1254 <li>absent</li> 1255 <li>terminated</li> 1256 <li>running</li> 1257 <li>started</li> 1258 <li>stopped</li> 1259 <li>rebooted</li> 1260 <li>restarted</li> 1261 </ul> 1262 </td> 1263 <td> 1264 <div>Whether the snapshot should exist or not. <em>rebooted</em> is not idempotent and will leave the DB instance in a running state and start it prior to rebooting if it was stopped. <em>present</em> will leave the DB instance in the current running/stopped state, (running if creating the DB instance).</div> 1265 <div><em>state=running</em> and <em>state=started</em> are synonyms, as are <em>state=rebooted</em> and <em>state=restarted</em>. Note - rebooting the instance is not idempotent.</div> 1266 </td> 1267 </tr> 1268 <tr> 1269 <td colspan="2"> 1270 <div class="ansibleOptionAnchor" id="parameter-"></div> 1271 <b>storage_encrypted</b> 1272 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1273 <div style="font-size: small"> 1274 <span style="color: purple">boolean</span> 1275 </div> 1276 </td> 1277 <td> 1278 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1279 <li>no</li> 1280 <li>yes</li> 1281 </ul> 1282 </td> 1283 <td> 1284 <div>Whether the DB instance is encrypted.</div> 1285 </td> 1286 </tr> 1287 <tr> 1288 <td colspan="2"> 1289 <div class="ansibleOptionAnchor" id="parameter-"></div> 1290 <b>storage_type</b> 1291 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1292 <div style="font-size: small"> 1293 <span style="color: purple">string</span> 1294 </div> 1295 </td> 1296 <td> 1297 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1298 <li>standard</li> 1299 <li>gp2</li> 1300 <li>io1</li> 1301 </ul> 1302 </td> 1303 <td> 1304 <div>The storage type to be associated with the DB instance. <em>storage_type</em> does not apply to Aurora DB instances.</div> 1305 </td> 1306 </tr> 1307 <tr> 1308 <td colspan="2"> 1309 <div class="ansibleOptionAnchor" id="parameter-"></div> 1310 <b>tags</b> 1311 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1312 <div style="font-size: small"> 1313 <span style="color: purple">dictionary</span> 1314 </div> 1315 </td> 1316 <td> 1317 </td> 1318 <td> 1319 <div>A dictionary of key value pairs to assign the DB cluster.</div> 1320 </td> 1321 </tr> 1322 <tr> 1323 <td colspan="2"> 1324 <div class="ansibleOptionAnchor" id="parameter-"></div> 1325 <b>tde_credential_arn</b> 1326 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1327 <div style="font-size: small"> 1328 <span style="color: purple">string</span> 1329 </div> 1330 </td> 1331 <td> 1332 </td> 1333 <td> 1334 <div>The ARN from the key store with which to associate the instance for Transparent Data Encryption. This is supported by Oracle or SQL Server DB instances and may be used in conjunction with <code>storage_encrypted</code> though it might slightly affect the performance of your database.</div> 1335 <div style="font-size: small; color: darkgreen"><br/>aliases: transparent_data_encryption_arn</div> 1336 </td> 1337 </tr> 1338 <tr> 1339 <td colspan="2"> 1340 <div class="ansibleOptionAnchor" id="parameter-"></div> 1341 <b>tde_credential_password</b> 1342 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1343 <div style="font-size: small"> 1344 <span style="color: purple">string</span> 1345 </div> 1346 </td> 1347 <td> 1348 </td> 1349 <td> 1350 <div>The password for the given ARN from the key store in order to access the device.</div> 1351 <div style="font-size: small; color: darkgreen"><br/>aliases: transparent_data_encryption_password</div> 1352 </td> 1353 </tr> 1354 <tr> 1355 <td colspan="2"> 1356 <div class="ansibleOptionAnchor" id="parameter-"></div> 1357 <b>timezone</b> 1358 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1359 <div style="font-size: small"> 1360 <span style="color: purple">string</span> 1361 </div> 1362 </td> 1363 <td> 1364 </td> 1365 <td> 1366 <div>The time zone of the DB instance.</div> 1367 </td> 1368 </tr> 1369 <tr> 1370 <td colspan="2"> 1371 <div class="ansibleOptionAnchor" id="parameter-"></div> 1372 <b>use_latest_restorable_time</b> 1373 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1374 <div style="font-size: small"> 1375 <span style="color: purple">boolean</span> 1376 </div> 1377 </td> 1378 <td> 1379 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1380 <li>no</li> 1381 <li>yes</li> 1382 </ul> 1383 </td> 1384 <td> 1385 <div>Whether to restore the DB instance to the latest restorable backup time.</div> 1386 <div>Only one of <em>use_latest_restorable_time</em> and <em>restore_time</em> may be provided.</div> 1387 <div style="font-size: small; color: darkgreen"><br/>aliases: restore_from_latest</div> 1388 </td> 1389 </tr> 1390 <tr> 1391 <td colspan="2"> 1392 <div class="ansibleOptionAnchor" id="parameter-"></div> 1393 <b>validate_certs</b> 1394 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1395 <div style="font-size: small"> 1396 <span style="color: purple">boolean</span> 1397 </div> 1398 </td> 1399 <td> 1400 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1401 <li>no</li> 1402 <li><div style="color: blue"><b>yes</b> ←</div></li> 1403 </ul> 1404 </td> 1405 <td> 1406 <div>When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.</div> 1407 </td> 1408 </tr> 1409 <tr> 1410 <td colspan="2"> 1411 <div class="ansibleOptionAnchor" id="parameter-"></div> 1412 <b>vpc_security_group_ids</b> 1413 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1414 <div style="font-size: small"> 1415 <span style="color: purple">list</span> 1416 / <span style="color: purple">elements=string</span> 1417 </div> 1418 </td> 1419 <td> 1420 </td> 1421 <td> 1422 <div>A list of EC2 VPC security groups to associate with the DB cluster.</div> 1423 </td> 1424 </tr> 1425 <tr> 1426 <td colspan="2"> 1427 <div class="ansibleOptionAnchor" id="parameter-"></div> 1428 <b>wait</b> 1429 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 1430 <div style="font-size: small"> 1431 <span style="color: purple">boolean</span> 1432 </div> 1433 </td> 1434 <td> 1435 <ul style="margin: 0; padding: 0"><b>Choices:</b> 1436 <li>no</li> 1437 <li><div style="color: blue"><b>yes</b> ←</div></li> 1438 </ul> 1439 </td> 1440 <td> 1441 <div>Whether to wait for the cluster to be available, stopped, or deleted. At a later time a wait_timeout option may be added. Following each API call to create/modify/delete the instance a waiter is used with a 60 second delay 30 times until the instance reaches the expected state (available/stopped/deleted). The total task time may also be influenced by AWSRetry which helps stabilize if the instance is in an invalid state to operate on to begin with (such as if you try to stop it when it is in the process of rebooting). If setting this to False task retries and delays may make your playbook execution better handle timeouts for major modifications.</div> 1442 </td> 1443 </tr> 1444 </table> 1445 <br/> 1446 1447 1448Notes 1449----- 1450 1451.. note:: 1452 - 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`` 1453 - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html 1454 - ``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 1455 1456 1457 1458Examples 1459-------- 1460 1461.. code-block:: yaml 1462 1463 # Note: These examples do not set authentication details, see the AWS Guide for details. 1464 - name: create minimal aurora instance in default VPC and default subnet group 1465 community.aws.rds_instance: 1466 engine: aurora 1467 db_instance_identifier: ansible-test-aurora-db-instance 1468 instance_type: db.t2.small 1469 password: "{{ password }}" 1470 username: "{{ username }}" 1471 cluster_id: ansible-test-cluster # This cluster must exist - see rds_cluster to manage it 1472 1473 - name: Create a DB instance using the default AWS KMS encryption key 1474 community.aws.rds_instance: 1475 id: test-encrypted-db 1476 state: present 1477 engine: mariadb 1478 storage_encrypted: True 1479 db_instance_class: db.t2.medium 1480 username: "{{ username }}" 1481 password: "{{ password }}" 1482 allocated_storage: "{{ allocated_storage }}" 1483 1484 - name: remove the DB instance without a final snapshot 1485 community.aws.rds_instance: 1486 id: "{{ instance_id }}" 1487 state: absent 1488 skip_final_snapshot: True 1489 1490 - name: remove the DB instance with a final snapshot 1491 community.aws.rds_instance: 1492 id: "{{ instance_id }}" 1493 state: absent 1494 final_snapshot_identifier: "{{ snapshot_id }}" 1495 1496 - name: Add a new security group without purge 1497 community.aws.rds_instance: 1498 id: "{{ instance_id }}" 1499 state: present 1500 vpc_security_group_ids: 1501 - sg-0be17ba10c9286b0b 1502 purge_security_groups: false 1503 register: result 1504 1505 1506 1507Return Values 1508------------- 1509Common 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: 1510 1511.. raw:: html 1512 1513 <table border=0 cellpadding=0 class="documentation-table"> 1514 <tr> 1515 <th colspan="4">Key</th> 1516 <th>Returned</th> 1517 <th width="100%">Description</th> 1518 </tr> 1519 <tr> 1520 <td colspan="4"> 1521 <div class="ansibleOptionAnchor" id="return-"></div> 1522 <b>allocated_storage</b> 1523 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1524 <div style="font-size: small"> 1525 <span style="color: purple">integer</span> 1526 </div> 1527 </td> 1528 <td>always</td> 1529 <td> 1530 <div>The allocated storage size in gibibytes. This is always 1 for aurora database engines.</div> 1531 <br/> 1532 <div style="font-size: smaller"><b>Sample:</b></div> 1533 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">20</div> 1534 </td> 1535 </tr> 1536 <tr> 1537 <td colspan="4"> 1538 <div class="ansibleOptionAnchor" id="return-"></div> 1539 <b>auto_minor_version_upgrade</b> 1540 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1541 <div style="font-size: small"> 1542 <span style="color: purple">boolean</span> 1543 </div> 1544 </td> 1545 <td>always</td> 1546 <td> 1547 <div>Whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.</div> 1548 <br/> 1549 <div style="font-size: smaller"><b>Sample:</b></div> 1550 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div> 1551 </td> 1552 </tr> 1553 <tr> 1554 <td colspan="4"> 1555 <div class="ansibleOptionAnchor" id="return-"></div> 1556 <b>availability_zone</b> 1557 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1558 <div style="font-size: small"> 1559 <span style="color: purple">string</span> 1560 </div> 1561 </td> 1562 <td>always</td> 1563 <td> 1564 <div>The availability zone for the DB instance.</div> 1565 <br/> 1566 <div style="font-size: smaller"><b>Sample:</b></div> 1567 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">us-east-1f</div> 1568 </td> 1569 </tr> 1570 <tr> 1571 <td colspan="4"> 1572 <div class="ansibleOptionAnchor" id="return-"></div> 1573 <b>backup_retention_period</b> 1574 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1575 <div style="font-size: small"> 1576 <span style="color: purple">integer</span> 1577 </div> 1578 </td> 1579 <td>always</td> 1580 <td> 1581 <div>The number of days for which automated backups are retained.</div> 1582 <br/> 1583 <div style="font-size: smaller"><b>Sample:</b></div> 1584 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">1</div> 1585 </td> 1586 </tr> 1587 <tr> 1588 <td colspan="4"> 1589 <div class="ansibleOptionAnchor" id="return-"></div> 1590 <b>ca_certificate_identifier</b> 1591 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1592 <div style="font-size: small"> 1593 <span style="color: purple">string</span> 1594 </div> 1595 </td> 1596 <td>always</td> 1597 <td> 1598 <div>The identifier of the CA certificate for the DB instance.</div> 1599 <br/> 1600 <div style="font-size: smaller"><b>Sample:</b></div> 1601 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">rds-ca-2015</div> 1602 </td> 1603 </tr> 1604 <tr> 1605 <td colspan="4"> 1606 <div class="ansibleOptionAnchor" id="return-"></div> 1607 <b>copy_tags_to_snapshot</b> 1608 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1609 <div style="font-size: small"> 1610 <span style="color: purple">boolean</span> 1611 </div> 1612 </td> 1613 <td>always</td> 1614 <td> 1615 <div>Whether tags are copied from the DB instance to snapshots of the DB instance.</div> 1616 <br/> 1617 </td> 1618 </tr> 1619 <tr> 1620 <td colspan="4"> 1621 <div class="ansibleOptionAnchor" id="return-"></div> 1622 <b>db_instance_arn</b> 1623 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1624 <div style="font-size: small"> 1625 <span style="color: purple">string</span> 1626 </div> 1627 </td> 1628 <td>always</td> 1629 <td> 1630 <div>The Amazon Resource Name (ARN) for the DB instance.</div> 1631 <br/> 1632 <div style="font-size: smaller"><b>Sample:</b></div> 1633 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">arn:aws:rds:us-east-1:123456789012:db:ansible-test</div> 1634 </td> 1635 </tr> 1636 <tr> 1637 <td colspan="4"> 1638 <div class="ansibleOptionAnchor" id="return-"></div> 1639 <b>db_instance_class</b> 1640 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1641 <div style="font-size: small"> 1642 <span style="color: purple">string</span> 1643 </div> 1644 </td> 1645 <td>always</td> 1646 <td> 1647 <div>The name of the compute and memory capacity class of the DB instance.</div> 1648 <br/> 1649 <div style="font-size: smaller"><b>Sample:</b></div> 1650 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">db.m4.large</div> 1651 </td> 1652 </tr> 1653 <tr> 1654 <td colspan="4"> 1655 <div class="ansibleOptionAnchor" id="return-"></div> 1656 <b>db_instance_identifier</b> 1657 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1658 <div style="font-size: small"> 1659 <span style="color: purple">string</span> 1660 </div> 1661 </td> 1662 <td>always</td> 1663 <td> 1664 <div>The identifier of the DB instance</div> 1665 <br/> 1666 <div style="font-size: smaller"><b>Sample:</b></div> 1667 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ansible-test</div> 1668 </td> 1669 </tr> 1670 <tr> 1671 <td colspan="4"> 1672 <div class="ansibleOptionAnchor" id="return-"></div> 1673 <b>db_instance_port</b> 1674 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1675 <div style="font-size: small"> 1676 <span style="color: purple">integer</span> 1677 </div> 1678 </td> 1679 <td>always</td> 1680 <td> 1681 <div>The port that the DB instance listens on.</div> 1682 <br/> 1683 </td> 1684 </tr> 1685 <tr> 1686 <td colspan="4"> 1687 <div class="ansibleOptionAnchor" id="return-"></div> 1688 <b>db_instance_status</b> 1689 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1690 <div style="font-size: small"> 1691 <span style="color: purple">string</span> 1692 </div> 1693 </td> 1694 <td>always</td> 1695 <td> 1696 <div>The current state of this database.</div> 1697 <br/> 1698 <div style="font-size: smaller"><b>Sample:</b></div> 1699 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">stopped</div> 1700 </td> 1701 </tr> 1702 <tr> 1703 <td colspan="4"> 1704 <div class="ansibleOptionAnchor" id="return-"></div> 1705 <b>db_parameter_groups</b> 1706 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1707 <div style="font-size: small"> 1708 <span style="color: purple">complex</span> 1709 </div> 1710 </td> 1711 <td>always</td> 1712 <td> 1713 <div>The list of DB parameter groups applied to this DB instance.</div> 1714 <br/> 1715 </td> 1716 </tr> 1717 <tr> 1718 <td class="elbow-placeholder"> </td> 1719 <td colspan="3"> 1720 <div class="ansibleOptionAnchor" id="return-"></div> 1721 <b>db_parameter_group_name</b> 1722 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1723 <div style="font-size: small"> 1724 <span style="color: purple">string</span> 1725 </div> 1726 </td> 1727 <td>always</td> 1728 <td> 1729 <div>The name of the DP parameter group.</div> 1730 <br/> 1731 <div style="font-size: smaller"><b>Sample:</b></div> 1732 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">default.mariadb10.0</div> 1733 </td> 1734 </tr> 1735 <tr> 1736 <td class="elbow-placeholder"> </td> 1737 <td colspan="3"> 1738 <div class="ansibleOptionAnchor" id="return-"></div> 1739 <b>parameter_apply_status</b> 1740 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1741 <div style="font-size: small"> 1742 <span style="color: purple">string</span> 1743 </div> 1744 </td> 1745 <td>always</td> 1746 <td> 1747 <div>The status of parameter updates.</div> 1748 <br/> 1749 <div style="font-size: smaller"><b>Sample:</b></div> 1750 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">in-sync</div> 1751 </td> 1752 </tr> 1753 1754 <tr> 1755 <td colspan="4"> 1756 <div class="ansibleOptionAnchor" id="return-"></div> 1757 <b>db_security_groups</b> 1758 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1759 <div style="font-size: small"> 1760 <span style="color: purple">list</span> 1761 </div> 1762 </td> 1763 <td>always</td> 1764 <td> 1765 <div>A list of DB security groups associated with this DB instance.</div> 1766 <br/> 1767 </td> 1768 </tr> 1769 <tr> 1770 <td colspan="4"> 1771 <div class="ansibleOptionAnchor" id="return-"></div> 1772 <b>db_subnet_group</b> 1773 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1774 <div style="font-size: small"> 1775 <span style="color: purple">complex</span> 1776 </div> 1777 </td> 1778 <td>always</td> 1779 <td> 1780 <div>The subnet group associated with the DB instance.</div> 1781 <br/> 1782 </td> 1783 </tr> 1784 <tr> 1785 <td class="elbow-placeholder"> </td> 1786 <td colspan="3"> 1787 <div class="ansibleOptionAnchor" id="return-"></div> 1788 <b>db_subnet_group_description</b> 1789 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1790 <div style="font-size: small"> 1791 <span style="color: purple">string</span> 1792 </div> 1793 </td> 1794 <td>always</td> 1795 <td> 1796 <div>The description of the DB subnet group.</div> 1797 <br/> 1798 <div style="font-size: smaller"><b>Sample:</b></div> 1799 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">default</div> 1800 </td> 1801 </tr> 1802 <tr> 1803 <td class="elbow-placeholder"> </td> 1804 <td colspan="3"> 1805 <div class="ansibleOptionAnchor" id="return-"></div> 1806 <b>db_subnet_group_name</b> 1807 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1808 <div style="font-size: small"> 1809 <span style="color: purple">string</span> 1810 </div> 1811 </td> 1812 <td>always</td> 1813 <td> 1814 <div>The name of the DB subnet group.</div> 1815 <br/> 1816 <div style="font-size: smaller"><b>Sample:</b></div> 1817 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">default</div> 1818 </td> 1819 </tr> 1820 <tr> 1821 <td class="elbow-placeholder"> </td> 1822 <td colspan="3"> 1823 <div class="ansibleOptionAnchor" id="return-"></div> 1824 <b>subnet_group_status</b> 1825 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1826 <div style="font-size: small"> 1827 <span style="color: purple">string</span> 1828 </div> 1829 </td> 1830 <td>always</td> 1831 <td> 1832 <div>The status of the DB subnet group.</div> 1833 <br/> 1834 <div style="font-size: smaller"><b>Sample:</b></div> 1835 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Complete</div> 1836 </td> 1837 </tr> 1838 <tr> 1839 <td class="elbow-placeholder"> </td> 1840 <td colspan="3"> 1841 <div class="ansibleOptionAnchor" id="return-"></div> 1842 <b>subnets</b> 1843 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1844 <div style="font-size: small"> 1845 <span style="color: purple">complex</span> 1846 </div> 1847 </td> 1848 <td>always</td> 1849 <td> 1850 <div>A list of Subnet elements.</div> 1851 <br/> 1852 </td> 1853 </tr> 1854 <tr> 1855 <td class="elbow-placeholder"> </td> 1856 <td class="elbow-placeholder"> </td> 1857 <td colspan="2"> 1858 <div class="ansibleOptionAnchor" id="return-"></div> 1859 <b>subnet_availability_zone</b> 1860 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1861 <div style="font-size: small"> 1862 <span style="color: purple">complex</span> 1863 </div> 1864 </td> 1865 <td>always</td> 1866 <td> 1867 <div>The availability zone of the subnet.</div> 1868 <br/> 1869 </td> 1870 </tr> 1871 <tr> 1872 <td class="elbow-placeholder"> </td> 1873 <td class="elbow-placeholder"> </td> 1874 <td class="elbow-placeholder"> </td> 1875 <td colspan="1"> 1876 <div class="ansibleOptionAnchor" id="return-"></div> 1877 <b>name</b> 1878 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1879 <div style="font-size: small"> 1880 <span style="color: purple">string</span> 1881 </div> 1882 </td> 1883 <td>always</td> 1884 <td> 1885 <div>The name of the Availability Zone.</div> 1886 <br/> 1887 <div style="font-size: smaller"><b>Sample:</b></div> 1888 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">us-east-1c</div> 1889 </td> 1890 </tr> 1891 1892 <tr> 1893 <td class="elbow-placeholder"> </td> 1894 <td class="elbow-placeholder"> </td> 1895 <td colspan="2"> 1896 <div class="ansibleOptionAnchor" id="return-"></div> 1897 <b>subnet_identifier</b> 1898 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1899 <div style="font-size: small"> 1900 <span style="color: purple">string</span> 1901 </div> 1902 </td> 1903 <td>always</td> 1904 <td> 1905 <div>The ID of the subnet.</div> 1906 <br/> 1907 <div style="font-size: smaller"><b>Sample:</b></div> 1908 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">subnet-12345678</div> 1909 </td> 1910 </tr> 1911 <tr> 1912 <td class="elbow-placeholder"> </td> 1913 <td class="elbow-placeholder"> </td> 1914 <td colspan="2"> 1915 <div class="ansibleOptionAnchor" id="return-"></div> 1916 <b>subnet_status</b> 1917 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1918 <div style="font-size: small"> 1919 <span style="color: purple">string</span> 1920 </div> 1921 </td> 1922 <td>always</td> 1923 <td> 1924 <div>The status of the subnet.</div> 1925 <br/> 1926 <div style="font-size: smaller"><b>Sample:</b></div> 1927 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Active</div> 1928 </td> 1929 </tr> 1930 1931 <tr> 1932 <td class="elbow-placeholder"> </td> 1933 <td colspan="3"> 1934 <div class="ansibleOptionAnchor" id="return-"></div> 1935 <b>vpc_id</b> 1936 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1937 <div style="font-size: small"> 1938 <span style="color: purple">string</span> 1939 </div> 1940 </td> 1941 <td>always</td> 1942 <td> 1943 <div>The VpcId of the DB subnet group.</div> 1944 <br/> 1945 <div style="font-size: smaller"><b>Sample:</b></div> 1946 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">vpc-12345678</div> 1947 </td> 1948 </tr> 1949 1950 <tr> 1951 <td colspan="4"> 1952 <div class="ansibleOptionAnchor" id="return-"></div> 1953 <b>dbi_resource_id</b> 1954 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1955 <div style="font-size: small"> 1956 <span style="color: purple">string</span> 1957 </div> 1958 </td> 1959 <td>always</td> 1960 <td> 1961 <div>The AWS Region-unique, immutable identifier for the DB instance.</div> 1962 <br/> 1963 <div style="font-size: smaller"><b>Sample:</b></div> 1964 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">db-UHV3QRNWX4KB6GALCIGRML6QFA</div> 1965 </td> 1966 </tr> 1967 <tr> 1968 <td colspan="4"> 1969 <div class="ansibleOptionAnchor" id="return-"></div> 1970 <b>domain_memberships</b> 1971 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1972 <div style="font-size: small"> 1973 <span style="color: purple">list</span> 1974 </div> 1975 </td> 1976 <td>always</td> 1977 <td> 1978 <div>The Active Directory Domain membership records associated with the DB instance.</div> 1979 <br/> 1980 </td> 1981 </tr> 1982 <tr> 1983 <td colspan="4"> 1984 <div class="ansibleOptionAnchor" id="return-"></div> 1985 <b>endpoint</b> 1986 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1987 <div style="font-size: small"> 1988 <span style="color: purple">complex</span> 1989 </div> 1990 </td> 1991 <td>always</td> 1992 <td> 1993 <div>The connection endpoint.</div> 1994 <br/> 1995 </td> 1996 </tr> 1997 <tr> 1998 <td class="elbow-placeholder"> </td> 1999 <td colspan="3"> 2000 <div class="ansibleOptionAnchor" id="return-"></div> 2001 <b>address</b> 2002 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2003 <div style="font-size: small"> 2004 <span style="color: purple">string</span> 2005 </div> 2006 </td> 2007 <td>always</td> 2008 <td> 2009 <div>The DNS address of the DB instance.</div> 2010 <br/> 2011 <div style="font-size: smaller"><b>Sample:</b></div> 2012 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ansible-test.cvlrtwiennww.us-east-1.rds.amazonaws.com</div> 2013 </td> 2014 </tr> 2015 <tr> 2016 <td class="elbow-placeholder"> </td> 2017 <td colspan="3"> 2018 <div class="ansibleOptionAnchor" id="return-"></div> 2019 <b>hosted_zone_id</b> 2020 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2021 <div style="font-size: small"> 2022 <span style="color: purple">string</span> 2023 </div> 2024 </td> 2025 <td>always</td> 2026 <td> 2027 <div>The ID that Amazon Route 53 assigns when you create a hosted zone.</div> 2028 <br/> 2029 <div style="font-size: smaller"><b>Sample:</b></div> 2030 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ZTR2ITUGPA61AM</div> 2031 </td> 2032 </tr> 2033 <tr> 2034 <td class="elbow-placeholder"> </td> 2035 <td colspan="3"> 2036 <div class="ansibleOptionAnchor" id="return-"></div> 2037 <b>port</b> 2038 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2039 <div style="font-size: small"> 2040 <span style="color: purple">integer</span> 2041 </div> 2042 </td> 2043 <td>always</td> 2044 <td> 2045 <div>The port that the database engine is listening on.</div> 2046 <br/> 2047 <div style="font-size: smaller"><b>Sample:</b></div> 2048 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">3306</div> 2049 </td> 2050 </tr> 2051 2052 <tr> 2053 <td colspan="4"> 2054 <div class="ansibleOptionAnchor" id="return-"></div> 2055 <b>engine</b> 2056 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2057 <div style="font-size: small"> 2058 <span style="color: purple">string</span> 2059 </div> 2060 </td> 2061 <td>always</td> 2062 <td> 2063 <div>The database engine version.</div> 2064 <br/> 2065 <div style="font-size: smaller"><b>Sample:</b></div> 2066 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">mariadb</div> 2067 </td> 2068 </tr> 2069 <tr> 2070 <td colspan="4"> 2071 <div class="ansibleOptionAnchor" id="return-"></div> 2072 <b>engine_version</b> 2073 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2074 <div style="font-size: small"> 2075 <span style="color: purple">string</span> 2076 </div> 2077 </td> 2078 <td>always</td> 2079 <td> 2080 <div>The database engine version.</div> 2081 <br/> 2082 <div style="font-size: smaller"><b>Sample:</b></div> 2083 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">10.0.35</div> 2084 </td> 2085 </tr> 2086 <tr> 2087 <td colspan="4"> 2088 <div class="ansibleOptionAnchor" id="return-"></div> 2089 <b>iam_database_authentication_enabled</b> 2090 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2091 <div style="font-size: small"> 2092 <span style="color: purple">boolean</span> 2093 </div> 2094 </td> 2095 <td>always</td> 2096 <td> 2097 <div>Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.</div> 2098 <br/> 2099 </td> 2100 </tr> 2101 <tr> 2102 <td colspan="4"> 2103 <div class="ansibleOptionAnchor" id="return-"></div> 2104 <b>instance_create_time</b> 2105 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2106 <div style="font-size: small"> 2107 <span style="color: purple">string</span> 2108 </div> 2109 </td> 2110 <td>always</td> 2111 <td> 2112 <div>The date and time the DB instance was created.</div> 2113 <br/> 2114 <div style="font-size: smaller"><b>Sample:</b></div> 2115 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">2018-07-04T16:48:35.332000+00:00</div> 2116 </td> 2117 </tr> 2118 <tr> 2119 <td colspan="4"> 2120 <div class="ansibleOptionAnchor" id="return-"></div> 2121 <b>kms_key_id</b> 2122 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2123 <div style="font-size: small"> 2124 <span style="color: purple">string</span> 2125 </div> 2126 </td> 2127 <td>When storage_encrypted is true</td> 2128 <td> 2129 <div>The AWS KMS key identifier for the encrypted DB instance when storage_encrypted is true.</div> 2130 <br/> 2131 <div style="font-size: smaller"><b>Sample:</b></div> 2132 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">arn:aws:kms:us-east-1:123456789012:key/70c45553-ad2e-4a85-9f14-cfeb47555c33</div> 2133 </td> 2134 </tr> 2135 <tr> 2136 <td colspan="4"> 2137 <div class="ansibleOptionAnchor" id="return-"></div> 2138 <b>latest_restorable_time</b> 2139 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2140 <div style="font-size: small"> 2141 <span style="color: purple">string</span> 2142 </div> 2143 </td> 2144 <td>always</td> 2145 <td> 2146 <div>The latest time to which a database can be restored with point-in-time restore.</div> 2147 <br/> 2148 <div style="font-size: smaller"><b>Sample:</b></div> 2149 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">2018-07-04T16:50:50.642000+00:00</div> 2150 </td> 2151 </tr> 2152 <tr> 2153 <td colspan="4"> 2154 <div class="ansibleOptionAnchor" id="return-"></div> 2155 <b>license_model</b> 2156 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2157 <div style="font-size: small"> 2158 <span style="color: purple">string</span> 2159 </div> 2160 </td> 2161 <td>always</td> 2162 <td> 2163 <div>The License model information for this DB instance.</div> 2164 <br/> 2165 <div style="font-size: smaller"><b>Sample:</b></div> 2166 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">general-public-license</div> 2167 </td> 2168 </tr> 2169 <tr> 2170 <td colspan="4"> 2171 <div class="ansibleOptionAnchor" id="return-"></div> 2172 <b>master_username</b> 2173 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2174 <div style="font-size: small"> 2175 <span style="color: purple">string</span> 2176 </div> 2177 </td> 2178 <td>always</td> 2179 <td> 2180 <div>The master username for the DB instance.</div> 2181 <br/> 2182 <div style="font-size: smaller"><b>Sample:</b></div> 2183 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">test</div> 2184 </td> 2185 </tr> 2186 <tr> 2187 <td colspan="4"> 2188 <div class="ansibleOptionAnchor" id="return-"></div> 2189 <b>max_allocated_storage</b> 2190 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2191 <div style="font-size: small"> 2192 <span style="color: purple">integer</span> 2193 </div> 2194 </td> 2195 <td>When max allocated storage is present.</td> 2196 <td> 2197 <div>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</div> 2198 <br/> 2199 <div style="font-size: smaller"><b>Sample:</b></div> 2200 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">100</div> 2201 </td> 2202 </tr> 2203 <tr> 2204 <td colspan="4"> 2205 <div class="ansibleOptionAnchor" id="return-"></div> 2206 <b>monitoring_interval</b> 2207 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2208 <div style="font-size: small"> 2209 <span style="color: purple">integer</span> 2210 </div> 2211 </td> 2212 <td>always</td> 2213 <td> 2214 <div>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. 0 means collecting Enhanced Monitoring metrics is disabled.</div> 2215 <br/> 2216 </td> 2217 </tr> 2218 <tr> 2219 <td colspan="4"> 2220 <div class="ansibleOptionAnchor" id="return-"></div> 2221 <b>multi_az</b> 2222 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2223 <div style="font-size: small"> 2224 <span style="color: purple">boolean</span> 2225 </div> 2226 </td> 2227 <td>always</td> 2228 <td> 2229 <div>Whether the DB instance is a Multi-AZ deployment.</div> 2230 <br/> 2231 </td> 2232 </tr> 2233 <tr> 2234 <td colspan="4"> 2235 <div class="ansibleOptionAnchor" id="return-"></div> 2236 <b>option_group_memberships</b> 2237 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2238 <div style="font-size: small"> 2239 <span style="color: purple">complex</span> 2240 </div> 2241 </td> 2242 <td>always</td> 2243 <td> 2244 <div>The list of option group memberships for this DB instance.</div> 2245 <br/> 2246 </td> 2247 </tr> 2248 <tr> 2249 <td class="elbow-placeholder"> </td> 2250 <td colspan="3"> 2251 <div class="ansibleOptionAnchor" id="return-"></div> 2252 <b>option_group_name</b> 2253 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2254 <div style="font-size: small"> 2255 <span style="color: purple">string</span> 2256 </div> 2257 </td> 2258 <td>always</td> 2259 <td> 2260 <div>The name of the option group that the instance belongs to.</div> 2261 <br/> 2262 <div style="font-size: smaller"><b>Sample:</b></div> 2263 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">default:mariadb-10-0</div> 2264 </td> 2265 </tr> 2266 <tr> 2267 <td class="elbow-placeholder"> </td> 2268 <td colspan="3"> 2269 <div class="ansibleOptionAnchor" id="return-"></div> 2270 <b>status</b> 2271 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2272 <div style="font-size: small"> 2273 <span style="color: purple">string</span> 2274 </div> 2275 </td> 2276 <td>always</td> 2277 <td> 2278 <div>The status of the DB instance's option group membership.</div> 2279 <br/> 2280 <div style="font-size: smaller"><b>Sample:</b></div> 2281 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">in-sync</div> 2282 </td> 2283 </tr> 2284 2285 <tr> 2286 <td colspan="4"> 2287 <div class="ansibleOptionAnchor" id="return-"></div> 2288 <b>pending_modified_values</b> 2289 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2290 <div style="font-size: small"> 2291 <span style="color: purple">complex</span> 2292 </div> 2293 </td> 2294 <td>always</td> 2295 <td> 2296 <div>The changes to the DB instance that are pending.</div> 2297 <br/> 2298 </td> 2299 </tr> 2300 <tr> 2301 <td colspan="4"> 2302 <div class="ansibleOptionAnchor" id="return-"></div> 2303 <b>performance_insights_enabled</b> 2304 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2305 <div style="font-size: small"> 2306 <span style="color: purple">boolean</span> 2307 </div> 2308 </td> 2309 <td>always</td> 2310 <td> 2311 <div>True if Performance Insights is enabled for the DB instance, and otherwise false.</div> 2312 <br/> 2313 </td> 2314 </tr> 2315 <tr> 2316 <td colspan="4"> 2317 <div class="ansibleOptionAnchor" id="return-"></div> 2318 <b>preferred_backup_window</b> 2319 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2320 <div style="font-size: small"> 2321 <span style="color: purple">string</span> 2322 </div> 2323 </td> 2324 <td>always</td> 2325 <td> 2326 <div>The daily time range during which automated backups are created if automated backups are enabled.</div> 2327 <br/> 2328 <div style="font-size: smaller"><b>Sample:</b></div> 2329 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">07:01-07:31</div> 2330 </td> 2331 </tr> 2332 <tr> 2333 <td colspan="4"> 2334 <div class="ansibleOptionAnchor" id="return-"></div> 2335 <b>preferred_maintenance_window</b> 2336 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2337 <div style="font-size: small"> 2338 <span style="color: purple">string</span> 2339 </div> 2340 </td> 2341 <td>always</td> 2342 <td> 2343 <div>The weekly time range (in UTC) during which system maintenance can occur.</div> 2344 <br/> 2345 <div style="font-size: smaller"><b>Sample:</b></div> 2346 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">sun:09:31-sun:10:01</div> 2347 </td> 2348 </tr> 2349 <tr> 2350 <td colspan="4"> 2351 <div class="ansibleOptionAnchor" id="return-"></div> 2352 <b>publicly_accessible</b> 2353 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2354 <div style="font-size: small"> 2355 <span style="color: purple">boolean</span> 2356 </div> 2357 </td> 2358 <td>always</td> 2359 <td> 2360 <div>True for an Internet-facing instance with a publicly resolvable DNS name, False to indicate an internal instance with a DNS name that resolves to a private IP address.</div> 2361 <br/> 2362 <div style="font-size: smaller"><b>Sample:</b></div> 2363 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div> 2364 </td> 2365 </tr> 2366 <tr> 2367 <td colspan="4"> 2368 <div class="ansibleOptionAnchor" id="return-"></div> 2369 <b>read_replica_db_instance_identifiers</b> 2370 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2371 <div style="font-size: small"> 2372 <span style="color: purple">list</span> 2373 </div> 2374 </td> 2375 <td>always</td> 2376 <td> 2377 <div>Identifiers of the Read Replicas associated with this DB instance.</div> 2378 <br/> 2379 </td> 2380 </tr> 2381 <tr> 2382 <td colspan="4"> 2383 <div class="ansibleOptionAnchor" id="return-"></div> 2384 <b>storage_encrypted</b> 2385 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2386 <div style="font-size: small"> 2387 <span style="color: purple">boolean</span> 2388 </div> 2389 </td> 2390 <td>always</td> 2391 <td> 2392 <div>Whether the DB instance is encrypted.</div> 2393 <br/> 2394 </td> 2395 </tr> 2396 <tr> 2397 <td colspan="4"> 2398 <div class="ansibleOptionAnchor" id="return-"></div> 2399 <b>storage_type</b> 2400 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2401 <div style="font-size: small"> 2402 <span style="color: purple">string</span> 2403 </div> 2404 </td> 2405 <td>always</td> 2406 <td> 2407 <div>The storage type to be associated with the DB instance.</div> 2408 <br/> 2409 <div style="font-size: smaller"><b>Sample:</b></div> 2410 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">standard</div> 2411 </td> 2412 </tr> 2413 <tr> 2414 <td colspan="4"> 2415 <div class="ansibleOptionAnchor" id="return-"></div> 2416 <b>tags</b> 2417 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2418 <div style="font-size: small"> 2419 <span style="color: purple">complex</span> 2420 </div> 2421 </td> 2422 <td>always</td> 2423 <td> 2424 <div>A dictionary of tags associated with the DB instance.</div> 2425 <br/> 2426 </td> 2427 </tr> 2428 <tr> 2429 <td colspan="4"> 2430 <div class="ansibleOptionAnchor" id="return-"></div> 2431 <b>vpc_security_groups</b> 2432 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2433 <div style="font-size: small"> 2434 <span style="color: purple">complex</span> 2435 </div> 2436 </td> 2437 <td>always</td> 2438 <td> 2439 <div>A list of VPC security group elements that the DB instance belongs to.</div> 2440 <br/> 2441 </td> 2442 </tr> 2443 <tr> 2444 <td class="elbow-placeholder"> </td> 2445 <td colspan="3"> 2446 <div class="ansibleOptionAnchor" id="return-"></div> 2447 <b>status</b> 2448 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2449 <div style="font-size: small"> 2450 <span style="color: purple">string</span> 2451 </div> 2452 </td> 2453 <td>always</td> 2454 <td> 2455 <div>The status of the VPC security group.</div> 2456 <br/> 2457 <div style="font-size: smaller"><b>Sample:</b></div> 2458 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">active</div> 2459 </td> 2460 </tr> 2461 <tr> 2462 <td class="elbow-placeholder"> </td> 2463 <td colspan="3"> 2464 <div class="ansibleOptionAnchor" id="return-"></div> 2465 <b>vpc_security_group_id</b> 2466 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 2467 <div style="font-size: small"> 2468 <span style="color: purple">string</span> 2469 </div> 2470 </td> 2471 <td>always</td> 2472 <td> 2473 <div>The name of the VPC security group.</div> 2474 <br/> 2475 <div style="font-size: smaller"><b>Sample:</b></div> 2476 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">sg-12345678</div> 2477 </td> 2478 </tr> 2479 2480 </table> 2481 <br/><br/> 2482 2483 2484Status 2485------ 2486 2487 2488Authors 2489~~~~~~~ 2490 2491- Sloane Hertel (@s-hertel) 2492