Skip to content

EksAccessEntry

Source code in docs_src/capo_batch/types/eks_access_entry.py 
12
13
14
15
16
17
18
class EksAccessEntry(TypedDict, closed=True):
    desired_state: NotRequired[
        "capo_batch.types.eks_access_entry_desired_state.EksAccessEntryDesiredState"
    ]
    """<p>The desired access entry state for the compute environment. Valid values:</p> <dl> <dt>ENABLED</dt> <dd> <p>Batch manages an access entry on the cluster for the compute environment.</p> </dd> <dt>DISABLED</dt> <dd> <p>Batch deletes the Batch-managed access entry for the cluster. This value is rejected if the cluster's <code>authenticationMode</code> is <code>API</code>, because such a cluster doesn't support the <code>aws-auth</code> ConfigMap.</p> </dd> <dt>INHERIT_FROM_CLUSTER</dt> <dd> <p>Batch defers to the cluster's current access entry <code>status</code>. On a cluster whose authentication mode is <code>API</code>, Batch creates and manages an access entry. On a cluster whose authentication mode is <code>API_AND_CONFIG_MAP</code> or <code>CONFIG_MAP</code>, Batch neither adds nor removes an access entry.</p> </dd> </dl>"""
    status: NotRequired["capo_batch.types.eks_access_entry_status.EksAccessEntryStatus"]
    """<p>The observed state of the access entry on the cluster. <code>ACTIVE</code> means that an access entry for the compute environment exists on the cluster and takes precedence over the <code>aws-auth</code> ConfigMap. <code>INACTIVE</code> means that no Batch-managed access entry is present. This is a read-only field returned by <code>DescribeComputeEnvironments</code>.</p>"""

desired_state instance-attribute 

desired_state: NotRequired[EksAccessEntryDesiredState]

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.

status instance-attribute 

status: NotRequired[EksAccessEntryStatus]

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.