Amazon EKS v3.3.0 published on Monday, Nov 25, 2024 by Pulumi
eks.Addon
Explore with Pulumi AI
Addon manages an EKS add-on. For more information about supported add-ons, see: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html
Create Addon Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Addon(name: string, args: AddonArgs, opts?: ComponentResourceOptions);
@overload
def Addon(resource_name: str,
args: AddonArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Addon(resource_name: str,
opts: Optional[ResourceOptions] = None,
addon_name: Optional[str] = None,
cluster: Optional[Cluster] = None,
addon_version: Optional[str] = None,
configuration_values: Optional[Mapping[str, Any]] = None,
preserve: Optional[bool] = None,
resolve_conflicts_on_create: Optional[str] = None,
resolve_conflicts_on_update: Optional[str] = None,
service_account_role_arn: Optional[str] = None,
tags: Optional[Sequence[Mapping[str, str]]] = None)
func NewAddon(ctx *Context, name string, args AddonArgs, opts ...ResourceOption) (*Addon, error)
public Addon(string name, AddonArgs args, ComponentResourceOptions? opts = null)
type: eks:Addon
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AddonArgs
- The arguments to resource properties.
- opts ComponentResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AddonArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AddonArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AddonArgs
- The arguments to resource properties.
- opts ComponentResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AddonArgs
- The arguments to resource properties.
- options ComponentResourceOptions
- Bag of options to control resource's behavior.
Addon Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Addon resource accepts the following input properties:
- Addon
Name string - Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
- Cluster
Pulumi.
Eks. Cluster - The target EKS cluster.
- Addon
Version string - The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
- Configuration
Values Dictionary<string, object> - Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
- Preserve bool
- Indicates if you want to preserve the created resources when deleting the EKS add-on.
- Resolve
Conflicts stringOn Create - How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
- Resolve
Conflicts stringOn Update - How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
- Service
Account stringRole Arn - 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: 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.
- List<Immutable
Dictionary<string, string>> - Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Addon
Name string - Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
- Cluster Cluster
- The target EKS cluster.
- Addon
Version string - The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
- Configuration
Values map[string]interface{} - Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
- Preserve bool
- Indicates if you want to preserve the created resources when deleting the EKS add-on.
- Resolve
Conflicts stringOn Create - How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
- Resolve
Conflicts stringOn Update - How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
- Service
Account stringRole Arn - 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: 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.
- []map[string]string
- Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- addon
Name String - Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
- cluster Cluster
- The target EKS cluster.
- addon
Version String - The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
- configuration
Values Map<String,Object> - Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
- preserve Boolean
- Indicates if you want to preserve the created resources when deleting the EKS add-on.
- resolve
Conflicts StringOn Create - How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
- resolve
Conflicts StringOn Update - How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
- service
Account StringRole Arn - 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: 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.
- List<Map<String,String>>
- Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- addon
Name string - Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
- cluster Cluster
- The target EKS cluster.
- addon
Version string - The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
- configuration
Values {[key: string]: any} - Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
- preserve boolean
- Indicates if you want to preserve the created resources when deleting the EKS add-on.
- resolve
Conflicts stringOn Create - How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
- resolve
Conflicts stringOn Update - How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
- service
Account stringRole Arn - 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: 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.
- {[key: string]: string}[]
- Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- addon_
name str - Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
- cluster Cluster
- The target EKS cluster.
- addon_
version str - The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
- configuration_
values Mapping[str, Any] - Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
- preserve bool
- Indicates if you want to preserve the created resources when deleting the EKS add-on.
- resolve_
conflicts_ stron_ create - How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
- resolve_
conflicts_ stron_ update - How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
- service_
account_ strrole_ arn - 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: 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.
- Sequence[Mapping[str, str]]
- Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- addon
Name String - Name of the EKS add-on. The name must match one of the names returned by describe-addon-versions.
- cluster eks:Cluster
- The target EKS cluster.
- addon
Version String - The version of the EKS add-on. The version must match one of the versions returned by describe-addon-versions.
- configuration
Values Map<Any> - Custom configuration values for addons specified as an object. This object value must match the JSON schema derived from describe-addon-configuration.
- preserve Boolean
- Indicates if you want to preserve the created resources when deleting the EKS add-on.
- resolve
Conflicts StringOn Create - How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are NONE and OVERWRITE. For more details see the CreateAddon API Docs.
- resolve
Conflicts StringOn Update - How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are NONE, OVERWRITE, and PRESERVE. For more details see the UpdateAddon API Docs.
- service
Account StringRole Arn - 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: 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.
- List<Map<String>>
- Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the Addon resource produces the following output properties:
Package Details
- Repository
- Amazon EKS pulumi/pulumi-eks
- License
- Apache-2.0