Spec-Zone.ru › AWS CLI v2

[ aws . elbv2 ]

create-listener

Описание

Создаёт слушатель для указанного Application Load Balancer, Network Load Balancer или Gateway Load Balancer.

Для получения дополнительной информации см. следующее:

  • Слушатели для ваших Application Load Balancers
  • Слушатели для ваших Network Load Balancers
  • Слушатели для ваших Gateway Load Balancers

Эта операция идемпотентна, что означает, что она завершается не более одного раза. Если вы попытаетесь создать несколько слушателей с одинаковыми настройками, каждый вызов будет успешным.

См. также: AWS API Documentation

Синтаксис

  create-listener
--load-balancer-arn <value>
[--protocol <value>]
[--port <value>]
[--ssl-policy <value>]
[--certificates <value>]
--default-actions <value>
[--alpn-policy <value>]
[--tags <value>]
[--mutual-authentication <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]

Параметры

--load-balancer-arn (строка)

Идентификатор ресурса Amazon (ARN) балансировщика нагрузки.

--protocol (строка)

Протокол соединений от клиентов к балансировщику нагрузки. Для Application Load Balancers поддерживаются протоколы HTTP и HTTPS. Для Network Load Balancers поддерживаются протоколы TCP, TLS, UDP и TCP_UDP. Вы не можете указать протоколы UDP или TCP_UDP, если включен режим двойного стека. Вы не можете указать протокол для Gateway Load Balancer.

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

  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
  • GENEVE

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

Порт, на котором слушает балансировщик нагрузки. Вы не можете указать порт для Gateway Load Balancer.

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

[Слушатели HTTPS и TLS] Политика безопасности, определяющая поддерживаемые протоколы и шифры.

Для получения дополнительной информации см. Раздел Политики безопасности в руководстве по Application Load Balancers и Раздел Политики безопасности в руководстве по Network Load Balancers.

--certificates (список)

[Слушатели HTTPS и TLS] Сертификат по умолчанию для слушателя. Вы должны предоставить ровно один сертификат. Установите CertificateArn на ARN сертификата, но не устанавливайте IsDefault.

(структура)

Информация о сертификате SSL-сервера.

CertificateArn -> (строка)

Идентификатор ресурса Amazon (ARN) сертификата.

IsDefault -> (булево)

Указывает, является ли сертификат сертификатом по умолчанию. Не устанавливайте это значение при указании сертификата в качестве входных данных. Это значение не включено в вывод при описании слушателя, но включено при описании сертификатов слушателей.

Сокращенная синтаксическая запись:

CertificateArn=string,IsDefault=boolean ...

Синтаксис JSON:

[
  {
    "CertificateArn": "string",
    "IsDefault": true|false
  }
  ...
]

--default-actions (список)

Действия для правила по умолчанию.

(структура)

Информация об действии.

Каждое правило должно включать ровно один из следующих типов действий: forward, fixed-response или redirect, и это должно быть последнее выполняемое действие.

Type -> (строка)

Тип действия.

TargetGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы целей. Указывается только когда Type является forward и вы хотите направить трафик на одну группу целей. Чтобы направить трафик на одну или несколько групп целей, используйте ForwardConfig.

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

[Слушатели HTTPS] Информация об поставщике удостоверений, соответствующем OpenID Connect (OIDC). Указывается только когда Type равно authenticate-oidc.

Issuer -> (строка)

Идентификатор издателя OIDC IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

AuthorizationEndpoint -> (строка)

Конечная точка авторизации IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

TokenEndpoint -> (строка)

Конечная точка получения токена IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

UserInfoEndpoint -> (строка)

Конечная точка получения информации о пользователе IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

ClientId -> (строка)

Идентификатор клиента OAuth 2.0.

ClientSecret -> (строка)

Секрет клиента OAuth 2.0. Этот параметр необходим при создании правила. Если вы изменяете правило, вы можете опустить этот параметр, если установите UseExistingClientSecret в значение true.

SessionCookieName -> (строка)

Имя cookie, используемого для сохранения информации о сеансе. По умолчанию AWSELBAuthSessionCookie.

Scope -> (строка)

Набор утверждений пользователя, которые требуется запросить у IdP. По умолчанию openid.

