You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the cluster.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#certificate_authorityTypes::Certificate

The certificate-authority-data for your cluster.

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#client_request_tokenString

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

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#endpointString

The endpoint for your Kubernetes API server.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#identityTypes::Identity

The identity provider information for the cluster.

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#loggingTypes::Logging

The logging configuration for your cluster.

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#nameString

The name of the cluster.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  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 .

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  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.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  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 AWS API operations on your behalf.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#statusString

The current status of the cluster.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  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.

Returns:

  • (Hash<String,String>)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end

#versionString

The Kubernetes server version for the cluster.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 142

class Cluster < Struct.new(
  :name,
  :arn,
  :created_at,
  :version,
  :endpoint,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :identity,
  :status,
  :certificate_authority,
  :client_request_token,
  :platform_version,
  :tags)
  include Aws::Structure
end