Class: Aws::Batch::Types::EksConfiguration

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

Overview

Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_entry ⇒ Types::EksAccessEntry

The Batch-managed Amazon EKS access entry for the compute environment. Set desiredState to declare whether Batch manages an access entry on the cluster. In a DescribeComputeEnvironments response, desiredState is the value that Batch recorded for the compute environment and status is the observed state of the access entry on the cluster. To change the access entry on an existing compute environment, use EksConfigurationUpdate.accessEntry .

Whether the entry is provisioned on the cluster depends on the cluster's authenticationMode and the desiredState recorded for each Batch compute environment targeting the cluster. For more information, see Amazon EKS access entry authentication in the Batch User Guide.

If you don't specify this field, Batch doesn't record a desiredState for the compute environment and DescribeComputeEnvironments doesn't return one. For the purpose of provisioning the access entry, Batch behaves as it does for INHERIT_FROM_CLUSTER.

Returns:



4901
4902
4903
4904
4905
4906
4907
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4901

class EksConfiguration < Struct.new(
  :eks_cluster_arn,
  :kubernetes_namespace,
  :access_entry)
  SENSITIVE = []
  include Aws::Structure
end

#eks_cluster_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch.

Returns:

  • (String) 


4901
4902
4903
4904
4905
4906
4907
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4901

class EksConfiguration < Struct.new(
  :eks_cluster_arn,
  :kubernetes_namespace,
  :access_entry)
  SENSITIVE = []
  include Aws::Structure
end

#kubernetes_namespace ⇒ String

The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or null. It must be fewer than 64 characters long, can't be set to default, can't start with "kube-," and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.

Returns:

  • (String) 


4901
4902
4903
4904
4905
4906
4907
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4901

class EksConfiguration < Struct.new(
  :eks_cluster_arn,
  :kubernetes_namespace,
  :access_entry)
  SENSITIVE = []
  include Aws::Structure
end