You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.aws.eks_cluster module – Manage Elastic Kubernetes Service (EKS) Clusters

Note

This module is part of the community.aws collection (version 5.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.aws.eks_cluster.

New in community.aws 1.0.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis 

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.

Requirements 

The below requirements are needed on the host that executes this module.

python >= 3.6
boto3 >= 1.18.0
botocore >= 1.21.0

Parameters 

Parameter	Comments
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` or `EC2_ACCESS_KEY` environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 access_key will always fall back to the environment variables if set. The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the `EC2_ACCESS_KEY` environment variable has been deprecated and will be removed in a release after 2024-12-01.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The `AWS_CA_BUNDLE` environment variable may also be used.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs boolean	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. Choices: `false` ← (default) `true`
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The `AWS_URL` or `EC2_URL` environment variables may also be used, in decreasing order of preference. The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the `EC2_URL` environment variable has been deprecated and will be removed in a release after 2024-12-01.
name string / required	Name of the EKS cluster.
profile aliases: aws_profile string	A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The `AWS_PROFILE` environment variable may also be used. Prior to release 6.0.0 the `AWS_PROFILE` environment variable will be ignored if any of access_key, secret_key, or session_token are passed. After release 6.0.0 profile will always fall back to the `AWS_PROFILE` environment variable if set. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
region aliases: aws_region, ec2_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The `AWS_REGION` or `EC2_REGION` environment variables may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The `ec2_region` alias has been deprecated and will be removed in a release after 2024-12-01 Support for the `EC2_REGION` environment variable has been deprecated and will be removed in a release after 2024-12-01.
role_arn string	ARN of IAM role used by the EKS cluster.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, or `EC2_SECRET_KEY` environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 secret_key will always fall back to the environment variables if set. The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the `EC2_SECRET_KEY` environment variable has been deprecated and will be removed in a release after 2024-12-01.
security_groups list / elements=string	List of security group names or IDs.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` or `EC2_SECURITY_TOKEN` environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 session_token will always fall back to the environment variables if set. The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the `EC2_SECRET_KEY` and `AWS_SECURITY_TOKEN` environment variables has been deprecated and will be removed in a release after 2024-12-01.
state string	Desired state of the EKS cluster. Choices: `"absent"` `"present"` ← (default)
subnets list / elements=string	List of subnet IDs for the Kubernetes cluster.
tags dictionary added in community.aws 5.3.0	A dictionary of tags to add the EKS cluster.
validate_certs boolean	When set to `false`, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: `false` `true` ← (default)
version string	Kubernetes version. Defaults to `latest`.
wait boolean	Specifies whether the module waits until the cluster is active or deleted before moving on. It takes “usually less than 10 minutes” per AWS documentation. Choices: `false` ← (default) `true`
wait_timeout integer	The duration in seconds to wait for the cluster to become active. Defaults to 1200 seconds (20 minutes). Default: `1200`

Notes 

Note

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.

Examples 

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create an EKS cluster
  community.aws.eks_cluster:
    name: my_cluster
    version: 1.14
    role_arn: my_eks_role
    subnets:
      - subnet-aaaa1111
    security_groups:
      - my_eks_sg
      - sg-abcd1234
  register: caller_facts

- name: Remove an EKS cluster
  community.aws.eks_cluster:
    name: my_cluster
    wait: true
    state: absent

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
arn string	ARN of the EKS cluster Returned: when state is present Sample: `"arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster"`
certificate_authority complex	Dictionary containing Certificate Authority Data for cluster Returned: after creation
data string	Base-64 encoded Certificate Authority Data for cluster Returned: when the cluster has been created and is active
created_at string	Cluster creation date and time Returned: when state is present Sample: `"2018-06-06T11:56:56.242000+00:00"`
endpoint string	Kubernetes API server endpoint Returned: when the cluster has been created and is active Sample: `"https://API_SERVER_ENDPOINT.yl4.us-west-2.eks.amazonaws.com"`
name string	EKS cluster name Returned: when state is present Sample: `"my-eks-cluster"`
resources_vpc_config complex	VPC configuration of the cluster Returned: when state is present
security_group_ids list / elements=string	List of security group IDs Returned: always Sample: `["sg-abcd1234", "sg-aaaa1111"]`
subnet_ids list / elements=string	List of subnet IDs Returned: always Sample: `["subnet-abcdef12", "subnet-345678ab", "subnet-cdef1234"]`
vpc_id string	VPC id Returned: always Sample: `"vpc-a1b2c3d4"`
role_arn string	ARN of the IAM role used by the cluster Returned: when state is present Sample: `"arn:aws:iam::123456789012:role/eks_cluster_role"`
status string	status of the EKS cluster Returned: when state is present Sample: `"['CREATING', 'ACTIVE']"`
version string	Kubernetes version of the cluster Returned: when state is present Sample: `"1.10"`

Authors

Will Thames (@willthames)

Collection links

Issue Tracker Repository (Sources) Communication

community.aws.eks_cluster module – Manage Elastic Kubernetes Service (EKS) Clusters

Synopsis

Requirements

Parameters

Notes

Examples

Return Values