Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

upload-server-certificate

Описание

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

Мы рекомендуем использовать Certificate Manager для подготовки, управления и развертывания сертификатов сервера. С помощью ACM вы можете запросить сертификат, развернуть его в ресурсах Amazon Web Services и позволить ACM обрабатывать обновления сертификатов. Сертификаты, предоставленные ACM, бесплатны. Дополнительную информацию об использовании ACM см. в руководстве пользователя Certificate Manager.

Дополнительную информацию о работе с сертификатами сервера см. в разделе «Работа с сертификатами сервера» в руководстве пользователя IAM. В данном разделе представлен список служб Amazon Web Services, которые могут использовать сертификаты сервера, управляемые IAM.

Дополнительную информацию о количестве загружаемых сертификатов сервера см. в разделе «Квоты IAM и STS» в руководстве пользователя IAM.

Примечание

Поскольку тело открытого сертификата ключа, закрытого ключа и цепочки сертификатов может быть большим, при вызове UploadServerCertificate следует использовать POST вместо GET. Дополнительную информацию о настройке подписей и авторизации через API см. в разделе «Подписание запросов API Amazon Web Services» в общей справке Amazon Web Services. Дополнительную информацию об использовании API запросов с IAM см. в разделе «Вызов API с помощью запросов HTTP» в руководстве пользователя IAM.

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

Синтаксис

  upload-server-certificate
[--path <value>]
--server-certificate-name <value>
--certificate-body <value>
--private-key <value>
[--certificate-chain <value>]
[--tags <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]

Параметры

--path (строка)

Путь к сертификату сервера. Дополнительную информацию о путях см. в разделе «Идентификаторы IAM» в руководстве пользователя IAM.

Этот параметр необязателен. Если он не указан, по умолчанию используется слеш (/). Этот параметр позволяет (через шаблон регулярных выражений) строку символов, состоящую либо из одного слеша (/), либо из строки, которая должна начинаться и заканчиваться слешами. Кроме того, он может содержать любой ASCII-символ от ! (\u0021 ) до символа DEL (\u007F ), включая большинство знаков препинания, цифр и прописных и строчных букв.

Примечание

Если вы загружаете сертификат сервера, предназначенный для использования с распределениями Amazon CloudFront, вы должны указать путь, используя параметр path. Путь должен начинаться с /cloudfront и должен включать конечный слеш (например, /cloudfront/test/).

--server-certificate-name (строка)

Имя сертификата сервера. Не включайте путь в это значение. Имя сертификата не должно содержать пробелов.

Этот параметр позволяет (через шаблон регулярных выражений) строку символов, состоящую из прописных и строчных буквенно-цифровых символов без пробелов. Вы также можете включить следующие символы: _+=,.@-

--certificate-body (строка)

Содержание открытого сертификата ключа в формате PEM.

Шаблон регулярных выражений для проверки этого параметра — это строка символов, состоящая из следующих символов:

  • Любой печатный ASCII-символ, начиная с пробела (\u0020 ) и до конца диапазона ASCII-символов
  • Печатные символы набора символов Basic Latin и Latin-1 Supplement (до \u00FF )
  • Специальные символы табуляции (\u0009 ), новой строки (\u000A ) и возврата каретки (\u000D )

--private-key (строка)

Содержание закрытого ключа в формате PEM.

Шаблон регулярных выражений для проверки этого параметра — это строка символов, состоящая из следующих символов:

  • Любой печатный ASCII-символ, начиная с пробела (\u0020 ) и до конца диапазона ASCII-символов
  • Печатные символы набора символов Basic Latin и Latin-1 Supplement (до \u00FF )
  • Специальные символы табуляции (\u0009 ), новой строки (\u000A ) и возврата каретки (\u000D )

--certificate-chain (строка)

Содержание цепочки сертификатов. Обычно это конкатенация PEM-закодированных открытых сертификатов ключей цепочки.

Шаблон регулярных выражений для проверки этого параметра — это строка символов, состоящая из следующих символов:

  • Любой печатный ASCII-символ, начиная с пробела (\u0020 ) и до конца диапазона ASCII-символов
  • Печатные символы набора символов Basic Latin и Latin-1 Supplement (до \u00FF )
  • Специальные символы табуляции (\u0009 ), новой строки (\u000A ) и возврата каретки (\u000D )

--tags (список)

Список тегов, которые вы хотите прикрепить к новому ресурсу серверного сертификата IAM. Каждый тег состоит из имени ключа и связанного значения. Дополнительную информацию о тегах см. в разделе «Тегирование ресурсов IAM» в руководстве пользователя IAM.

