Spec-Zone.ru › AWS CLI v2

[ aws . eks ]

associate-encryption-config

Описание

Связывает конфигурацию шифрования с существующим кластером.

Используйте этот API для включения шифрования в существующих кластерах, которые еще не имеют включенного шифрования. Это позволяет реализовать стратегию защиты в глубину без миграции приложений в новые кластеры Amazon EKS.

См. также: Документация AWS API

Синтаксис

  associate-encryption-config
--cluster-name <value>
--encryption-config <value>
[--client-request-token <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]

Параметры

--cluster-name (строка)

Имя вашего кластера.

--encryption-config (список)

Конфигурация, используемая для шифрования.

(структура)

Конфигурация шифрования для кластера.

resources -> (список)

Указывает ресурсы, которые будут зашифрованы. Единственное поддерживаемое значение — secrets.

(строка)

provider -> (структура)

Ключ Управления ключами (KMS). Можно использовать как ARN, так и псевдоним.

keyArn -> (строка)

Идентификатор ресурса Amazon (ARN) или псевдоним ключа KMS. Ключ KMS должен быть симметричным и созданным в той же области Amazon Web Services, что и кластер. Если ключ KMS был создан в другом аккаунте, у принципала IAM должны быть права доступа к ключу KMS. Дополнительную информацию см. в разделе Разрешение пользователям из других аккаунтов использовать ключ KMS в руководстве разработчика службы управления ключами.

Сокращенный синтаксис:

resources=string,string,provider={keyArn=string} ...

Синтаксис JSON:

[
  {
    "resources": ["string", ...],
    "provider": {
      "keyArn": "string"
    }
  }
  ...
]

--client-request-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или значении input выводит пример JSON ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при значении yaml-input выводится пример YAML ввода, который можно использовать с --cli-input-yaml. При значении output выполняется валидация входных данных команды и возвращается пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды на заданный URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Используемая область. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для заданной конфигурации cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пагинатор CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство «Начало работы» в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. Подробную информацию см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.

Для связывания конфигурации шифрования с существующим кластером

Следующий associate-encryption-config пример включает шифрование в существующих кластерах EKS, которые еще не имеют включенного шифрования.

aws eks associate-encryption-config \
    --cluster-name my-eks-cluster \
    --encryption-config '[{"resources":["secrets"],"provider":{"keyArn":"arn:aws:kms:region-code:account:key/key"}}]'

Вывод:

{
    "update": {
        "id": "3141b835-8103-423a-8e68-12c2521ffa4d",
        "status": "InProgress",
        "type": "AssociateEncryptionConfig",
        "params": [
            {
                "type": "EncryptionConfig",
                "value": "[{\"resources\":[\"secrets\"],\"provider\":{\"keyArn\":\"arn:aws:kms:region-code:account:key/key\"}}]"
            }
        ],
        "createdAt": "2024-03-14T11:01:26.297000-04:00",
        "errors": []
    }
}

Дополнительную информацию см. в разделе Включение шифрования секретов в существующем кластере в руководстве пользователя Amazon EKS.

Вывод

update -> (структура)

Объект, представляющий асинхронное обновление.

id -> (строка)

UUID, используемый для отслеживания обновления.

status -> (строка)

Текущий статус обновления.

type -> (строка)

Тип обновления.

params -> (список)

Ключевое значение, содержащее параметры, связанные с обновлением.

(структура)

Объект, представляющий подробности запроса обновления.

type -> (строка)

Ключи, связанные с запросом обновления.

value -> (строка)

Значение ключей, переданных в качестве части запроса обновления.

createdAt -> (временная метка)

Временная метка Unix эпохи при создании объекта.

errors -> (список)

Возможные ошибки, связанные с обновлением Failed.

(структура)

Объект, представляющий ошибку при сбое асинхронной операции.

errorCode -> (строка)

Краткое описание ошибки.

  • SubnetNotFound : Не удалось найти одну из подсетей, связанных с кластером.
  • SecurityGroupNotFound : Не удалось найти одну из групп безопасности, связанных с кластером.
  • EniLimitReached : Достигнут предел сетевых интерфейсов для вашего аккаунта.
  • IpNotAvailable : У подсети, связанной с кластером, нет доступных IP-адресов.
  • AccessDenied : У вас нет разрешений для выполнения указанной операции.
  • OperationNotPermitted : У роли службы, связанной с кластером, нет необходимых разрешений доступа к Amazon EKS.
  • VpcIdNotFound : Не удалось найти VPC, связанный с кластером.

errorMessage -> (строка)

Более полное описание ошибки.

resourceIds -> (список)

Необязательное поле, содержащее идентификаторы ресурсов, связанные с ошибкой.

(строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API