Чтобы проверить, какие значения scope поддерживает ваш IdP и как разделять несколько значений, см. документацию вашего IdP.

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

Максимальная продолжительность сеанса аутентификации в секундах. По умолчанию 604800 секунд (7 дней).

AuthenticationRequestExtraParams -> (массив)

Параметры запроса (до 10) для включения в запрос перенаправления на конечную точку авторизации.

key -> (строка)

value -> (строка)

OnUnauthenticatedRequest -> (строка)

Поведение, если пользователь не аутентифицирован. Возможные значения:

  • deny- Возвращает ошибку HTTP 401 Unauthorized.
  • allow- Разрешает передать запрос целевому ресурсу.
  • authenticate- Перенаправляет запрос на конечную точку авторизации IdP. Это значение по умолчанию.

UseExistingClientSecret -> (булево)

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

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

[Слушатели HTTPS] Информация для использования Amazon Cognito для аутентификации пользователей. Указывается только когда Type равно authenticate-cognito.

UserPoolArn -> (строка)

Идентификатор ресурса Amazon (ARN) пула пользователей Amazon Cognito.

UserPoolClientId -> (строка)

Идентификатор клиента пула пользователей Amazon Cognito.

UserPoolDomain -> (строка)

Префикс домена или полное доменное имя пула пользователей Amazon Cognito.

SessionCookieName -> (строка)

Имя cookie, используемого для сохранения информации о сеансе. По умолчанию AWSELBAuthSessionCookie.

Scope -> (строка)

Набор утверждений пользователя, которые требуется запросить у IdP. По умолчанию openid.

Чтобы проверить, какие значения scope поддерживает ваш IdP и как разделять несколько значений, см. документацию вашего IdP.

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

Максимальная продолжительность сеанса аутентификации в секундах. По умолчанию 604800 секунд (7 дней).

AuthenticationRequestExtraParams -> (массив)

Параметры запроса (до 10) для включения в запрос перенаправления на конечную точку авторизации.

key -> (строка)

value -> (строка)

OnUnauthenticatedRequest -> (строка)

Поведение, если пользователь не аутентифицирован. Возможные значения:

  • deny- Возвращает ошибку HTTP 401 Unauthorized.
  • allow- Разрешает передать запрос целевому ресурсу.
  • authenticate- Перенаправляет запрос на конечную точку авторизации IdP. Это значение по умолчанию.

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

Порядок действия. Это значение требуется для правил с несколькими действиями. Действие с наименьшим значением order выполняется первым.

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

[Application Load Balancer] Информация для создания действия перенаправления. Указывается только когда Type равно redirect.

Protocol -> (строка)

Протокол. Можно указать HTTP, HTTPS или #{protocol}. Можно перенаправить HTTP на HTTP, HTTP на HTTPS и HTTPS на HTTPS. Нельзя перенаправить HTTPS на HTTP.

Port -> (строка)

Порт. Можно указать значение от 1 до 65535 или #{port}.

Host -> (строка)

Имя хоста. Этот компонент не закодирован по процентам. Имя хоста может содержать #{host}.

Path -> (строка)

Абсолютный путь, начинающийся с ведущей "/". Этот компонент не закодирован по процентам. Путь может содержать #{host}, #{path} и #{port}.

Query -> (строка)

Параметры запроса, закодированные по URL при необходимости, но не закодированные по процентам. Не включайте ведущий "?", так как он автоматически добавляется. Можно указать любые зарезервированные ключевые слова.

StatusCode -> (строка)

Код HTTP перенаправления. Перенаправление является постоянным (HTTP 301) или временным (HTTP 302).

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

[Application Load Balancer] Информация для создания действия, возвращающего пользовательский HTTP-ответ. Указывается только когда Type равно fixed-response.

MessageBody -> (строка)

Сообщение.

StatusCode -> (строка)

Код HTTP-ответа (2XX, 4XX или 5XX).

ContentType -> (строка)

Тип содержимого.

Допустимые значения: text/plain | text/css | text/html | application/javascript | application/json

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

Информация для создания действия, распределяющего запросы между одной или несколькими группами целей. Для Network Load Balancers можно указать одну группу целей. Указывается только когда Type равно forward. Если вы указываете и ForwardConfig, и TargetGroupArn, то можно указать только одну группу целей с помощью ForwardConfig, и она должна быть той же группой целей, что и в TargetGroupArn.

