Spec-Zone.ru › AWS CLI v2

[ aws . cloudfront ]

create-field-level-encryption-config

Описание

Создать новую конфигурацию шифрования на уровне поля.

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

Синтаксис

  create-field-level-encryption-config
--field-level-encryption-config <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"
        }
        ...
      ]
    }
  }
}

--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

В следующем примере создается конфигурация шифрования на уровне поля, путем предоставления параметров конфигурации в файле JSON с именем fle-config.json. Прежде чем создать конфигурацию шифрования на уровне поля, необходимо иметь профиль шифрования на уровне поля. Чтобы создать профиль, см. команду create-field-level-encryption-profile.

Дополнительную информацию о шифровании на уровне поля CloudFront см. в разделе Использование шифрования на уровне поля для защиты конфиденциальных данных в Руководстве разработчика Amazon CloudFront.

aws cloudfront create-field-level-encryption-config \
    --field-level-encryption-config file://fle-config.json

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

{
    "CallerReference": "cli-example",
    "Comment": "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"
                }
            ]
        }
    }
}

Вывод:

{
    "Location": "https://cloudfront.amazonaws.com/2019-03-26/field-level-encryption/C3KM2WVD605UAY",
    "ETag": "E2P4Z4VU7TY5SG",
    "FieldLevelEncryption": {
        "Id": "C3KM2WVD605UAY",
        "LastModifiedTime": "2019-12-10T21:30:18.974Z",
        "FieldLevelEncryptionConfig": {
            "CallerReference": "cli-example",
            "Comment": "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 -> (строка)

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

Location -> (строка)

Полный URI нового созданного ресурса конфигурации.

ETag -> (строка)

Текущая версия конфигурации шифрования полей. Например: E2QWRUHAPOMQZL .

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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