Class: Aws::Batch::Types::EksMetadata

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

Overview

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the ‘jobID` for a job running in the pod. For more information, see [ Understanding Kubernetes Objects] in the *Kubernetes documentation*.

[1]: kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Key-value pairs used to attach arbitrary, non-identifying metadata to Kubernetes objects. Valid annotation keys have two segments: an optional prefix and a name, separated by a slash (/).

  • The prefix is optional and must be 253 characters or less. If specified, the prefix must be a DNS subdomain− a series of DNS labels separated by dots (.), and it must end with a slash (/).

  • The name segment is required and must be 63 characters or less. It can include alphanumeric characters ([a-z0-9A-Z]), dashes (-), underscores (_), and dots (.), but must begin and end with an alphanumeric character.

<note markdown=“1”> Annotation values must be 255 characters or less.

</note>

Annotations can be added or modified at any time. Each resource can have multiple annotations.

Returns:

  • (Hash<String,String>) 


4150
4151
4152
4153
4154
4155
4156
 
# File 'lib/aws-sdk-batch/types.rb', line 4150

class EksMetadata < Struct.new(
  :labels,
  :annotations,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#labels ⇒ Hash<String,String>

Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63 uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be added or modified at any time. Each resource can have multiple labels, but each key must be unique for a given object.

Returns:

  • (Hash<String,String>) 


4150
4151
4152
4153
4154
4155
4156
 
# File 'lib/aws-sdk-batch/types.rb', line 4150

class EksMetadata < Struct.new(
  :labels,
  :annotations,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the Amazon EKS cluster. In Kubernetes, namespaces provide a mechanism for isolating groups of resources within a single cluster. Names of resources need to be unique within a namespace, but not across namespaces. Batch places Batch Job pods in this namespace. If this field is provided, the value can’t be empty or null. It must meet the following requirements:

  • 1-63 characters long

  • Can’t be set to default

  • Can’t start with ‘kube`

  • Must match the following regular expression: ‘^[a-z0-9](*[a-z0-9])?$`

For more information, see [Namespaces] in the *Kubernetes documentation*. This namespace can be different from the ‘kubernetesNamespace` set in the compute environment’s ‘EksConfiguration`, but must have identical role-based access control (RBAC) roles as the compute environment’s ‘kubernetesNamespace`. For multi-node parallel jobs, the same value must be provided across all the node ranges.

[1]: kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

Returns:

  • (String) 


4150
4151
4152
4153
4154
4155
4156
 
# File 'lib/aws-sdk-batch/types.rb', line 4150

class EksMetadata < Struct.new(
  :labels,
  :annotations,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end