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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eks/types.rb

Overview

Note:

When making an API call, you may pass CreateAddonRequest data as a hash:

{
  cluster_name: "ClusterName", # required
  addon_name: "String", # required
  addon_version: "String",
  service_account_role_arn: "RoleArn",
  resolve_conflicts: "OVERWRITE", # accepts OVERWRITE, NONE
  client_request_token: "String",
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#addon_nameString

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)

585
586
587
588
589
590
591
592
593
594
595
# File 'lib/aws-sdk-eks/types.rb', line 585

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

#addon_versionString

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)

585
586
587
588
589
590
591
592
593
594
595
# File 'lib/aws-sdk-eks/types.rb', line 585

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

#client_request_tokenString

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)

585
586
587
588
589
590
591
592
593
594
595
# File 'lib/aws-sdk-eks/types.rb', line 585

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

#cluster_nameString

The name of the cluster to create the add-on for.

Returns:

  • (String)

585
586
587
588
589
590
591
592
593
594
595
# File 'lib/aws-sdk-eks/types.rb', line 585

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

#resolve_conflictsString

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.

Returns:

  • (String)

585
586
587
588
589
590
591
592
593
594
595
# File 'lib/aws-sdk-eks/types.rb', line 585

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

#service_account_role_arnString

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)

585
586
587
588
589
590
591
592
593
594
595
# File 'lib/aws-sdk-eks/types.rb', line 585

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

#tagsHash<String,String>

The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.

Returns:

  • (Hash<String,String>)

585
586
587
588
589
590
591
592
593
594
595
# File 'lib/aws-sdk-eks/types.rb', line 585

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