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

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

Overview

An object representing an Amazon EKS cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the cluster.

Returns:

  • (String)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_authorityTypes::Certificate

The `certificate-authority-data` for your cluster.

Returns:


461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

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

Returns:

  • (String)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix epoch timestamp in seconds for when the cluster was created.

Returns:

  • (Time)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configArray<Types::EncryptionConfig>

The encryption configuration for the cluster.

Returns:


461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#endpointString

The endpoint for your Kubernetes API server.

Returns:

  • (String)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#identityTypes::Identity

The identity provider information for the cluster.

Returns:


461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#kubernetes_network_configTypes::KubernetesNetworkConfigResponse

The Kubernetes network configuration for the cluster.


461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#loggingTypes::Logging

The logging configuration for your cluster.

Returns:


461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the cluster.

Returns:

  • (String)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#platform_versionString

The platform version of your Amazon EKS cluster. For more information, see [Platform Versions] in the Amazon EKS User Guide .

[1]: docs.aws.amazon.com/eks/latest/userguide/platform-versions.html

Returns:

  • (String)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#resources_vpc_configTypes::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*.

[1]: docs.aws.amazon.com/eks/latest/userguide/network_reqs.html [2]: docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html


461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the cluster.

Returns:

  • (String)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.

Returns:

  • (Hash<String,String>)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

The Kubernetes server version for the cluster.

Returns:

  • (String)

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/aws-sdk-eks/types.rb', line 461

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)
  SENSITIVE = []
  include Aws::Structure
end