Class CreateAddonRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAddonRequest.Builder,
CreateAddonRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the add-on.final String
The version of the add-on.static CreateAddonRequest.Builder
builder()
final String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final String
The name of your cluster.final String
The set of configuration values for the add-on that's created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final ResolveConflicts
How to resolve field value conflicts for an Amazon EKS add-on.final String
How to resolve field value conflicts for an Amazon EKS add-on.static Class
<? extends CreateAddonRequest.Builder> final String
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.tags()
Metadata that assists with categorization and organization.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clusterName
The name of your cluster.
- Returns:
- The name of your cluster.
-
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
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
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
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.
If the service returns an enum value that is not available in the current SDK version,
resolveConflicts
will returnResolveConflicts.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresolveConflictsAsString()
.- Returns:
- 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.
-
- See Also:
-
-
resolveConflictsAsString
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.
If the service returns an enum value that is not available in the current SDK version,
resolveConflicts
will returnResolveConflicts.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresolveConflictsAsString()
.- Returns:
- 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.
-
- See Also:
-
-
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 theisEmpty()
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
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.
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:
- 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.
-
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
.- Returns:
- 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
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAddonRequest.Builder,
CreateAddonRequest> - Specified by:
toBuilder
in classEksRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-