изменение_конечной_точки_клиентского_vpn

Описание

Изменяет указанную конечную точку Клиентского VPN. Изменение DNS-серверов сбрасывает существующие подключения клиентов.

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

Синтаксис

  modify-client-vpn-endpoint
--client-vpn-endpoint-id <value>
[--server-certificate-arn <value>]
[--connection-log-options <value>]
[--dns-servers <value>]
[--vpn-port <value>]
[--description <value>]
[--split-tunnel | --no-split-tunnel]
[--dry-run | --no-dry-run]
[--security-group-ids <value>]
[--vpc-id <value>]
[--self-service-portal <value>]
[--client-connect-options <value>]
[--session-timeout-hours <value>]
[--client-login-banner-options <value>]
[--client-route-enforcement-options <value>]
[--disconnect-on-session-timeout | --no-disconnect-on-session-timeout]
[--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]

Параметры

--client-vpn-endpoint-id (строка)

--server-certificate-arn (строка)

--connection-log-options (структура)

Синтаксис сокращенного формата:

Enabled=boolean,CloudwatchLogGroup=string,CloudwatchLogStream=string

Синтаксис JSON:

{
  "Enabled": true|false,
  "CloudwatchLogGroup": "string",
  "CloudwatchLogStream": "string"
}

--dns-servers (структура)

Синтаксис сокращенного формата:

CustomDnsServers=string,string,Enabled=boolean

Синтаксис JSON:

{
  "CustomDnsServers": ["string", ...],
  "Enabled": true|false
}

--vpn-port (целое число)

--description (строка)

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

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

--security-group-ids (список)

Синтаксис:

"string" "string" ...

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

--self-service-portal (строка)

--client-connect-options (структура)

Синтаксис сокращенного формата:

Enabled=boolean,LambdaFunctionArn=string

Синтаксис JSON:

{
  "Enabled": true|false,
  "LambdaFunctionArn": "string"
}

--session-timeout-hours (целое число)

--client-login-banner-options (структура)

Синтаксис сокращенного формата:

Enabled=boolean,BannerText=string

Синтаксис JSON:

{
  "Enabled": true|false,
  "BannerText": "string"
}

--client-route-enforcement-options (структура)

Синтаксис сокращенного формата:

Enforced=boolean

Синтаксис JSON:

{
  "Enforced": true|false
}

--disconnect-on-session-timeout | --no-disconnect-on-session-timeout (логическое значение)

--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 для вывода.

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

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

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

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

Примеры

Изменение конечной точки VPN-клиента

Следующий modify-client-vpn-endpoint пример включает протоколирование подключений клиентов для указанной конечной точки VPN-клиента.

aws ec2 modify-client-vpn-endpoint \
    --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \
    --connection-log-options Enabled=true,CloudwatchLogGroup=ClientVPNLogs

Вывод:

{
    "Return": true
}

Дополнительную информацию см. в разделе Конечные точки VPN-клиента в Руководстве администратора AWS Client VPN.

Вывод

Возврат -> (boolean)