Spec-Zone.ru › AWS CLI v2

[ aws . apprunner ]

описать-настраиваемые-домены

Описание

Возвращает описание настраиваемых доменных имен, связанных с сервисом App Runner.

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

Синтаксис

  describe-custom-domains
--service-arn <value>
[--next-token <value>]
[--max-results <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]

Параметры

--service-arn (строка)

Amazon Resource Name (ARN) сервиса App Runner, для которого необходимо получить описание связанных настраиваемых доменных имен.

--next-token (строка)

Токен с предыдущей страницы результатов. Используется для запросов с постраничной навигацией. Запрос извлекает следующую страницу результатов. Все остальные значения параметров должны быть идентичны значениям, указанным в исходном запросе.

Если вы не укажете NextToken, запрос извлечёт первую страницу результатов.

--max-results (целое число)

Максимальное количество результатов, которое может содержать каждый ответ (страница результатов). Используется для запросов с постраничной навигацией.

Если вы не укажете MaxResults, запрос извлечёт все доступные результаты в одном ответе.

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

Переопределяет адрес по умолчанию команды заданным адресом.

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

Для получения описания настраиваемых доменных имен, связанных с сервисом

Следующий describe-custom-domains пример получает описания и статус настраиваемых доменных имен, связанных с сервисом App Runner.

aws apprunner describe-custom-domains \
    --cli-input-json file://input.json

Содержимое input.json:

{
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa",
    "DomainName": "example.com",
    "EnableWWWSubdomain": true
}

Вывод:

{
    "CustomDomains": [
        {
            "CertificateValidationRecords": [
                {
                    "Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com",
                    "Status": "PENDING_VALIDATION",
                    "Type": "CNAME",
                    "Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws."
                },
                {
                    "Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com",
                    "Status": "PENDING_VALIDATION",
                    "Type": "CNAME",
                    "Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws."
                }
            ],
            "DomainName": "example.com",
            "EnableWWWSubdomain": true,
            "Status": "PENDING_CERTIFICATE_DNS_VALIDATION"
        },
        {
            "CertificateValidationRecords": [
                {
                    "Name": "_a94f784c70d3f507c72dc28f55db2f6b.deals.example.com",
                    "Status": "SUCCESS",
                    "Type": "CNAME",
                    "Value": "_2db02504c1270c137383c6307b6834b0.bsgbmzkfwj.acm-validations.aws."
                }
            ],
            "DomainName": "deals.example.com",
            "EnableWWWSubdomain": false,
            "Status": "ACTIVE"
        }
    ],
    "DNSTarget": "psbqam834h.us-east-1.awsapprunner.com",
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa"
}

Вывод

DNSTarget -> (строка)

Поддомен App Runner сервиса App Runner. Связанные настраиваемые доменные имена отображаются на этом целевом имени.

ServiceArn -> (строка)

Amazon Resource Name (ARN) сервиса App Runner, для которого необходимо описать связанные настраиваемые доменные имена.

CustomDomains -> (список)

Список описаний настраиваемых доменных имен, связанных с сервисом. В запросе с постраничной навигацией запрос возвращает до MaxResults записей за один вызов.

(структура)

Описание настраиваемого домена, связанного с сервисом App Runner.

DomainName -> (строка)

Связанный пользовательский доменный конечный пункт. Это может быть корневой домен (например, example.com), поддомен (например, login.example.com или admin.login.example.com) или универсальный символ (например, *.example.com).

EnableWWWSubdomain -> (логическое значение)

Если true, поддомен ``www.*DomainName* `` связывается с сервисом App Runner дополнительно к основному домену.

CertificateValidationRecords -> (список)

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

(структура)

Описание записи CNAME сертификата, которую необходимо добавить в вашу систему DNS. Подробнее см. в разделе AssociateCustomDomain.

Name -> (строка)

Имя записи CNAME сертификата.

Type -> (строка)

Тип записи, всегда CNAME.

Value -> (строка)

Значение записи CNAME сертификата.

Status -> (строка)

Текущее состояние валидации записи CNAME сертификата. Оно должно измениться на SUCCESS после завершения App Runner валидации с вашей системой DNS.

Status -> (строка)

Текущее состояние связывания доменного имени.

VpcDNSTargets -> (список)

Записи DNS Target для настраиваемых доменных имен этой Amazon VPC.

(структура)

Запись DNS Target для настраиваемого доменного имени этой Amazon VPC.

VpcIngressConnectionArn -> (строка)

Amazon Resource Name (ARN) подключения VPC Ingress, связанного с вашим сервисом.

VpcId -> (строка)

ID Amazon VPC, связанной с настраиваемым доменным именем целевого DNS.

DomainName -> (строка)

Доменное имя вашего целевого DNS, связанного с Amazon VPC.

NextToken -> (строка)

Токен, который можно передать в последующем запросе для получения следующей страницы результатов. Возвращается в запросе с постраничной навигацией.

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

Spec-Zone.ru

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