Spec-Zone.ru › AWS CLI v2

[ 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 -> (строка)

Доменное имя для API.

CertificateArn -> (строка)

Управляемый AWS сертификат, который будет использоваться оптимизированным по краям конечным пунктом для этого доменного имени. Поддерживается только AWS Certificate Manager.

CertificateName -> (строка)

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

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

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

DomainNameStatus -> (строка)

Статус миграции доменного имени. Допустимые значения: AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT и PENDING_OWNERSHIP_VERIFICATION. Если статус UPDATING, домен нельзя больше изменять, пока не завершится текущая операция. Если статус AVAILABLE, домен можно обновить.

DomainNameStatusMessage -> (строка)

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

EndpointType -> (строка)

Тип конечной точки.

HostedZoneId -> (строка)

Идентификатор размещённой зоны Amazon Route 53 конечной точки.

IpAddressType -> (строка)

Типы IP-адресов, которые могут вызывать доменное имя. Используйте ipv4, чтобы разрешить вызовы только с использованием IPv4-адресов, или dualstack, чтобы разрешить вызовы с использованием как IPv4, так и IPv6-адресов.

SecurityPolicy -> (строка)

Версия Transport Layer Security (TLS) политики безопасности для этого доменного имени. Допустимые значения: TLS_1_0 и TLS_1_2.

OwnershipVerificationCertificateArn -> (строка)

ARN общедоступного сертификата, выданного ACM для подтверждения владения вашим пользовательским доменом. Требуется только при настройке взаимной аутентификации TLS и использовании ARN импортированного или частного CA-сертификата ACM в качестве regionalCertificateArn

Сокращённый синтаксис:

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 -> (строка)

URL Amazon S3, указывающий хранилище доверенных сертификатов для взаимной аутентификации TLS, например, s3://bucket-name/key-name. Хранилище доверенных сертификатов может содержать сертификаты общедоступных или частных центров сертификации. Для обновления хранилища доверенных сертификатов загрузите новую версию в S3, а затем обновите пользовательское доменное имя, чтобы использовать новую версию. Для обновления хранилища доверенных сертификатов необходимо иметь разрешения на доступ к объекту S3.

TruststoreVersion -> (строка)

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

Сокращённый синтаксис:

TruststoreUri=string,TruststoreVersion=string

Синтаксис JSON:

{
  "TruststoreUri": "string",
  "TruststoreVersion": "string"
}

--tags (карта)

Коллекция тегов, связанных с доменным именем.

key -> (строка)

value -> (строка)

Строка длиной от 0 до 1600 символов.

Сокращённый синтаксис:

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 -> (строка)

Выражение выбора сопоставления API.

DomainName -> (строка)

Имя ресурса DomainName.

DomainNameConfigurations -> (список)

Конфигурации имени домена.

(структура)

Конфигурация имени домена.

ApiGatewayDomainName -> (строка)

Имя домена для API.

CertificateArn -> (строка)

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

CertificateName -> (строка)

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

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

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

DomainNameStatus -> (строка)

Статус миграции имени домена. Допустимые значения: AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT и PENDING_OWNERSHIP_VERIFICATION. Если статус UPDATING, домен нельзя изменить, пока не завершится текущая операция. Если статус AVAILABLE, домен можно обновить.

DomainNameStatusMessage -> (строка)

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

EndpointType -> (строка)

Тип конечной точки.

HostedZoneId -> (строка)

Идентификатор узла Amazon Route 53 для конечной точки.

IpAddressType -> (строка)

Типы IP-адресов, которые могут обращаться к имени домена. Используйте ipv4, чтобы разрешить обращение только по IPv4-адресам, или dualstack, чтобы разрешить обращение по IPv4 и IPv6-адресам.

SecurityPolicy -> (строка)

Версия TLS (Transport Layer Security) политики безопасности для этого имени домена. Допустимые значения: TLS_1_0 и TLS_1_2.

OwnershipVerificationCertificateArn -> (строка)

ARN публичного сертификата, выпущенного ACM для проверки владения вашим пользовательским доменом. Требуется только при настройке взаимной аутентификации TLS и использовании ARN импортированного или частного сертификата ACM в качестве regionalCertificateArn

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

Конфигурация взаимной аутентификации TLS для пользовательского имени домена.

TruststoreUri -> (строка)

URL Amazon S3, указывающий хранилище ключей для взаимной аутентификации TLS, например, s3://имя-ведра/имя-ключа. Хранилище ключей может содержать сертификаты от общедоступных или частных центров сертификации. Чтобы обновить хранилище ключей, загрузите новую версию в S3, а затем обновите имя пользовательского домена, чтобы использовать новую версию. Чтобы обновить хранилище ключей, у вас должны быть разрешения на доступ к объекту S3.

TruststoreVersion -> (строка)

Версия объекта S3, содержащего ваше хранилище ключей. Для указания версии необходимо включить версионирование для ведра S3.

TruststoreWarnings -> (список)

Список предупреждений, которые API Gateway возвращает при обработке вашего хранилища ключей. Неверные сертификаты порождают предупреждения. Взаимная аутентификация TLS все еще включена, но некоторые клиенты могут не иметь доступа к вашему API. Чтобы устранить предупреждения, загрузите новое хранилище ключей в S3, а затем обновите имя домена, чтобы использовать новую версию.

(строка)

Tags -> (карта)

Коллекция тегов, связанных с именем домена.

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

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

Строка длиной от [0 до 1600].

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

Spec-Zone.ru

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