[ aws . apigatewayv2 ]
создание доменного имени
Описание
Создаёт доменное имя.
См. также: Документация API AWS
Синтаксис
create-domain-name
--domain-name <value>
[--domain-name-configurations <value>]
[--mutual-tls-authentication <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]
Параметры
--domain-name (строка)
--domain-name-configurations (список)
Конфигурации доменного имени.
(структура)
Конфигурация доменного имени.
ApiGatewayDomainName -> (строка)
CertificateArn -> (строка)
CertificateName -> (строка)
CertificateUploadDate -> (метка времени)
DomainNameStatus -> (строка)
DomainNameStatusMessage -> (строка)
EndpointType -> (строка)
HostedZoneId -> (строка)
IpAddressType -> (строка)
SecurityPolicy -> (строка)
OwnershipVerificationCertificateArn -> (строка)
Сокращённый синтаксис:
ApiGatewayDomainName=string,CertificateArn=string,CertificateName=string,CertificateUploadDate=timestamp,DomainNameStatus=string,DomainNameStatusMessage=string,EndpointType=string,HostedZoneId=string,IpAddressType=string,SecurityPolicy=string,OwnershipVerificationCertificateArn=string ...
Синтаксис JSON:
[
{
"ApiGatewayDomainName": "string",
"CertificateArn": "string",
"CertificateName": "string",
"CertificateUploadDate": timestamp,
"DomainNameStatus": "AVAILABLE"|"UPDATING"|"PENDING_CERTIFICATE_REIMPORT"|"PENDING_OWNERSHIP_VERIFICATION",
"DomainNameStatusMessage": "string",
"EndpointType": "REGIONAL"|"EDGE",
"HostedZoneId": "string",
"IpAddressType": "ipv4"|"dualstack",
"SecurityPolicy": "TLS_1_0"|"TLS_1_2",
"OwnershipVerificationCertificateArn": "string"
}
...
]
--mutual-tls-authentication (структура)
Конфигурация взаимной аутентификации TLS для пользовательского доменного имени.
TruststoreUri -> (строка)
TruststoreVersion -> (строка)
Сокращённый синтаксис:
TruststoreUri=string,TruststoreVersion=string
Синтаксис JSON:
{
"TruststoreUri": "string",
"TruststoreVersion": "string"
}
--tags (карта)
Коллекция тегов, связанных с доменным именем.
key -> (строка)
value -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "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.
Создание пользовательского доменного имени
Следующий пример создания регионального пользовательского доменного имени для API.
aws apigatewayv2 create-domain-name \
--domain-name regional.example.com \
--domain-name-configurations CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678
Вывод:
{
"ApiMappingSelectionExpression": "$request.basepath",
"DomainName": "regional.example.com",
"DomainNameConfigurations": [
{
"ApiGatewayDomainName": "d-id.execute-api.us-west-2.amazonaws.com",
"CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
"EndpointType": "REGIONAL",
"HostedZoneId": "123456789111",
"SecurityPolicy": "TLS_1_2",
"DomainNameStatus": "AVAILABLE"
}
]
}
Дополнительная информация: Настройка регионального пользовательского доменного имени в API Gateway в руководстве разработчика Amazon API Gateway.
Вывод
ApiMappingSelectionExpression -> (строка)
DomainName -> (строка)
DomainNameConfigurations -> (список)
Конфигурации имени домена.
(структура)
Конфигурация имени домена.
ApiGatewayDomainName -> (строка)
CertificateArn -> (строка)
CertificateName -> (строка)
CertificateUploadDate -> (метка времени)
DomainNameStatus -> (строка)
DomainNameStatusMessage -> (строка)
EndpointType -> (строка)
HostedZoneId -> (строка)
IpAddressType -> (строка)
SecurityPolicy -> (строка)
OwnershipVerificationCertificateArn -> (строка)
MutualTlsAuthentication -> (структура)
Конфигурация взаимной аутентификации TLS для пользовательского имени домена.
TruststoreUri -> (строка)
TruststoreVersion -> (строка)
TruststoreWarnings -> (список)
Список предупреждений, которые API Gateway возвращает при обработке вашего хранилища ключей. Неверные сертификаты порождают предупреждения. Взаимная аутентификация TLS все еще включена, но некоторые клиенты могут не иметь доступа к вашему API. Чтобы устранить предупреждения, загрузите новое хранилище ключей в S3, а затем обновите имя домена, чтобы использовать новую версию.
(строка)
Tags -> (карта)
Коллекция тегов, связанных с именем домена.
ключ -> (строка)
значение -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.