amazon.aws [WIP] Initial refactor of AWS Lookup Plugins

Depends-On: #873

SUMMARY

We've a lot of Copy and Paste in our non-module Plugins. Start working on a refactor to reduce the duplication.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

plugins/module_utils/botocore.py plugins/module_utils/modules.py plugins/plugin_utils/botocore.py plugins/plugin_utils/modules.py

ADDITIONAL INFORMATION

Very much a Work in Progress, looking to land in 5.0.0 NOT 4.0.0

Jun 16 '22 13:06 tremble

Docs Build 📝

Thank you for contribution!✨

The docsite for this PR is available for download as an artifact from this run: https://github.com/ansible-collections/amazon.aws/actions/runs/2575366886

File changes:

M collections/amazon/aws/aws_ssm_lookup.html

Click to see the diff comparison.

NOTE: only file modifications are shown here. New and deleted files are excluded. See the file list and check the published docs to see those files.

diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_ssm_lookup.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_ssm_lookup.html
index a8f598f..e5851da 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/aws_ssm_lookup.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/aws_ssm_lookup.html
@@ -169,6 +169,63 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </thead>
 <tbody>
 <tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-aws_access_key"></div>
+<div class="ansibleOptionAnchor" id="parameter-aws_access_key_id"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-aws-access-key-id"><span id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-aws-access-key"></span><strong>aws_access_key</strong></p>
+<a class="ansibleOptionLink" href="#parameter-aws_access_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_access_key_id</span></p>
+<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>The AWS access key to use.</p>
+<p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
+<ul class="simple">
+<li><p>Environment variable: EC2_ACCESS_KEY</p></li>
+<li><p>Environment variable: AWS_ACCESS_KEY</p></li>
+<li><p>Environment variable: AWS_ACCESS_KEY_ID</p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-aws_profile"></div>
+<div class="ansibleOptionAnchor" id="parameter-boto_profile"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-boto-profile"><span id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-aws-profile"></span><strong>aws_profile</strong></p>
+<a class="ansibleOptionLink" href="#parameter-aws_profile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: boto_profile</span></p>
+<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>The AWS profile</p>
+<p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
+<ul class="simple">
+<li><p>Environment variable: AWS_DEFAULT_PROFILE</p></li>
+<li><p>Environment variable: AWS_PROFILE</p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-aws_secret_key"></div>
+<div class="ansibleOptionAnchor" id="parameter-aws_secret_access_key"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-aws-secret-key"><span id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-aws-secret-access-key"></span><strong>aws_secret_key</strong></p>
+<a class="ansibleOptionLink" href="#parameter-aws_secret_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: aws_secret_access_key</span></p>
+<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>The AWS secret key that corresponds to the access key.</p>
+<p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
+<ul class="simple">
+<li><p>Environment variable: EC2_SECRET_KEY</p></li>
+<li><p>Environment variable: AWS_SECRET_KEY</p></li>
+<li><p>Environment variable: AWS_SECRET_ACCESS_KEY</p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-aws_security_token"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-aws-security-token"><strong>aws_security_token</strong></p>
+<a class="ansibleOptionLink" href="#parameter-aws_security_token" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>The AWS security token if using temporary access and secret keys.</p>
+<p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
+<ul class="simple">
+<li><p>Environment variable: EC2_SECURITY_TOKEN</p></li>
+<li><p>Environment variable: AWS_SESSION_TOKEN</p></li>
+<li><p>Environment variable: AWS_SECURITY_TOKEN</p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-bypath"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-bypath"><strong>bypath</strong></p>
 <a class="ansibleOptionLink" href="#parameter-bypath" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
 </div></td>
@@ -247,6 +304,18 @@ To check whether it is installed, run <code class="code docutils literal notrans
 </div></td>
 </tr>
 <tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-region"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-region"><strong>region</strong></p>
+<a class="ansibleOptionLink" href="#parameter-region" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>The region for which to create the connection.</p>
+<p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
+<ul class="simple">
+<li><p>Environment variable: EC2_REGION</p></li>
+<li><p>Environment variable: AWS_REGION</p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-shortnames"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-aws-ssm-lookup-parameter-shortnames"><strong>shortnames</strong></p>
 <a class="ansibleOptionLink" href="#parameter-shortnames" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
 </div></td>

Jun 16 '22 13:06 github-actions[bot]

Build failed.

Jun 16 '22 14:06 softwarefactory-project-zuul[bot]

Build failed.

Jun 16 '22 17:06 softwarefactory-project-zuul[bot]

Build failed.

Jun 27 '22 09:06 softwarefactory-project-zuul[bot]

Build failed.

Jun 27 '22 13:06 softwarefactory-project-zuul[bot]

Build failed.

Jun 27 '22 15:06 softwarefactory-project-zuul[bot]

Build failed.

Jun 27 '22 20:06 softwarefactory-project-zuul[bot]

Build failed.

Jun 28 '22 09:06 softwarefactory-project-zuul[bot]

Build failed.

Jun 28 '22 10:06 softwarefactory-project-zuul[bot]

bitrot has set in. I'm going to close this PR. I'm going to break this into a number of smaller changes and try again.

Oct 29 '22 16:10 tremble

amazon.aws amazon.aws copied to clipboard

[WIP] Initial refactor of AWS Lookup Plugins

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Docs Build 📝

amazon.aws
amazon.aws copied to clipboard