software.amazon.awscdk.services.eks.legacy

Class CfnAddon

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.eks.legacy.CfnAddon

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:34.901Z")
public class CfnAddon
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EKS::Addon`.

Creates an Amazon EKS add-on.

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide .

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.*;
 CfnAddon cfnAddon = CfnAddon.Builder.create(this, "MyCfnAddon")
         .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	Class and Description
static class	CfnAddon.Builder A fluent builder for CfnAddon.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAddon(Construct scope, java.lang.String id, CfnAddonProps props) Create a new `AWS::EKS::Addon`.
protected	CfnAddon(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAddon(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddonName() The name of the add-on.
java.lang.String	getAddonVersion() The version of the add-on.
java.lang.String	getAttrArn() The ARN of the add-on, such as `arn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getClusterName() The name of the cluster.
java.lang.String	getConfigurationValues() The configuration values that you provided.
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.
java.lang.String	getResolveConflicts() How to resolve field value conflicts for an Amazon EKS add-on.
java.lang.String	getServiceAccountRoleArn() The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
TagManager	getTags() The metadata that you apply to the add-on to assist with categorization and organization.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAddonName(java.lang.String value) The name of the add-on.
void	setAddonVersion(java.lang.String value) The version of the add-on.
void	setClusterName(java.lang.String value) The name of the cluster.
void	setConfigurationValues(java.lang.String value) The configuration values that you provided.
void	setPreserveOnDelete(java.lang.Boolean value) Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
void	setPreserveOnDelete(IResolvable value) Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
void	setResolveConflicts(java.lang.String value) How to resolve field value conflicts for an Amazon EKS add-on.
void	setServiceAccountRoleArn(java.lang.String value) The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAddon

protected CfnAddon(software.amazon.jsii.JsiiObjectRef objRef)

CfnAddon

protected CfnAddon(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAddon

public CfnAddon(Construct scope,
                java.lang.String id,
                CfnAddonProps props)

Create a new `AWS::EKS::Addon`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the add-on, such as `arn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager 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.

getAddonName

public java.lang.String getAddonName()

The name of the add-on.

setAddonName

public void setAddonName(java.lang.String value)

The name of the add-on.

getClusterName

public java.lang.String getClusterName()

The name of the cluster.

setClusterName

public void setClusterName(java.lang.String value)

The name of the cluster.

getAddonVersion

public java.lang.String getAddonVersion()

The version of the add-on.

setAddonVersion

public void setAddonVersion(java.lang.String value)

The version of the add-on.

getConfigurationValues

public java.lang.String getConfigurationValues()

The configuration values that you provided.

setConfigurationValues

public void setConfigurationValues(java.lang.String value)

The configuration values that you provided.

getPreserveOnDelete

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

setPreserveOnDelete

public void setPreserveOnDelete(java.lang.Boolean value)

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.

setPreserveOnDelete

public void setPreserveOnDelete(IResolvable value)

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

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

setResolveConflicts

public void setResolveConflicts(java.lang.String value)

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

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

setServiceAccountRoleArn

public void setServiceAccountRoleArn(java.lang.String value)

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 .