Spec-Zone.ru › AWS CLI v2

[ aws . cloudfront ]

обновить-профиль-шифрования-по-полям

Описание

Обновление профиля шифрования по полям.

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

Синтаксис

  update-field-level-encryption-profile
--field-level-encryption-profile-config <value>
--id <value>
[--if-match <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]

Параметры

--field-level-encryption-profile-config (структура)

Запрос на обновление профиля шифрования по полям.

Name -> (строка)

Имя профиля для профиля шифрования по полям.

CallerReference -> (строка)

Уникальное число, гарантирующее, что запрос не может быть повторён.

Comment -> (строка)

Необязательное описание для профиля шифрования по полям. Описание не может быть длиннее 128 символов.

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

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

Quantity -> (целое число)

Количество элементов шаблона поля в сопоставлении типа содержимого профиля с шифрованием по полям.

Items -> (список)

Массив шаблонов полей в сопоставлении типа содержимого профиля с шифрованием по полям.

(структура)

Сложный тип данных для профилей шифрования по полям, включающий спецификации ключа шифрования и шаблона поля.

PublicKeyId -> (строка)

Открытый ключ, связанный с набором шаблонов шифрования по полям, используемый при шифровании полей, соответствующих шаблонам.

ProviderId -> (строка)

Поставщик, связанный с открытым ключом, используемым для шифрования. Это значение также должно быть предоставлено с закрытым ключом, чтобы приложения могли расшифровывать данные.

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

Шаблоны полей в профиле типа содержимого с шифрованием по полям указывают поля, которые необходимо зашифровать. Вы можете указать полное имя поля или любые начальные символы, за которыми следует символ подстановки (*). Шаблоны полей не должны перекрываться. Например, вы не можете использовать одновременно ABC* и AB*. Обратите внимание, что шаблоны полей чувствительны к регистру.

Quantity -> (целое число)

Количество шаблонов полей шифрования по полям.

Items -> (список)

Массив шаблонов полей шифрования по полям.

(строка)

Синтаксис JSON:

{
  "Name": "string",
  "CallerReference": "string",
  "Comment": "string",
  "EncryptionEntities": {
    "Quantity": integer,
    "Items": [
      {
        "PublicKeyId": "string",
        "ProviderId": "string",
        "FieldPatterns": {
          "Quantity": integer,
          "Items": ["string", ...]
        }
      }
      ...
    ]
  }
}

--id (строка)

Идентификатор запроса на обновление профиля шифрования по полям.

--if-match (строка)

Значение заголовка ETag, полученного при получении идентификатора профиля для обновления. Например: E2QWRUHAPOMQZL.

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

--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-auto-prompt (логическое значение)

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

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

Отключение автоматического запроса параметров CLI.

Примеры

Примечание

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

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

Обновление профиля шифрования по полям CloudFront

В следующем примере обновляется профиль шифрования по полям с идентификатором PPK0UOSIF5WSV. В этом примере обновляются Name и Comment профиля и добавляется второй элемент FieldPatterns, предоставляя параметры в файле JSON.

Для обновления профиля шифрования по полям необходимы идентификатор профиля и ETag. Идентификатор возвращается в выводе команд create-field-level-encryption-profile и list-field-level-encryption-profiles. Чтобы получить ETag, используйте команды get-field-level-encryption-profile или get-field-level-encryption-profile-config. Используйте опцию --if-match для предоставления ETag профиля.

aws cloudfront update-field-level-encryption-profile \
    --id PPK0UOSIF5WSV \
    --if-match E1QQG65FS2L2GC \
    --field-level-encryption-profile-config file://fle-profile-config.json

Файл fle-profile-config.json — это JSON-документ в текущей директории, содержащий следующее:

{
    "Name": "ExampleFLEProfileUpdated",
    "CallerReference": "cli-example",
    "Comment": "Updated FLE profile for AWS CLI example",
    "EncryptionEntities": {
        "Quantity": 1,
        "Items": [
            {
                "PublicKeyId": "K2K8NC4HVFE3M0",
                "ProviderId": "ExampleFLEProvider",
                "FieldPatterns": {
                    "Quantity": 2,
                    "Items": [
                        "ExampleSensitiveField",
                        "SecondExampleSensitiveField"
                    ]
                }
            }
        ]
    }
}

Вывод:

{
    "ETag": "EJETYFJ9CL66D",
    "FieldLevelEncryptionProfile": {
        "Id": "PPK0UOSIF5WSV",
        "LastModifiedTime": "2019-12-10T19:05:58.296Z",
        "FieldLevelEncryptionProfileConfig": {
            "Name": "ExampleFLEProfileUpdated",
            "CallerReference": "cli-example",
            "Comment": "Updated FLE profile for AWS CLI example",
            "EncryptionEntities": {
                "Quantity": 1,
                "Items": [
                    {
                        "PublicKeyId": "K2K8NC4HVFE3M0",
                        "ProviderId": "ExampleFLEProvider",
                        "FieldPatterns": {
                            "Quantity": 2,
                            "Items": [
                                "ExampleSensitiveField",
                                "SecondExampleSensitiveField"
                            ]
                        }
                    }
                ]
            }
        }
    }
}

Вывод

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

Возвращает результаты обновления профиля.

Id -> (строка)

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

LastModifiedTime -> (метка времени)

Последнее время обновления профиля шифрования на уровне поля.

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

Сложный тип данных, включающий имя профиля и сущности шифрования для профиля шифрования на уровне поля.

Name -> (строка)

Имя профиля для профиля шифрования на уровне поля.

CallerReference -> (строка)

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

Comment -> (строка)

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

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

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

Quantity -> (целое число)

Количество элементов шаблонов полей в сопоставлении профиля типа содержимого и шифрования на уровне поля.

Items -> (список)

Массив шаблонов полей в сопоставлении профиля типа содержимого и шифрования на уровне поля.

(структура)

Сложный тип данных для профилей шифрования на уровне поля, включающий спецификации ключа шифрования и шаблонов полей.

PublicKeyId -> (строка)

Открытый ключ, связанный с набором шаблонов шифрования на уровне поля, который будет использоваться при шифровании полей, соответствующих шаблонам.

ProviderId -> (строка)

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

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

Шаблоны полей в профиле типа содержимого и шифрования на уровне поля определяют поля, которые вы хотите зашифровать. Вы можете указать полное имя поля или любые начальные символы, за которыми следует символ подстановки (*). Шаблоны полей не могут перекрываться. Например, вы не можете иметь как ABC* и AB*. Обратите внимание, что шаблоны полей чувствительны к регистру.

Quantity -> (целое число)

Количество шаблонов полей шифрования на уровне поля.

Items -> (список)

Массив шаблонов полей шифрования на уровне поля.

(строка)

ETag -> (строка)

Результат запроса к профилю шифрования на уровне поля.

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

Spec-Zone.ru

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