com.amazonaws.services.eks.model

Class CreateAddonRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.eks.model.CreateAddonRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAddonRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAddonRequest()

Method Summary

Modifier and Type	Method and Description
CreateAddonRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateAddonRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateAddonRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAddonName() The name of the add-on.
String	getAddonVersion() The version of the add-on.
String	getClientRequestToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getClusterName() The name of your cluster.
String	getConfigurationValues() The set of configuration values for the add-on that's created.
List<AddonPodIdentityAssociations>	getPodIdentityAssociations() An array of Pod Identity Assocations to be created.
String	getResolveConflicts() How to resolve field value conflicts for an Amazon EKS add-on.
String	getServiceAccountRoleArn() The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
Map<String,String>	getTags() Metadata that assists with categorization and organization.
int	hashCode()
void	setAddonName(String addonName) The name of the add-on.
void	setAddonVersion(String addonVersion) The version of the add-on.
void	setClientRequestToken(String clientRequestToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setClusterName(String clusterName) The name of your cluster.
void	setConfigurationValues(String configurationValues) The set of configuration values for the add-on that's created.
void	setPodIdentityAssociations(Collection<AddonPodIdentityAssociations> podIdentityAssociations) An array of Pod Identity Assocations to be created.
void	setResolveConflicts(String resolveConflicts) How to resolve field value conflicts for an Amazon EKS add-on.
void	setServiceAccountRoleArn(String serviceAccountRoleArn) The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
void	setTags(Map<String,String> tags) Metadata that assists with categorization and organization.
String	toString() Returns a string representation of this object.
CreateAddonRequest	withAddonName(String addonName) The name of the add-on.
CreateAddonRequest	withAddonVersion(String addonVersion) The version of the add-on.
CreateAddonRequest	withClientRequestToken(String clientRequestToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateAddonRequest	withClusterName(String clusterName) The name of your cluster.
CreateAddonRequest	withConfigurationValues(String configurationValues) The set of configuration values for the add-on that's created.
CreateAddonRequest	withPodIdentityAssociations(AddonPodIdentityAssociations... podIdentityAssociations) An array of Pod Identity Assocations to be created.
CreateAddonRequest	withPodIdentityAssociations(Collection<AddonPodIdentityAssociations> podIdentityAssociations) An array of Pod Identity Assocations to be created.
CreateAddonRequest	withResolveConflicts(ResolveConflicts resolveConflicts) How to resolve field value conflicts for an Amazon EKS add-on.
CreateAddonRequest	withResolveConflicts(String resolveConflicts) How to resolve field value conflicts for an Amazon EKS add-on.
CreateAddonRequest	withServiceAccountRoleArn(String serviceAccountRoleArn) The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account.
CreateAddonRequest	withTags(Map<String,String> tags) Metadata that assists with categorization and organization.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAddonRequest

public CreateAddonRequest()

Method Detail

setClusterName

public void setClusterName(String clusterName)

The name of your cluster.

Parameters:

clusterName - The name of your cluster.

getClusterName

public String getClusterName()

The name of your cluster.

Returns:

The name of your cluster.

withClusterName

public CreateAddonRequest withClusterName(String 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.

setAddonName

public void setAddonName(String 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 by DescribeAddonVersions.

getAddonName

public String getAddonName()

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.

withAddonName

public CreateAddonRequest withAddonName(String 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 by DescribeAddonVersions.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAddonVersion

public void setAddonVersion(String 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 by DescribeAddonVersions .

getAddonVersion

public String getAddonVersion()

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 .

withAddonVersion

public CreateAddonRequest withAddonVersion(String 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 by DescribeAddonVersions .

Returns:

Returns a reference to this object so that method calls can be chained together.

setServiceAccountRoleArn

public void setServiceAccountRoleArn(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.

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.

getServiceAccountRoleArn

public String getServiceAccountRoleArn()

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.

withServiceAccountRoleArn

public CreateAddonRequest withServiceAccountRoleArn(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.

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.

setResolveConflicts

public void setResolveConflicts(String 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.

See Also:

ResolveConflicts

getResolveConflicts

public String getResolveConflicts()

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:

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

withResolveConflicts

public CreateAddonRequest withResolveConflicts(String 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

withResolveConflicts

public CreateAddonRequest withResolveConflicts(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.

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

setClientRequestToken

public void setClientRequestToken(String 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.

getClientRequestToken

public String getClientRequestToken()

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.

withClientRequestToken

public CreateAddonRequest withClientRequestToken(String 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.

getTags

public Map<String,String> getTags()

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:

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.

setTags

public void setTags(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.

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.

withTags

public CreateAddonRequest withTags(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.

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.

addTagsEntry

public CreateAddonRequest addTagsEntry(String key,
                                       String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateAddonRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConfigurationValues

public void setConfigurationValues(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.

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 by DescribeAddonConfiguration.

getConfigurationValues

public String getConfigurationValues()

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.

withConfigurationValues

public CreateAddonRequest withConfigurationValues(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.

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 by DescribeAddonConfiguration.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPodIdentityAssociations

public List<AddonPodIdentityAssociations> getPodIdentityAssociations()

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:

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.

setPodIdentityAssociations

public void setPodIdentityAssociations(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.

withPodIdentityAssociations

public CreateAddonRequest withPodIdentityAssociations(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.

NOTE: This method appends the values to the existing list (if any). Use setPodIdentityAssociations(java.util.Collection) or withPodIdentityAssociations(java.util.Collection) if you want to override the existing values.

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.

withPodIdentityAssociations

public CreateAddonRequest withPodIdentityAssociations(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAddonRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()