Class Capability

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

An object representing a managed capability in an Amazon EKS cluster. This includes all configuration, status, and health information for the capability.

See Also:

  • Method Details

    • capabilityName

      public final String capabilityName()

      The unique name of the capability within the cluster.

      Returns:
      The unique name of the capability within the cluster.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the capability.

      Returns:
      The Amazon Resource Name (ARN) of the capability.

    • clusterName

      public final String clusterName()

      The name of the Amazon EKS cluster that contains this capability.

      Returns:
      The name of the Amazon EKS cluster that contains this capability.

    • type

      public final CapabilityType type()

      The type of capability. Valid values are ACK, ARGOCD, or KRO.

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

      Returns:
      The type of capability. Valid values are ACK, ARGOCD, or KRO.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of capability. Valid values are ACK, ARGOCD, or KRO.

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

      Returns:
      The type of capability. Valid values are ACK, ARGOCD, or KRO.
      See Also:

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services.

    • status

      public final CapabilityStatus status()

      The current status of the capability. Valid values include:

      • CREATING – The capability is being created.

      • ACTIVE – The capability is running and available.

      • UPDATING – The capability is being updated.

      • DELETING – The capability is being deleted.

      • CREATE_FAILED – The capability creation failed.

      • UPDATE_FAILED – The capability update failed.

      • DELETE_FAILED – The capability deletion failed.

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

      Returns:
      The current status of the capability. Valid values include:

      • CREATING – The capability is being created.

      • ACTIVE – The capability is running and available.

      • UPDATING – The capability is being updated.

      • DELETING – The capability is being deleted.

      • CREATE_FAILED – The capability creation failed.

      • UPDATE_FAILED – The capability update failed.

      • DELETE_FAILED – The capability deletion failed.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the capability. Valid values include:

      • CREATING – The capability is being created.

      • ACTIVE – The capability is running and available.

      • UPDATING – The capability is being updated.

      • DELETING – The capability is being deleted.

      • CREATE_FAILED – The capability creation failed.

      • UPDATE_FAILED – The capability update failed.

      • DELETE_FAILED – The capability deletion failed.

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

      Returns:
      The current status of the capability. Valid values include:

      • CREATING – The capability is being created.

      • ACTIVE – The capability is running and available.

      • UPDATING – The capability is being updated.

      • DELETING – The capability is being deleted.

      • CREATE_FAILED – The capability creation failed.

      • UPDATE_FAILED – The capability update failed.

      • DELETE_FAILED – The capability deletion failed.

      See Also:

    • version

      public final String version()

      The version of the capability software that is currently running.

      Returns:
      The version of the capability software that is currently running.

    • configuration

      public final CapabilityConfigurationResponse configuration()

      The configuration settings for the capability. The structure varies depending on the capability type.

      Returns:
      The configuration settings for the capability. The structure varies depending on the capability type.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()
      Returns the value of the Tags property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The value of the Tags property for this object.

    • health

      public final CapabilityHealth health()

      Health information for the capability, including any issues that may be affecting its operation.

      Returns:
      Health information for the capability, including any issues that may be affecting its operation.

    • createdAt

      public final Instant createdAt()

      The Unix epoch timestamp in seconds for when the capability was created.

      Returns:
      The Unix epoch timestamp in seconds for when the capability was created.

    • modifiedAt

      public final Instant modifiedAt()

      The Unix epoch timestamp in seconds for when the capability was last modified.

      Returns:
      The Unix epoch timestamp in seconds for when the capability was last modified.

    • deletePropagationPolicy

      public final CapabilityDeletePropagationPolicy deletePropagationPolicy()

      The delete propagation policy for the capability. Currently, the only supported value is RETAIN, which keeps all resources managed by the capability when the capability is deleted.

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

      Returns:
      The delete propagation policy for the capability. Currently, the only supported value is RETAIN, which keeps all resources managed by the capability when the capability is deleted.
      See Also:

    • deletePropagationPolicyAsString

      public final String deletePropagationPolicyAsString()

      The delete propagation policy for the capability. Currently, the only supported value is RETAIN, which keeps all resources managed by the capability when the capability is deleted.

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

      Returns:
      The delete propagation policy for the capability. Currently, the only supported value is RETAIN, which keeps all resources managed by the capability when the capability is deleted.
      See Also:

    • toBuilder

      public Capability.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<Capability.Builder,Capability>
      Returns:
      a builder for type T

    • builder

      public static Capability.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Capability.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.