Package software.amazon.awscdk.cfnpropertymixins.services.eks

Class CfnAddonPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.eks.CfnAddonPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAddonPropsMixin>

Enclosing class:

CfnAddonPropsMixin

@Stability(Stable)
public static final class CfnAddonPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAddonPropsMixin>

A fluent builder for CfnAddonPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAddonPropsMixin.Builder	addonName(String addonName)	The name of the add-on.
CfnAddonPropsMixin.Builder	addonVersion(String addonVersion)	The version of the add-on.
CfnAddonPropsMixin	build()
CfnAddonPropsMixin.Builder	clusterName(String clusterName)	The name of your cluster.
CfnAddonPropsMixin.Builder	configurationValues(String configurationValues)	The configuration values that you provided.
static CfnAddonPropsMixin.Builder	create()
static CfnAddonPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAddonPropsMixin.Builder	namespaceConfig(CfnAddonPropsMixin.NamespaceConfigProperty namespaceConfig)	The namespace configuration for the addon.
CfnAddonPropsMixin.Builder	namespaceConfig(IResolvable namespaceConfig)	The namespace configuration for the addon.
CfnAddonPropsMixin.Builder	podIdentityAssociations(List<? extends Object> podIdentityAssociations)	An array of EKS Pod Identity associations owned by the add-on.
CfnAddonPropsMixin.Builder	podIdentityAssociations(IResolvable podIdentityAssociations)	An array of EKS Pod Identity associations owned by the add-on.
CfnAddonPropsMixin.Builder	preserveOnDelete(Boolean preserveOnDelete)	Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
CfnAddonPropsMixin.Builder	preserveOnDelete(IResolvable preserveOnDelete)	Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
CfnAddonPropsMixin.Builder	resolveConflicts(String resolveConflicts)	How to resolve field value conflicts for an Amazon EKS add-on.
CfnAddonPropsMixin.Builder	serviceAccountRoleArn(String serviceAccountRoleArn)	The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
CfnAddonPropsMixin.Builder	serviceAccountRoleArn(IRoleRef serviceAccountRoleArn)	The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
CfnAddonPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The metadata that you apply to the add-on to assist with categorization and organization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAddonPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAddonPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAddonPropsMixin.Builder create()

Returns:

a new instance of CfnAddonPropsMixin.Builder.

addonName

@Stability(Stable)
public CfnAddonPropsMixin.Builder addonName(String addonName)

The name of the add-on.

Parameters:

addonName - The name of the add-on. This parameter is required.

Returns:

this

See Also:

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

addonVersion

@Stability(Stable)
public CfnAddonPropsMixin.Builder addonVersion(String addonVersion)

The version of the add-on.

Parameters:

addonVersion - The version of the add-on. This parameter is required.

Returns:

this

See Also:

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

clusterName

@Stability(Stable)
public CfnAddonPropsMixin.Builder clusterName(String clusterName)

The name of your cluster.

Parameters:

clusterName - The name of your cluster. This parameter is required.

Returns:

this

See Also:

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

configurationValues

@Stability(Stable)
public CfnAddonPropsMixin.Builder configurationValues(String configurationValues)

The configuration values that you provided.

Parameters:

configurationValues - The configuration values that you provided. This parameter is required.

Returns:

this

See Also:

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

namespaceConfig

@Stability(Stable)
public CfnAddonPropsMixin.Builder namespaceConfig(IResolvable namespaceConfig)

The namespace configuration for the addon.

This specifies the Kubernetes namespace where the addon is installed.

Parameters:

namespaceConfig - The namespace configuration for the addon. This parameter is required.

Returns:

this

See Also:

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

namespaceConfig

@Stability(Stable)
public CfnAddonPropsMixin.Builder namespaceConfig(CfnAddonPropsMixin.NamespaceConfigProperty namespaceConfig)

The namespace configuration for the addon.

This specifies the Kubernetes namespace where the addon is installed.

Parameters:

namespaceConfig - The namespace configuration for the addon. This parameter is required.

Returns:

this

See Also:

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

podIdentityAssociations

@Stability(Stable)
public CfnAddonPropsMixin.Builder podIdentityAssociations(IResolvable podIdentityAssociations)

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

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 .

Parameters:

podIdentityAssociations - An array of EKS Pod Identity associations owned by the add-on. This parameter is required.

Returns:

this

See Also:

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

podIdentityAssociations

@Stability(Stable)
public CfnAddonPropsMixin.Builder podIdentityAssociations(List<? extends Object> podIdentityAssociations)

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

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 .

Parameters:

podIdentityAssociations - An array of EKS Pod Identity associations owned by the add-on. This parameter is required.

Returns:

this

See Also:

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

preserveOnDelete

@Stability(Stable)
public CfnAddonPropsMixin.Builder preserveOnDelete(Boolean preserveOnDelete)

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

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

Parameters:

preserveOnDelete - Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. This parameter is required.

Returns:

this

See Also:

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

preserveOnDelete

@Stability(Stable)
public CfnAddonPropsMixin.Builder preserveOnDelete(IResolvable preserveOnDelete)

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.

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

Parameters:

preserveOnDelete - Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. This parameter is required.

Returns:

this

See Also:

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

resolveConflicts

@Stability(Stable)
public CfnAddonPropsMixin.Builder resolveConflicts(String resolveConflicts)

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

Conflicts are handled based on the value you choose:

• None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.
• Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.
• Preserve – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn't change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. For more information, see UpdateAddon .

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.

Parameters:

resolveConflicts - How to resolve field value conflicts for an Amazon EKS add-on. This parameter is required.

Returns:

this

See Also:

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

serviceAccountRoleArn

@Stability(Stable)
public CfnAddonPropsMixin.Builder serviceAccountRoleArn(String serviceAccountRoleArn)

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 .

Parameters:

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

Returns:

this

See Also:

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

serviceAccountRoleArn

@Stability(Stable)
public CfnAddonPropsMixin.Builder serviceAccountRoleArn(IRoleRef serviceAccountRoleArn)

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 .

Parameters:

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

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnAddonPropsMixin.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - The metadata that you apply to the add-on to assist with categorization and organization. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAddonPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAddonPropsMixin>

Returns:

a newly built instance of CfnAddonPropsMixin.