modify-rule

Описание

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

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

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

Синтаксис

  modify-rule
--rule-arn <value>
[--conditions <value>]
[--actions <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]

Параметры

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

Amazon Resource Name (ARN) правила.

--conditions (список)

Условия.

(структура)

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

Каждое правило может необязательно содержать по одному из следующих условий: http-request-method , host-header , path-pattern , и source-ip . Каждое правило также может необязательно содержать один или несколько из следующих условий: http-header и query-string . Обратите внимание, что значение условия не может быть пустым.

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

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

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

http-header
http-request-method
host-header
path-pattern
query-string
source-ip

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

Значение условия. Указывать только когда Field равно host-header или path-pattern . В качестве альтернативы, чтобы указать несколько имен хостов или несколько шаблонов путей, используйте HostHeaderConfig или PathPatternConfig .

Если Field равно host-header и вы не используете HostHeaderConfig, вы можете указать одно имя хоста (например, my.example.com) в Values . Имя хоста нечувствительно к регистру, может содержать до 128 символов и может содержать следующие символы:

A-Z, a-z, 0-9
- .
- (соответствует 0 или более символам)
? (соответствует ровно одному символу)

Если Field равно path-pattern и вы не используете PathPatternConfig, вы можете указать один шаблон пути (например, /img/*) в Values . Шаблон пути чувствителен к регистру, может содержать до 128 символов и может содержать следующие символы:

A-Z, a-z, 0-9
_ - . $ / ~ “ ‘ @ : +
& (используя &)
- (соответствует 0 или более символам)
? (соответствует ровно одному символу)

(строка)

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

Информация для условия имени хоста. Указывать только когда Field равно host-header.

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

Имена хостов. Максимальный размер каждого имени — 128 символов. Сравнение нечувствительно к регистру. Поддерживаются следующие символы подстановки: * (соответствует 0 или более символам) и ? (соответствует ровно одному символу).

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

(строка)

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

Информация для условия шаблона пути. Указывать только когда Field равно path-pattern.

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

Шаблоны путей для сравнения с URL-адресом запроса. Максимальный размер каждой строки — 128 символов. Сравнение чувствительно к регистру. Поддерживаются следующие символы подстановки: * (соответствует 0 или более символам) и ? (соответствует ровно одному символу).

Если вы указываете несколько строк, условие выполняется, если одна из них соответствует URL-адресу запроса. Шаблон пути сравнивается только с путем URL-адреса, а не с его строкой запроса. Чтобы сравнить со строкой запроса, используйте QueryStringConditionConfig.

(строка)

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

Информация для условия HTTP-заголовка. Указывать только когда Field равно http-header.

HttpHeaderName -> (строка)

Имя поля HTTP-заголовка. Максимальный размер 40 символов. Имя заголовка нечувствительно к регистру. Разрешенные символы указаны в RFC 7230. Подстановки не поддерживаются.

Вы не можете использовать условие HTTP-заголовка для указания имени хоста. Используйте HostHeaderConditionConfig для указания условия имени хоста.

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

Строки для сравнения со значением HTTP-заголовка. Максимальный размер каждой строки — 128 символов. Строки сравнения нечувствительны к регистру. Поддерживаются следующие символы подстановки: * (соответствует 0 или более символам) и ? (соответствует ровно одному символу).

Если один и тот же заголовок появляется несколько раз в запросе, мы ищем их в порядке, пока не найдем совпадение.

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

(строка)

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

Информация для условия строки запроса. Указывать только когда Field равно query-string.

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

Ключи/значения или значения для поиска в строке запроса. Максимальный размер каждой строки — 128 символов. Сравнение нечувствительно к регистру. Поддерживаются следующие символы подстановки: * (соответствует 0 или более символам) и ? (соответствует ровно одному символу). Чтобы найти литерные символы «*» или «?» в строке запроса, вы должны экранировать эти символы в Values с помощью символа «'».

Если вы указываете несколько пар «ключ/значение» или значений, условие выполняется, если одно из них найдено в строке запроса.

(структура)

Информация об паре «ключ/значение».

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

Ключ. Вы можете опустить ключ.

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

Значение.

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

Информация для условия HTTP-метода. Указывать только когда Field равно http-request-method.

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

Название метода запроса. Максимальный размер 40 символов. Разрешенные символы — A-Z, дефис (-) и нижнее подчеркивание (_). Сравнение чувствительно к регистру. Символы подстановки не поддерживаются; следовательно, имя метода должно точно совпадать.

Если вы указываете несколько строк, условие выполняется, если одна из строк соответствует методу HTTP-запроса. Рекомендуется обрабатывать запросы GET и HEAD одинаково, так как ответ на запрос HEAD может быть кэширован.

(строка)

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

Информация для условия IP-адреса источника. Указывать только когда Field равно source-ip.

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

IP-адреса источника в формате CIDR. Можно использовать как IPv4, так и IPv6-адреса. Символы подстановки не поддерживаются.

Если вы указываете несколько адресов, условие выполняется, если IP-адрес источника запроса соответствует одному из блоков CIDR. Это условие не выполняется для адресов в заголовке X-Forwarded-For. Чтобы искать адреса в заголовке X-Forwarded-For, используйте HttpHeaderConditionConfig.

Общее количество значений должно быть меньше или равно пяти.

(строка)

Синтаксис JSON:

[
  {
    "Field": "string",
    "Values": ["string", ...],
    "HostHeaderConfig": {
      "Values": ["string", ...]
    },
    "PathPatternConfig": {
      "Values": ["string", ...]
    },
    "HttpHeaderConfig": {
      "HttpHeaderName": "string",
      "Values": ["string", ...]
    },
    "QueryStringConfig": {
      "Values": [
        {
          "Key": "string",
          "Value": "string"
        }
        ...
      ]
    },
    "HttpRequestMethodConfig": {
      "Values": ["string", ...]
    },
    "SourceIpConfig": {
      "Values": ["string", ...]
    }
  }
  ...
]

--actions (список)

Действия.

(структура)

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

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

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

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

TargetGroupArn -> (строка)

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

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

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

Issuer -> (строка)

Идентификатор издателя OIDC поставщика идентификации. Должен быть полным 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.

Для проверки поддерживаемых значений области и способов разделения нескольких значений см. документацию вашего 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 Resource Name (ARN) пула пользователей Amazon Cognito.

UserPoolClientId -> (строка)

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

UserPoolDomain -> (строка)

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

SessionCookieName -> (строка)

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

Scope -> (строка)

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

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

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

AuthenticationRequestExtraParams -> (массив)

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

key -> (строка)

value -> (строка)

OnUnauthenticatedRequest -> (строка)

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

deny- Возвращает ошибку HTTP 401 Неавторизован.
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 Resource Name (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
      }
    }
  }
  ...
]

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

Для изменения правила

Следующий modify-rule пример обновляет действия и условия для указанного правила.

aws elbv2 modify-rule \
  --actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \
  --conditions Field=path-pattern,Values='/images/*'
  --rule-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee

Вывод:

{
    "Rules": [
        {
            "Priority": "10",
            "Conditions": [
                {
                    "Field": "path-pattern",
                    "Values": [
                        "/images/*"
                    ]
                }
            ],
            "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee",
            "IsDefault": false,
            "Actions": [
                {
                    "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
                    "Type": "forward"
                }
            ]
        }
    ]
}

Вывод

Правила -> (список)

Информация о измененном правиле.

(структура)

Информация о правиле.

RuleArn -> (строка)

Amazon Resource Name (ARN) правила.

Priority -> (строка)

Приоритет.

Conditions -> (список)

Условия. Каждое правило может включать ноль или одно из следующих условий: http-request-method , host-header , path-pattern , и source-ip , и ноль или более из следующих условий: http-header и query-string .

(структура)

Информация об условии для правила.

Каждое правило может необязательно включать до одного из следующих условий: http-request-method , host-header , path-pattern , и source-ip . Каждое правило также может необязательно включать одно или несколько из следующих условий: http-header и query-string . Обратите внимание, что значение условия не может быть пустым.

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

Field -> (строка)

Поле в запросе HTTP. Доступны следующие значения:

http-header
http-request-method
host-header
path-pattern
query-string
source-ip

Values -> (список)

Значение условия. Указывается только когда Field имеет значение host-header или path-pattern . В качестве альтернативы, для указания нескольких имен хостов или нескольких шаблонов путей используйте HostHeaderConfig или PathPatternConfig .

Если Field имеет значение host-header и вы не используете HostHeaderConfig , вы можете указать единственное имя хоста (например, my.example.com) в Values . Имя хоста нечувствительно к регистру, может содержать до 128 символов и может содержать любые из следующих символов.

A-Z, a-z, 0-9
- .
- (соответствует 0 или более символам)
? (соответствует ровно 1 символу)

Если Field имеет значение path-pattern и вы не используете PathPatternConfig , вы можете указать единственный шаблон пути (например, /img/*) в Values . Шаблон пути чувствителен к регистру, может содержать до 128 символов и может содержать любые из следующих символов.

A-Z, a-z, 0-9
_ - . $ / ~ “ ‘ @ : +
& (используя &)
- (соответствует 0 или более символам)
? (соответствует ровно 1 символу)

(строка)

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

Информация для условия заголовка хоста. Указывается только когда Field имеет значение host-header .

Values -> (список)

Имена хостов. Максимальный размер каждого имени — 128 символов. Сравнение нечувствительно к регистру. Поддерживаются следующие символы подстановочных значений: * (соответствует 0 или более символам) и ? (соответствует ровно 1 символу).

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

(строка)

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

Информация для условия шаблона пути. Указывается только когда Field имеет значение path-pattern .

Values -> (список)

Шаблоны путей для сравнения с URL-адресом запроса. Максимальный размер каждой строки — 128 символов. Сравнение чувствительно к регистру. Поддерживаются следующие символы подстановочных значений: * (соответствует 0 или более символам) и ? (соответствует ровно 1 символу).

Если вы указываете несколько строк, условие выполняется, если одна из них соответствует URL-адресу запроса. Шаблон пути сравнивается только с путем URL-адреса, а не с его строкой запроса. Чтобы сравнить с строкой запроса, используйте QueryStringConditionConfig.

(строка)

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

Информация для условия HTTP-заголовка. Указывается только когда Field имеет значение http-header .

HttpHeaderName -> (строка)

Имя поля HTTP-заголовка. Максимальный размер — 40 символов. Имя заголовка нечувствительно к регистру. Допустимые символы указаны в RFC 7230. Подстановочные знаки не поддерживаются.

Нельзя использовать условие HTTP-заголовка для указания заголовка хоста. Используйте HostHeaderConditionConfig для указания условия заголовка хоста.

Values -> (список)

Строки для сравнения со значением HTTP-заголовка. Максимальный размер каждой строки — 128 символов. Строки сравнения нечувствительны к регистру. Поддерживаются следующие символы подстановочных значений: * (соответствует 0 или более символам) и ? (соответствует ровно 1 символу).

Если вы указываете несколько строк, условие выполняется, если одна из строк соответствует значению HTTP-заголовка. Чтобы потребовать, чтобы все строки совпадали, создайте одно условие на каждую строку.

(строка)

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

Информация для условия строки запроса. Указывается только когда Field имеет значение query-string .

Values -> (список)

Ключ/значение или значения, которые нужно найти в строке запроса. Максимальный размер каждой строки — 128 символов. Сравнение нечувствительно к регистру. Поддерживаются следующие символы подстановочных значений: * (соответствует 0 или более символам) и ? (соответствует ровно 1 символу). Чтобы найти буквальный символ '*' или '?', необходимо экранировать эти символы в Values с помощью символа «'».

Если вы указываете несколько пар ключ/значение или значений, условие выполняется, если одно из них найдено в строке запроса.

(структура)

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

Key -> (строка)

Ключ. Можно опустить.

Value -> (строка)

Значение.

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

Информация для условия метода HTTP. Указывается только когда Field имеет значение http-request-method .

Values -> (список)

Название метода запроса. Максимальный размер — 40 символов. Допустимые символы — A-Z, дефис (-) и нижнее подчеркивание (_). Сравнение чувствительно к регистру. Подстановочные знаки не поддерживаются, поэтому имя метода должно точно совпадать.

(строка)

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

Информация для условия IP-адреса источника. Указывается только когда Field имеет значение source-ip .

Values -> (список)

IP-адреса источника в формате CIDR. Можно использовать как IPv4, так и IPv6-адреса. Подстановочные знаки не поддерживаются.

Общее количество значений должно быть меньше или равно пяти.

(строка)

Actions -> (список)

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

(структура)

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

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

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

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

TargetGroupArn -> (строка)

Amazon Resource Name (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) для включения в запрос перенаправления на адрес конечной точки авторизации.

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

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

OnUnauthenticatedRequest -> (строка)

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

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

UseExistingClientSecret -> (логическое)

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

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

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

UserPoolArn -> (строка)

Amazon Resource Name (ARN) пула пользователей Amazon Cognito.

UserPoolClientId -> (строка)

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

UserPoolDomain -> (строка)

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

SessionCookieName -> (строка)

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

Scope -> (строка)

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

SessionTimeout -> (целое)

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

AuthenticationRequestExtraParams -> (массив)

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

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

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

OnUnauthenticatedRequest -> (строка)

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

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

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 Resource Name (ARN) целевой группы.

Weight -> (целое)

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

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

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

Enabled -> (логическое)

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

DurationSeconds -> (целое)

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

IsDefault -> (логическое)

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

END_OF_DOCUMENT_MARKER