Package software.amazon.awscdk.services.eks

Interface CfnAddonProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAddonProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.397Z")
@Stability(Stable)
public interface CfnAddonProps
extends software.amazon.jsii.JsiiSerializable

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.*;
 CfnAddonProps cfnAddonProps = CfnAddonProps.builder()
         .addonName("addonName")
         .clusterName("clusterName")
         // the properties below are optional
         .addonVersion("addonVersion")
         .configurationValues("configurationValues")
         .podIdentityAssociations(List.of(PodIdentityAssociationProperty.builder()
                 .roleArn("roleArn")
                 .serviceAccount("serviceAccount")
                 .build()))
         .preserveOnDelete(false)
         .resolveConflicts("resolveConflicts")
         .serviceAccountRoleArn("serviceAccountRoleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAddonProps.Builder	builder()
String	getAddonName()	The name of the add-on.
default String	getAddonVersion()	The version of the add-on.
String	getClusterName()	The name of your cluster.
default String	getConfigurationValues()	The configuration values that you provided.
default Object	getPodIdentityAssociations()	An array of Pod Identity Assocations owned by the Addon.
default 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 String	getResolveConflicts()	How to resolve field value conflicts for an Amazon EKS add-on.
default String	getServiceAccountRoleArn()	The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
default List<CfnTag>	getTags()	The metadata that you apply to the add-on to assist with categorization and organization.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddonName

@Stability(Stable)
@NotNull
String getAddonName()

The name of the add-on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-addonname

getClusterName

@Stability(Stable)
@NotNull
String getClusterName()

The name of your cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-clustername

getAddonVersion

@Stability(Stable)
@Nullable
default String getAddonVersion()

The version of the add-on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-addonversion

getConfigurationValues

@Stability(Stable)
@Nullable
default String getConfigurationValues()

The configuration values that you provided.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-configurationvalues

getPodIdentityAssociations

@Stability(Stable)
@Nullable
default Object getPodIdentityAssociations()

An array of Pod Identity Assocations owned by the Addon.

Each EKS Pod Identity association maps a role to a service account in a namespace in the cluster.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-podidentityassociations

getPreserveOnDelete

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-preserveondelete

getResolveConflicts

@Stability(Stable)
@Nullable
default 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 – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn't change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-resolveconflicts

getServiceAccountRoleArn

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-serviceaccountrolearn

getTags

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-tags

builder

@Stability(Stable)
static CfnAddonProps.Builder builder()

Returns:

a CfnAddonProps.Builder of CfnAddonProps