Spec-Zone.ru › AWS CLI v2

[ aws . elbv2 ]

modify-listener

Описание

Заменяет указанные свойства указанного слушателя. Любые свойства, которые вы не указываете, остаются без изменений.

Изменение протокола с HTTPS на HTTP или с TLS на TCP удаляет политику безопасности и свойства сертификата по умолчанию. Если вы изменяете протокол с HTTP на HTTPS или с TCP на TLS, необходимо добавить политику безопасности и свойства сертификата по умолчанию.

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

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

Синтаксис

  modify-listener
--listener-arn <value>
[--port <value>]
[--protocol <value>]
[--ssl-policy <value>]
[--certificates <value>]
[--default-actions <value>]
[--alpn-policy <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]

Параметры

--listener-arn (строка)

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

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

Порт для подключений клиентов к балансировщику нагрузки. Для балансировщика нагрузки типа Gateway Load Balancer порт указать нельзя.

--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

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

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

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

--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 поставщика удостоверений. Он должен быть полным URL-адресом, включающим протокол HTTPS, домен и путь.

AuthorizationEndpoint -> (строка)

Адрес конечной точки авторизации поставщика удостоверений. Он должен быть полным URL-адресом, включающим протокол HTTPS, домен и путь.

TokenEndpoint -> (строка)

Адрес конечной точки получения токенов поставщика удостоверений. Он должен быть полным URL-адресом, включающим протокол HTTPS, домен и путь.

UserInfoEndpoint -> (строка)

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

ClientId -> (строка)

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

ClientSecret -> (строка)

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

SessionCookieName -> (строка)

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

Scope -> (строка)

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

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

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

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

AuthenticationRequestExtraParams -> (карта)

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

key -> (строка)

value -> (строка)

OnUnauthenticatedRequest -> (строка)

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

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

UseExistingClientSecret -> (булево)

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

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

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

UserPoolArn -> (строка)

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

UserPoolClientId -> (строка)

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

UserPoolDomain -> (строка)

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

SessionCookieName -> (строка)

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

Scope -> (строка)

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

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

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

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

AuthenticationRequestExtraParams -> (карта)

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

key -> (строка)

value -> (строка)

OnUnauthenticatedRequest -> (строка)

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

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

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 дней).

Синтаксис 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] Имя политики согласования протоколов прикладного уровня (ALPN). Можно указать одно имя политики. Возможные значения:

  • HTTP1Only
  • HTTP2Only
  • HTTP2Optional
  • HTTP2Preferred
  • None

Дополнительную информацию см. в разделе «Политики ALPN» в руководстве по балансировщикам сетей.

(строка)

Синтаксис:

"string" "string" ...

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

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

Mode -> (строка)

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

TrustStoreArn -> (строка)

Идентификатор ресурса Amazon (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
  • текст
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить паджинг для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Пример 1: Изменение действия по умолчанию на действие «перенаправление»

Следующий modify-listener пример изменяет действие по умолчанию на действие «forward» для указанного слушателя.

aws elbv2 modify-listener \
    --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \
    --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f

Вывод:

{
    "Listeners": [
        {
            "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2",
            "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
            "Protocol": "HTTP",
            "Port": 80,
            "DefaultActions": [
                {
                    "Type": "forward",
                    "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f"
                }
            ]
        }
    ]
}

Пример 2: Изменение действия по умолчанию на действие «перенаправление»

Следующий modify-listener пример изменяет действие по умолчанию на действие «redirect» для указанного слушателя.

aws elbv2 modify-listener \
    --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \
    --default-actions Type=redirect, RedirectConfig='{Protocol=HTTPS,StatusCode=HTTP_302}'

Вывод:

{
    "Listeners": [
        {
            "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2",
            "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
            "Protocol": "HTTP",
            "Port": 80,
            "DefaultActions": [
                {
                    "Type": "redirect",
                    "RedirectConfig": {
                        "Protocol": "HTTPS",
                        "Port": "#{port}",
                        "Host": "#{host}",
                        "Path": "/#{path}",
                        "Query": "#{query}",
                        "StatusCode": "HTTP_302",
                    }
                }
            ]
        }
    ]
}

Пример 3: Изменение серверного сертификата

Следующий modify-listener пример изменяет серверный сертификат для указанного HTTPS-слушателя.

aws elbv2 modify-listener \
    --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65 \
    --certificates CertificateArn=arn:aws:iam::123456789012:server-certificate/my-new-server-cert

Вывод:

{
    "Listeners": [
        {
            "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65",
            "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
            "Protocol": "HTTPS",
            "Port": 443,
            "DefaultActions": [
                {
                    "Type": "forward",
                    "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
                }
            ],
            "SslPolicy": "ELBSecurityPolicy-2015-05",
            "Certificates": [
                {
                    "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert"
                }
            ],
        }
    ]
}

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

Вывод

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

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

(структура)

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

ListenerArn -> (строка)

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

LoadBalancerArn -> (строка)

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

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

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

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

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

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

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

(структура)

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

CertificateArn -> (строка)

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

IsDefault -> (булево)

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

SslPolicy -> (строка)

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

DefaultActions -> (список)

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

(структура)

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

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

Тип -> (строка)

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

TargetGroupArn -> (строка)

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

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

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

Issuer -> (строка)

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

AuthorizationEndpoint -> (строка)

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

TokenEndpoint -> (строка)

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

UserInfoEndpoint -> (строка)

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

ClientId -> (строка)

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

ClientSecret -> (строка)

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

SessionCookieName -> (строка)

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

Scope -> (строка)

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

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

SessionTimeout -> (целое число с большой точностью)

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

AuthenticationRequestExtraParams -> (карта)

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

ключ -> (строка)

значение -> (строка)

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 -> (строка)

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

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

SessionTimeout -> (целое число с большой точностью)

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

AuthenticationRequestExtraParams -> (карта)

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

ключ -> (строка)

значение -> (строка)

OnUnauthenticatedRequest -> (строка)

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

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

Порядок -> (целое число)

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

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

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

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

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

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

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

Хост -> (строка)

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

Путь -> (строка)

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

Запрос -> (строка)

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

Код состояния -> (строка)

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

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

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

Тело сообщения -> (строка)

Сообщение.

Код состояния -> (строка)

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

Тип контента -> (строка)

Тип контента.

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

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

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

TargetGroups -> (список)

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

(структура)

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

TargetGroupArn -> (строка)

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

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

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

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

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

Включено -> (булево)

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

Длительность в секундах -> (целое число)

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

AlpnPolicy -> (список)

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

(строка)

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

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

Режим -> (строка)

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

TrustStoreArn -> (строка)

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

IgnoreClientCertificateExpiry -> (булево)

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

TrustStoreAssociationStatus -> (строка)

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

AdvertiseTrustStoreCaNames -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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