Class EksAccessEntry

java.lang.Object
software.amazon.awssdk.services.batch.model.EksAccessEntry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EksAccessEntry.Builder,EksAccessEntry>
@Generated("software.amazon.awssdk:codegen") public final class EksAccessEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EksAccessEntry.Builder,EksAccessEntry>

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.

See Also:

  • Method Details

    • desiredState

      public final EksAccessEntryDesiredState 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.

      If the service returns an enum value that is not available in the current SDK version, desiredState will return EksAccessEntryDesiredState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

      Returns:
      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.

      See Also:

    • desiredStateAsString

      public final String desiredStateAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, desiredState will return EksAccessEntryDesiredState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

      Returns:
      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.

      See Also:

    • status

      public final EksAccessEntryStatus 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.

      If the service returns an enum value that is not available in the current SDK version, status will return EksAccessEntryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.
      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return EksAccessEntryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.
      See Also:

    • toBuilder

      public EksAccessEntry.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<EksAccessEntry.Builder,EksAccessEntry>
      Returns:
      a builder for type T

    • builder

      public static EksAccessEntry.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EksAccessEntry.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.