Class: Ansible::Ruby::Modules::Aws_eks_cluster

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb

Overview

Manage Elastic Kubernetes Service Clusters

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#name ⇒ String

Returns Name of EKS cluster.

Returns:

  • (String) —

    Name of EKS cluster



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb', line 12

attribute :name

#role_arn ⇒ String?

Returns ARN of IAM role used by the EKS cluster.

Returns:

  • (String, nil) —

    ARN of IAM role used by the EKS cluster



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb', line 20

attribute :role_arn

#security_groups ⇒ Array<String>, ...

Returns list of security group names or IDs.

Returns:

  • (Array<String>, String, nil) —

    list of security group names or IDs



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb', line 28

attribute :security_groups

#state ⇒ :absent, ...

Returns desired state of the EKS cluster.

Returns:

  • (:absent, :present, nil) —

    desired state of the EKS cluster



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb', line 32

attribute :state

#subnets ⇒ Array<String>, ...

Returns list of subnet IDs for the Kubernetes cluster.

Returns:

  • (Array<String>, String, nil) —

    list of subnet IDs for the Kubernetes cluster



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb', line 24

attribute :subnets

#version ⇒ String?

Returns Kubernetes version - defaults to latest.

Returns:

  • (String, nil) —

    Kubernetes version - defaults to latest



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb', line 16

attribute :version

#wait ⇒ :yes, ...

Returns Specifies whether the module waits until the cluster becomes active after creation. It takes “usually less than 10 minutes” per AWS documentation.

Returns:

  • (:yes, :no, nil) —

    Specifies whether the module waits until the cluster becomes active after creation. It takes “usually less than 10 minutes” per AWS documentation.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb', line 36

attribute :wait

#wait_timeout ⇒ Integer?

Returns The duration in seconds to wait for the cluster to become active. Defaults to 1200 seconds (20 minutes).

Returns:

  • (Integer, nil) —

    The duration in seconds to wait for the cluster to become active. Defaults to 1200 seconds (20 minutes).



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_eks_cluster.rb', line 40

attribute :wait_timeout