community / community.aws / 5.1.0 / module / eks_cluster Manage Elastic Kubernetes Service (EKS) Clusters | "added in version" 1.0.0 of community.aws" Authors: Will Thames (@willthames)community.aws.eks_cluster (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
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.
# 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
name: description: Name of the EKS cluster. required: true type: str wait: default: false 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. type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str subnets: description: List of subnet IDs for the Kubernetes cluster. elements: str type: list version: description: - Kubernetes version. - Defaults to C(latest). type: str role_arn: description: ARN of IAM role used by the EKS cluster. type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str wait_timeout: default: 1200 description: The duration in seconds to wait for the cluster to become active. Defaults to 1200 seconds (20 minutes). type: int aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool security_groups: description: List of security group names or IDs. elements: str type: list debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(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:123456789012: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::123456789012:role/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