Update Capability

eks_update_capability

R Documentation

Updates the configuration of a managed capability in your Amazon EKS cluster

Description

Updates the configuration of a managed capability in your Amazon EKS cluster. You can update the IAM role, configuration settings, and delete propagation policy for a capability.

When you update a capability, Amazon EKS applies the changes and may restart capability components as needed. The capability remains available during the update process, but some operations may be temporarily unavailable.

Usage

eks_update_capability(clusterName, capabilityName, roleArn,
  configuration, clientRequestToken, deletePropagationPolicy)

Arguments

clusterName	[required] The name of the Amazon EKS cluster that contains the capability you want to update configuration for.
capabilityName	[required] The name of the capability to update configuration for.
roleArn	The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services. If you specify a new role ARN, the capability will start using the new role for all subsequent operations.
configuration	The updated configuration settings for the capability. You only need to specify the configuration parameters you want to change. For Argo CD capabilities, you can update RBAC role mappings and network access settings.
clientRequestToken	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 24 hours after creation.
deletePropagationPolicy	The updated delete propagation policy for the capability. Currently, the only supported value is RETAIN.

Value

A list with the following syntax:

list(
  update = list(
    id = "string",
    status = "InProgress"|"Failed"|"Cancelled"|"Successful",
    type = "VersionUpdate"|"EndpointAccessUpdate"|"LoggingUpdate"|"ConfigUpdate"|"AssociateIdentityProviderConfig"|"DisassociateIdentityProviderConfig"|"AssociateEncryptionConfig"|"AddonUpdate"|"VpcConfigUpdate"|"AccessConfigUpdate"|"UpgradePolicyUpdate"|"ZonalShiftConfigUpdate"|"AutoModeUpdate"|"RemoteNetworkConfigUpdate"|"DeletionProtectionUpdate"|"ControlPlaneScalingConfigUpdate"|"VendedLogsUpdate",
    params = list(
      list(
        type = "Version"|"PlatformVersion"|"EndpointPrivateAccess"|"EndpointPublicAccess"|"ClusterLogging"|"DesiredSize"|"LabelsToAdd"|"LabelsToRemove"|"TaintsToAdd"|"TaintsToRemove"|"MaxSize"|"MinSize"|"ReleaseVersion"|"PublicAccessCidrs"|"LaunchTemplateName"|"LaunchTemplateVersion"|"IdentityProviderConfig"|"EncryptionConfig"|"AddonVersion"|"ServiceAccountRoleArn"|"ResolveConflicts"|"MaxUnavailable"|"MaxUnavailablePercentage"|"NodeRepairEnabled"|"UpdateStrategy"|"ConfigurationValues"|"SecurityGroups"|"Subnets"|"AuthenticationMode"|"PodIdentityAssociations"|"UpgradePolicy"|"ZonalShiftConfig"|"ComputeConfig"|"StorageConfig"|"KubernetesNetworkConfig"|"RemoteNetworkConfig"|"DeletionProtection"|"NodeRepairConfig"|"VendedLogs"|"UpdatedTier"|"PreviousTier"|"WarmPoolEnabled"|"WarmPoolMaxGroupPreparedCapacity"|"WarmPoolMinSize"|"WarmPoolState"|"WarmPoolReuseOnScaleIn",
        value = "string"
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    errors = list(
      list(
        errorCode = "SubnetNotFound"|"SecurityGroupNotFound"|"EniLimitReached"|"IpNotAvailable"|"AccessDenied"|"OperationNotPermitted"|"VpcIdNotFound"|"Unknown"|"NodeCreationFailure"|"PodEvictionFailure"|"InsufficientFreeAddresses"|"ClusterUnreachable"|"InsufficientNumberOfReplicas"|"ConfigurationConflict"|"AdmissionRequestDenied"|"UnsupportedAddonModification"|"K8sResourceNotFound",
        errorMessage = "string",
        resourceIds = list(
          "string"
        )
      )
    )
  )
)

Request syntax

svc$update_capability(
  clusterName = "string",
  capabilityName = "string",
  roleArn = "string",
  configuration = list(
    argoCd = list(
      rbacRoleMappings = list(
        addOrUpdateRoleMappings = list(
          list(
            role = "ADMIN"|"EDITOR"|"VIEWER",
            identities = list(
              list(
                id = "string",
                type = "SSO_USER"|"SSO_GROUP"
              )
            )
          )
        ),
        removeRoleMappings = list(
          list(
            role = "ADMIN"|"EDITOR"|"VIEWER",
            identities = list(
              list(
                id = "string",
                type = "SSO_USER"|"SSO_GROUP"
              )
            )
          )
        )
      ),
      networkAccess = list(
        vpceIds = list(
          "string"
        )
      )
    )
  ),
  clientRequestToken = "string",
  deletePropagationPolicy = "RETAIN"
)