create-domain-association
Описание
Создаёт новую ассоциацию домена для приложения Amplify. Это действие связывает пользовательский домен с приложением Amplify
См. также: Документацию API AWS
Синтаксис
create-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 (строка)
--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 (строка)
--certificate-settings (структура)
Тип сертификата SSL/TLS для использования с вашим пользовательским доменом. Если вы не укажете тип сертификата, Amplify использует по умолчанию сертификат, который он предоставляет и управляет им.
type -> (строка)
Тип сертификата.
Укажите AMPLIFY_MANAGED для использования по умолчанию сертификата, который предоставляет Amplify.
Укажите CUSTOM для использования своего сертификата, который вы уже добавили в Certificate Manager в вашей учетной записи Amazon Web Services. Убедитесь, что вы запросили (или импортировали) сертификат в регионе US East (N. Virginia) (us-east-1). Дополнительную информацию об использовании ACM см. в руководстве пользователя ACM по импорту сертификатов в Certificate Manager.
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-stream
--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.
Вывод
domainAssociation -> (структура)
Описывает структуру ассоциации домена, которая связывает пользовательский домен с приложением Amplify.
domainAssociationArn -> (строка)
domainName -> (строка)
enableAutoSubDomain -> (логическое значение)
autoSubDomainCreationPatterns -> (список)
Устанавливает шаблоны ветвей для автоматического создания поддоменов.
(строка)
autoSubDomainIAMRole -> (строка)
domainStatus -> (строка)
updateStatus -> (строка)
Статус операции обновления домена, которая в настоящее время выполняется. Следующий список описывает допустимые состояния обновления.
Сертификат находится в процессе обновления.
Указывает, что управляемый Amplify сертификат находится в процессе проверки. Это происходит во время создания пользовательского домена или при обновлении пользовательского домена для использования управляемого сертификата.
Указывает, что пользовательский сертификат Amplify находится в процессе импорта. Это происходит во время создания пользовательского домена или при обновлении пользовательского домена для использования пользовательского сертификата.
Указывает, что изменения поддомена или сертификата распространяются.
Amplify ожидает распространения записей CNAME, соответствующих поддоменам. Если ваш пользовательский домен находится на Route 53, Amplify обрабатывает это автоматически. Дополнительную информацию о пользовательских доменах см. в руководстве пользователя Amplify Hosting по настройке пользовательских доменов.
Сертификат был связан с доменом.
Сертификат не удалось развернуть или связать, и нет существующего активного сертификата для отката.
statusReason -> (строка)
certificateVerificationDNSRecord -> (строка)
subDomains -> (список)
Поддомены для ассоциации домена.
(структура)
Поддомен для ассоциации домена.
subDomainSetting -> (структура)
Описание настроек для поддомена.
prefix -> (строка)
branchName -> (строка)
verified -> (логическое значение)
dnsRecord -> (строка)
certificate -> (структура)
Описывает SSL/TLS-сертификат для ассоциации домена. Это может быть ваш собственный пользовательский сертификат или по умолчанию сертификат, который предоставляет Amplify.
Если вы обновляете свой домен для использования другого сертификата, certificate указывает на новый создаваемый сертификат вместо текущего активного сертификата. В противном случае, certificate указывает на текущий активный сертификат.
type -> (строка)
Тип SSL/TLS-сертификата, который вы хотите использовать.
Укажите AMPLIFY_MANAGED для использования по умолчанию сертификата, который предоставляет Amplify.
Укажите CUSTOM для использования своего сертификата, который вы уже добавили в Certificate Manager в вашей учетной записи Amazon Web Services. Убедитесь, что вы запросили (или импортировали) сертификат в регионе US East (N. Virginia) (us-east-1). Дополнительную информацию об использовании ACM см. в руководстве пользователя ACM по импорту сертификатов в Certificate Manager.
customCertificateArn -> (строка)
Amazon Resource Name (ARN) для пользовательского сертификата, который вы уже добавили в Certificate Manager в вашей учетной записи Amazon Web Services.
Это поле обязательно только в том случае, если тип сертификата CUSTOM.
certificateVerificationDNSRecord -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.