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("software.amazon.awssdk:codegen") public final class CreateAddonRequest extends EksRequest implements ToCopyableBuilder<CreateAddonRequest.Builder,CreateAddonRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateAddonRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaddonName()The name of the add-on.StringaddonVersion()The version of the add-on.static CreateAddonRequest.Builderbuilder()StringclientRequestToken()A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.StringclusterName()The name of your cluster.StringconfigurationValues()The set of configuration values for the add-on that's created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.ResolveConflictsresolveConflicts()How to resolve field value conflicts for an Amazon EKS add-on.StringresolveConflictsAsString()How to resolve field value conflicts for an Amazon EKS add-on.List<SdkField<?>>sdkFields()static Class<? extends CreateAddonRequest.Builder>serializableBuilderClass()StringserviceAccountRoleArn()The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.Map<String,String>tags()Metadata that assists with categorization and organization.CreateAddonRequest.BuildertoBuilder()StringtoString()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 your cluster.
- Returns:
- The name of your cluster.
-
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 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,
resolveConflictswill 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:
ResolveConflicts
-
-
resolveConflictsAsString
public final String 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,
resolveConflictswill 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:
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 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
public final Map<String,String> 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
public final String 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
public CreateAddonRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateAddonRequest.Builder,CreateAddonRequest>- Specified by:
toBuilderin classEksRequest
-
builder
public static CreateAddonRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateAddonRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-