software.amazon.awssdk.services.eks.model

Class CreateAddonRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eks.model.EksRequest

software.amazon.awssdk.services.eks.model.CreateAddonRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAddonRequest.Builder,CreateAddonRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAddonRequest
extends EksRequest
implements ToCopyableBuilder<CreateAddonRequest.Builder,CreateAddonRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAddonRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	addonName() The name of the add-on.
String	addonVersion() The version of the add-on.
static CreateAddonRequest.Builder	builder()
String	clientRequestToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	clusterName() The name of the cluster to create the add-on for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
ResolveConflicts	resolveConflicts() How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.
String	resolveConflictsAsString() How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAddonRequest.Builder>	serializableBuilderClass()
String	serviceAccountRoleArn() The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
Map<String,String>	tags() The metadata to apply to the cluster to assist with categorization and organization.
CreateAddonRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clusterName

public final String clusterName()

The name of the cluster to create the add-on for.

Returns:

The name of the cluster to create the add-on for.

addonName

public final String addonName()

The name of the add-on. The name must match one of the names returned by DescribeAddonVersions .

Returns:

The name of the add-on. The name must match one of the names returned by DescribeAddonVersions .

addonVersion

public final String addonVersion()

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

Returns:

The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

serviceAccountRoleArn

public final 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.

Returns:

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.

resolveConflicts

public final ResolveConflicts resolveConflicts()

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

If the service returns an enum value that is not available in the current SDK version, resolveConflicts will return ResolveConflicts.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resolveConflictsAsString().

Returns:

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

See Also:

ResolveConflicts

resolveConflictsAsString

public final String resolveConflictsAsString()

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

If the service returns an enum value that is not available in the current SDK version, resolveConflicts will return ResolveConflicts.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resolveConflictsAsString().

Returns:

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

See Also:

ResolveConflicts

clientRequestToken

public final String clientRequestToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

toBuilder

public CreateAddonRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAddonRequest.Builder,CreateAddonRequest>

Specified by:

toBuilder in class EksRequest

builder

public static CreateAddonRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAddonRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo