Package software.amazon.awscdk.services.eks

Class CfnAddon

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.eks.CfnAddon

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.387Z")
@Stability(Stable)
public class CfnAddon
extends CfnResource
implements IInspectable, ITaggable

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.*;
 CfnAddon cfnAddon = CfnAddon.Builder.create(this, "MyCfnAddon")
         .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	Class	Description
static final class	CfnAddon.Builder	A fluent builder for CfnAddon.
static interface	CfnAddon.PodIdentityAssociationProperty	Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnAddon(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAddon(software.amazon.jsii.JsiiObjectRef objRef)
	CfnAddon(software.constructs.Construct scope, String id, CfnAddonProps props)

Method Summary

Modifier and Type	Method	Description
String	getAddonName()	The name of the add-on.
String	getAddonVersion()	The version of the add-on.
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 Map<String,Object>	getCfnProperties()
String	getClusterName()	The name of your cluster.
String	getConfigurationValues()	The configuration values that you provided.
Object	getPodIdentityAssociations()	An array of Pod Identity Assocations owned by the Addon.
Object	getPreserveOnDelete()	Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
String	getResolveConflicts()	How to resolve field value conflicts for an Amazon EKS add-on.
String	getServiceAccountRoleArn()	The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAddonName(String value)	The name of the add-on.
void	setAddonVersion(String value)	The version of the add-on.
void	setClusterName(String value)	The name of your cluster.
void	setConfigurationValues(String value)	The configuration values that you provided.
void	setPodIdentityAssociations(List<Object> value)	An array of Pod Identity Assocations owned by the Addon.
void	setPodIdentityAssociations(IResolvable value)	An array of Pod Identity Assocations owned by the Addon.
void	setPreserveOnDelete(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(String value)	How to resolve field value conflicts for an Amazon EKS add-on.
void	setServiceAccountRoleArn(String value)	The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
void	setTagsRaw(List<CfnTag> value)	The metadata that you apply to the add-on to assist with categorization and organization.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnAddon

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

CfnAddon

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

CfnAddon

@Stability(Stable)
public CfnAddon(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAddonProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 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

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public 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

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAddonName

@Stability(Stable)
@NotNull
public String getAddonName()

The name of the add-on.

setAddonName

@Stability(Stable)
public void setAddonName(@NotNull
 String value)

The name of the add-on.

getClusterName

@Stability(Stable)
@NotNull
public String getClusterName()

The name of your cluster.

setClusterName

@Stability(Stable)
public void setClusterName(@NotNull
 String value)

The name of your cluster.

getAddonVersion

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

The version of the add-on.

setAddonVersion

@Stability(Stable)
public void setAddonVersion(@Nullable
 String value)

The version of the add-on.

getConfigurationValues

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

The configuration values that you provided.

setConfigurationValues

@Stability(Stable)
public void setConfigurationValues(@Nullable
 String value)

The configuration values that you provided.

getPodIdentityAssociations

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

An array of Pod Identity Assocations owned by the Addon.

setPodIdentityAssociations

@Stability(Stable)
public void setPodIdentityAssociations(@Nullable
 IResolvable value)

An array of Pod Identity Assocations owned by the Addon.

setPodIdentityAssociations

@Stability(Stable)
public void setPodIdentityAssociations(@Nullable
 List<Object> value)

An array of Pod Identity Assocations owned by the Addon.

getPreserveOnDelete

@Stability(Stable)
@Nullable
public Object getPreserveOnDelete()

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

setPreserveOnDelete

@Stability(Stable)
public void setPreserveOnDelete(@Nullable
 Boolean value)

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

setPreserveOnDelete

@Stability(Stable)
public void setPreserveOnDelete(@Nullable
 IResolvable value)

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

getResolveConflicts

@Stability(Stable)
@Nullable
public String getResolveConflicts()

How to resolve field value conflicts for an Amazon EKS add-on.

setResolveConflicts

@Stability(Stable)
public void setResolveConflicts(@Nullable
 String value)

How to resolve field value conflicts for an Amazon EKS add-on.

getServiceAccountRoleArn

@Stability(Stable)
@Nullable
public String getServiceAccountRoleArn()

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.

setServiceAccountRoleArn

@Stability(Stable)
public void setServiceAccountRoleArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The metadata that you apply to the add-on to assist with categorization and organization.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The metadata that you apply to the add-on to assist with categorization and organization.