Interface CreateAddonRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAddonRequest.Builder,
,CreateAddonRequest> EksRequest.Builder
,SdkBuilder<CreateAddonRequest.Builder,
,CreateAddonRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAddonRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the add-on.addonVersion
(String addonVersion) The version of the add-on.clientRequestToken
(String clientRequestToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.clusterName
(String clusterName) The name of your cluster.configurationValues
(String configurationValues) The set of configuration values for the add-on that's created.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.podIdentityAssociations
(Collection<AddonPodIdentityAssociations> podIdentityAssociations) An array of Pod Identity Assocations to be created.podIdentityAssociations
(Consumer<AddonPodIdentityAssociations.Builder>... podIdentityAssociations) An array of Pod Identity Assocations to be created.podIdentityAssociations
(AddonPodIdentityAssociations... podIdentityAssociations) An array of Pod Identity Assocations to be created.resolveConflicts
(String resolveConflicts) How to resolve field value conflicts for an Amazon EKS add-on.resolveConflicts
(ResolveConflicts resolveConflicts) How to resolve field value conflicts for an Amazon EKS add-on.serviceAccountRoleArn
(String serviceAccountRoleArn) The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.Metadata that assists with categorization and organization.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.eks.model.EksRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
clusterName
The name of your cluster.
- Parameters:
clusterName
- The name of your cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addonName
The name of the add-on. The name must match one of the names returned by
DescribeAddonVersions
.- Parameters:
addonName
- The name of the add-on. The name must match one of the names returned byDescribeAddonVersions
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addonVersion
The version of the add-on. The version must match one of the versions returned by
DescribeAddonVersions
.- Parameters:
addonVersion
- The version of the add-on. The version must match one of the versions returned byDescribeAddonVersions
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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. 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
clientRequestToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Parameters:
clientRequestToken
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
- Parameters:
tags
- Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configurationValues
The set of configuration values for the add-on that's created. The values that you provide are validated against the schema returned by
DescribeAddonConfiguration
.- Parameters:
configurationValues
- The set of configuration values for the add-on that's created. The values that you provide are validated against the schema returned byDescribeAddonConfiguration
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
podIdentityAssociations
CreateAddonRequest.Builder podIdentityAssociations(Collection<AddonPodIdentityAssociations> podIdentityAssociations) An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.
For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.
- Parameters:
podIdentityAssociations
- An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
podIdentityAssociations
CreateAddonRequest.Builder podIdentityAssociations(AddonPodIdentityAssociations... podIdentityAssociations) An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.
For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.
- Parameters:
podIdentityAssociations
- An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
podIdentityAssociations
CreateAddonRequest.Builder podIdentityAssociations(Consumer<AddonPodIdentityAssociations.Builder>... podIdentityAssociations) An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.
For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.
This is a convenience method that creates an instance of theAddonPodIdentityAssociations.Builder
avoiding the need to create one manually viaAddonPodIdentityAssociations.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topodIdentityAssociations(List<AddonPodIdentityAssociations>)
.- Parameters:
podIdentityAssociations
- a consumer that will call methods onAddonPodIdentityAssociations.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateAddonRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateAddonRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-