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.92.0 (build db7f27d)",
date="2023-12-06T04:49:38.326Z")
@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") .preserveOnDelete(false) .resolveConflicts("resolveConflicts") .serviceAccountRoleArn("serviceAccountRoleArn") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesNested 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
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe name of the add-on.The version of the add-on.The ARN of the add-on, such asarn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
.The name of the cluster.The configuration values that you provided.Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.How to resolve field value conflicts for an Amazon EKS add-on.The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.getTags()
Tag Manager which manages the tags for this resource.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.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
setConfigurationValues
(String value) The configuration values that you provided.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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the add-on, such asarn:aws:eks:us-west-2:111122223333:addon/1-19/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAddonName
The name of the add-on. -
setAddonName
The name of the add-on. -
getClusterName
The name of the cluster. -
setClusterName
The name of the cluster. -
getAddonVersion
The version of the add-on. -
setAddonVersion
The version of the add-on. -
getConfigurationValues
The configuration values that you provided. -
setConfigurationValues
The configuration values that you provided. -
getPreserveOnDelete
Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. -
setPreserveOnDelete
Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. -
setPreserveOnDelete
Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. -
getResolveConflicts
How to resolve field value conflicts for an Amazon EKS add-on. -
setResolveConflicts
How to resolve field value conflicts for an Amazon EKS add-on. -
getServiceAccountRoleArn
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. -
setServiceAccountRoleArn
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. -
getTagsRaw
The metadata that you apply to the add-on to assist with categorization and organization. -
setTagsRaw
The metadata that you apply to the add-on to assist with categorization and organization.
-