TargetGroups -> (список)

Группы целей. Для Network Load Balancers можно указать одну группу целей.

(структура)

Информация о том, как трафик будет распределяться между несколькими группами целей в правиле перенаправления.

TargetGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы целей.

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

Вес. Диапазон от 0 до 999.

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

Настройка привязки к группе целей для правила.

Enabled -> (булево)

Указывает, включена ли привязка к группе целей.

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

Период времени в секундах, в течение которого запросы от клиента должны направляться в ту же группу целей. Диапазон от 1 до 604800 секунд (7 дней).

Синтаксис JSON:

[
  {
    "Type": "forward"|"authenticate-oidc"|"authenticate-cognito"|"redirect"|"fixed-response",
    "TargetGroupArn": "string",
    "AuthenticateOidcConfig": {
      "Issuer": "string",
      "AuthorizationEndpoint": "string",
      "TokenEndpoint": "string",
      "UserInfoEndpoint": "string",
      "ClientId": "string",
      "ClientSecret": "string",
      "SessionCookieName": "string",
      "Scope": "string",
      "SessionTimeout": long,
      "AuthenticationRequestExtraParams": {"string": "string"
        ...},
      "OnUnauthenticatedRequest": "deny"|"allow"|"authenticate",
      "UseExistingClientSecret": true|false
    },
    "AuthenticateCognitoConfig": {
      "UserPoolArn": "string",
      "UserPoolClientId": "string",
      "UserPoolDomain": "string",
      "SessionCookieName": "string",
      "Scope": "string",
      "SessionTimeout": long,
      "AuthenticationRequestExtraParams": {"string": "string"
        ...},
      "OnUnauthenticatedRequest": "deny"|"allow"|"authenticate"
    },
    "Order": integer,
    "RedirectConfig": {
      "Protocol": "string",
      "Port": "string",
      "Host": "string",
      "Path": "string",
      "Query": "string",
      "StatusCode": "HTTP_301"|"HTTP_302"
    },
    "FixedResponseConfig": {
      "MessageBody": "string",
      "StatusCode": "string",
      "ContentType": "string"
    },
    "ForwardConfig": {
      "TargetGroups": [
        {
          "TargetGroupArn": "string",
          "Weight": integer
        }
        ...
      ],
      "TargetGroupStickinessConfig": {
        "Enabled": true|false,
        "DurationSeconds": integer
      }
    }
  }
  ...
]

--alpn-policy (список)

[Слушатели TLS] Название политики Application-Layer Protocol Negotiation (ALPN). Можно указать одно имя политики. Возможные значения:

  • HTTP1Only
  • HTTP2Only
  • HTTP2Optional
  • HTTP2Preferred
  • None

Для получения дополнительной информации см. Раздел ALPN-политики в руководстве по Network Load Balancers.

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

Теги для назначения слушателю.

(структура)

Информация о теге.

Key -> (строка)

Ключ тега.

Value -> (строка)

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

Сокращенная синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--mutual-authentication (структура)

Информация о конфигурации взаимной аутентификации.

Mode -> (строка)

Метод обработки сертификата клиента. Доступные варианты — off , passthrough или verify . Значение по умолчанию — off .

TrustStoreArn -> (строка)

Amazon Resource Name (ARN) хранилища доверенных сертификатов.

IgnoreClientCertificateExpiry -> (булево)

Указывает, игнорируются ли истекшие сертификаты клиентов.

TrustStoreAssociationStatus -> (строка)

Указывает статус ассоциации с общим хранилищем доверенных сертификатов.

AdvertiseTrustStoreCaNames -> (строка)

Указывает, рекламируются ли имена сертификатов CA хранилища доверенных сертификатов.

Сокращённая запись:

Mode=string,TrustStoreArn=string,IgnoreClientCertificateExpiry=boolean,TrustStoreAssociationStatus=string,AdvertiseTrustStoreCaNames=string

Формат JSON:

{
  "Mode": "string",
  "TrustStoreArn": "string",
  "IgnoreClientCertificateExpiry": true|false,
  "TrustStoreAssociationStatus": "active"|"removed",
  "AdvertiseTrustStoreCaNames": "on"|"off"
}

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображение версии данного инструмента.

