Class CreateCapabilityRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.eks.model.EksRequest
software.amazon.awssdk.services.eks.model.CreateCapabilityRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateCapabilityRequest.Builder,CreateCapabilityRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCapabilityRequest extends EksRequest implements ToCopyableBuilder<CreateCapabilityRequest.Builder,CreateCapabilityRequest>

  • Method Details

    • capabilityName

      public final String capabilityName()

      A unique name for the capability. The name must be unique within your cluster and can contain alphanumeric characters, hyphens, and underscores.

      Returns:
      A unique name for the capability. The name must be unique within your cluster and can contain alphanumeric characters, hyphens, and underscores.

    • clusterName

      public final String clusterName()

      The name of the Amazon EKS cluster where you want to create the capability.

      Returns:
      The name of the Amazon EKS cluster where you want to create the capability.

    • clientRequestToken

      public final String clientRequestToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 24 hours after creation. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 24 hours after creation. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

    • type

      public final CapabilityType type()

      The type of capability to create. Valid values are:

      • ACK – Amazon Web Services Controllers for Kubernetes (ACK), which lets you manage resources directly from Kubernetes.

      • ARGOCD – Argo CD for GitOps-based continuous delivery.

      • KRO – Kube Resource Orchestrator (KRO) for composing and managing custom Kubernetes resources.

      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 to create. Valid values are:

      • ACK – Amazon Web Services Controllers for Kubernetes (ACK), which lets you manage resources directly from Kubernetes.

      • ARGOCD – Argo CD for GitOps-based continuous delivery.

      • KRO – Kube Resource Orchestrator (KRO) for composing and managing custom Kubernetes resources.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of capability to create. Valid values are:

      • ACK – Amazon Web Services Controllers for Kubernetes (ACK), which lets you manage resources directly from Kubernetes.

      • ARGOCD – Argo CD for GitOps-based continuous delivery.

      • KRO – Kube Resource Orchestrator (KRO) for composing and managing custom Kubernetes resources.

      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 to create. Valid values are:

      • ACK – Amazon Web Services Controllers for Kubernetes (ACK), which lets you manage resources directly from Kubernetes.

      • ARGOCD – Argo CD for GitOps-based continuous delivery.

      • KRO – Kube Resource Orchestrator (KRO) for composing and managing custom Kubernetes resources.

      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. This role must have a trust policy that allows the EKS service principal to assume it, and it must have the necessary permissions for the capability type you're creating.

      For ACK capabilities, the role needs permissions to manage the resources you want to control through Kubernetes. For Argo CD capabilities, the role needs permissions to access Git repositories and Secrets Manager. For KRO capabilities, the role needs permissions based on the resources you'll be orchestrating.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services. This role must have a trust policy that allows the EKS service principal to assume it, and it must have the necessary permissions for the capability type you're creating.

      For ACK capabilities, the role needs permissions to manage the resources you want to control through Kubernetes. For Argo CD capabilities, the role needs permissions to access Git repositories and Secrets Manager. For KRO capabilities, the role needs permissions based on the resources you'll be orchestrating.

    • configuration

      public final CapabilityConfigurationRequest configuration()

      The configuration settings for the capability. The structure of this object varies depending on the capability type. For Argo CD capabilities, you can configure IAM Identity CenterIAM; Identity Center integration, RBAC role mappings, and network access settings.

      Returns:
      The configuration settings for the capability. The structure of this object varies depending on the capability type. For Argo CD capabilities, you can configure IAM Identity CenterIAM; Identity Center integration, RBAC role mappings, and network access settings.

    • 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.

    • deletePropagationPolicy

      public final CapabilityDeletePropagationPolicy deletePropagationPolicy()

      Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted. Currently, the only supported value is RETAIN which retains all Kubernetes resources managed by the capability when the capability is deleted.

      Because resources are retained, all Kubernetes resources created by the capability should be deleted from the cluster before deleting the capability itself. After the capability is deleted, these resources become difficult to manage because the controller is no longer available.

      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:
      Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted. Currently, the only supported value is RETAIN which retains all Kubernetes resources managed by the capability when the capability is deleted.

      Because resources are retained, all Kubernetes resources created by the capability should be deleted from the cluster before deleting the capability itself. After the capability is deleted, these resources become difficult to manage because the controller is no longer available.

      See Also:

    • deletePropagationPolicyAsString

      public final String deletePropagationPolicyAsString()

      Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted. Currently, the only supported value is RETAIN which retains all Kubernetes resources managed by the capability when the capability is deleted.

      Because resources are retained, all Kubernetes resources created by the capability should be deleted from the cluster before deleting the capability itself. After the capability is deleted, these resources become difficult to manage because the controller is no longer available.

      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:
      Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted. Currently, the only supported value is RETAIN which retains all Kubernetes resources managed by the capability when the capability is deleted.

      Because resources are retained, all Kubernetes resources created by the capability should be deleted from the cluster before deleting the capability itself. After the capability is deleted, these resources become difficult to manage because the controller is no longer available.

      See Also:

    • toBuilder

      public CreateCapabilityRequest.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<CreateCapabilityRequest.Builder,CreateCapabilityRequest>
      Specified by:
      toBuilder in class EksRequest
      Returns:
      a builder for type T

    • builder

      public static CreateCapabilityRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.