Class: Aws::EKS::Types::Cluster

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb

Overview

An object representing an Amazon EKS cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_config ⇒ Types::AccessConfigResponse

The access configuration for the cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the cluster.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_authority ⇒ Types::Certificate

The certificate-authority-data for your cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#compute_config ⇒ Types::ComputeConfigResponse

Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#connector_config ⇒ Types::ConnectorConfigResponse

The configuration used to connect to a cluster for registration.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#control_plane_scaling_config ⇒ Types::ControlPlaneScalingConfig

The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The Unix epoch timestamp at object creation.

Returns:

  • (Time) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ Boolean

The current deletion protection setting for the cluster. When true, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false, the cluster can be deleted normally. This setting only applies to clusters in an active state.

Returns:

  • (Boolean) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_config ⇒ Array<Types::EncryptionConfig>

The encryption configuration for the cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

The endpoint for your Kubernetes API server.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#health ⇒ Types::ClusterHealth

An object representing the health of your Amazon EKS cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#identity ⇒ Types::Identity

The identity provider information for the cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#kube_api_server_config ⇒ Types::KubeApiServerConfigResponse

The Kubernetes API server configuration for the cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#kube_controller_manager_config ⇒ Types::KubeControllerManagerConfigResponse

The Kubernetes controller manager configuration for the cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#kube_scheduler_config ⇒ Types::KubeSchedulerConfigResponse

The Kubernetes scheduler configuration for the cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#kubernetes_network_config ⇒ Types::KubernetesNetworkConfigResponse

The Kubernetes network configuration for the cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#logging ⇒ Types::Logging

The logging configuration for your cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of your cluster.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_config ⇒ Types::OutpostConfigResponse

An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#platform_version ⇒ String

The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#remote_network_config ⇒ Types::RemoteNetworkConfigResponse

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#resources_vpc_config ⇒ Types::VpcConfigResponse

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC considerations and Cluster security group considerations in the Amazon EKS User Guide.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the cluster.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#storage_config ⇒ Types::StorageConfigResponse

Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

Returns:

  • (Hash<String,String>) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#upgrade_policy ⇒ Types::UpgradePolicyResponse

This value indicates if extended support is enabled or disabled for the cluster.

Learn more about EKS Extended Support in the Amazon EKS User Guide.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The Kubernetes server version for the cluster.

Returns:

  • (String) 


1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#zonal_shift_config ⇒ Types::ZonalShiftConfigResponse

The configuration for zonal shift for the cluster.

Returns:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1902

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags,
  :encryption_config,
  :connector_config,
  :id,
  :health,
  :outpost_config,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end