Class: Aws::Batch::Types::EksAccessEntry

Inherits:

Struct

Object
Struct
Aws::Batch::Types::EksAccessEntry

show all

Defined in:: gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Configures whether Batch manages an Amazon EKS access entry on the cluster for the compute environment. For information on how the fields interact with the cluster's authenticationMode and with other compute environments that share the cluster, see Amazon EKS access entry authentication in the Batch User Guide.

Setting desiredState=ENABLED on a single compute environment does not guarantee that Batch creates an access entry, and setting desiredState=DISABLED on a single compute environment does not guarantee that Batch deletes one. Batch compares the desiredState across all compute environments that target the same cluster. The Batch-managed access entry is created only when all compute environments have desiredState=ENABLED, and deleted only when all have desiredState=DISABLED. If you have multiple compute environments on the same cluster, set desiredState consistently across all of them to avoid uncertainty. For more information, see Reconciling desiredState across compute environments in the Batch User Guide.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#desired_state ⇒ String
The desired access entry state for the compute environment.
#status ⇒ String
The observed state of the access entry on the cluster.

Instance Attribute Details

#desired_state ⇒ `String`

The desired access entry state for the compute environment. Valid values:

ENABLED: Batch manages an access entry on the cluster for the compute environment.
DISABLED: Batch deletes the Batch-managed access entry for the cluster. This value is rejected if the cluster's authenticationMode is API, because such a cluster doesn't support the aws-auth ConfigMap.
INHERIT_FROM_CLUSTER: Batch defers to the cluster's current access entry status. On a cluster whose authentication mode is API, Batch creates and manages an access entry. On a cluster whose authentication mode is API_AND_CONFIG_MAP or CONFIG_MAP, Batch neither adds nor removes an access entry.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4748

class EksAccessEntry < Struct.new(
  :desired_state,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The observed state of the access entry on the cluster. ACTIVE means that an access entry for the compute environment exists on the cluster and takes precedence over the aws-auth ConfigMap. INACTIVE means that no Batch-managed access entry is present. This is a read-only field returned by DescribeComputeEnvironments.