software.amazon.awscdk.services.eks.legacy

Interface CfnAddonProps

All Known Implementing Classes:

CfnAddonProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:59.783Z")
public interface CfnAddonProps

Properties for defining a `CfnAddon`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.legacy.*;
 CfnAddonProps cfnAddonProps = CfnAddonProps.builder()
         .addonName("addonName")
         .clusterName("clusterName")
         // the properties below are optional
         .addonVersion("addonVersion")
         .configurationValues("configurationValues")
         .preserveOnDelete(false)
         .resolveConflicts("resolveConflicts")
         .serviceAccountRoleArn("serviceAccountRoleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAddonProps.Builder A builder for CfnAddonProps
static class	CfnAddonProps.Jsii$Proxy An implementation for CfnAddonProps

Method Summary

Modifier and Type	Method and Description
static CfnAddonProps.Builder	builder()
java.lang.String	getAddonName() The name of the add-on.
default java.lang.String	getAddonVersion() The version of the add-on.
java.lang.String	getClusterName() The name of the cluster.
default java.lang.String	getConfigurationValues() The configuration values that you provided.
default java.lang.Object	getPreserveOnDelete() Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
default java.lang.String	getResolveConflicts() How to resolve field value conflicts for an Amazon EKS add-on.
default java.lang.String	getServiceAccountRoleArn() The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
default java.util.List<CfnTag>	getTags() The metadata that you apply to the add-on to assist with categorization and organization.

Method Detail

getAddonName

java.lang.String getAddonName()

The name of the add-on.

getClusterName

java.lang.String getClusterName()

The name of the cluster.

getAddonVersion

default java.lang.String getAddonVersion()

The version of the add-on.

getConfigurationValues

default java.lang.String getConfigurationValues()

The configuration values that you provided.

getPreserveOnDelete

default java.lang.Object getPreserveOnDelete()

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.

getResolveConflicts

default java.lang.String getResolveConflicts()

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.

getServiceAccountRoleArn

default java.lang.String getServiceAccountRoleArn()

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 .

getTags

default java.util.List<CfnTag> getTags()

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.

builder

static CfnAddonProps.Builder builder()

Returns:

a CfnAddonProps.Builder of CfnAddonProps