EKS / Client / delete_addon
delete_addon#
- EKS.Client.delete_addon(**kwargs)#
Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
See also: AWS API Documentation
Request Syntax
response = client.delete_addon( clusterName='string', addonName='string', preserve=True|False )
- Parameters:
clusterName (string) –
[REQUIRED]
The name of the cluster to delete the add-on from.
addonName (string) –
[REQUIRED]
The name of the add-on. The name must match one of the names returned by ListAddons.
preserve (boolean) – Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it isn’t removed.
- Return type:
dict
- Returns:
Response Syntax
{ 'addon': { 'addonName': 'string', 'clusterName': 'string', 'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETE_FAILED'|'DEGRADED'|'UPDATE_FAILED', 'addonVersion': 'string', 'health': { 'issues': [ { 'code': 'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound', 'message': 'string', 'resourceIds': [ 'string', ] }, ] }, 'addonArn': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'serviceAccountRoleArn': 'string', 'tags': { 'string': 'string' }, 'publisher': 'string', 'owner': 'string', 'marketplaceInformation': { 'productId': 'string', 'productUrl': 'string' }, 'configurationValues': 'string' } }
Response Structure
(dict) –
addon (dict) –
An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.
addonName (string) –
The name of the add-on.
clusterName (string) –
The name of the cluster.
status (string) –
The status of the add-on.
addonVersion (string) –
The version of the add-on.
health (dict) –
An object that represents the health of the add-on.
issues (list) –
An object representing the health issues for an add-on.
(dict) –
An issue related to an add-on.
code (string) –
A code that describes the type of issue.
message (string) –
A message that provides details about the issue and what might cause it.
resourceIds (list) –
The resource IDs of the issue.
(string) –
addonArn (string) –
The Amazon Resource Name (ARN) of the add-on.
createdAt (datetime) –
The date and time that the add-on was created.
modifiedAt (datetime) –
The date and time that the add-on was last modified.
serviceAccountRoleArn (string) –
The Amazon Resource Name (ARN) of the IAM role that’s bound to the Kubernetes service account that the add-on uses.
tags (dict) –
The metadata that you apply to the add-on to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Add-on tags do not propagate to any other resources associated with the cluster.
(string) –
(string) –
publisher (string) –
The publisher of the add-on.
owner (string) –
The owner of the add-on.
marketplaceInformation (dict) –
Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.
productId (string) –
The product ID from the Amazon Web Services Marketplace.
productUrl (string) –
The product URL from the Amazon Web Services Marketplace.
configurationValues (string) –
The configuration values that you provided.
Exceptions
EKS.Client.exceptions.InvalidParameterException
EKS.Client.exceptions.InvalidRequestException
EKS.Client.exceptions.ResourceNotFoundException
EKS.Client.exceptions.ClientException
EKS.Client.exceptions.ServerException