Spec-Zone.ru › AWS CLI v2

[ aws . cloudfront ]

создание-профиля-шифрования-по-полям

Описание

Создаёт профиль шифрования по полям.

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

Синтаксис

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

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

В следующем примере создается профиль шифрования по полям путём предоставления параметров в файле JSON с именем fle-profile-config.json. Перед созданием профиля шифрования по полям необходимо иметь открытый ключ CloudFront. Чтобы создать открытый ключ CloudFront, см. команду create-public-key.

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

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

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

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

Вывод:

{
    "Location": "https://cloudfront.amazonaws.com/2019-03-26/field-level-encryption-profile/PPK0UOSIF5WSV",
    "ETag": "E2QWRUHEXAMPLE",
    "FieldLevelEncryptionProfile": {
        "Id": "PPK0UOSIF5WSV",
        "LastModifiedTime": "2019-12-10T01:03:16.537Z",
        "FieldLevelEncryptionProfileConfig": {
            "Name": "ExampleFLEProfile",
            "CallerReference": "cli-example",
            "Comment": "FLE profile for AWS CLI example",
            "EncryptionEntities": {
                "Quantity": 1,
                "Items": [
                    {
                        "PublicKeyId": "K2K8NC4HVFE3M0",
                        "ProviderId": "ExampleFLEProvider",
                        "FieldPatterns": {
                            "Quantity": 1,
                            "Items": [
                                "ExampleSensitiveField"
                            ]
                        }
                    }
                ]
            }
        }
    }
}

Вывод

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

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

Id -> (строка)

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

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

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

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

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

Name -> (строка)

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

CallerReference -> (строка)

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

Comment -> (строка)

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

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

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

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

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

Items -> (список)

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

(структура)

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

PublicKeyId -> (строка)

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

ProviderId -> (строка)

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

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

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

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

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

Items -> (список)

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

(строка)

Location -> (строка)

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

ETag -> (строка)

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

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

Spec-Zone.ru

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