create-verified-access-endpoint

Описание

Конечная точка Amazon Web Services Verified Access — это место, где вы определяете своё приложение вместе с необязательной политикой доступа на уровне конечной точки.

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

Синтаксис

  create-verified-access-endpoint
--verified-access-group-id <value>
--endpoint-type <value>
--attachment-type <value>
[--domain-certificate-arn <value>]
[--application-domain <value>]
[--endpoint-domain-prefix <value>]
[--security-group-ids <value>]
[--load-balancer-options <value>]
[--network-interface-options <value>]
[--description <value>]
[--policy-document <value>]
[--tag-specifications <value>]
[--client-token <value>]
[--dry-run | --no-dry-run]
[--sse-specification <value>]
[--rds-options <value>]
[--cidr-options <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]

Параметры

--verified-access-group-id (строка)

Идентификатор группы Verified Access, которую нужно ассоциировать с конечной точкой.

--endpoint-type (строка)

Тип конечной точки Verified Access, которую нужно создать.

Возможные значения:

load-balancer
network-interface
rds
cidr

--attachment-type (строка)

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

Возможные значения:

vpc

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

ARN общедоступного сертификата TLS/SSL в Amazon Web Services Certificate Manager, который нужно ассоциировать с конечной точкой. CN в сертификате должен соответствовать имени DNS, которое ваши конечные пользователи будут использовать для доступа к вашему приложению.

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

Имя DNS для доступа к вашему приложению.

--endpoint-domain-prefix (строка)

Пользовательский идентификатор, который добавляется к имени DNS, сгенерированному для конечной точки.

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

Идентификаторы сетевых групп, которые нужно ассоциировать с конечной точкой Verified Access. Требуется, если AttachmentType установлено в vpc.

(строка)

Синтаксис:

"string" "string" ...

--load-balancer-options (структура)

Подробности балансировщика нагрузки. Этот параметр требуется, если тип конечной точки — load-balancer.

Протокол -> (строка)

Сетевой протокол.

Порт -> (целое число)

Номер порта.

LoadBalancerArn -> (строка)

ARN балансировщика нагрузки.

SubnetIds -> (список)

Идентификаторы подсетей. Вы можете указать только одну подсеть на зону доступности.

(строка)

PortRanges -> (список)

Диапазоны портов.

(структура)

Описание диапазона портов для конечной точки Verified Access.

FromPort -> (целое число)

Начало диапазона портов.

ToPort -> (целое число)

Конец диапазона портов.

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

Protocol=string,Port=integer,LoadBalancerArn=string,SubnetIds=string,string,PortRanges=[{FromPort=integer,ToPort=integer},{FromPort=integer,ToPort=integer}]

Синтаксис JSON:

{
  "Protocol": "http"|"https"|"tcp",
  "Port": integer,
  "LoadBalancerArn": "string",
  "SubnetIds": ["string", ...],
  "PortRanges": [
    {
      "FromPort": integer,
      "ToPort": integer
    }
    ...
  ]
}

--network-interface-options (структура)

Подробности сетевого интерфейса. Этот параметр требуется, если тип конечной точки — network-interface.

NetworkInterfaceId -> (строка)

Идентификатор сетевого интерфейса.

Протокол -> (строка)

Сетевой протокол.

Порт -> (целое число)

Номер порта.

PortRanges -> (список)

Диапазоны портов.

(структура)

Описание диапазона портов для конечной точки Verified Access.

FromPort -> (целое число)

Начало диапазона портов.

ToPort -> (целое число)

Конец диапазона портов.

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

NetworkInterfaceId=string,Protocol=string,Port=integer,PortRanges=[{FromPort=integer,ToPort=integer},{FromPort=integer,ToPort=integer}]

Синтаксис JSON:

{
  "NetworkInterfaceId": "string",
  "Protocol": "http"|"https"|"tcp",
  "Port": integer,
  "PortRanges": [
    {
      "FromPort": integer,
      "ToPort": integer
    }
    ...
  ]
}

--description (строка)

Описание конечной точки Verified Access.

--policy-document (строка)

Документ политики Verified Access.

--tag-specifications (список)

Теги, которые нужно назначить конечной точке Verified Access.

(структура)

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

Примечание

Список Valid Values содержит все типы ресурсов, которые можно тегировать. Однако действие, которое вы используете, может не поддерживать тегирование всех этих типов ресурсов. Если вы попытаетесь тегировать тип ресурса, который не поддерживается для используемого вами действия, вы получите ошибку.

