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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.895Z")
 @Stability(value=Stable)
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. Amazon EKS add-ons require clusters running version 1.18 or later because Amazon EKS add-ons rely on the Server-side Apply Kubernetes feature, which is only available in Kubernetes 1.18 and later. 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")
         .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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAddon(software.constructs.Construct scope, 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
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 the cluster.
String	getResolveConflicts() How to resolve parameter value conflicts when migrating an existing add-on to 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() 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 the cluster.
void	setResolveConflicts(String value) How to resolve parameter value conflicts when migrating an existing add-on to 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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnAddon(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         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

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

The name of the add-on.

setAddonName

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

The name of the add-on.

getClusterName

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

The name of the cluster.

setClusterName

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

The name of the cluster.

getAddonVersion

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

The version of the add-on.

setAddonVersion

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

The version of the add-on.

getResolveConflicts

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

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

setResolveConflicts

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

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

getServiceAccountRoleArn

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=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.

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 .