Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@tremble
tremble committed Jun 23, 2022
1 parent 1b49b69 commit 1bc54b9
Show file tree
Hide file tree
Showing 11 changed files with 381 additions and 139 deletions.
65 changes: 62 additions & 3 deletions docs/community.aws.aws_codebuild_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
/ <span style="color: red">required</span>
</div>
</td>
<td>
</td>
<td>
<div>Information about the build output artifacts for the build project.</div>
<div><em>artifacts</em> is required when creating a new project.</div>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -477,6 +477,27 @@ Parameters
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>purge_tags</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul>
</td>
<td>
<div>If <em>purge_tags=true</em> and <em>tags</em> is set, existing tags will be purged from the resource to match exactly what is defined by <em>tags</em> parameter.</div>
<div>If the <em>resource_tags</em> parameter is not set then tags will not be modified, even if <em>purge_tags=True</em>.</div>
<div>Tag keys beginning with <code>aws:</code> are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the <em>purge_tags</em> parameter. See the Amazon documentation for more information <a href='https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions'>https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions</a>.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
Expand All @@ -493,6 +514,23 @@ Parameters
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_region, ec2_region</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>resource_tags</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>A dictionary representing the tags to be applied to the build project.</div>
<div>If the <em>resource_tags</em> parameter is not set then tags will not be modified.</div>
<div>Mutually exclusive with the <em>tags</em> parameter.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
Expand Down Expand Up @@ -534,13 +572,13 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
/ <span style="color: red">required</span>
</div>
</td>
<td>
</td>
<td>
<div>Configure service and location for the build input source.</div>
<div><em>source</em> is required when creating a new project.</div>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -662,6 +700,8 @@ Parameters
</td>
<td>
<div>A set of tags for the build project.</div>
<div>Mutually exclusive with the <em>resource_tags</em> parameter.</div>
<div>In release 6.0.0 this parameter will accept a simple dictionary instead of the list of dictionaries format. To use the simple dictionary format prior to release 6.0.0 the <em>resource_tags</em> can be used instead of <em>tags</em>.</div>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -980,6 +1020,24 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">my_project</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder">&nbsp;</td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="return-"></div>
<b>reource_tags</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 4.0.0</div>
</td>
<td>when configured</td>
<td>
<div>A simple dictionary representing the tags added to the project.</div>
<div><em>tags</em> and <em>reource_tags</em> represent the same information in different formats.</div>
<br/>
</td>
</tr>
<tr>
<td class="elbow-placeholder">&nbsp;</td>
<td colspan="2">
Expand Down Expand Up @@ -1131,7 +1189,8 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
</td>
<td>when configured</td>
<td>
<div>Tags added to the project</div>
<div>Tags added to the project in the boto3 list of dictionaries format.</div>
<div><em>tags</em> and <em>reource_tags</em> represent the same information in different formats.</div>
<br/>
</td>
</tr>
Expand Down
3 changes: 2 additions & 1 deletion docs/community.aws.ec2_customer_gateway_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ Parameters
<td>
</td>
<td>
<div>Border Gateway Protocol (BGP) Autonomous System Number (ASN), required when <em>state=present</em>.</div>
<div>Border Gateway Protocol (BGP) Autonomous System Number (ASN).</div>
<div>Defaults to <code>65000</code> if not specified when <em>state=present</em>.</div>
</td>
</tr>
<tr>
Expand Down
1 change: 1 addition & 0 deletions docs/community.aws.ecs_service_info_module.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,7 @@ Parameters
</td>
<td>
<div>One or more services to get details for</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: name</div>
</td>
</tr>
<tr>
Expand Down
Loading

0 comments on commit 1bc54b9

Please sign in to comment.