Class: Aws::EKS::Types::CreateAddonRequest

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::CreateAddonRequest

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 Pod Identity Assocations to be created.

• #resolve_conflicts ⇒ String

  How to resolve field value conflicts for an Amazon EKS add-on.

• #service_account_role_arn ⇒ String

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

• #tags ⇒ Hash<String,String>

  Metadata that assists with categorization and organization.

Instance Attribute Details

#addon_name ⇒ String

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

Returns:

• (String)

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

class CreateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :tags,
  :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 1325

class CreateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :tags,
  :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 1325

class CreateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :tags,
  :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 1325

class CreateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :tags,
  :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 1325

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

#pod_identity_associations ⇒ Array<Types::AddonPodIdentityAssociations>

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.

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

Returns:

• (Array<Types::AddonPodIdentityAssociations>)

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

class CreateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :tags,
  :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. 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.

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

Returns:

• (String)

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

class CreateAddonRequest < Struct.new(
  :cluster_name,
  :addon_name,
  :addon_version,
  :service_account_role_arn,
  :resolve_conflicts,
  :client_request_token,
  :tags,
  :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 1325

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

#tags ⇒ Hash<String,String>

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:

• (Hash<String,String>)

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

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