Class: Aws::EKS::Types::Capability

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

Overview

An object representing a managed capability in an Amazon EKS cluster. This includes all configuration, status, and health information for the capability.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the capability.

Returns:

  • (String) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#capability_name ⇒ String

The unique name of the capability within the cluster.

Returns:

  • (String) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

The name of the Amazon EKS cluster that contains this capability.

Returns:

  • (String) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::CapabilityConfigurationResponse

The configuration settings for the capability. The structure varies depending on the capability type.

Returns:



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

  • (Time) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#delete_propagation_policy ⇒ String

The delete propagation policy for the capability. Currently, the only supported value is RETAIN, which keeps all resources managed by the capability when the capability is deleted.

Returns:

  • (String) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#health ⇒ Types::CapabilityHealth

Health information for the capability, including any issues that may be affecting its operation.

Returns:



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#modified_at ⇒ Time

The Unix epoch timestamp in seconds for when the capability was last modified.

Returns:

  • (Time) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services.

Returns:

  • (String) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the capability. Valid values include:

  • CREATING – The capability is being created.

  • ACTIVE – The capability is running and available.

  • UPDATING – The capability is being updated.

  • DELETING – The capability is being deleted.

  • CREATE_FAILED – The capability creation failed.

  • UPDATE_FAILED – The capability update failed.

  • DELETE_FAILED – The capability deletion failed.

Returns:

  • (String) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource – 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length – 128 Unicode characters in UTF-8

  • Maximum value length – 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

  • (Hash<String,String>) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of capability. Valid values are ACK, ARGOCD, or KRO.

Returns:

  • (String) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version of the capability software that is currently running.

Returns:

  • (String) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 1121

class Capability < Struct.new(
  :capability_name,
  :arn,
  :cluster_name,
  :type,
  :role_arn,
  :status,
  :version,
  :configuration,
  :tags,
  :health,
  :created_at,
  :modified_at,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end