Class CfnAddon
A CloudFormation AWS::EKS::Addon
.
Inherited Members
Namespace: Amazon.CDK.AWS.EKS.Legacy
Assembly: Amazon.CDK.AWS.EKS.Legacy.dll
Syntax (csharp)
public class CfnAddon : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAddon
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::EKS::Addon
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKS.Legacy;
var cfnAddon = new CfnAddon(this, "MyCfnAddon", new CfnAddonProps {
AddonName = "addonName",
ClusterName = "clusterName",
// the properties below are optional
AddonVersion = "addonVersion",
ConfigurationValues = "configurationValues",
PreserveOnDelete = false,
ResolveConflicts = "resolveConflicts",
ServiceAccountRoleArn = "serviceAccountRoleArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnAddon(Construct, String, ICfnAddonProps) | Create a new |
CfnAddon(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAddon(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AddonName | The name of the add-on. |
AddonVersion | The version of the add-on. |
AttrArn | The ARN of the add-on, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterName | The name of the cluster. |
ConfigurationValues | The configuration values that you provided. |
PreserveOnDelete | Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. |
ResolveConflicts | How to resolve field value conflicts for an Amazon EKS add-on. |
ServiceAccountRoleArn | The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. |
Tags | The metadata that you apply to the add-on to assist with categorization and organization. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAddon(Construct, String, ICfnAddonProps)
Create a new AWS::EKS::Addon
.
public CfnAddon(Construct scope, string id, ICfnAddonProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAddonProps
- resource properties.
CfnAddon(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAddon(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAddon(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAddon(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AddonName
The name of the add-on.
public virtual string AddonName { get; set; }
Property Value
System.String
Remarks
AddonVersion
The version of the add-on.
public virtual string AddonVersion { get; set; }
Property Value
System.String
Remarks
AttrArn
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
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClusterName
The name of the cluster.
public virtual string ClusterName { get; set; }
Property Value
System.String
Remarks
ConfigurationValues
The configuration values that you provided.
public virtual string ConfigurationValues { get; set; }
Property Value
System.String
Remarks
PreserveOnDelete
Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
public virtual object PreserveOnDelete { get; set; }
Property Value
System.Object
Remarks
If an IAM account is associated with the add-on, it isn't removed.
ResolveConflicts
How to resolve field value conflicts for an Amazon EKS add-on.
public virtual string ResolveConflicts { get; set; }
Property Value
System.String
Remarks
Conflicts are handled based on the value you choose:
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.
ServiceAccountRoleArn
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
public virtual string ServiceAccountRoleArn { get; set; }
Property Value
System.String
Remarks
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 .
Tags
The metadata that you apply to the add-on to assist with categorization and organization.
public virtual TagManager Tags { get; }
Property Value
Remarks
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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>