Class CfnAddonProps
Properties for defining a CfnAddon
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAddonProps : Object, ICfnAddonProps
Syntax (vb)
Public Class CfnAddonProps
Inherits Object
Implements ICfnAddonProps
Remarks
See: 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;
var cfnAddonProps = 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
CfnAddonProps() |
Properties
AddonName | The name of the add-on. |
AddonVersion | The version of the add-on. |
ClusterName | The name of your 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. |
Constructors
CfnAddonProps()
public CfnAddonProps()
Properties
AddonName
The name of the add-on.
public string AddonName { get; set; }
Property Value
System.String
Remarks
AddonVersion
The version of the add-on.
public string AddonVersion { get; set; }
Property Value
System.String
Remarks
ClusterName
The name of your cluster.
public string ClusterName { get; set; }
Property Value
System.String
Remarks
ConfigurationValues
The configuration values that you provided.
public 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 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 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 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 ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
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.