Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-transit-gateway-vpc-attachments

Описание

Описывает одну или несколько привязок VPC. По умолчанию описываются все привязки VPC. Также можно отфильтровать результаты.

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

describe-transit-gateway-vpc-attachments является постраничным запросом. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих запросов: TransitGatewayVpcAttachments

Синтаксис

  describe-transit-gateway-vpc-attachments
[--transit-gateway-attachment-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--transit-gateway-attachment-ids (список)

Идентификаторы привязок.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Один или несколько фильтров. Возможные значения:

  • state - Состояние привязки. Допустимые значения: available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting .
  • transit-gateway-attachment-id - Идентификатор привязки.
  • transit-gateway-id - Идентификатор шлюза транзита.
  • vpc-id - Идентификатор VPC.

(структура)

Пара имя-значение фильтра, используемая для возвращения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

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

Для получения дополнительной информации см. Список и фильтрацию с помощью командной строки и API в Руководстве пользователя Amazon EC2 .

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

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

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (логическое значение)

Проверяет, есть ли у вас необходимые разрешения для действия, не выполняя фактический запрос, и предоставляет ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке - DryRunOperation . В противном случае - UnauthorizedOperation .

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, указанные в JSON. Невозможно передать произвольные двоичные значения с помощью значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания места начала постраничного вывода. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS CLI .

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface .

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

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface .

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

За исключением случаев, когда оговаривается иное, во всех примерах используются правила цитирования для Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для описания привязок VPC вашего шлюза транзита

Следующий describe-transit-gateway-vpc-attachments пример отображает подробности привязок VPC вашего шлюза транзита.

aws ec2 describe-transit-gateway-vpc-attachments

Вывод:

{
    "TransitGatewayVpcAttachments": [
        {
            "TransitGatewayAttachmentId": "tgw-attach-0a08e88308EXAMPLE",
            "TransitGatewayId": "tgw-0043d72bb4EXAMPLE",
            "VpcId": "vpc-0f501f7ee8EXAMPLE",
            "VpcOwnerId": "111122223333",
            "State": "available",
            "SubnetIds": [
                "subnet-045d586432EXAMPLE",
                "subnet-0a0ad478a6EXAMPLE"
            ],
            "CreationTime": "2019-02-13T11:04:02.000Z",
            "Options": {
                "DnsSupport": "enable",
                "Ipv6Support": "disable"
            },
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "attachment name"
                }
            ]
        }
    ]
}

Для получения дополнительной информации см. Просмотр привязок VPC в Руководстве по шлюзам транзита.

Вывод

TransitGatewayVpcAttachments -> (список)

Информация о подключении VPC.

(структура)

Описание подключения VPC.

TransitGatewayAttachmentId -> (строка)

Идентификатор подключения.

TransitGatewayId -> (строка)

Идентификатор транзитной шлюзовой точки.

VpcId -> (строка)

Идентификатор VPC.

VpcOwnerId -> (строка)

Идентификатор учётной записи Amazon Web Services, владеющей VPC.

State -> (строка)

Состояние подключения VPC. Обратите внимание, что состояние initiating устарело.

SubnetIds -> (список)

Идентификаторы подсетей.

(строка)

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

Время создания.

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

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

DnsSupport -> (строка)

Указывает, включена ли поддержка DNS.

SecurityGroupReferencingSupport -> (строка)

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

Этот параметр включен по умолчанию.

Дополнительную информацию о ссылке на группу безопасности см. в руководстве Amazon Web Services Transit Gateways Guide в разделе «Ссылка на группу безопасности».

Ipv6Support -> (строка)

Указывает, отключена ли поддержка IPv6.

ApplianceModeSupport -> (строка)

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

Tags -> (список)

Теги для подключения VPC.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Ограничения: Ключи тегов чувствительны к регистру и принимают максимум 127 символов Юникода. Не может начинаться с aws: .

Value -> (строка)

Значение тега.

Ограничения: Значения тегов чувствительны к регистру и принимают максимум 256 символов Юникода.

NextToken -> (строка)

Маркер для получения следующей страницы результатов. Это значение равно null, если больше результатов нет.

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

Spec-Zone.ru

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