--color (строка)

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

  • on
  • off
  • auto

--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 в руководстве пользователя AWS CLI.

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

Пример 1: Создание HTTP-листера

Следующий create-listener пример создаёт HTTP-листер для указанного балансировщика приложений, перенаправляя запросы на указанную целевую группу.

aws elbv2 create-listener \
    --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \
    --protocol HTTP \
    --port 80 \
    --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067

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

Пример 2: Создание HTTPS-листера

Следующий create-listener пример создаёт HTTPS-листер для указанного балансировщика приложений, перенаправляя запросы на указанную целевую группу. Для HTTPS-листера необходимо указать SSL-сертификат. Вы можете создавать и управлять сертификатами с помощью AWS Certificate Manager (ACM). В качестве альтернативы, вы можете создать сертификат с помощью инструментов SSL/TLS, получить подписанный сертификат от центра сертификации (CA) и загрузить сертификат в AWS Identity and Access Management (IAM).

aws elbv2 create-listener \
    --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \
    --protocol HTTPS \
    --port 443 \
    --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/3dcb0a41-bd72-4774-9ad9-756919c40557 \
    --ssl-policy ELBSecurityPolicy-2016-08 \
    --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067

Дополнительную информацию см. в разделе «Добавление HTTPS-листера» в Руководстве пользователя по балансировщикам приложений.

Пример 3: Создание TCP-листера

Следующий create-listener пример создаёт TCP-листер для указанного сетевого балансировщика, перенаправляя запросы на указанную целевую группу.

aws elbv2 create-listener \
    --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/net/my-network-load-balancer/5d1b75f4f1cee11e \
    --protocol TCP \
    --port 80 \
    --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-targets/b6bba954d1361c78

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

Пример 4: Создание TLS-листера

Следующий create-listener пример создаёт TLS-листер для указанного сетевого балансировщика, перенаправляя запросы на указанную целевую группу. Для TLS-листера необходимо указать SSL-сертификат.

aws elbv2 create-listener \
    --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \
    --protocol TLS \
    --port 443 \
    --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/3dcb0a41-bd72-4774-9ad9-756919c40557 \
    --ssl-policy ELBSecurityPolicy-2016-08 \
    --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067

Дополнительную информацию см. в разделе «TLS-листеры для сетевого балансировщика» в Руководстве пользователя для сетевых балансировщиков.

Пример 5: Создание UDP-листера

Следующий create-listener пример создаёт UDP-листер для указанного сетевого балансировщика, перенаправляя запросы на указанную целевую группу.

aws elbv2 create-listener \
    --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/net/my-network-load-balancer/5d1b75f4f1cee11e \
    --protocol UDP \
    --port 53 \
    --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-targets/b6bba954d1361c78

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

Пример 6: Создание листера для указанного шлюза и перенаправления

Следующий create-listener пример создаёт листер для указанного балансировщика шлюзов, перенаправляя запросы на указанную целевую группу.

aws elbv2 create-listener \
    --load-balancer-arn arn:aws:elasticloadbalancing:us-east-1:850631746142:loadbalancer/gwy/my-gateway-load-balancer/e0f9b3d5c7f7d3d6 \
    --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-east-1:850631746142:targetgroup/my-glb-targets/007ca469fae3bb1615

Вывод:

