Refactor ec2_eip* modules

ansible-collections / amazon.aws

Ansible Collection for Amazon AWS

GNU General Public License v3.0

278 stars 322 forks source link

Refactor ec2_eip* modules #2165

Open abikouo opened 4 days ago

abikouo commented 4 days ago

SUMMARY

Refactor ec2_eip,ec2_eip_info modules

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

ec2_eip ec2_eip_info

github-actions[bot] commented 4 days ago

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/9744500510

You can compare to the docs for the main branch here: https://ansible-collections.github.io/amazon.aws/branch/main

File changes:

M collections/amazon/aws/ec2_eip_info_module.html

M collections/amazon/aws/ec2_eip_module.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 diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ec2_eip_info_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ec2_eip_info_module.html index 3968862..23a9a17 100644 --- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ec2_eip_info_module.html +++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ec2_eip_info_module.html @@ -249,7 +249,7 @@ see

filters

dictionary

A dict of filters to apply. Each dict item consists of a filter key and filter value. See https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses.html#options for possible filters. Filter names and values are case sensitive.

Default: {}

@@ -427,7 +427,7 @@ see

domain

string

The network (vpc).

The network ( vpc).

Returned: always

Sample: "vpc"

diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ec2_eip_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ec2_eip_module.html index 45db018..4ab2dc2 100644 --- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ec2_eip_module.html +++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ec2_eip_module.html @@ -250,7 +250,7 @@ see

The id of the device for the EIP.

Can be an EC2 Instance id or Elastic Network Interface (ENI) id.

When specifying an ENI id, in_vpc must be true.

When specifying an ENI id, in_vpc must be true

The instance_id alias was removed in release 6.0.0.

@@ -273,7 +273,7 @@ see

boolean

Allocate an EIP inside a VPC or not.

Required if specifying an ENI with device_id.

Required if specifying an ENI with device_id.

Choices:

false ← (default)

string

The IP address of a previously allocated EIP.

When state=present and device is specified, the EIP is associated with the device.

When state=absent and device is specified, the EIP is disassociated from the device.

When state=present and device is specified, the EIP is associated with the device.

When state=absent and device is specified, the EIP is disassociated from the device.

public_ipv4_pool

string

Allocates the new Elastic IP from the provided public IPv4 pool (BYOIP) only applies to newly allocated Elastic IPs, isn’t validated when reuse_existing_ip_allowed=true.

Allocates the new Elastic IP from the provided public IPv4 pool (BYOIP) only applies to newly allocated Elastic IPs, isn’t validated when reuse_existing_ip_allowed=true.

@@ -410,8 +410,8 @@ see

state

string

When state=present, allocate an EIP or associate an existing EIP with a device.

When state=absent, disassociate the EIP from the device and optionally release it.

When state=present, allocate an EIP or associate an existing EIP with a device.

When state=absent, disassociate the EIP from the device and optionally release it.

Choices:

"present" ← (default)

tag_name

string

When reuse_existing_ip_allowed=true, supplement with this option to only reuse an Elastic IP if it is tagged with tag_name.

When reuse_existing_ip_allowed=true, supplement with this option to only reuse an Elastic IP if it is tagged with tag_name.

tag_value

string

Supplements tag_name but also checks that the value of the tag provided in tag_name matches tag_value.

Supplements tag_name but also checks that the value of the tag provided in tag_name matches tag_value.

@@ -466,7 +466,7 @@ see

There may be a delay between the time the EIP is assigned and when the cloud instance is reachable via the new address. Use wait_for and pause to delay further playbook execution until the instance is reachable, if necessary.

This module returns multiple changed statuses on disassociation or release. It returns an overall status based on any changes occurring. It also returns individual changed statuses for disassociation and release.

Support for tags and purge_tags was added in release 2.1.0.

Support for tags and purge_tags was added in release 2.1.0.

Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

@@ -596,7 +596,7 @@ see

allocation_id

string

Allocation id of the elastic ip.

allocation_id of the elastic ip

Returned: on success

Sample: "eipalloc-51aa3a6c"

@@ -605,7 +605,7 @@ see

public_ip

string

An elastic ip address.

an elastic ip address

Returned: on success

Sample: "52.88.159.209"

```

softwarefactory-project-zuul[bot] commented 4 days ago

Build failed. https://ansible.softwarefactory-project.io/zuul/buildset/a1546cce045543748bd3d26bc0be440b

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 3m 25s :heavy_check_mark: build-ansible-collection SUCCESS in 15m 55s :heavy_check_mark: ansible-test-splitter SUCCESS in 6m 47s :x: integration-amazon.aws-1 FAILURE in 6m 52s Skipped 43 jobs

softwarefactory-project-zuul[bot] commented 4 days ago

Build succeeded. https://ansible.softwarefactory-project.io/zuul/buildset/4d53ca6c0b0b4fde83c0e9c1eba8c7ae

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 3m 21s :heavy_check_mark: build-ansible-collection SUCCESS in 15m 38s :heavy_check_mark: ansible-test-splitter SUCCESS in 6m 38s :heavy_check_mark: integration-amazon.aws-1 SUCCESS in 9m 36s Skipped 43 jobs