Package software.amazon.awssdk.services.eks.model

Class UpdateAddonRequest

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.UpdateAddonRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateAddonRequest.Builder,UpdateAddonRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateAddonRequest extends EksRequest implements ToCopyableBuilder<UpdateAddonRequest.Builder,UpdateAddonRequest>

  • Method Details

    • clusterName

      public final String clusterName()

      The name of your cluster.

      Returns:
      The name of your cluster.

    • addonName

      public final String addonName()

      The name of the add-on. The name must match one of the names returned by ListAddons .

      Returns:
      The name of the add-on. The name must match one of the names returned by ListAddons .

    • addonVersion

      public final String addonVersion()

      The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

      Returns:
      The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

    • serviceAccountRoleArn

      public final String serviceAccountRoleArn()

      The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

      To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.

      Returns:
      The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

      To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.

    • resolveConflicts

      public final ResolveConflicts resolveConflicts()

      How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:

      • None – Amazon EKS doesn't change the value. The update might fail.

      • Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.

      • Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.

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

      Returns:
      How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:

      • None – Amazon EKS doesn't change the value. The update might fail.

      • Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.

      • Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.

      See Also:

    • resolveConflictsAsString

      public final String resolveConflictsAsString()

      How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:

      • None – Amazon EKS doesn't change the value. The update might fail.

      • Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.

      • Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.

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

      Returns:
      How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:

      • None – Amazon EKS doesn't change the value. The update might fail.

      • Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.

      • Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.

      See Also:

    • clientRequestToken

      public final String clientRequestToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • configurationValues

      public final String configurationValues()

      The set of configuration values for the add-on that's created. The values that you provide are validated against the schema returned by DescribeAddonConfiguration.

      Returns:
      The set of configuration values for the add-on that's created. The values that you provide are validated against the schema returned by DescribeAddonConfiguration.

    • hasPodIdentityAssociations

      public final boolean hasPodIdentityAssociations()
      For responses, this returns true if the service returned a value for the PodIdentityAssociations 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.

    • podIdentityAssociations

      public final List<AddonPodIdentityAssociations> podIdentityAssociations()

      An array of Pod Identity Assocations to be updated. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role. If this value is left blank, no change. If an empty array is provided, existing Pod Identity Assocations owned by the Addon are deleted.

      For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

      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 hasPodIdentityAssociations() method.

      Returns:
      An array of Pod Identity Assocations to be updated. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role. If this value is left blank, no change. If an empty array is provided, existing Pod Identity Assocations owned by the Addon are deleted.

      For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

    • toBuilder

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

    • builder

      public static UpdateAddonRequest.Builder builder()

    • serializableBuilderClass

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