/AWS1/CL_BTCEKSACCESSENTRY

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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_desiredstate TYPE /AWS1/BTCEKSACCENTRDESIREDSTAT /AWS1/BTCEKSACCENTRDESIREDSTAT

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.

Optional arguments:

iv_status TYPE /AWS1/BTCEKSACCESSENTRYSTATUS /AWS1/BTCEKSACCESSENTRYSTATUS

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.

---

Queryable Attributes

desiredState

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.

Accessible with the following methods

Method	Description
GET_DESIREDSTATE()	Getter for DESIREDSTATE, with configurable default
ASK_DESIREDSTATE()	Getter for DESIREDSTATE w/ exceptions if field has no value
HAS_DESIREDSTATE()	Determine if DESIREDSTATE has a value

status

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.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value