Class: Aws::EKS::Types::UpdateAddonRequest

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::UpdateAddonRequest

Includes:

Structure

Defined in:

lib/aws-sdk-eks/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #addon_name ⇒ String

  The name of the add-on.

• #addon_version ⇒ String

  The version of the add-on.

• #client_request_token ⇒ String

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

• #cluster_name ⇒ String

  The name of your cluster.

• #configuration_values ⇒ String

  The set of configuration values for the add-on that’s created.

• #pod_identity_associations ⇒ Array<Types::AddonPodIdentityAssociations>

  An array of EKS Pod Identity associations to be updated.

• #resolve_conflicts ⇒ String

  How to resolve field value conflicts for an Amazon EKS add-on if you’ve changed a value from the Amazon EKS default value.

• #service_account_role_arn ⇒ String

  The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on’s service account.

Instance Attribute Details

#addon_name ⇒ String

The name of the add-on. The name must match one of the names returned by [ ‘ListAddons` ][1].

[1]: docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 6933

class UpdateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :configuration_values,
  :pod_identity_associations)
  SENSITIVE = []
  include Aws::Structure
end

#addon_version ⇒ String

The version of the add-on. The version must match one of the versions returned by [ ‘DescribeAddonVersions` ][1].

[1]: docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 6933

class UpdateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :configuration_values,
  :pod_identity_associations)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 6933

class UpdateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :configuration_values,
  :pod_identity_associations)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

The name of your cluster.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 6933

class UpdateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :configuration_values,
  :pod_identity_associations)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_values ⇒ String

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:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 6933

class UpdateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :configuration_values,
  :pod_identity_associations)
  SENSITIVE = []
  include Aws::Structure
end

#pod_identity_associations ⇒ Array<Types::AddonPodIdentityAssociations>

An array of EKS Pod Identity associations to be updated. Each association maps a Kubernetes service account to an IAM role. If this value is left blank, no change. If an empty array is provided, existing associations owned by the add-on are deleted.

For more information, see [Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity] in the *Amazon EKS User Guide*.

[1]: docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html

Returns:

• (Array<Types::AddonPodIdentityAssociations>)

# File 'lib/aws-sdk-eks/types.rb', line 6933

class UpdateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :configuration_values,
  :pod_identity_associations)
  SENSITIVE = []
  include Aws::Structure
end

#resolve_conflicts ⇒ String

How to resolve field value conflicts for an Amazon EKS add-on if you’ve changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:

• None – Amazon EKS doesn’t change the value. The update might fail.

• Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.

• Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 6933

class UpdateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :configuration_values,
  :pod_identity_associations)
  SENSITIVE = []
  include Aws::Structure
end

#service_account_role_arn ⇒ String

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*.

<note markdown=“1”> 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][2

in the

*Amazon EKS User Guide*.

</note>

[1]: docs.aws.amazon.com/eks/latest/userguide/create-node-role.html [2]: docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 6933

class UpdateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :configuration_values,
  :pod_identity_associations)
  SENSITIVE = []
  include Aws::Structure
end