Package software.amazon.awscdk.services.eks.legacy

Class CfnAddon.Builder

java.lang.Object
software.amazon.awscdk.services.eks.legacy.CfnAddon.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAddon>
Enclosing class:
CfnAddon
@Stability(Stable) public static final class CfnAddon.Builder extends Object implements software.amazon.jsii.Builder<CfnAddon>
A fluent builder for CfnAddon.

  • Method Details

    • create

      @Stability(Stable) public static CfnAddon.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnAddon.Builder.

    • addonName

      @Stability(Stable) public CfnAddon.Builder addonName(String addonName)
      The name of the add-on.

      Parameters:
      addonName - The name of the add-on. This parameter is required.
      Returns:
      this

    • clusterName

      @Stability(Stable) public CfnAddon.Builder clusterName(String clusterName)
      The name of the cluster.

      Parameters:
      clusterName - The name of the cluster. This parameter is required.
      Returns:
      this

    • addonVersion

      @Stability(Stable) public CfnAddon.Builder addonVersion(String addonVersion)
      The version of the add-on.

      Parameters:
      addonVersion - The version of the add-on. This parameter is required.
      Returns:
      this

    • configurationValues

      @Stability(Stable) public CfnAddon.Builder configurationValues(String configurationValues)
      The configuration values that you provided.

      Parameters:
      configurationValues - The configuration values that you provided. This parameter is required.
      Returns:
      this

    • preserveOnDelete

      @Stability(Stable) public CfnAddon.Builder preserveOnDelete(Boolean preserveOnDelete)
      Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

      If an IAM account is associated with the add-on, it isn't removed.

      Parameters:
      preserveOnDelete - Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. This parameter is required.
      Returns:
      this

    • preserveOnDelete

      @Stability(Stable) public CfnAddon.Builder preserveOnDelete(IResolvable preserveOnDelete)
      Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

      If an IAM account is associated with the add-on, it isn't removed.

      Parameters:
      preserveOnDelete - Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. This parameter is required.
      Returns:
      this

    • resolveConflicts

      @Stability(Stable) public CfnAddon.Builder resolveConflicts(String resolveConflicts)
      How to resolve field value conflicts for an Amazon EKS add-on.

      Conflicts are handled based on the value you choose:

      • None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.
      • Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.
      • Preserve – Not supported. You can set this value when updating an add-on though. For more information, see UpdateAddon .

      If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.

      Parameters:
      resolveConflicts - How to resolve field value conflicts for an Amazon EKS add-on. This parameter is required.
      Returns:
      this

    • serviceAccountRoleArn

      @Stability(Stable) public CfnAddon.Builder serviceAccountRoleArn(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 .

      Parameters:
      serviceAccountRoleArn - The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnAddon.Builder tags(List<? extends CfnTag> tags)
      The metadata that you apply to the add-on to assist with categorization and organization.

      Each tag consists of a key and an optional value, both of which you define. Add-on tags do not propagate to any other resources associated with the cluster.

      Parameters:
      tags - The metadata that you apply to the add-on to assist with categorization and organization. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnAddon build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAddon>
      Returns:
      a newly built instance of CfnAddon.