Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

обновление-связи-домена

Описание

Создает новую связь домена для приложения Amplify.

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

Синтаксис

  update-domain-association
--app-id <value>
--domain-name <value>
[--enable-auto-sub-domain | --no-enable-auto-sub-domain]
[--sub-domain-settings <value>]
[--auto-sub-domain-creation-patterns <value>]
[--auto-sub-domain-iam-role <value>]
[--certificate-settings <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]

Параметры

--app-id (строка)

Уникальный идентификатор приложения Amplify.

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

Имя домена.

--enable-auto-sub-domain | --no-enable-auto-sub-domain (логическое значение)

Включает автоматическое создание поддоменов для ветвей.

--sub-domain-settings (список)

Описывает параметры поддомена.

(структура)

Описывает параметры поддомена.

prefix -> (строка)

Настройка префикса для поддомена.

branchName -> (строка)

Настройка имени ветви для поддомена.

Краткая запись:

prefix=string,branchName=string ...

Синтаксис JSON:

[
  {
    "prefix": "string",
    "branchName": "string"
  }
  ...
]

--auto-sub-domain-creation-patterns (список)

Устанавливает шаблоны ветвей для автоматического создания поддоменов.

(строка)

Синтаксис:

"string" "string" ...

--auto-sub-domain-iam-role (строка)

Требуемая роль службы AWS Identity and Access Management (IAM) для Amazon Resource Name (ARN) для автоматического создания поддоменов.

--certificate-settings (структура)

Тип SSL/TLS-сертификата для использования с вашим пользовательским доменом.

type -> (строка)

Тип сертификата.

Укажите AMPLIFY_MANAGED, чтобы использовать стандартный сертификат, предоставляемый Amplify.

Укажите CUSTOM, чтобы использовать свой собственный сертификат, который вы уже добавили в Certificate Manager в вашем аккаунте Amazon Web Services. Убедитесь, что вы запрашиваете (или импортируете) сертификат в регионе US East (Северная Вирджиния) (us-east-1). Для получения дополнительной информации об использовании ACM, см. Импорт сертификатов в Certificate Manager в руководстве пользователя ACM.

customCertificateArn -> (строка)

Amazon Resource Name (ARN) пользовательского сертификата, который вы уже добавили в Certificate Manager в вашем аккаунте Amazon Web Services.

Это поле необходимо только при типе сертификата CUSTOM .

Краткая запись:

type=string,customCertificateArn=string

Синтаксис JSON:

{
  "type": "AMPLIFY_MANAGED"|"CUSTOM",
  "customCertificateArn": "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
  • text
  • таблица
  • 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-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

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

Описывает связь домена, которая связывает пользовательский домен с приложением Amplify.

domainAssociationArn -> (строка)

Amazon Resource Name (ARN) для связи домена.

domainName -> (строка)

Имя домена.

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

Включает автоматическое создание поддоменов для ветвей.

autoSubDomainCreationPatterns -> (список)

Устанавливает шаблоны ветвей для автоматического создания поддоменов.

(строка)

autoSubDomainIAMRole -> (строка)

Требуемая роль службы AWS Identity and Access Management (IAM) для Amazon Resource Name (ARN) для автоматического создания поддоменов.

domainStatus -> (строка)

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

updateStatus -> (строка)

Статус операции обновления домена, которая в настоящее время выполняется. Следующий список описывает допустимые состояния обновления.

REQUESTING_CERTIFICATE

Сертификат находится в процессе обновления.

PENDING_VERIFICATION

Указывает, что управляемый Amplify сертификат находится в процессе проверки. Это происходит во время создания пользовательского домена или при обновлении пользовательского домена для использования управляемого сертификата.

IMPORTING_CUSTOM_CERTIFICATE

Указывает, что пользовательский сертификат Amplify находится в процессе импорта. Это происходит во время создания пользовательского домена или при обновлении пользовательского домена для использования пользовательского сертификата.

PENDING_DEPLOYMENT

Указывает, что изменения в поддомене или сертификате распространяются.

AWAITING_APP_CNAME

Amplify ожидает распространения записей CNAME, соответствующих поддоменам. Если ваш пользовательский домен находится на Route 53, Amplify обрабатывает это автоматически. Для получения дополнительной информации о пользовательских доменах, см. Настройка пользовательских доменов в руководстве пользователя Amplify Hosting.

UPDATE_COMPLETE

Сертификат был связан с доменом.

UPDATE_FAILED

Сертификат не удалось установить или связать, и нет существующего активного сертификата для отката.

statusReason -> (строка)

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

certificateVerificationDNSRecord -> (строка)

DNS-запись для проверки сертификата.

subDomains -> (список)

Поддомены для связи домена.

(структура)

Поддомен для связи домена.

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

Описывает параметры поддомена.

prefix -> (строка)

Настройка префикса для поддомена.

branchName -> (строка)

Настройка имени ветви для поддомена.

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

Статус проверки поддомена

dnsRecord -> (строка)

DNS-запись для поддомена.

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

Описывает SSL/TLS-сертификат для связи домена. Это может быть ваш собственный пользовательский сертификат или стандартный сертификат, предоставляемый Amplify.

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

type -> (строка)

Тип SSL/TLS-сертификата, который вы хотите использовать.

Укажите AMPLIFY_MANAGED, чтобы использовать стандартный сертификат, предоставляемый Amplify.

Укажите CUSTOM, чтобы использовать свой собственный сертификат, который вы уже добавили в Certificate Manager в вашем аккаунте Amazon Web Services. Убедитесь, что вы запрашиваете (или импортируете) сертификат в регионе US East (Северная Вирджиния) (us-east-1). Для получения дополнительной информации об использовании ACM, см. Импорт сертификатов в Certificate Manager в руководстве пользователя ACM.

customCertificateArn -> (строка)

Amazon Resource Name (ARN) пользовательского сертификата, который вы уже добавили в Certificate Manager в вашем аккаунте Amazon Web Services.

Это поле необходимо только при типе сертификата CUSTOM .

certificateVerificationDNSRecord -> (строка)

DNS-запись для проверки сертификата.

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

Spec-Zone.ru

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