update-capability¶

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.

Synopsis¶

  update-capability
--cluster-name <value>
--capability-name <value>
[--role-arn <value>]
[--configuration <value>]
[--client-request-token <value>]
[--delete-propagation-policy <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--cluster-name (string) [required]

The name of the Amazon EKS cluster that contains the capability you want to update configuration for.

--capability-name (string) [required]

The name of the capability to update configuration for.

--role-arn (string)

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 (structure)

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.

argoCd -> (structure)

Configuration updates specific to Argo CD capabilities.

rbacRoleMappings -> (structure)

Updated RBAC role mappings for the Argo CD capability. You can add, update, or remove role mappings.

addOrUpdateRoleMappings -> (list)

A list of role mappings to add or update. If a mapping for the specified role already exists, it will be updated with the new identities. If it doesn’t exist, a new mapping will be created.

(structure)

A mapping between an Argo CD role and IAM Identity CenterIAM; Identity Center identities. This defines which users or groups have specific permissions in Argo CD.

role -> (string) [required]

The Argo CD role to assign. Valid values are:

ADMIN – Full administrative access to Argo CD.

EDITOR – Edit access to Argo CD resources.

VIEWER – Read-only access to Argo CD resources.

Possible values:

ADMIN

EDITOR

VIEWER

identities -> (list) [required]

A list of IAM Identity CenterIAM; Identity Center identities (users or groups) that should be assigned this Argo CD role.

(structure)

An IAM Identity CenterIAM; Identity Center identity (user or group) that can be assigned permissions in a capability.

id -> (string) [required]

The unique identifier of the IAM Identity CenterIAM; Identity Center user or group.

type -> (string) [required]

The type of identity. Valid values are SSO_USER or SSO_GROUP .

Possible values:

SSO_USER

SSO_GROUP

removeRoleMappings -> (list)

A list of role mappings to remove from the RBAC configuration. Each mapping specifies an Argo CD role (ADMIN , EDITOR , or VIEWER ) and the identities to remove from that role.

(structure)

A mapping between an Argo CD role and IAM Identity CenterIAM; Identity Center identities. This defines which users or groups have specific permissions in Argo CD.

role -> (string) [required]

The Argo CD role to assign. Valid values are:

ADMIN – Full administrative access to Argo CD.

EDITOR – Edit access to Argo CD resources.

VIEWER – Read-only access to Argo CD resources.

Possible values:

ADMIN

EDITOR

VIEWER

identities -> (list) [required]

A list of IAM Identity CenterIAM; Identity Center identities (users or groups) that should be assigned this Argo CD role.

(structure)

An IAM Identity CenterIAM; Identity Center identity (user or group) that can be assigned permissions in a capability.

id -> (string) [required]

The unique identifier of the IAM Identity CenterIAM; Identity Center user or group.

type -> (string) [required]

The type of identity. Valid values are SSO_USER or SSO_GROUP .

Possible values:

SSO_USER

SSO_GROUP

networkAccess -> (structure)

Updated network access configuration for the Argo CD capability’s managed API server endpoint. You can add or remove VPC endpoint associations to control which VPCs have private access to the Argo CD server.

vpceIds -> (list)

A list of VPC endpoint IDs to associate with the managed Argo CD API server endpoint. Each VPC endpoint provides private connectivity from a specific VPC to the Argo CD server. You can specify multiple VPC endpoint IDs to enable access from multiple VPCs.

(string)

JSON Syntax:

{
  "argoCd": {
    "rbacRoleMappings": {
      "addOrUpdateRoleMappings": [
        {
          "role": "ADMIN"|"EDITOR"|"VIEWER",
          "identities": [
            {
              "id": "string",
              "type": "SSO_USER"|"SSO_GROUP"
            }
            ...
          ]
        }
        ...
      ],
      "removeRoleMappings": [
        {
          "role": "ADMIN"|"EDITOR"|"VIEWER",
          "identities": [
            {
              "id": "string",
              "type": "SSO_USER"|"SSO_GROUP"
            }
            ...
          ]
        }
        ...
      ]
    },
    "networkAccess": {
      "vpceIds": ["string", ...]
    }
  }
}

--client-request-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 24 hours after creation.

--delete-propagation-policy (string)

The updated delete propagation policy for the capability. Currently, the only supported value is RETAIN .

Possible values:

RETAIN

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

update -> (structure)

An object representing an asynchronous update.

id -> (string)

A UUID that is used to track the update.

status -> (string)

The current status of the update.

Possible values:

InProgress

Failed

Cancelled

Successful

type -> (string)

The type of the update.

Possible values:

VersionUpdate

EndpointAccessUpdate

LoggingUpdate

ConfigUpdate

AssociateIdentityProviderConfig

DisassociateIdentityProviderConfig

AssociateEncryptionConfig

AddonUpdate

VpcConfigUpdate

AccessConfigUpdate

UpgradePolicyUpdate

ZonalShiftConfigUpdate

AutoModeUpdate

RemoteNetworkConfigUpdate

DeletionProtectionUpdate

ControlPlaneScalingConfigUpdate

params -> (list)

A key-value map that contains the parameters associated with the update.

(structure)

An object representing the details of an update request.

type -> (string)

The keys associated with an update request.

Possible values:

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

UpdatedTier

PreviousTier

value -> (string)

The value of the keys submitted as part of an update request.

createdAt -> (timestamp)

The Unix epoch timestamp at object creation.

errors -> (list)

Any errors associated with a Failed update.

(structure)

An object representing an error when an asynchronous operation fails.

errorCode -> (string)

A brief description of the error.

SubnetNotFound : We couldn’t find one of the subnets associated with the cluster.

SecurityGroupNotFound : We couldn’t find one of the security groups associated with the cluster.

EniLimitReached : You have reached the elastic network interface limit for your account.

IpNotAvailable : A subnet associated with the cluster doesn’t have any available IP addresses.

AccessDenied : You don’t have permissions to perform the specified operation.

OperationNotPermitted : The service role associated with the cluster doesn’t have the required access permissions for Amazon EKS.

VpcIdNotFound : We couldn’t find the VPC associated with the cluster.

Possible values:

SubnetNotFound

SecurityGroupNotFound

EniLimitReached

IpNotAvailable

AccessDenied

OperationNotPermitted

VpcIdNotFound

Unknown

NodeCreationFailure

PodEvictionFailure

InsufficientFreeAddresses

ClusterUnreachable

InsufficientNumberOfReplicas

ConfigurationConflict

AdmissionRequestDenied

UnsupportedAddonModification

K8sResourceNotFound

errorMessage -> (string)

A more complete description of the error.

resourceIds -> (list)

An optional field that contains the resource IDs associated with the error.

(string)

Table of Contents

Feedback

User Guide