Примечание

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

(структура)

Структура, представляющая предоставляемые пользователем метаданные, которые могут быть связаны с ресурсом IAM. Дополнительную информацию о тегах см. в разделе «Тегирование ресурсов IAM» в руководстве пользователя IAM.

Ключ -> (строка)

Имя ключа, которое можно использовать для поиска или извлечения связанного значения. Например, Department или Cost Center являются распространенными вариантами.

Значение -> (строка)

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения такие как Human Resources , Accounting и Support . Теги с именем ключа Cost Center могут иметь значения, состоящие из номера, связанного с различными центрами затрат в вашей компании. Обычно у многих ресурсов есть теги с одинаковым именем ключа, но разными значениями.

Примечание

Amazon Web Services всегда интерпретирует тег Value как одну строку. Если вам нужно сохранить массив, вы можете сохранить значения, разделенные запятыми, в строке. Однако вы должны интерпретировать значение в своём коде.

Сокращенная синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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.

Загрузка сертификата сервера в ваш аккаунт AWS

Следующая команда upload-server-certificate загружает сертификат сервера в ваш аккаунт AWS. В этом примере сертификат находится в файле public_key_cert_file.pem, соответствующий закрытый ключ — в файле my_private_key.pem, а цепочка сертификатов, предоставленная центром сертификации (ЦС), — в файле my_certificate_chain_file.pem. После завершения загрузки файл будет доступен под именем myServerCertificate. Параметры, начинающиеся с file://, сообщают команде читать содержимое файла и использовать его как значение параметра вместо имени файла.

aws iam upload-server-certificate \
    --server-certificate-name myServerCertificate \
    --certificate-body file://public_key_cert_file.pem \
    --private-key file://my_private_key.pem \
    --certificate-chain file://my_certificate_chain_file.pem

Вывод:

{
    "ServerCertificateMetadata": {
        "Path": "/",
        "ServerCertificateName": "myServerCertificate",
        "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE",
        "Arn": "arn:aws:iam::1234567989012:server-certificate/myServerCertificate",
        "UploadDate": "2019-04-22T21:13:44+00:00",
        "Expiration": "2019-10-15T22:23:16+00:00"
    }
}

Дополнительную информацию см. в разделе `Создание, загрузка и удаление сертификатов сервера`__ в руководстве Использование IAM.

Вывод

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

Метаинформация загруженного сертификата сервера без его тела сертификата, цепочки сертификатов и закрытого ключа.

Path -> (строка)

Путь к сертификату сервера. Дополнительную информацию о путях см. в разделе «Идентификаторы IAM» в руководстве пользователя IAM.

ServerCertificateName -> (строка)

Имя, идентифицирующее сертификат сервера.

ServerCertificateId -> (строка)

Устойчивая и уникальная строка, идентифицирующая сертификат сервера. Дополнительную информацию об идентификаторах см. в разделе «Идентификаторы IAM» в руководстве пользователя IAM.

Arn -> (строка)

Amazon Resource Name (ARN), определяющий сертификат сервера. Дополнительную информацию об ARN и о том, как их использовать в политиках, см. в разделе «Идентификаторы IAM» в руководстве пользователя IAM.

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

Дата загрузки сертификата сервера.

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

Дата истечения срока действия сертификата.

Tags -> (список)

Список тегов, прикрепленных к новому сертификату сервера IAM. Возвращаемый список тегов отсортирован по ключу тега. Дополнительную информацию о тегах см. в разделе «Маркирование ресурсов IAM» в руководстве пользователя IAM.

(структура)

Структура, представляющая пользовательские метаданные, которые могут быть связаны с ресурсом IAM. Дополнительную информацию о тегах см. в разделе «Маркирование ресурсов IAM» в руководстве пользователя IAM.

Key -> (строка)

Имя ключа, которое может быть использовано для поиска или получения связанного значения. Например, Department или Cost Center — распространенные варианты.

Value -> (строка)

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Теги с именем ключа Cost Center могут содержать значения, представляющие номера, связанные с различными центрами затрат в вашей компании. Обычно многие ресурсы имеют теги с одинаковым именем ключа, но с разными значениями.

Примечание

Amazon Web Services всегда интерпретирует тег Value как одну строку. Если вам нужно хранить массив, вы можете хранить значения, разделенные запятыми, в строке. Однако вы должны интерпретировать значение в своём коде.

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

Spec-Zone.ru

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