1.. _community.aws.elasticache_info_module: 2 3 4****************************** 5community.aws.elasticache_info 6****************************** 7 8**Retrieve information for AWS ElastiCache clusters** 9 10 11Version added: 1.0.0 12 13.. contents:: 14 :local: 15 :depth: 1 16 17 18Synopsis 19-------- 20- Retrieve information from AWS ElastiCache clusters 21- This module was called ``elasticache_facts`` before Ansible 2.9. The usage did not change. 22 23 24 25Requirements 26------------ 27The below requirements are needed on the host that executes this module. 28 29- python >= 2.6 30- boto 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>debug_botocore_endpoint_logs</b> 118 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 119 <div style="font-size: small"> 120 <span style="color: purple">boolean</span> 121 </div> 122 </td> 123 <td> 124 <ul style="margin: 0; padding: 0"><b>Choices:</b> 125 <li><div style="color: blue"><b>no</b> ←</div></li> 126 <li>yes</li> 127 </ul> 128 </td> 129 <td> 130 <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> 131 </td> 132 </tr> 133 <tr> 134 <td colspan="1"> 135 <div class="ansibleOptionAnchor" id="parameter-"></div> 136 <b>ec2_url</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>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> 146 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_endpoint_url, endpoint_url</div> 147 </td> 148 </tr> 149 <tr> 150 <td colspan="1"> 151 <div class="ansibleOptionAnchor" id="parameter-"></div> 152 <b>name</b> 153 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 154 <div style="font-size: small"> 155 <span style="color: purple">string</span> 156 </div> 157 </td> 158 <td> 159 </td> 160 <td> 161 <div>The name of an ElastiCache cluster.</div> 162 </td> 163 </tr> 164 <tr> 165 <td colspan="1"> 166 <div class="ansibleOptionAnchor" id="parameter-"></div> 167 <b>profile</b> 168 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 169 <div style="font-size: small"> 170 <span style="color: purple">string</span> 171 </div> 172 </td> 173 <td> 174 </td> 175 <td> 176 <div>Uses a boto profile. Only works with boto >= 2.24.0.</div> 177 <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> 178 <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> 179 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div> 180 </td> 181 </tr> 182 <tr> 183 <td colspan="1"> 184 <div class="ansibleOptionAnchor" id="parameter-"></div> 185 <b>region</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>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> 195 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_region, ec2_region</div> 196 </td> 197 </tr> 198 <tr> 199 <td colspan="1"> 200 <div class="ansibleOptionAnchor" id="parameter-"></div> 201 <b>security_token</b> 202 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 203 <div style="font-size: small"> 204 <span style="color: purple">string</span> 205 </div> 206 </td> 207 <td> 208 </td> 209 <td> 210 <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> 211 <div>If <em>profile</em> is set this parameter is ignored.</div> 212 <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> 213 <div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div> 214 </td> 215 </tr> 216 <tr> 217 <td colspan="1"> 218 <div class="ansibleOptionAnchor" id="parameter-"></div> 219 <b>validate_certs</b> 220 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 221 <div style="font-size: small"> 222 <span style="color: purple">boolean</span> 223 </div> 224 </td> 225 <td> 226 <ul style="margin: 0; padding: 0"><b>Choices:</b> 227 <li>no</li> 228 <li><div style="color: blue"><b>yes</b> ←</div></li> 229 </ul> 230 </td> 231 <td> 232 <div>When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.</div> 233 </td> 234 </tr> 235 </table> 236 <br/> 237 238 239Notes 240----- 241 242.. note:: 243 - 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`` 244 - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html 245 - ``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 246 247 248 249Examples 250-------- 251 252.. code-block:: yaml 253 254 - name: obtain all ElastiCache information 255 community.aws.elasticache_info: 256 257 - name: obtain all information for a single ElastiCache cluster 258 community.aws.elasticache_info: 259 name: test_elasticache 260 261 262 263Return Values 264------------- 265Common 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: 266 267.. raw:: html 268 269 <table border=0 cellpadding=0 class="documentation-table"> 270 <tr> 271 <th colspan="4">Key</th> 272 <th>Returned</th> 273 <th width="100%">Description</th> 274 </tr> 275 <tr> 276 <td colspan="4"> 277 <div class="ansibleOptionAnchor" id="return-"></div> 278 <b>elasticache_clusters</b> 279 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 280 <div style="font-size: small"> 281 <span style="color: purple">complex</span> 282 </div> 283 </td> 284 <td>always</td> 285 <td> 286 <div>List of ElastiCache clusters</div> 287 <br/> 288 </td> 289 </tr> 290 <tr> 291 <td class="elbow-placeholder"> </td> 292 <td colspan="3"> 293 <div class="ansibleOptionAnchor" id="return-"></div> 294 <b>auto_minor_version_upgrade</b> 295 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 296 <div style="font-size: small"> 297 <span style="color: purple">boolean</span> 298 </div> 299 </td> 300 <td>always</td> 301 <td> 302 <div>Whether to automatically upgrade to minor versions</div> 303 <br/> 304 <div style="font-size: smaller"><b>Sample:</b></div> 305 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">True</div> 306 </td> 307 </tr> 308 <tr> 309 <td class="elbow-placeholder"> </td> 310 <td colspan="3"> 311 <div class="ansibleOptionAnchor" id="return-"></div> 312 <b>cache_cluster_create_time</b> 313 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 314 <div style="font-size: small"> 315 <span style="color: purple">string</span> 316 </div> 317 </td> 318 <td>always</td> 319 <td> 320 <div>Date and time cluster was created</div> 321 <br/> 322 <div style="font-size: smaller"><b>Sample:</b></div> 323 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">2017-09-15T05:43:46.038000+00:00</div> 324 </td> 325 </tr> 326 <tr> 327 <td class="elbow-placeholder"> </td> 328 <td colspan="3"> 329 <div class="ansibleOptionAnchor" id="return-"></div> 330 <b>cache_cluster_id</b> 331 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 332 <div style="font-size: small"> 333 <span style="color: purple">string</span> 334 </div> 335 </td> 336 <td>always</td> 337 <td> 338 <div>ID of the cache cluster</div> 339 <br/> 340 <div style="font-size: smaller"><b>Sample:</b></div> 341 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">abcd-1234-001</div> 342 </td> 343 </tr> 344 <tr> 345 <td class="elbow-placeholder"> </td> 346 <td colspan="3"> 347 <div class="ansibleOptionAnchor" id="return-"></div> 348 <b>cache_cluster_status</b> 349 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 350 <div style="font-size: small"> 351 <span style="color: purple">string</span> 352 </div> 353 </td> 354 <td>always</td> 355 <td> 356 <div>Status of ElastiCache cluster</div> 357 <br/> 358 <div style="font-size: smaller"><b>Sample:</b></div> 359 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">available</div> 360 </td> 361 </tr> 362 <tr> 363 <td class="elbow-placeholder"> </td> 364 <td colspan="3"> 365 <div class="ansibleOptionAnchor" id="return-"></div> 366 <b>cache_node_type</b> 367 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 368 <div style="font-size: small"> 369 <span style="color: purple">string</span> 370 </div> 371 </td> 372 <td>always</td> 373 <td> 374 <div>Instance type of ElastiCache nodes</div> 375 <br/> 376 <div style="font-size: smaller"><b>Sample:</b></div> 377 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">cache.t2.micro</div> 378 </td> 379 </tr> 380 <tr> 381 <td class="elbow-placeholder"> </td> 382 <td colspan="3"> 383 <div class="ansibleOptionAnchor" id="return-"></div> 384 <b>cache_nodes</b> 385 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 386 <div style="font-size: small"> 387 <span style="color: purple">complex</span> 388 </div> 389 </td> 390 <td>always</td> 391 <td> 392 <div>List of ElastiCache nodes in the cluster</div> 393 <br/> 394 </td> 395 </tr> 396 <tr> 397 <td class="elbow-placeholder"> </td> 398 <td class="elbow-placeholder"> </td> 399 <td colspan="2"> 400 <div class="ansibleOptionAnchor" id="return-"></div> 401 <b>cache_node_create_time</b> 402 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 403 <div style="font-size: small"> 404 <span style="color: purple">string</span> 405 </div> 406 </td> 407 <td>always</td> 408 <td> 409 <div>Date and time node was created</div> 410 <br/> 411 <div style="font-size: smaller"><b>Sample:</b></div> 412 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">2017-09-15T05:43:46.038000+00:00</div> 413 </td> 414 </tr> 415 <tr> 416 <td class="elbow-placeholder"> </td> 417 <td class="elbow-placeholder"> </td> 418 <td colspan="2"> 419 <div class="ansibleOptionAnchor" id="return-"></div> 420 <b>cache_node_id</b> 421 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 422 <div style="font-size: small"> 423 <span style="color: purple">string</span> 424 </div> 425 </td> 426 <td>always</td> 427 <td> 428 <div>ID of the cache node</div> 429 <br/> 430 <div style="font-size: smaller"><b>Sample:</b></div> 431 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">0001</div> 432 </td> 433 </tr> 434 <tr> 435 <td class="elbow-placeholder"> </td> 436 <td class="elbow-placeholder"> </td> 437 <td colspan="2"> 438 <div class="ansibleOptionAnchor" id="return-"></div> 439 <b>cache_node_status</b> 440 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 441 <div style="font-size: small"> 442 <span style="color: purple">string</span> 443 </div> 444 </td> 445 <td>always</td> 446 <td> 447 <div>Status of the cache node</div> 448 <br/> 449 <div style="font-size: smaller"><b>Sample:</b></div> 450 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">available</div> 451 </td> 452 </tr> 453 <tr> 454 <td class="elbow-placeholder"> </td> 455 <td class="elbow-placeholder"> </td> 456 <td colspan="2"> 457 <div class="ansibleOptionAnchor" id="return-"></div> 458 <b>customer_availability_zone</b> 459 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 460 <div style="font-size: small"> 461 <span style="color: purple">string</span> 462 </div> 463 </td> 464 <td>always</td> 465 <td> 466 <div>Availability Zone in which the cache node was created</div> 467 <br/> 468 <div style="font-size: smaller"><b>Sample:</b></div> 469 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ap-southeast-2b</div> 470 </td> 471 </tr> 472 <tr> 473 <td class="elbow-placeholder"> </td> 474 <td class="elbow-placeholder"> </td> 475 <td colspan="2"> 476 <div class="ansibleOptionAnchor" id="return-"></div> 477 <b>endpoint</b> 478 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 479 <div style="font-size: small"> 480 <span style="color: purple">complex</span> 481 </div> 482 </td> 483 <td>always</td> 484 <td> 485 <div>Connection details for the cache node</div> 486 <br/> 487 </td> 488 </tr> 489 <tr> 490 <td class="elbow-placeholder"> </td> 491 <td class="elbow-placeholder"> </td> 492 <td class="elbow-placeholder"> </td> 493 <td colspan="1"> 494 <div class="ansibleOptionAnchor" id="return-"></div> 495 <b>address</b> 496 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 497 <div style="font-size: small"> 498 <span style="color: purple">string</span> 499 </div> 500 </td> 501 <td>always</td> 502 <td> 503 <div>URL of the cache node endpoint</div> 504 <br/> 505 <div style="font-size: smaller"><b>Sample:</b></div> 506 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com</div> 507 </td> 508 </tr> 509 <tr> 510 <td class="elbow-placeholder"> </td> 511 <td class="elbow-placeholder"> </td> 512 <td class="elbow-placeholder"> </td> 513 <td colspan="1"> 514 <div class="ansibleOptionAnchor" id="return-"></div> 515 <b>port</b> 516 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 517 <div style="font-size: small"> 518 <span style="color: purple">integer</span> 519 </div> 520 </td> 521 <td>always</td> 522 <td> 523 <div>Port of the cache node endpoint</div> 524 <br/> 525 <div style="font-size: smaller"><b>Sample:</b></div> 526 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">6379</div> 527 </td> 528 </tr> 529 530 <tr> 531 <td class="elbow-placeholder"> </td> 532 <td class="elbow-placeholder"> </td> 533 <td colspan="2"> 534 <div class="ansibleOptionAnchor" id="return-"></div> 535 <b>parameter_group_status</b> 536 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 537 <div style="font-size: small"> 538 <span style="color: purple">string</span> 539 </div> 540 </td> 541 <td>always</td> 542 <td> 543 <div>Status of the Cache Parameter Group</div> 544 <br/> 545 <div style="font-size: smaller"><b>Sample:</b></div> 546 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">in-sync</div> 547 </td> 548 </tr> 549 550 <tr> 551 <td class="elbow-placeholder"> </td> 552 <td colspan="3"> 553 <div class="ansibleOptionAnchor" id="return-"></div> 554 <b>cache_parameter_group</b> 555 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 556 <div style="font-size: small"> 557 <span style="color: purple">complex</span> 558 </div> 559 </td> 560 <td>always</td> 561 <td> 562 <div>Contents of the Cache Parameter Group</div> 563 <br/> 564 </td> 565 </tr> 566 <tr> 567 <td class="elbow-placeholder"> </td> 568 <td class="elbow-placeholder"> </td> 569 <td colspan="2"> 570 <div class="ansibleOptionAnchor" id="return-"></div> 571 <b>cache_node_ids_to_reboot</b> 572 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 573 <div style="font-size: small"> 574 <span style="color: purple">list</span> 575 </div> 576 </td> 577 <td>always</td> 578 <td> 579 <div>Cache nodes which need to be rebooted for parameter changes to be applied</div> 580 <br/> 581 </td> 582 </tr> 583 <tr> 584 <td class="elbow-placeholder"> </td> 585 <td class="elbow-placeholder"> </td> 586 <td colspan="2"> 587 <div class="ansibleOptionAnchor" id="return-"></div> 588 <b>cache_parameter_group_name</b> 589 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 590 <div style="font-size: small"> 591 <span style="color: purple">string</span> 592 </div> 593 </td> 594 <td>always</td> 595 <td> 596 <div>Name of the cache parameter group</div> 597 <br/> 598 <div style="font-size: smaller"><b>Sample:</b></div> 599 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">default.redis3.2</div> 600 </td> 601 </tr> 602 <tr> 603 <td class="elbow-placeholder"> </td> 604 <td class="elbow-placeholder"> </td> 605 <td colspan="2"> 606 <div class="ansibleOptionAnchor" id="return-"></div> 607 <b>parameter_apply_status</b> 608 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 609 <div style="font-size: small"> 610 <span style="color: purple">string</span> 611 </div> 612 </td> 613 <td>always</td> 614 <td> 615 <div>Status of parameter updates</div> 616 <br/> 617 <div style="font-size: smaller"><b>Sample:</b></div> 618 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">in-sync</div> 619 </td> 620 </tr> 621 622 <tr> 623 <td class="elbow-placeholder"> </td> 624 <td colspan="3"> 625 <div class="ansibleOptionAnchor" id="return-"></div> 626 <b>cache_security_groups</b> 627 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 628 <div style="font-size: small"> 629 <span style="color: purple">list</span> 630 </div> 631 </td> 632 <td>always</td> 633 <td> 634 <div>Security Groups used by the cache</div> 635 <br/> 636 <div style="font-size: smaller"><b>Sample:</b></div> 637 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['sg-abcd1234']</div> 638 </td> 639 </tr> 640 <tr> 641 <td class="elbow-placeholder"> </td> 642 <td colspan="3"> 643 <div class="ansibleOptionAnchor" id="return-"></div> 644 <b>cache_subnet_group_name</b> 645 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 646 <div style="font-size: small"> 647 <span style="color: purple">string</span> 648 </div> 649 </td> 650 <td>always</td> 651 <td> 652 <div>ElastiCache Subnet Group used by the cache</div> 653 <br/> 654 <div style="font-size: smaller"><b>Sample:</b></div> 655 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">abcd-subnet-group</div> 656 </td> 657 </tr> 658 <tr> 659 <td class="elbow-placeholder"> </td> 660 <td colspan="3"> 661 <div class="ansibleOptionAnchor" id="return-"></div> 662 <b>client_download_landing_page</b> 663 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 664 <div style="font-size: small"> 665 <span style="color: purple">string</span> 666 </div> 667 </td> 668 <td>always</td> 669 <td> 670 <div>URL of client download web page</div> 671 <br/> 672 <div style="font-size: smaller"><b>Sample:</b></div> 673 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">https://console.aws.amazon.com/elasticache/home#client-download:</div> 674 </td> 675 </tr> 676 <tr> 677 <td class="elbow-placeholder"> </td> 678 <td colspan="3"> 679 <div class="ansibleOptionAnchor" id="return-"></div> 680 <b>engine</b> 681 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 682 <div style="font-size: small"> 683 <span style="color: purple">string</span> 684 </div> 685 </td> 686 <td>always</td> 687 <td> 688 <div>Engine used by ElastiCache</div> 689 <br/> 690 <div style="font-size: smaller"><b>Sample:</b></div> 691 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">redis</div> 692 </td> 693 </tr> 694 <tr> 695 <td class="elbow-placeholder"> </td> 696 <td colspan="3"> 697 <div class="ansibleOptionAnchor" id="return-"></div> 698 <b>engine_version</b> 699 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 700 <div style="font-size: small"> 701 <span style="color: purple">string</span> 702 </div> 703 </td> 704 <td>always</td> 705 <td> 706 <div>Version of ElastiCache engine</div> 707 <br/> 708 <div style="font-size: smaller"><b>Sample:</b></div> 709 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">3.2.4</div> 710 </td> 711 </tr> 712 <tr> 713 <td class="elbow-placeholder"> </td> 714 <td colspan="3"> 715 <div class="ansibleOptionAnchor" id="return-"></div> 716 <b>notification_configuration</b> 717 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 718 <div style="font-size: small"> 719 <span style="color: purple">complex</span> 720 </div> 721 </td> 722 <td>if notifications are enabled</td> 723 <td> 724 <div>Configuration of notifications</div> 725 <br/> 726 </td> 727 </tr> 728 <tr> 729 <td class="elbow-placeholder"> </td> 730 <td class="elbow-placeholder"> </td> 731 <td colspan="2"> 732 <div class="ansibleOptionAnchor" id="return-"></div> 733 <b>topic_arn</b> 734 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 735 <div style="font-size: small"> 736 <span style="color: purple">string</span> 737 </div> 738 </td> 739 <td>if notifications are enabled</td> 740 <td> 741 <div>ARN of notification destination topic</div> 742 <br/> 743 <div style="font-size: smaller"><b>Sample:</b></div> 744 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">arn:aws:sns:*:123456789012:my_topic</div> 745 </td> 746 </tr> 747 <tr> 748 <td class="elbow-placeholder"> </td> 749 <td class="elbow-placeholder"> </td> 750 <td colspan="2"> 751 <div class="ansibleOptionAnchor" id="return-"></div> 752 <b>topic_name</b> 753 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 754 <div style="font-size: small"> 755 <span style="color: purple">string</span> 756 </div> 757 </td> 758 <td>if notifications are enabled</td> 759 <td> 760 <div>Name of notification destination topic</div> 761 <br/> 762 <div style="font-size: smaller"><b>Sample:</b></div> 763 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">MyTopic</div> 764 </td> 765 </tr> 766 767 <tr> 768 <td class="elbow-placeholder"> </td> 769 <td colspan="3"> 770 <div class="ansibleOptionAnchor" id="return-"></div> 771 <b>num_cache_nodes</b> 772 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 773 <div style="font-size: small"> 774 <span style="color: purple">integer</span> 775 </div> 776 </td> 777 <td>always</td> 778 <td> 779 <div>Number of Cache Nodes</div> 780 <br/> 781 <div style="font-size: smaller"><b>Sample:</b></div> 782 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">1</div> 783 </td> 784 </tr> 785 <tr> 786 <td class="elbow-placeholder"> </td> 787 <td colspan="3"> 788 <div class="ansibleOptionAnchor" id="return-"></div> 789 <b>pending_modified_values</b> 790 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 791 <div style="font-size: small"> 792 <span style="color: purple">complex</span> 793 </div> 794 </td> 795 <td>always</td> 796 <td> 797 <div>Values that are pending modification</div> 798 <br/> 799 </td> 800 </tr> 801 <tr> 802 <td class="elbow-placeholder"> </td> 803 <td colspan="3"> 804 <div class="ansibleOptionAnchor" id="return-"></div> 805 <b>preferred_availability_zone</b> 806 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 807 <div style="font-size: small"> 808 <span style="color: purple">string</span> 809 </div> 810 </td> 811 <td>always</td> 812 <td> 813 <div>Preferred Availability Zone</div> 814 <br/> 815 <div style="font-size: smaller"><b>Sample:</b></div> 816 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">ap-southeast-2b</div> 817 </td> 818 </tr> 819 <tr> 820 <td class="elbow-placeholder"> </td> 821 <td colspan="3"> 822 <div class="ansibleOptionAnchor" id="return-"></div> 823 <b>preferred_maintenance_window</b> 824 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 825 <div style="font-size: small"> 826 <span style="color: purple">string</span> 827 </div> 828 </td> 829 <td>always</td> 830 <td> 831 <div>Time slot for preferred maintenance window</div> 832 <br/> 833 <div style="font-size: smaller"><b>Sample:</b></div> 834 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">sat:12:00-sat:13:00</div> 835 </td> 836 </tr> 837 <tr> 838 <td class="elbow-placeholder"> </td> 839 <td colspan="3"> 840 <div class="ansibleOptionAnchor" id="return-"></div> 841 <b>replication_group_id</b> 842 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 843 <div style="font-size: small"> 844 <span style="color: purple">string</span> 845 </div> 846 </td> 847 <td>always</td> 848 <td> 849 <div>Replication Group Id</div> 850 <br/> 851 <div style="font-size: smaller"><b>Sample:</b></div> 852 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">replication-001</div> 853 </td> 854 </tr> 855 <tr> 856 <td class="elbow-placeholder"> </td> 857 <td colspan="3"> 858 <div class="ansibleOptionAnchor" id="return-"></div> 859 <b>security_groups</b> 860 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 861 <div style="font-size: small"> 862 <span style="color: purple">complex</span> 863 </div> 864 </td> 865 <td>always</td> 866 <td> 867 <div>List of Security Groups associated with ElastiCache</div> 868 <br/> 869 </td> 870 </tr> 871 <tr> 872 <td class="elbow-placeholder"> </td> 873 <td class="elbow-placeholder"> </td> 874 <td colspan="2"> 875 <div class="ansibleOptionAnchor" id="return-"></div> 876 <b>security_group_id</b> 877 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 878 <div style="font-size: small"> 879 <span style="color: purple">string</span> 880 </div> 881 </td> 882 <td>always</td> 883 <td> 884 <div>Security Group ID</div> 885 <br/> 886 <div style="font-size: smaller"><b>Sample:</b></div> 887 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">sg-abcd1234</div> 888 </td> 889 </tr> 890 <tr> 891 <td class="elbow-placeholder"> </td> 892 <td class="elbow-placeholder"> </td> 893 <td colspan="2"> 894 <div class="ansibleOptionAnchor" id="return-"></div> 895 <b>status</b> 896 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 897 <div style="font-size: small"> 898 <span style="color: purple">string</span> 899 </div> 900 </td> 901 <td>always</td> 902 <td> 903 <div>Status of Security Group</div> 904 <br/> 905 <div style="font-size: smaller"><b>Sample:</b></div> 906 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">active</div> 907 </td> 908 </tr> 909 910 <tr> 911 <td class="elbow-placeholder"> </td> 912 <td colspan="3"> 913 <div class="ansibleOptionAnchor" id="return-"></div> 914 <b>tags</b> 915 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 916 <div style="font-size: small"> 917 <span style="color: purple">complex</span> 918 </div> 919 </td> 920 <td>always</td> 921 <td> 922 <div>Tags applied to the ElastiCache cluster</div> 923 <br/> 924 <div style="font-size: smaller"><b>Sample:</b></div> 925 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{'Application': 'web', 'Environment': 'test'}</div> 926 </td> 927 </tr> 928 929 </table> 930 <br/><br/> 931 932 933Status 934------ 935 936 937Authors 938~~~~~~~ 939 940- Will Thames (@willthames) 941