{
    "Listeners": [
        {
            "ListenerArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:listener/gwy/my-agw-lb-example2/e0f9b3d5c7f7d3d6/afc127db15f925de",
            "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:loadbalancer/gwy/my-agw-lb-example2/e0f9b3d5c7f7d3d6",
            "DefaultActions": [
                {
                    "Type": "forward",
                    "TargetGroupArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:targetgroup/test-tg-agw-2/007ca469fae3bb1615",
                    "ForwardConfig": {
                        "TargetGroups": [
                            {
                                "TargetGroupArn": "arn:aws:elasticloadbalancing:us-east-1:850631746142:targetgroup/test-tg-agw-2/007ca469fae3bb1615"
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

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

Вывод

Слушатели -> (список)

Информация о слушателе.

(структура)

Информация о слушателе.

ListenerArn -> (строка)

Идентификатор ресурса Amazon (ARN) слушателя.

LoadBalancerArn -> (строка)

Идентификатор ресурса Amazon (ARN) балансировщика нагрузки.

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

Порт, на котором балансировщик нагрузки прослушивает соединения.

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

Протокол для соединений от клиентов к балансировщику нагрузки.

Сертификаты -> (список)

[Слушатель HTTPS или TLS] Стандартный сертификат для слушателя.

(структура)

Информация о сертификате сервера SSL.

CertificateArn -> (строка)

Идентификатор ресурса Amazon (ARN) сертификата.

IsDefault -> (булево)

Указывает, является ли сертификат стандартным. Не устанавливайте это значение при указании сертификата в качестве входного параметра. Это значение не включается в выходные данные при описании слушателя, но включается при описании сертификатов слушателя.

SslPolicy -> (строка)

[Слушатель HTTPS или TLS] Политика безопасности, определяющая поддерживаемые протоколы и шифры.

DefaultActions -> (список)

Стандартные действия для слушателя.

(структура)

Информация об действии.

Каждое правило должно содержать ровно одно из следующих типов действий: forward , fixed-response , или redirect , и оно должно быть последним выполняемым действием.

Type -> (строка)

Тип действия.

TargetGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы целей. Указывается только когда Type является forward и вы хотите перенаправить трафик на одну группу целей. Чтобы перенаправить трафик на одну или несколько групп целей, используйте ForwardConfig вместо этого.

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

[Слушатели HTTPS] Информация об идентификаторе поставщика, совместимом с OpenID Connect (OIDC). Указывается только когда Type является authenticate-oidc .

Issuer -> (строка)

Идентификатор поставщика OIDC IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

AuthorizationEndpoint -> (строка)

Конечная точка авторизации IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

TokenEndpoint -> (строка)

Конечная точка получения токена IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

UserInfoEndpoint -> (строка)

Конечная точка получения информации о пользователе IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

ClientId -> (строка)

Идентификатор клиента OAuth 2.0.

ClientSecret -> (строка)

Секрет клиента OAuth 2.0. Этот параметр необходим при создании правила. При модификации правила вы можете опустить этот параметр, если установите UseExistingClientSecret в значение true.

SessionCookieName -> (строка)

Имя cookie, используемого для хранения информации о сеансе. По умолчанию - AWSELBAuthSessionCookie.

Scope -> (строка)

Набор пользовательских утверждений, которые требуется запросить у IdP. По умолчанию - openid .

Чтобы проверить, какие значения scope поддерживает ваш IdP и как разделять несколько значений, см. документацию вашего IdP.

SessionTimeout -> (длинное целое число)

Максимальная продолжительность сеанса аутентификации в секундах. По умолчанию - 604800 секунд (7 дней).

AuthenticationRequestExtraParams -> (массив)

Параметры запроса (до 10) для включения в запросе перенаправления к конечной точке авторизации.

key -> (строка)

value -> (строка)

OnUnauthenticatedRequest -> (строка)

Действие, если пользователь не аутентифицирован. Возможные значения:

  • deny- Возвращает ошибку HTTP 401 Неавторизован.
  • allow- Разрешает перенаправление запроса к целевому ресурсу.
  • authenticate- Перенаправляет запрос к конечной точке авторизации IdP. Это значение по умолчанию.

UseExistingClientSecret -> (булево)

Указывает, использовать ли существующий секрет клиента при модификации правила. При создании правила вы можете опустить этот параметр или установить его в значение false.

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

[Слушатели HTTPS] Информация для использования Amazon Cognito для аутентификации пользователей. Указывается только когда Type является authenticate-cognito .

UserPoolArn -> (строка)

Идентификатор ресурса Amazon (ARN) пула пользователей Amazon Cognito.

UserPoolClientId -> (строка)

Идентификатор клиента пула пользователей Amazon Cognito.

UserPoolDomain -> (строка)

Префикс домена или полное доменное имя пула пользователей Amazon Cognito.

SessionCookieName -> (строка)

Имя cookie, используемого для хранения информации о сеансе. По умолчанию - AWSELBAuthSessionCookie.

Scope -> (строка)

Набор пользовательских утверждений, которые требуется запросить у IdP. По умолчанию - openid .

Чтобы проверить, какие значения scope поддерживает ваш IdP и как разделять несколько значений, см. документацию вашего IdP.

SessionTimeout -> (длинное целое число)

Максимальная продолжительность сеанса аутентификации в секундах. По умолчанию - 604800 секунд (7 дней).

AuthenticationRequestExtraParams -> (массив)

Параметры запроса (до 10) для включения в запросе перенаправления к конечной точке авторизации.

key -> (строка)

value -> (строка)

OnUnauthenticatedRequest -> (строка)

Действие, если пользователь не аутентифицирован. Возможные значения:

  • deny- Возвращает ошибку HTTP 401 Неавторизован.
  • allow- Разрешает перенаправление запроса к целевому ресурсу.
  • authenticate- Перенаправляет запрос к конечной точке авторизации IdP. Это значение по умолчанию.

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

Порядок действия. Требуется для правил с несколькими действиями. Действие с наименьшим значением order выполняется первым.

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

[Балансировщик приложений] Информация для создания действия перенаправления. Указывается только когда Type является redirect .

Protocol -> (строка)

Протокол. Можно указать HTTP, HTTPS или #{protocol}. Можно перенаправлять HTTP на HTTP, HTTP на HTTPS и HTTPS на HTTPS. Нельзя перенаправлять HTTPS на HTTP.

Port -> (строка)

Порт. Можно указать значение от 1 до 65535 или #{port}.

Host -> (строка)

Имя хоста. Эта часть не кодируется в процентах. Имя хоста может содержать #{host}.

Path -> (строка)

Абсолютный путь, начинающийся с ведущей «/». Эта часть не кодируется в процентах. Путь может содержать #{host}, #{path} и #{port}.

Query -> (строка)

Параметры запроса, закодированные в URL при необходимости, но не закодированные в процентах. Не включайте ведущий «?», так как он добавляется автоматически. Можно указать любые зарезервированные ключевые слова.

StatusCode -> (строка)

Код HTTP перенаправления. Перенаправление может быть постоянным (HTTP 301) или временным (HTTP 302).

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

[Балансировщик приложений] Информация для создания действия, возвращающего пользовательский HTTP-ответ. Указывается только когда Type является fixed-response .

MessageBody -> (строка)

Сообщение.

StatusCode -> (строка)

Код HTTP-ответа (2XX, 4XX или 5XX).

ContentType -> (строка)

Тип содержимого.

Допустимые значения: text/plain | text/css | text/html | application/javascript | application/json

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

Информация для создания действия, распределяющего запросы между одной или несколькими группами целей. Для балансировщиков сетевого типа можно указать одну группу целей. Указывается только когда Type является forward . Если вы указываете как ForwardConfig, так и TargetGroupArn, можно указать только одну группу целей с помощью ForwardConfig и она должна быть той же группой, что и в TargetGroupArn.

TargetGroups -> (список)

Группы целей. Для сетевых балансировщиков можно указать одну группу целей.

(структура)

Информация о том, как трафик будет распределяться между несколькими группами целей в правиле перенаправления.

TargetGroupArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы целей.

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

Вес. Диапазон от 0 до 999.

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

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

Enabled -> (булево)

Указывает, включено ли прилипание к группе целей.

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

Период времени в секундах, в течение которого запросы от клиента должны перенаправляться на ту же группу целей. Диапазон от 1 до 604800 секунд (7 дней).

AlpnPolicy -> (список)

[Слушатель TLS] Название политики Application-Layer Protocol Negotiation (ALPN).

(строка)

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

Информация о конфигурации взаимной аутентификации.

Mode -> (строка)

Метод обработки сертификатов клиента. Допустимые значения: off , passthrough или verify . Значение по умолчанию - off .

TrustStoreArn -> (строка)

Идентификатор ресурса Amazon (ARN) хранилища доверия.

IgnoreClientCertificateExpiry -> (булево)

Указывает, игнорировать ли истекшие сертификаты клиентов.

TrustStoreAssociationStatus -> (строка)

Указывает статус ассоциации с общим хранилищем доверия.

AdvertiseTrustStoreCaNames -> (строка)

Указывает, отображать ли имена сертификатов CA хранилища доверия.

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

Spec-Zone.ru

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