diff --git a/README.md b/README.md
index 136cfb0b40f..4f278ae4dfd 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,6 @@ Name | Description
[community.aws.aws_direct_connect_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_direct_connect_gateway_module.rst)|Manage AWS Direct Connect gateway
[community.aws.aws_direct_connect_link_aggregation_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst)|Manage Direct Connect LAG bundles
[community.aws.aws_direct_connect_virtual_interface](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_direct_connect_virtual_interface_module.rst)|Manage Direct Connect virtual interfaces
-[community.aws.aws_eks_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_eks_cluster_module.rst)|Manage Elastic Kubernetes Service Clusters
[community.aws.aws_elasticbeanstalk_app](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_elasticbeanstalk_app_module.rst)|Create, update, and delete an elastic beanstalk application
[community.aws.aws_glue_connection](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_glue_connection_module.rst)|Manage an AWS Glue connection
[community.aws.aws_glue_job](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_glue_job_module.rst)|Manage an AWS Glue job
@@ -137,6 +136,7 @@ Name | Description
[community.aws.efs](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_module.rst)|create and maintain EFS file systems
[community.aws.efs_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_info_module.rst)|Get information about Amazon EFS file systems
[community.aws.efs_tag](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_tag_module.rst)|create and remove tags on Amazon EFS resources
+[community.aws.eks_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.eks_cluster_module.rst)|Manage Elastic Kubernetes Service (EKS) Clusters
[community.aws.eks_fargate_profile](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.eks_fargate_profile_module.rst)|Manage EKS Fargate Profile
[community.aws.elasticache](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_module.rst)|Manage cache clusters in Amazon ElastiCache
[community.aws.elasticache_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_info_module.rst)|Retrieve information for AWS ElastiCache clusters
diff --git a/changelogs/fragments/1269-rename_eks.yml b/changelogs/fragments/1269-rename_eks.yml
new file mode 100644
index 00000000000..99e64d69234
--- /dev/null
+++ b/changelogs/fragments/1269-rename_eks.yml
@@ -0,0 +1,2 @@
+minor_changes:
+- aws_eks_cluster - the ``aws_eks_cluster`` module has been renamed to ``eks_cluster``, ``aws_eks_cluster`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1269).
diff --git a/docs/community.aws.aws_eks_cluster_module.rst b/docs/community.aws.eks_cluster_module.rst
similarity index 97%
rename from docs/community.aws.aws_eks_cluster_module.rst
rename to docs/community.aws.eks_cluster_module.rst
index bc3da6fa36a..7cb33961fdb 100644
--- a/docs/community.aws.aws_eks_cluster_module.rst
+++ b/docs/community.aws.eks_cluster_module.rst
@@ -1,11 +1,11 @@
-.. _community.aws.aws_eks_cluster_module:
+.. _community.aws.eks_cluster_module:
-*****************************
-community.aws.aws_eks_cluster
-*****************************
+*************************
+community.aws.eks_cluster
+*************************
-**Manage Elastic Kubernetes Service Clusters**
+**Manage Elastic Kubernetes Service (EKS) Clusters**
Version added: 1.0.0
@@ -17,7 +17,8 @@ Version added: 1.0.0
Synopsis
--------
-- Manage Elastic Kubernetes Service Clusters
+- Manage Elastic Kubernetes Service (EKS) Clusters.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_eks_cluster``. The usage did not change.
@@ -155,7 +156,7 @@ Parameters
|
|
- Name of EKS cluster
+ Name of the EKS cluster.
|
@@ -202,7 +203,7 @@ Parameters
|
|
- ARN of IAM role used by the EKS cluster
+ ARN of IAM role used by the EKS cluster.
|
@@ -218,7 +219,7 @@ Parameters
|
|
- list of security group names or IDs
+ List of security group names or IDs.
|
@@ -255,7 +256,7 @@ Parameters
|
- desired state of the EKS cluster
+ Desired state of the EKS cluster.
|
@@ -271,7 +272,7 @@ Parameters
|
|
- list of subnet IDs for the Kubernetes cluster
+ List of subnet IDs for the Kubernetes cluster.
|
@@ -305,7 +306,8 @@ Parameters
|
|
- Kubernetes version - defaults to latest
+ Kubernetes version.
+ Defaults to latest.
|
@@ -365,7 +367,7 @@ Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create an EKS cluster
- community.aws.aws_eks_cluster:
+ community.aws.eks_cluster:
name: my_cluster
version: 1.14
role_arn: my_eks_role
@@ -377,7 +379,7 @@ Examples
register: caller_facts
- name: Remove an EKS cluster
- community.aws.aws_eks_cluster:
+ community.aws.eks_cluster:
name: my_cluster
wait: yes
state: absent
@@ -580,7 +582,7 @@ Common return values are documented `here ARN of the IAM role used by the cluster
Sample:
- arn:aws:iam::111111111111:role/aws_eks_cluster_role
+ arn:aws:iam::111111111111:role/eks_cluster_role
diff --git a/meta/runtime.yml b/meta/runtime.yml
index 68f9b76e54d..0a4afb0b219 100644
--- a/meta/runtime.yml
+++ b/meta/runtime.yml
@@ -111,6 +111,7 @@ action_groups:
- ecs_taskdefinition_info
- efs
- efs_info
+ - eks_cluster
- efs_tag
- eks_fargate_profile
- elasticache
@@ -214,6 +215,9 @@ plugin_routing:
aws_ses_identity:
# Deprecation for this alias should not *start* prior to 2024-09-01
redirect: community.aws.ses_identity
+ aws_eks_cluster:
+ # Deprecation for this alias should not *start* prior to 2024-09-01
+ redirect: community.aws.eks_cluster
aws_ses_identity_policy:
# Deprecation for this alias should not *start* prior to 2024-09-01
redirect: community.aws.ses_identity_policy
diff --git a/plugins/modules/aws_eks_cluster.py b/plugins/modules/eks_cluster.py
similarity index 91%
rename from plugins/modules/aws_eks_cluster.py
rename to plugins/modules/eks_cluster.py
index 895758f0cf5..0794efef16d 100644
--- a/plugins/modules/aws_eks_cluster.py
+++ b/plugins/modules/eks_cluster.py
@@ -8,35 +8,38 @@
DOCUMENTATION = r'''
---
-module: aws_eks_cluster
+module: eks_cluster
version_added: 1.0.0
-short_description: Manage Elastic Kubernetes Service Clusters
+short_description: Manage Elastic Kubernetes Service (EKS) Clusters
description:
- - Manage Elastic Kubernetes Service Clusters
-
-author: Will Thames (@willthames)
-
+ - Manage Elastic Kubernetes Service (EKS) Clusters.
+ - Prior to release 5.0.0 this module was called C(community.aws.aws_eks_cluster).
+ The usage did not change.
+author:
+ - Will Thames (@willthames)
options:
name:
- description: Name of EKS cluster
+ description: Name of the EKS cluster.
required: True
type: str
version:
- description: Kubernetes version - defaults to latest
+ description:
+ - Kubernetes version.
+ - Defaults to C(latest).
type: str
role_arn:
- description: ARN of IAM role used by the EKS cluster
+ description: ARN of IAM role used by the EKS cluster.
type: str
subnets:
- description: list of subnet IDs for the Kubernetes cluster
+ description: List of subnet IDs for the Kubernetes cluster.
type: list
elements: str
security_groups:
- description: list of security group names or IDs
+ description: List of security group names or IDs.
type: list
elements: str
state:
- description: desired state of the EKS cluster
+ description: Desired state of the EKS cluster.
choices:
- absent
- present
@@ -55,16 +58,15 @@
default: 1200
type: int
extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-
+ - amazon.aws.aws
+ - amazon.aws.ec2
'''
EXAMPLES = r'''
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create an EKS cluster
- community.aws.aws_eks_cluster:
+ community.aws.eks_cluster:
name: my_cluster
version: 1.14
role_arn: my_eks_role
@@ -76,7 +78,7 @@
register: caller_facts
- name: Remove an EKS cluster
- community.aws.aws_eks_cluster:
+ community.aws.eks_cluster:
name: my_cluster
wait: yes
state: absent
@@ -141,7 +143,7 @@
description: ARN of the IAM role used by the cluster
returned: when state is present
type: str
- sample: arn:aws:iam::111111111111:role/aws_eks_cluster_role
+ sample: arn:aws:iam::111111111111:role/eks_cluster_role
status:
description: status of the EKS cluster
returned: when state is present
diff --git a/tests/integration/targets/aws_eks_cluster/aliases b/tests/integration/targets/eks_cluster/aliases
similarity index 100%
rename from tests/integration/targets/aws_eks_cluster/aliases
rename to tests/integration/targets/eks_cluster/aliases
diff --git a/tests/integration/targets/aws_eks_cluster/defaults/main.yml b/tests/integration/targets/eks_cluster/defaults/main.yml
similarity index 100%
rename from tests/integration/targets/aws_eks_cluster/defaults/main.yml
rename to tests/integration/targets/eks_cluster/defaults/main.yml
diff --git a/tests/integration/targets/aws_eks_cluster/files/eks-trust-policy.json b/tests/integration/targets/eks_cluster/files/eks-trust-policy.json
similarity index 100%
rename from tests/integration/targets/aws_eks_cluster/files/eks-trust-policy.json
rename to tests/integration/targets/eks_cluster/files/eks-trust-policy.json
diff --git a/tests/integration/targets/aws_eks_cluster/meta/main.yml b/tests/integration/targets/eks_cluster/meta/main.yml
similarity index 100%
rename from tests/integration/targets/aws_eks_cluster/meta/main.yml
rename to tests/integration/targets/eks_cluster/meta/main.yml
diff --git a/tests/integration/targets/aws_eks_cluster/tasks/full_test.yml b/tests/integration/targets/eks_cluster/tasks/full_test.yml
similarity index 100%
rename from tests/integration/targets/aws_eks_cluster/tasks/full_test.yml
rename to tests/integration/targets/eks_cluster/tasks/full_test.yml
diff --git a/tests/integration/targets/aws_eks_cluster/tasks/main.yml b/tests/integration/targets/eks_cluster/tasks/main.yml
similarity index 100%
rename from tests/integration/targets/aws_eks_cluster/tasks/main.yml
rename to tests/integration/targets/eks_cluster/tasks/main.yml