Spec-Zone.ru › AWS CLI v2

[ aws . cloudfront ]

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

Описание

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

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

Синтаксис

  update-field-level-encryption-config
--field-level-encryption-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-config (структура)

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

CallerReference -> (строка)

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

Comment -> (строка)

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

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

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

ForwardWhenQueryArgProfileIsUnknown -> (логическое)

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

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

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

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

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

Items -> (список)

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

(структура)

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

QueryArg -> (строка)

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

ProfileId -> (строка)

Идентификатор профиля для использования в сопоставлении профилей с аргументами запроса шифрования по полям

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

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

ForwardWhenContentTypeIsUnknown -> (логическое)

Настройка в сопоставлении профилей с типами содержимого шифрования по полям, которая определяет действия при предоставлении неизвестного типа содержимого для профиля. Если значение true, содержимое пересылается без шифрования при неизвестном типе содержимого. Если false (по умолчанию), возвращается ошибка при неизвестном типе содержимого.

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

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

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

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

Items -> (список)

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

(структура)

Профиль типа содержимого для шифрования по полям.

Format -> (строка)

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

ProfileId -> (строка)

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

ContentType -> (строка)

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

Синтаксис JSON:

{
  "CallerReference": "string",
  "Comment": "string",
  "QueryArgProfileConfig": {
    "ForwardWhenQueryArgProfileIsUnknown": true|false,
    "QueryArgProfiles": {
      "Quantity": integer,
      "Items": [
        {
          "QueryArg": "string",
          "ProfileId": "string"
        }
        ...
      ]
    }
  },
  "ContentTypeProfileConfig": {
    "ForwardWhenContentTypeIsUnknown": true|false,
    "ContentTypeProfiles": {
      "Quantity": integer,
      "Items": [
        {
          "Format": "URLEncoded",
          "ProfileId": "string",
          "ContentType": "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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для обновления конфигурации шифрования по полям CloudFront

В следующем примере обновляется поле Comment конфигурации шифрования по полям с идентификатором C3KM2WVD605UAY, предоставляя параметры в файле JSON.

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

aws cloudfront update-field-level-encryption-config \
    --id C3KM2WVD605UAY \
    --if-match E2P4Z4VU7TY5SG \
    --field-level-encryption-config file://fle-config.json

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

{
    "CallerReference": "cli-example",
    "Comment": "Updated example FLE configuration",
    "QueryArgProfileConfig": {
        "ForwardWhenQueryArgProfileIsUnknown": true,
        "QueryArgProfiles": {
            "Quantity": 0
        }
    },
    "ContentTypeProfileConfig": {
        "ForwardWhenContentTypeIsUnknown": true,
        "ContentTypeProfiles": {
            "Quantity": 1,
            "Items": [
                {
                    "Format": "URLEncoded",
                    "ProfileId": "P280MFCLSYOCVU",
                    "ContentType": "application/x-www-form-urlencoded"
                }
            ]
        }
    }
}

Вывод:

{
    "ETag": "E26M4BIAV81ZF6",
    "FieldLevelEncryption": {
        "Id": "C3KM2WVD605UAY",
        "LastModifiedTime": "2019-12-10T22:26:26.170Z",
        "FieldLevelEncryptionConfig": {
            "CallerReference": "cli-example",
            "Comment": "Updated example FLE configuration",
            "QueryArgProfileConfig": {
                "ForwardWhenQueryArgProfileIsUnknown": true,
                "QueryArgProfiles": {
                    "Quantity": 0,
                    "Items": []
                }
            },
            "ContentTypeProfileConfig": {
                "ForwardWhenContentTypeIsUnknown": true,
                "ContentTypeProfiles": {
                    "Quantity": 1,
                    "Items": [
                        {
                            "Format": "URLEncoded",
                            "ProfileId": "P280MFCLSYOCVU",
                            "ContentType": "application/x-www-form-urlencoded"
                        }
                    ]
                }
            }
        }
    }
}

Вывод

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

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

Id -> (строка)

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

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

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

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

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

CallerReference -> (строка)

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

Comment -> (строка)

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

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

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

ForwardWhenQueryArgProfileIsUnknown -> (булево)

Флаг для установки, если вы хотите, чтобы запрос пересылался в исходный сервер даже если профиль, указанный аргументом запроса шифрования на уровне поля, fle-profile, неизвестен.

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

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

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

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

Items -> (список)

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

(структура)

Сопоставление профиля аргумента запроса для шифрования на уровне поля.

QueryArg -> (строка)

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

ProfileId -> (строка)

Идентификатор профиля для использования в сопоставлении профилей аргументов запроса шифрования на уровне поля

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

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

ForwardWhenContentTypeIsUnknown -> (булево)

Настройка в сопоставлении профиля типа содержимого шифрования на уровне поля, которая определяет, что делать при предоставлении неизвестного типа содержимого для профиля. Если true, содержимое пересылается без шифрования, когда тип содержимого неизвестен. Если false (по умолчанию), возвращается ошибка, когда тип содержимого неизвестен.

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

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

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

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

Items -> (список)

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

(структура)

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

Format -> (строка)

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

ProfileId -> (строка)

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

ContentType -> (строка)

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

ETag -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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