Class CfnAddonProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAddonProps>
- Enclosing interface:
CfnAddonProps
CfnAddonProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnAddonProps.getAddonName()
addonVersion
(String addonVersion) Sets the value ofCfnAddonProps.getAddonVersion()
build()
Builds the configured instance.clusterName
(String clusterName) Sets the value ofCfnAddonProps.getClusterName()
configurationValues
(String configurationValues) Sets the value ofCfnAddonProps.getConfigurationValues()
podIdentityAssociations
(List<? extends Object> podIdentityAssociations) Sets the value ofCfnAddonProps.getPodIdentityAssociations()
podIdentityAssociations
(IResolvable podIdentityAssociations) Sets the value ofCfnAddonProps.getPodIdentityAssociations()
preserveOnDelete
(Boolean preserveOnDelete) Sets the value ofCfnAddonProps.getPreserveOnDelete()
preserveOnDelete
(IResolvable preserveOnDelete) Sets the value ofCfnAddonProps.getPreserveOnDelete()
resolveConflicts
(String resolveConflicts) Sets the value ofCfnAddonProps.getResolveConflicts()
serviceAccountRoleArn
(String serviceAccountRoleArn) Sets the value ofCfnAddonProps.getServiceAccountRoleArn()
Sets the value ofCfnAddonProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
addonName
Sets the value ofCfnAddonProps.getAddonName()
- Parameters:
addonName
- The name of the add-on. This parameter is required.- Returns:
this
-
clusterName
Sets the value ofCfnAddonProps.getClusterName()
- Parameters:
clusterName
- The name of your cluster. This parameter is required.- Returns:
this
-
addonVersion
Sets the value ofCfnAddonProps.getAddonVersion()
- Parameters:
addonVersion
- The version of the add-on.- Returns:
this
-
configurationValues
Sets the value ofCfnAddonProps.getConfigurationValues()
- Parameters:
configurationValues
- The configuration values that you provided.- Returns:
this
-
podIdentityAssociations
@Stability(Stable) public CfnAddonProps.Builder podIdentityAssociations(IResolvable podIdentityAssociations) Sets the value ofCfnAddonProps.getPodIdentityAssociations()
- Parameters:
podIdentityAssociations
- An array of Pod Identity Assocations owned by the Addon. Each EKS Pod Identity 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 Pod Identity in the EKS User Guide.
- Returns:
this
-
podIdentityAssociations
@Stability(Stable) public CfnAddonProps.Builder podIdentityAssociations(List<? extends Object> podIdentityAssociations) Sets the value ofCfnAddonProps.getPodIdentityAssociations()
- Parameters:
podIdentityAssociations
- An array of Pod Identity Assocations owned by the Addon. Each EKS Pod Identity 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 Pod Identity in the EKS User Guide.
- Returns:
this
-
preserveOnDelete
Sets the value ofCfnAddonProps.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
Sets the value ofCfnAddonProps.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
Sets the value ofCfnAddonProps.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
Sets the value ofCfnAddonProps.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
Sets the value ofCfnAddonProps.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
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAddonProps>
- Returns:
- a new instance of
CfnAddonProps
- Throws:
NullPointerException
- if any required attribute was not provided
-