Class CfnAddonMixinProps

Properties for CfnAddonPropsMixin.

Inheritance

object

CfnAddonMixinProps

Implements

ICfnAddonMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.EKS

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnAddonMixinProps : ICfnAddonMixinProps

Syntax (vb)

Public Class CfnAddonMixinProps Implements ICfnAddonMixinProps

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.CfnPropertyMixins.AWS.EKS;

             var cfnAddonMixinProps = new CfnAddonMixinProps {
                 AddonName = "addonName",
                 AddonVersion = "addonVersion",
                 ClusterName = "clusterName",
                 ConfigurationValues = "configurationValues",
                 NamespaceConfig = new NamespaceConfigProperty {
                     Namespace = "namespace"
                 },
                 PodIdentityAssociations = new [] { new PodIdentityAssociationProperty {
                     RoleArn = "roleArn",
                     ServiceAccount = "serviceAccount"
                 } },
                 PreserveOnDelete = false,
                 ResolveConflicts = "resolveConflicts",
                 ServiceAccountRoleArn = "serviceAccountRoleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnAddonMixinProps()

Properties for CfnAddonPropsMixin.

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.
NamespaceConfig	The namespace configuration for the addon.
PodIdentityAssociations	An array of EKS Pod Identity associations owned by the add-on.
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

CfnAddonMixinProps()

Properties for CfnAddonPropsMixin.

public CfnAddonMixinProps()

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.CfnPropertyMixins.AWS.EKS;

             var cfnAddonMixinProps = new CfnAddonMixinProps {
                 AddonName = "addonName",
                 AddonVersion = "addonVersion",
                 ClusterName = "clusterName",
                 ConfigurationValues = "configurationValues",
                 NamespaceConfig = new NamespaceConfigProperty {
                     Namespace = "namespace"
                 },
                 PodIdentityAssociations = new [] { new PodIdentityAssociationProperty {
                     RoleArn = "roleArn",
                     ServiceAccount = "serviceAccount"
                 } },
                 PreserveOnDelete = false,
                 ResolveConflicts = "resolveConflicts",
                 ServiceAccountRoleArn = "serviceAccountRoleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AddonName

The name of the add-on.

public string? AddonName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-addonname

AddonVersion

The version of the add-on.

public string? AddonVersion { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-addonversion

ClusterName

The name of your cluster.

public string? ClusterName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-clustername

ConfigurationValues

The configuration values that you provided.

public string? ConfigurationValues { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-configurationvalues

NamespaceConfig

The namespace configuration for the addon.

public object? NamespaceConfig { get; set; }

Property Value

object

Remarks

This specifies the Kubernetes namespace where the addon is installed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-namespaceconfig

Type union: either IResolvable or CfnAddonPropsMixin.INamespaceConfigProperty

PodIdentityAssociations

An array of EKS Pod Identity associations owned by the add-on.

public object? PodIdentityAssociations { get; set; }

Property Value

object

Remarks

Each association maps a role to a service account in a namespace in the cluster.

For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the Amazon EKS User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-podidentityassociations

Type union: either IResolvable or (either IResolvable or CfnAddonPropsMixin.IPodIdentityAssociationProperty)[]

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

object

Remarks

If an IAM account is associated with the add-on, it isn't removed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-preserveondelete

Type union: either bool or IResolvable

ResolveConflicts

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

public string? ResolveConflicts { get; set; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-resolveconflicts

ServiceAccountRoleArn

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

public object? ServiceAccountRoleArn { get; set; }

Property Value

object

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 <a href="https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html">Enabling IAM roles for service accounts on your cluster</a> in the <em>Amazon EKS User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html#cfn-eks-addon-serviceaccountrolearn

Type union: either string or IRoleRef

Implements

ICfnAddonMixinProps