ansible / ansible.builtin / v2.9.17 / module / aws_eks_cluster Manage Elastic Kubernetes Service Clusters | "added in version" 2.7 of ansible.builtin" Authors: Will Thames (@willthames) preview | supported by communityansible.builtin.aws_eks_cluster (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Manage Elastic Kubernetes Service Clusters
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: Create an EKS cluster aws_eks_cluster: name: my_cluster version: v1.10.0 role_arn: my_eks_role subnets: - subnet-aaaa1111 security_groups: - my_eks_sg - sg-abcd1234 register: caller_facts
- name: Remove an EKS cluster aws_eks_cluster: name: my_cluster wait: yes state: absent
name: description: Name of EKS cluster required: true wait: default: 'no' description: 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. type: bool state: choices: - absent - present default: present description: desired state of the EKS cluster region: aliases: - aws_region - ec2_region description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str subnets: description: list of subnet IDs for the Kubernetes cluster version: description: Kubernetes version - defaults to latest role_arn: description: ARN of IAM role used by the EKS cluster aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict wait_timeout: default: 1200 description: The duration in seconds to wait for the cluster to become active. Defaults to 1200 seconds (20 minutes). aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool security_groups: description: list of security group names or IDs debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
arn: description: ARN of the EKS cluster returned: when state is present sample: arn:aws:eks:us-west-2:111111111111:cluster/my-eks-cluster type: str certificate_authority: contains: data: description: Base-64 encoded Certificate Authority Data for cluster returned: when the cluster has been created and is active type: str description: Dictionary containing Certificate Authority Data for cluster returned: after creation type: complex created_at: description: Cluster creation date and time returned: when state is present sample: '2018-06-06T11:56:56.242000+00:00' type: str endpoint: description: 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 type: str name: description: EKS cluster name returned: when state is present sample: my-eks-cluster type: str resources_vpc_config: contains: security_group_ids: description: List of security group IDs returned: always sample: - sg-abcd1234 - sg-aaaa1111 type: list subnet_ids: description: List of subnet IDs returned: always sample: - subnet-abcdef12 - subnet-345678ab - subnet-cdef1234 type: list vpc_id: description: VPC id returned: always sample: vpc-a1b2c3d4 type: str description: VPC configuration of the cluster returned: when state is present type: complex role_arn: description: ARN of the IAM role used by the cluster returned: when state is present sample: arn:aws:iam::111111111111:role/aws_eks_cluster_role type: str status: description: status of the EKS cluster returned: when state is present sample: - CREATING - ACTIVE type: str version: description: Kubernetes version of the cluster returned: when state is present sample: '1.10' type: str