ResourceType -> (строка)

Тип ресурса, который нужно тегировать при создании.

Tags -> (список)

Теги, которые нужно применить к ресурсу.

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

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

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

Синтаксис JSON:

[
  {
    "ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"mac-modification-task",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

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

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

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

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

--sse-specification (структура)

Параметры шифрования на стороне сервера.

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

Включить или выключить использование управляемых пользователем ключей KMS для шифрования на стороне сервера.

KmsKeyArn -> (строка)

ARN ключа KMS.

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

CustomerManagedKeyEnabled=boolean,KmsKeyArn=string

Синтаксис JSON:

{
  "CustomerManagedKeyEnabled": true|false,
  "KmsKeyArn": "string"
}

--rds-options (структура)

Подробности RDS. Этот параметр требуется, если тип конечной точки — rds.

Протокол -> (строка)

Протокол.

Порт -> (целое число)

Порт.

RdsDbInstanceArn -> (строка)

ARN экземпляра RDS.

RdsDbClusterArn -> (строка)

ARN кластера БД.

RdsDbProxyArn -> (строка)

ARN прокси RDS.

RdsEndpoint -> (строка)

Конечная точка RDS.

SubnetIds -> (список)

Идентификаторы подсетей. Вы можете указать только одну подсеть на зону доступности.

(строка)

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

Protocol=string,Port=integer,RdsDbInstanceArn=string,RdsDbClusterArn=string,RdsDbProxyArn=string,RdsEndpoint=string,SubnetIds=string,string

Синтаксис JSON:

{
  "Protocol": "http"|"https"|"tcp",
  "Port": integer,
  "RdsDbInstanceArn": "string",
  "RdsDbClusterArn": "string",
  "RdsDbProxyArn": "string",
  "RdsEndpoint": "string",
  "SubnetIds": ["string", ...]
}

--cidr-options (структура)

Параметры CIDR. Этот параметр требуется, если тип конечной точки — cidr.

Протокол -> (строка)

Протокол.

SubnetIds -> (список)

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

(строка)

Cidr -> (строка)

CIDR.

PortRanges -> (список)

Диапазоны портов.

(структура)

Описание диапазона портов для конечной точки Verified Access.

FromPort -> (целое число)

Начало диапазона портов.

ToPort -> (целое число)

Конец диапазона портов.

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

Protocol=string,SubnetIds=string,string,Cidr=string,PortRanges=[{FromPort=integer,ToPort=integer},{FromPort=integer,ToPort=integer}]

Синтаксис JSON:

{
  "Protocol": "http"|"https"|"tcp",
  "SubnetIds": ["string", ...],
  "Cidr": "string",
  "PortRanges": [
    {
      "FromPort": integer,
      "ToPort": integer
    }
    ...
  ]
}

--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 (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить URL по умолчанию команды на предоставленный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команд.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружаться, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаут. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаут. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Для создания конечной точки Verified Access

Следующий create-verified-access-endpoint пример создаёт конечную точку Verified Access для указанной группы Verified Access. Указанный сетевой интерфейс и группа безопасности должны принадлежать одной и той же VPC.

aws ec2 create-verified-access-endpoint \
    --verified-access-group-id vagr-0dbe967baf14b7235 \
    --endpoint-type network-interface \
    --attachment-type vpc \
    --domain-certificate-arn arn:aws:acm:us-east-2:123456789012:certificate/eb065ea0-26f9-4e75-a6ce-0a1a7EXAMPLE \
    --application-domain example.com \
    --endpoint-domain-prefix my-ava-app \
    --security-group-ids sg-004915970c4c8f13a \
    --network-interface-options NetworkInterfaceId=eni-0aec70418c8d87a0f,Protocol=https,Port=443 \
    --tag-specifications ResourceType=verified-access-endpoint,Tags=[{Key=Name,Value=my-va-endpoint}]

Вывод:

{
    "VerifiedAccessEndpoint": {
        "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea",
        "VerifiedAccessGroupId": "vagr-0dbe967baf14b7235",
        "VerifiedAccessEndpointId": "vae-066fac616d4d546f2",
        "ApplicationDomain": "example.com",
        "EndpointType": "network-interface",
        "AttachmentType": "vpc",
        "DomainCertificateArn": "arn:aws:acm:us-east-2:123456789012:certificate/eb065ea0-26f9-4e75-a6ce-0a1a7EXAMPLE",
        "EndpointDomain": "my-ava-app.edge-00c3372d53b1540bb.vai-0ce000c0b7643abea.prod.verified-access.us-east-2.amazonaws.com",
        "SecurityGroupIds": [
            "sg-004915970c4c8f13a"
        ],
        "NetworkInterfaceOptions": {
            "NetworkInterfaceId": "eni-0aec70418c8d87a0f",
            "Protocol": "https",
            "Port": 443
        },
        "Status": {
            "Code": "pending"
        },
        "Description": "",
        "CreationTime": "2023-08-25T20:54:43",
        "LastUpdatedTime": "2023-08-25T20:54:43",
        "Tags": [
            {
                "Key": "Name",
                "Value": "my-va-endpoint"
            }
        ]
    }
}

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

Вывод

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

Подробная информация о конечной точке Verified Access.

VerifiedAccessInstanceId -> (строка)

Идентификатор экземпляра Amazon Web Services Verified Access.

VerifiedAccessGroupId -> (строка)

Идентификатор группы Amazon Web Services Verified Access.

VerifiedAccessEndpointId -> (строка)

Идентификатор конечной точки Amazon Web Services Verified Access.

ApplicationDomain -> (строка)

Имя домена DNS для доступа к вашему приложению.

EndpointType -> (строка)

Тип конечной точки Amazon Web Services Verified Access. Входящие запросы приложения будут отправляться на IP-адрес, балансировщик нагрузки или сетевой интерфейс в зависимости от указанного типа конечной точки.

AttachmentType -> (строка)

Тип подключения, используемого для обеспечения связи между конечной точкой Amazon Web Services Verified Access и приложением.

DomainCertificateArn -> (строка)

ARN общедоступного TLS/SSL-сертификата, импортированного или созданного с помощью ACM.

EndpointDomain -> (строка)

Имя домена DNS, сгенерированное для конечной точки.

DeviceValidationDomain -> (строка)

Возвращается, если к конечной точке подключён поставщик доверия устройств.

SecurityGroupIds -> (список)

Идентификаторы групп безопасности для конечной точки.

(строка)

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

Подробная информация о балансировщике нагрузки при создании конечной точки Amazon Web Services Verified Access типа load-balancer.

Protocol -> (строка)

IP-протокол.

Port -> (целое число)

Номер IP-порта.

LoadBalancerArn -> (строка)

ARN балансировщика нагрузки.

SubnetIds -> (список)

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

(строка)

PortRanges -> (список)

Диапазоны портов.

(структура)

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

FromPort -> (целое число)

Начало диапазона портов.

ToPort -> (целое число)

Конец диапазона портов.

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

Параметры для конечной точки типа сетевого интерфейса.

NetworkInterfaceId -> (строка)

Идентификатор сетевого интерфейса.

Protocol -> (строка)

IP-протокол.

Port -> (целое число)

Номер IP-порта.

PortRanges -> (список)

Диапазоны портов.

(структура)

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

FromPort -> (целое число)

Начало диапазона портов.

ToPort -> (целое число)

Конец диапазона портов.

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

Статус конечной точки.

Code -> (строка)

Код состояния конечной точки Verified Access.

Message -> (строка)

Сообщение о состоянии конечной точки Verified Access.

Description -> (строка)

Описание конечной точки Amazon Web Services Verified Access.

CreationTime -> (строка)

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

LastUpdatedTime -> (строка)

Время последнего обновления.

DeletionTime -> (строка)

Время удаления.

Tags -> (список)

Теги.

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

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

Параметры, используемые для шифрования на стороне сервера.

CustomerManagedKeyEnabled -> (boolean)

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

Допустимые значения: True | False

KmsKeyArn -> (строка)

ARN ключа KMS.

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

Параметры для конечной точки RDS.

Protocol -> (строка)

Протокол.

Port -> (целое число)

Порт.

RdsDbInstanceArn -> (строка)

ARN экземпляра RDS.

RdsDbClusterArn -> (строка)

ARN кластера DB.

RdsDbProxyArn -> (строка)

ARN прокси-сервера RDS.

RdsEndpoint -> (строка)

Конечная точка RDS.

SubnetIds -> (список)

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

(строка)

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

Параметры для конечной точки CIDR.

Cidr -> (строка)

CIDR.

PortRanges -> (список)

Диапазоны портов.

(структура)

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

FromPort -> (целое число)

Начало диапазона портов.

ToPort -> (целое число)

Конец диапазона портов.

Protocol -> (строка)

Протокол.

SubnetIds -> (список)

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

(строка)