Spec-Zone.ru › AWS CLI v2

[ aws . apprunner ]

associate-custom-domain

Описание

Свяжите свой доменное имя с поддоменным URL-адресом App Runner для вашей службы App Runner.

После вызова AssociateCustomDomain и получения успешного ответа используйте информацию в записи CustomDomain, которая возвращается, чтобы добавить записи CNAME в вашу систему доменных имен (DNS). Для каждого сопоставленного доменного имени добавьте сопоставление с целевым поддоменом App Runner и одну или несколько записей валидации сертификата. App Runner выполнит валидацию DNS, чтобы проверить, что вы являетесь владельцем или управляете доменом, который вы связали. App Runner отслеживает действительность домена в сертификате, хранящемся в AWS Certificate Manager (ACM).

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

Синтаксис

  associate-custom-domain
--service-arn <value>
--domain-name <value>
[--enable-www-subdomain | --no-enable-www-subdomain]
[--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, с которой вы хотите связать доменное имя.

--domain-name (строка)

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

--enable-www-subdomain | --no-enable-www-subdomain (логическое значение)

Установите в значение true, чтобы связать поддомен ``www.*DomainName* `` со службой App Runner, помимо базового домена.

По умолчанию: true

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

Связать доменное имя и поддомен www со службой

В следующем associate-custom-domain примере связывается вами контролируемое доменное имя со службой App Runner. Доменное имя — это корневой домен example.com, включая поддомен www.example.com.

aws apprunner associate-custom-domain \
    --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
}

Вывод:

{
    "CustomDomain": {
        "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": "CREATING"
    },
    "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, с которой связано пользовательское доменное имя.

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

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

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

Идентификатор Amazon VPC, связанный с пользовательским доменным именем целевого DNS.

DomainName -> (строка)

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

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

Spec-Zone.ru

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