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

Class CfnAddonMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAddonMixinProps>

Enclosing interface:

CfnAddonMixinProps

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

A builder for CfnAddonMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAddonMixinProps.Builder	addonName(String addonName)	Sets the value of CfnAddonMixinProps.getAddonName()
CfnAddonMixinProps.Builder	addonVersion(String addonVersion)	Sets the value of CfnAddonMixinProps.getAddonVersion()
CfnAddonMixinProps	build()	Builds the configured instance.
CfnAddonMixinProps.Builder	clusterName(String clusterName)	Sets the value of CfnAddonMixinProps.getClusterName()
CfnAddonMixinProps.Builder	configurationValues(String configurationValues)	Sets the value of CfnAddonMixinProps.getConfigurationValues()
CfnAddonMixinProps.Builder	namespaceConfig(CfnAddonPropsMixin.NamespaceConfigProperty namespaceConfig)	Sets the value of CfnAddonMixinProps.getNamespaceConfig()
CfnAddonMixinProps.Builder	namespaceConfig(IResolvable namespaceConfig)	Sets the value of CfnAddonMixinProps.getNamespaceConfig()
CfnAddonMixinProps.Builder	podIdentityAssociations(List<? extends Object> podIdentityAssociations)	Sets the value of CfnAddonMixinProps.getPodIdentityAssociations()
CfnAddonMixinProps.Builder	podIdentityAssociations(IResolvable podIdentityAssociations)	Sets the value of CfnAddonMixinProps.getPodIdentityAssociations()
CfnAddonMixinProps.Builder	preserveOnDelete(Boolean preserveOnDelete)	Sets the value of CfnAddonMixinProps.getPreserveOnDelete()
CfnAddonMixinProps.Builder	preserveOnDelete(IResolvable preserveOnDelete)	Sets the value of CfnAddonMixinProps.getPreserveOnDelete()
CfnAddonMixinProps.Builder	resolveConflicts(String resolveConflicts)	Sets the value of CfnAddonMixinProps.getResolveConflicts()
CfnAddonMixinProps.Builder	serviceAccountRoleArn(String serviceAccountRoleArn)	Sets the value of CfnAddonMixinProps.getServiceAccountRoleArn()
CfnAddonMixinProps.Builder	serviceAccountRoleArn(IRoleRef serviceAccountRoleArn)	Sets the value of CfnAddonMixinProps.getServiceAccountRoleArn()
CfnAddonMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnAddonMixinProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

addonName

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

Sets the value of CfnAddonMixinProps.getAddonName()

Parameters:

addonName - The name of the add-on.

Returns:

this

addonVersion

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

Sets the value of CfnAddonMixinProps.getAddonVersion()

Parameters:

addonVersion - The version of the add-on.

Returns:

this

clusterName

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

Sets the value of CfnAddonMixinProps.getClusterName()

Parameters:

clusterName - The name of your cluster.

Returns:

this

configurationValues

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

Sets the value of CfnAddonMixinProps.getConfigurationValues()

Parameters:

configurationValues - The configuration values that you provided.

Returns:

this

namespaceConfig

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

Sets the value of CfnAddonMixinProps.getNamespaceConfig()

Parameters:

namespaceConfig - The namespace configuration for the addon. This specifies the Kubernetes namespace where the addon is installed.

Returns:

this

namespaceConfig

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

Sets the value of CfnAddonMixinProps.getNamespaceConfig()

Parameters:

namespaceConfig - The namespace configuration for the addon. This specifies the Kubernetes namespace where the addon is installed.

Returns:

this

podIdentityAssociations

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

Sets the value of CfnAddonMixinProps.getPodIdentityAssociations()

Parameters:

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 .

Returns:

this

podIdentityAssociations

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

Sets the value of CfnAddonMixinProps.getPodIdentityAssociations()

Parameters:

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 .

Returns:

this

preserveOnDelete

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

Sets the value of CfnAddonMixinProps.getPreserveOnDelete()

Parameters:

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.

Returns:

this

preserveOnDelete

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

Sets the value of CfnAddonMixinProps.getPreserveOnDelete()

Parameters:

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.

Returns:

this

resolveConflicts

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

Sets the value of CfnAddonMixinProps.getResolveConflicts()

Parameters:

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.

Returns:

this

serviceAccountRoleArn

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

Sets the value of CfnAddonMixinProps.getServiceAccountRoleArn()

Parameters:

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 .

Returns:

this

serviceAccountRoleArn

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

Sets the value of CfnAddonMixinProps.getServiceAccountRoleArn()

Parameters:

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 .

Returns:

this

tags

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

Sets the value of CfnAddonMixinProps.getTags()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnAddonMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAddonMixinProps

Throws:

NullPointerException - if any required attribute was not provided