обновить-пайп

Описание

Обновление существующего пайпа. Когда вы вызываете UpdatePipe, EventBridge обновляет только те поля, которые вы указали в запросе; остальные остаются неизменными. Исключением является изменение полей, специфичных для сервисов Amazon Web Services, в объектах SourceParameters, EnrichmentParameters или TargetParameters. Например, DynamoDBStreamParameters или EventBridgeEventBusParameters. EventBridge обновляет поля в этих объектах атомарно и перезаписывает существующие значения. Это сделано по умолчанию, и это означает, что если вы не укажете необязательное поле в одном из этих объектов Parameters, EventBridge установит для этого поля значение по умолчанию системы во время обновления.

Дополнительную информацию о пайпах см. в руководстве пользователя Amazon EventBridge в разделе Amazon EventBridge Pipes.

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

Синтаксис

  update-pipe
--name <value>
[--description <value>]
[--desired-state <value>]
[--source-parameters <value>]
[--enrichment <value>]
[--enrichment-parameters <value>]
[--target <value>]
[--target-parameters <value>]
--role-arn <value>
[--log-configuration <value>]
[--kms-key-identifier <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]

Параметры

--name (строка)

Название пайпа.

--description (строка)

Описание пайпа.

--desired-state (строка)

Состояние, в котором должен находиться пайп.

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

RUNNING
STOPPED

--source-parameters (структура)

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

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

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

Чтобы удалить фильтр, укажите объект FilterCriteria с пустым массивом объектов Filter.

Дополнительную информацию см. в разделе «События и шаблоны событий» в руководстве пользователя Amazon EventBridge.

Filters -> (список)

Шаблоны событий.

(структура)

Фильтруйте события с помощью шаблона события. Дополнительную информацию см. в разделе «События и шаблоны событий» в руководстве пользователя Amazon EventBridge.

Pattern -> (строка)

Шаблон события.

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

Параметры использования потока Kinesis в качестве источника.

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

Максимальное количество записей в каждой группе.

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

Определите целевую очередь для отправки событий очереди с необработанными сообщениями.

Arn -> (строка)

ARN указанной цели для очереди с необработанными сообщениями.

Для источников Amazon Kinesis stream и Amazon DynamoDB stream укажите ARN темы Amazon SNS или очереди Amazon SQS.

OnPartialBatchItemFailure -> (строка)

Определите, как обрабатывать ошибки обработки элементов. AUTOMATIC_BISECT делит каждую группу пополам и повторно пытается обработать каждую половину, пока все записи не будут обработаны или не останется одно необработанное сообщение в группе.

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

Максимальная длительность ожидания событий.

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

Отбрасывать записи, возраст которых превышает указанный. Значение по умолчанию равно -1, что устанавливает максимальный возраст в бесконечность. При значении бесконечность EventBridge никогда не отбрасывает старые записи.

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

Отбрасывать записи после указанного числа попыток. Значение по умолчанию равно -1, что устанавливает максимальное количество попыток в бесконечность. При бесконечном MaximumRetryAttempts EventBridge повторно пытается обработать ошибочные записи, пока запись не истечёт в источнике событий.

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

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

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

Параметры использования потока DynamoDB в качестве источника.

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

Максимальное количество записей в каждой группе.

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

Определите целевую очередь для отправки событий очереди с необработанными сообщениями.

Arn -> (строка)

ARN указанной цели для очереди с необработанными сообщениями.

Для источников Amazon Kinesis stream и Amazon DynamoDB stream укажите ARN темы Amazon SNS или очереди Amazon SQS.

OnPartialBatchItemFailure -> (строка)

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

Максимальная длительность ожидания событий.

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

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

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

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

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

Параметры использования потока Amazon SQS в качестве источника.

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

Максимальное количество записей в каждой группе.

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

Максимальная длительность ожидания событий.

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

Параметры использования брокера Active MQ в качестве источника.

Credentials -> (структура объединенного типа)

Необходимые учетные данные для доступа к ресурсу.

Примечание

Это структура объединенного типа. Можно установить только один из следующих ключей верхнего уровня: BasicAuth.

BasicAuth -> (строка)

ARN секрета Secrets Manager.

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

Максимальное количество записей в каждой группе.

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

Максимальная длительность ожидания событий.

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

Параметры использования брокера Rabbit MQ в качестве источника.

Credentials -> (структура объединенного типа)

Необходимые учетные данные для доступа к ресурсу.

Примечание

Это структура объединенного типа. Можно установить только один из следующих ключей верхнего уровня: BasicAuth.

BasicAuth -> (строка)

ARN секрета Secrets Manager.

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

Максимальное количество записей в каждой группе.

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

Максимальная длительность ожидания событий.

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

Параметры использования потока MSK в качестве источника.

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

Максимальное количество записей в каждой группе.

Credentials -> (структура объединенного типа)

Необходимые учетные данные для доступа к ресурсу.

Примечание

Это структура объединенного типа. Можно установить только один из следующих ключей верхнего уровня: SaslScram512Auth, ClientCertificateTlsAuth.

SaslScram512Auth -> (строка)

ARN секрета Secrets Manager.

ClientCertificateTlsAuth -> (строка)

ARN секрета Secrets Manager.

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

Максимальная длительность ожидания событий.

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

Параметры использования управляемого пользователем потока Apache Kafka в качестве источника.

Управляемый пользователем кластер — это любой кластер Apache Kafka, не размещенный в Amazon Web Services. Это включает кластеры, которые вы управляете сами, а также кластеры, размещенные сторонним поставщиком, например, Confluent Cloud, CloudKarafka или Redpanda. Дополнительную информацию см. в разделе Потоки Apache Kafka в качестве источника в руководстве пользователя Amazon EventBridge.

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

Максимальное количество записей в каждой группе.

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

Максимальная длительность ожидания событий.

Credentials -> (структура объединенного типа)

Необходимые учетные данные для доступа к ресурсу.

Примечание

Это структура объединенного типа. Можно установить только один из следующих ключей верхнего уровня: BasicAuth, SaslScram512Auth, SaslScram256Auth, ClientCertificateTlsAuth.

BasicAuth -> (строка)

ARN секрета Secrets Manager.

SaslScram512Auth -> (строка)

ARN секрета Secrets Manager.

SaslScram256Auth -> (строка)

ARN секрета Secrets Manager.

ClientCertificateTlsAuth -> (строка)

ARN секрета Secrets Manager.

ServerRootCaCertificate -> (строка)

ARN секрета Secrets Manager, используемого для сертификации.

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

Эта структура определяет подсети VPC и группы безопасности для потока и то, используется ли общедоступный IP-адрес.

Subnets -> (список)

Определяет подсети, связанные с потоком. Все эти подсети должны находиться в одной VPC. Вы можете указать до 16 подсетей.

(строка)

SecurityGroup -> (список)

Определяет группы безопасности, связанные с потоком. Все эти группы безопасности должны находиться в одной VPC. Вы можете указать до пяти групп безопасности.

(строка)

Синтаксис JSON:

{
  "FilterCriteria": {
    "Filters": [
      {
        "Pattern": "string"
      }
      ...
    ]
  },
  "KinesisStreamParameters": {
    "BatchSize": integer,
    "DeadLetterConfig": {
      "Arn": "string"
    },
    "OnPartialBatchItemFailure": "AUTOMATIC_BISECT",
    "MaximumBatchingWindowInSeconds": integer,
    "MaximumRecordAgeInSeconds": integer,
    "MaximumRetryAttempts": integer,
    "ParallelizationFactor": integer
  },
  "DynamoDBStreamParameters": {
    "BatchSize": integer,
    "DeadLetterConfig": {
      "Arn": "string"
    },
    "OnPartialBatchItemFailure": "AUTOMATIC_BISECT",
    "MaximumBatchingWindowInSeconds": integer,
    "MaximumRecordAgeInSeconds": integer,
    "MaximumRetryAttempts": integer,
    "ParallelizationFactor": integer
  },
  "SqsQueueParameters": {
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer
  },
  "ActiveMQBrokerParameters": {
    "Credentials": {
      "BasicAuth": "string"
    },
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer
  },
  "RabbitMQBrokerParameters": {
    "Credentials": {
      "BasicAuth": "string"
    },
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer
  },
  "ManagedStreamingKafkaParameters": {
    "BatchSize": integer,
    "Credentials": {
      "SaslScram512Auth": "string",
      "ClientCertificateTlsAuth": "string"
    },
    "MaximumBatchingWindowInSeconds": integer
  },
  "SelfManagedKafkaParameters": {
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer,
    "Credentials": {
      "BasicAuth": "string",
      "SaslScram512Auth": "string",
      "SaslScram256Auth": "string",
      "ClientCertificateTlsAuth": "string"
    },
    "ServerRootCaCertificate": "string",
    "Vpc": {
      "Subnets": ["string", ...],
      "SecurityGroup": ["string", ...]
    }
  }
}

--enrichment (строка)

ARN ресурса обогащения.

--enrichment-parameters (структура)

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

InputTemplate -> (строка)

Действительный текст JSON, переданный обогащению. В данном случае ничего из самого события не передается обогащению. Дополнительную информацию см. в разделе «Формат обмена данными JavaScript Object Notation (JSON)».

Чтобы удалить шаблон ввода, укажите пустую строку.

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

Содержит параметры HTTP, которые необходимо использовать, когда целевой ресурс — конечная точка API Gateway REST или EventBridge ApiDestination.

Если вы указываете API Gateway REST API или EventBridge ApiDestination в качестве цели, вы можете использовать этот параметр для указания заголовков, параметров пути и ключей/значений строки запроса в качестве части запроса вызова вашей цели. Если вы используете ApiDestinations, соответствующий соединение также может иметь эти значения, настроенные. В случае конфликтующих ключей значения из соединения имеют приоритет.

PathParameterValues -> (список)

Значения параметров пути, которые необходимо использовать для заполнения шаблонов пути API Gateway REST API или EventBridge ApiDestination («*»).

(строка)

HeaderParameters -> (массив)

Заголовки, которые необходимо отправить в рамках запроса вызова API Gateway REST API или EventBridge ApiDestination.

key -> (строка)

value -> (строка)

QueryStringParameters -> (массив)

Ключи/значения строки запроса, которые необходимо отправить в рамках запроса вызова API Gateway REST API или EventBridge ApiDestination.

key -> (строка)

value -> (строка)

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

InputTemplate=string,HttpParameters={PathParameterValues=[string,string],HeaderParameters={KeyName1=string,KeyName2=string},QueryStringParameters={KeyName1=string,KeyName2=string}}

Синтаксис JSON:

{
  "InputTemplate": "string",
  "HttpParameters": {
    "PathParameterValues": ["string", ...],
    "HeaderParameters": {"string": "string"
      ...},
    "QueryStringParameters": {"string": "string"
      ...}
  }
}

--target (строка)

ARN целевого ресурса.

--target-parameters (структура)

Параметры, необходимые для настройки цели для вашей трубы.

Дополнительную информацию о параметрах цели трубы, включая использование динамических параметров пути, см. в разделе «Параметры цели» в руководстве пользователя Amazon EventBridge.

InputTemplate -> (строка)

Действительный текст JSON, переданный целевому элементу. В данном случае ничего из самого события не передаётся целевому элементу. Дополнительную информацию см. в разделе «Формат обмена данными JavaScript Object Notation (JSON)».

Чтобы удалить шаблон входных данных, укажите пустую строку.

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

Параметры для использования функции Lambda в качестве цели.

InvocationType -> (строка)

Укажите, следует ли вызывать функцию синхронно или асинхронно.

REQUEST_RESPONSE (по умолчанию) — Вызвать синхронно. Это соответствует параметру RequestResponse в параметре InvocationType для API Lambda Invoke.
FIRE_AND_FORGET — Вызвать асинхронно. Это соответствует параметру Event в параметре InvocationType для API Lambda Invoke.

Дополнительную информацию см. в разделе «Типы вызовов» в руководстве пользователя Amazon EventBridge.

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

Параметры для использования состояния машины Step Functions в качестве цели.

InvocationType -> (строка)

Укажите, следует ли вызывать состояние машины Step Functions синхронно или асинхронно.

REQUEST_RESPONSE (по умолчанию) — Вызвать синхронно. Дополнительную информацию см. в разделе StartSyncExecution в справочнике по API Step Functions.

Примечание

REQUEST_RESPONSE не поддерживается для рабочих процессов состояний машины STANDARD.

FIRE_AND_FORGET — Вызвать асинхронно. Дополнительную информацию см. в разделе StartExecution в справочнике по API Step Functions.

Дополнительную информацию см. в разделе «Типы вызовов» в руководстве пользователя Amazon EventBridge.

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

Параметры для использования потока Kinesis в качестве цели.

PartitionKey -> (строка)

Определяет, к какому фрагменту в потоке назначается запись данных. Разделительные ключи — это строки Юникода с максимальным пределом длины 256 символов для каждого ключа. Amazon Kinesis Data Streams использует разделительный ключ в качестве входных данных для хеш-функции, которая отображает разделительный ключ и связанные данные на определённый фрагмент. В частности, для сопоставления разделительных ключей с 128-битными целочисленными значениями и для сопоставления связанных записей данных с фрагментами используется хеш-функция MD5. В результате этого механизма хеширования все записи данных с одним разделительным ключом отображаются на один и тот же фрагмент в потоке.

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

Параметры для использования задачи Amazon ECS в качестве цели.

TaskDefinitionArn -> (строка)

ARN определения задачи, используемого, если целевой элемент события — это задача Amazon ECS.

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

Количество задач, создаваемых на основе TaskDefinition. По умолчанию — 1.

LaunchType -> (строка)

Указывает тип запуска, на котором выполняется ваша задача. Указанный здесь тип запуска должен соответствовать одному из типов запуска (совместимости) целевой задачи. Значение FARGATE поддерживается только в регионах, где поддерживается Fargate с Amazon ECS. Дополнительную информацию см. в разделе Fargate на Amazon ECS в руководстве разработчика Amazon Elastic Container Service.

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

Используйте эту структуру, если задача Amazon ECS использует режим сети awsvpc. Эта структура определяет подсети VPC и группы безопасности, связанные с задачей, а также то, используется ли общедоступный IP-адрес. Эта структура требуется, если LaunchType является FARGATE, поскольку режим awsvpc необходим для задач Fargate.

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

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

Используйте эту структуру для указания подсетей VPC и групп безопасности для задачи и того, используется ли общедоступный IP-адрес. Эта структура актуальна только для задач ECS, использующих режим сети awsvpc.

Subnets -> (список)

Указывает подсети, связанные с задачей. Все эти подсети должны находиться в одной и той же VPC. Вы можете указать до 16 подсетей.

(строка)

SecurityGroups -> (список)

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

(строка)

AssignPublicIp -> (строка)

Указывает, получает ли эластичный сетевой интерфейс задачи общедоступный IP-адрес. Вы можете указать ENABLED только когда LaunchType в EcsParameters установлен в FARGATE.

PlatformVersion -> (строка)

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

Эта структура используется только если LaunchType является FARGATE. Дополнительную информацию о допустимых версиях платформы см. в разделе «Версии платформы Fargate» в руководстве разработчика Amazon Elastic Container Service.

Group -> (строка)

Указывает группу задач Amazon ECS для задачи. Максимальная длина — 255 символов.

CapacityProviderStrategy -> (список)

Стратегия использования поставщика ресурсов для задачи.

Если указана capacityProviderStrategy, параметр launchType должен быть опущен. Если не указан ни capacityProviderStrategy, ни launchType, используется defaultCapacityProviderStrategy для кластера.

(структура)

Подробности стратегии использования поставщика ресурсов. Дополнительную информацию см. в разделе CapacityProviderStrategyItem в справочнике по API Amazon ECS.

capacityProvider -> (строка)

Короткое имя поставщика ресурсов.

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

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

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

Базовое значение определяет минимальное количество задач, которые следует запустить на указанном поставщике ресурсов. Только один поставщик ресурсов в стратегии использования поставщика ресурсов может иметь определённое базовое значение. Если значение не указано, используется значение по умолчанию 0.

EnableECSManagedTags -> (булево значение)

Указывает, следует ли включить управляемые Amazon ECS теги для задачи. Дополнительную информацию см. в разделе «Использование тегов для ресурсов Amazon ECS» в руководстве разработчика Amazon Elastic Container Service.

EnableExecuteCommand -> (булево значение)

Включить или выключить функциональность выполнения команды для контейнеров в этой задаче. Если значение true, это включает функциональность выполнения команды для всех контейнеров в задаче.

PlacementConstraints -> (список)

Массив объектов ограничений размещения для использования в задаче. Вы можете указать до 10 ограничений на задачу (включая ограничения в определении задачи и те, которые указаны во время выполнения).

(структура)

Объект, представляющий ограничение размещения задачи. Дополнительную информацию см. в разделе «Ограничения размещения задач» в руководстве разработчика Amazon Elastic Container Service.

type -> (строка)

Тип ограничения. Используйте distinctInstance для обеспечения того, чтобы каждая задача в определённой группе работала на разных экземплярах контейнера. Используйте memberOf для ограничения выбора группой допустимых кандидатов.

expression -> (строка)

Выражение языка запросов кластера, которое нужно применить к ограничению. Вы не можете указать выражение, если тип ограничения — distinctInstance. Дополнительную информацию см. в разделе «Язык запросов кластера» в руководстве разработчика Amazon Elastic Container Service.

PlacementStrategy -> (список)

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

(структура)

Стратегия размещения задач для задачи или службы. Дополнительную информацию см. в разделе «Стратегии размещения задач» в руководстве разработчика службы Amazon Elastic Container Service.

type -> (строка)

Тип стратегии размещения. Случайная стратегия размещения случайным образом размещает задачи на доступных кандидатах. Стратегия равномерного размещения равномерно распределяет размещение по доступным кандидатам на основе параметра поля. Стратегия binpack размещает задачи на доступных кандидатах с наименьшим доступным количеством ресурса, указанного в параметре поля. Например, если вы используете binpack на памяти, задача размещается на экземпляре с наименьшим количеством свободной памяти (но всё ещё достаточно для запуска задачи).

field -> (строка)

Поле, к которому применяется стратегия размещения. Для стратегии равномерного размещения допустимые значения — instanceId (или host, что имеет тот же эффект), или любой атрибут платформы или пользовательский атрибут, применённый к экземпляру контейнера, например, attribute:ecs.availability-zone. Для стратегии размещения binpack допустимые значения — cpu и memory. Для случайной стратегии размещения это поле не используется.

PropagateTags -> (строка)

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

ReferenceId -> (строка)

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

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

Переопределения, связанные с задачей.

ContainerOverrides -> (список)

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

(структура)

Переопределения, отправляемые контейнеру. Можно передать пустое переопределение контейнера. Пример пустого переопределения контейнера — {"containerOverrides": [ ] }. Если указано непустое переопределение контейнера, необходимо включить параметр name.

Command -> (список)

Команда, отправляемая контейнеру, которая переопределяет команду по умолчанию из образа Docker или определения задачи. Также необходимо указать имя контейнера.

(строка)

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

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

Environment -> (список)

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

(структура)

name -> (строка)

Имя пары «ключ-значение». Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары «ключ-значение». Для переменных среды это значение переменной среды.

EnvironmentFiles -> (список)

Список файлов, содержащих переменные среды для передачи контейнеру вместо значения из определения контейнера.

(структура)

Список файлов, содержащих переменные среды для передачи контейнеру. Вы можете указать до десяти файлов среды. Файл должен иметь расширение .env. Каждая строка в файле среды должна содержать переменную среды в формате VARIABLE=VALUE. Строки, начинающиеся с #, обрабатываются как комментарии и игнорируются. Дополнительную информацию о синтаксисе файла переменных среды см. в разделе Определение переменных среды по умолчанию в файле.

Если переменные среды указаны с помощью параметра environment в определении контейнера, они имеют приоритет над переменными, содержащимися в файле среды. Если указано несколько файлов среды, содержащих одну и ту же переменную, они обрабатываются сверху вниз. Рекомендуется использовать уникальные имена переменных. Дополнительную информацию см. в разделе Определение переменных среды в руководстве разработчика Amazon Elastic Container Service.

Этот параметр поддерживается только для задач, размещенных на Fargate, с использованием следующих версий платформы:

Версия платформы Linux 1.4.0 или более поздняя.
Версия платформы Windows 1.0.0 или более поздняя.

type -> (строка)

Тип файла для использования. Поддерживается только значение s3.

value -> (строка)

Amazon Resource Name (ARN) объекта Amazon S3, содержащего файл переменной среды.

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

Жесткое ограничение (в МБ) памяти, предоставляемой контейнеру, вместо значения по умолчанию из определения задачи. Если контейнер пытается превысить указанный здесь объем памяти, контейнер завершается. Также необходимо указать имя контейнера.

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

Мягкое ограничение (в МБ) памяти, резервируемой для контейнера, вместо значения по умолчанию из определения задачи. Также необходимо указать имя контейнера.

Name -> (строка)

Имя контейнера, который получает переопределение. Этот параметр обязателен, если указано какое-либо переопределение.

ResourceRequirements -> (список)

Тип и количество ресурса, назначенного контейнеру, вместо значения по умолчанию из определения задачи. Поддерживается только ресурс GPU.

(структура)

Тип и количество ресурса, назначенного контейнеру. Поддерживаемые типы ресурсов — GPU и ускорители Elastic Inference. Дополнительную информацию см. в руководстве разработчика Amazon Elastic Container Service в разделах «Работа с GPU в Amazon ECS» или «Работа с Amazon Elastic Inference в Amazon ECS».

type -> (строка)

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

value -> (строка)

Значение для указанного типа ресурса.

Если используется тип GPU, значение представляет собой количество физических GPUs, которые агент контейнера Amazon ECS резервирует для контейнера. Количество зарезервированных GPU для всех контейнеров в задаче не может превышать количество доступных GPU на экземпляре контейнера, на котором запускается задача.

Если используется тип InferenceAccelerator, значение value соответствует значению deviceName для ускорителя Inference, указанного в определении задачи.

Cpu -> (строка)

Переопределение CPU для задачи.

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

Переопределение настроек временного хранения для задачи.

Примечание

Этот параметр поддерживается только для задач, размещенных на Fargate, которые используют следующие версии платформы:

Версия платформы Linux 1.4.0 или более поздняя.
Версия платформы Windows 1.0.0 или более поздняя.

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

Общий объем временного хранилища в ГБ для задания. Минимальное поддерживаемое значение — 21 ГБ, максимальное — 200 ГБ.

ExecutionRoleArn -> (строка)

Amazon Resource Name (ARN) переопределения роли IAM выполнения задачи для задачи. Дополнительную информацию см. в разделе Роль IAM выполнения задач Amazon ECS в руководстве разработчика Amazon Elastic Container Service.

InferenceAcceleratorOverrides -> (список)

Переопределение ускорителя Elastic Inference для задачи.

(структура)

Подробная информация о переопределении задачи ускорителя Elastic Inference. Этот параметр используется для переопределения ускорителя Elastic Inference, указанного в определении задачи. Дополнительную информацию см. в разделе «Работа с Amazon Elastic Inference в Amazon ECS» в руководстве разработчика Amazon Elastic Container Service.

deviceName -> (строка)

Имя устройства ускорителя Elastic Inference для переопределения в задаче. Этот параметр должен соответствовать deviceName, указанному в определении задачи.

deviceType -> (строка)

Тип ускорителя Elastic Inference, который необходимо использовать.

Memory -> (строка)

Переопределение памяти для задачи.

TaskRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которую контейнеры в этой задаче могут принять. Все контейнеры в этой задаче получают разрешения, указанные в этой роли. Дополнительную информацию см. в разделе Роль IAM для задач в руководстве разработчика Amazon Elastic Container Service.

Tags -> (список)

Метаданные, которые вы применяете к задаче для облегчения их категоризации и организации. Каждый тег состоит из ключа и необязательного значения, которые вы определяете. Дополнительную информацию см. в разделе RunTask в справочнике по API Amazon ECS.

(структура)

Пара «ключ-значение», связанная с ресурсом Amazon Web Services. В EventBridge правила и шины событий поддерживают тегирование.

Key -> (строка)

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

Value -> (строка)

Значение для указанного ключа тега.

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

Параметры для использования задания Batch в качестве целевого объекта.

JobDefinition -> (строка)

Определение задания, используемое этим заданием. Это значение может быть одним из name , name:revision или Amazon Resource Name (ARN) для определения задания. Если имя указано без ревизии, используется последняя активная ревизия.

JobName -> (строка)

Имя задания. Оно может содержать до 128 символов. Первый символ должен быть буквенно-цифровым, может содержать прописные и строчные буквы, цифры, дефисы (-) и символы подчеркивания (_).

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

Свойства массива для отправленного задания, такие как размер массива. Размер массива может быть от 2 до 10 000. Если вы указываете свойства массива для задания, оно становится заданием массива. Этот параметр используется только если целевой объект является заданием Batch.

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

Размер массива, если это задание массива Batch.

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

Стратегия повторных попыток для задания, завершившегося ошибкой. При указании здесь стратегии повторных попыток, она переопределяет стратегию повторных попыток, определенную в определении задания.

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

Количество попыток перевода задания в состояние RUNNABLE. Если значение attempts больше одного, задание повторяется при ошибке столько раз, сколько указано в этом значении.

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

Переопределения, отправляемые контейнеру.

Command -> (список)

Команда, отправляемая контейнеру, которая переопределяет стандартную команду из образа Docker или определения задачи.

(строка)

Environment -> (список)

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

Примечание

Переменные среды не могут начинаться с “Batch “. Эта конвенция именования зарезервирована для переменных, которые устанавливает Batch.

(структура)

Примечание

Name -> (строка)

Имя пары «ключ-значение». Для переменных среды это имя переменной среды.

Value -> (строка)

Значение пары «ключ-значение». Для переменных среды это значение переменной среды.

InstanceType -> (строка)

Тип экземпляра для использования в задании параллельной обработки на нескольких узлах.

Примечание

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

ResourceRequirements -> (список)

Тип и количество ресурсов, которые нужно назначить контейнеру. Это переопределяет параметры в определении задания. Поддерживаемые ресурсы включают в себя GPU , MEMORY и VCPU .

(структура)

Тип и количество ресурса, который нужно назначить контейнеру. Поддерживаемые ресурсы включают в себя GPU , MEMORY и VCPU .

Type -> (строка)

Тип ресурса, который нужно назначить контейнеру. Поддерживаемые ресурсы включают в себя GPU , MEMORY и VCPU .

Value -> (строка)

Количество указанного ресурса, которое необходимо зарезервировать для контейнера. Значения зависят от указанного type.

type=”GPU”

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

Примечание

GPU недоступны для заданий, выполняемых на ресурсах Fargate.

type=”MEMORY”

Максимальный объём памяти (в МБ), доступный контейнеру. Этот параметр поддерживается для заданий, выполняемых на ресурсах EC2. Если контейнер попытается превысить указанный объем памяти, контейнер будет завершен. Этот параметр соответствует Memory в разделе «Создание контейнера» API Docker и опции --memory к docker run. Для задания необходимо указать не менее 4 МБ памяти. Это обязательно, но может быть указано в нескольких местах для заданий параллельной обработки на нескольких узлах (MNP). Он должен быть указан для каждого узла хотя бы один раз. Этот параметр соответствует Memory в разделе «Создание контейнера» API Docker и опции --memory к docker run.

Примечание

Если вы пытаетесь максимизировать использование ресурсов, предоставляя своим заданиям как можно больше памяти для конкретного типа экземпляра, см. Управление памятью в Руководстве пользователя Batch.

Для заданий, выполняемых на ресурсах Fargate, value является жестким лимитом (в МБ) и должен соответствовать одному из поддерживаемых значений, а значения VCPU должны быть одним из значений, поддерживаемых для этого значения памяти.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 или 0.5

value = 2048

VCPU = 0.25, 0.5 или 1

value = 3072

VCPU = 0.5 или 1

value = 4096

VCPU = 0.5, 1 или 2

value = 5120, 6144 или 7168

VCPU = 1 или 2

value = 8192

VCPU = 1, 2, 4 или 8

value = 9216, 10240, 11264, 12288, 13312, 14336 или 15360

VCPU = 2 или 4

value = 16384

VCPU = 2, 4 или 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696 или 30720

VCPU = 4

value = 20480, 24576 или 28672

VCPU = 4 или 8

value = 36864, 45056, 53248 или 61440

VCPU = 8

value = 32768, 40960, 49152 или 57344

VCPU = 8 или 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688 или 122880

VCPU = 16

type=”VCPU”

Количество виртуальных процессоров (vCPU), резервируемых для контейнера. Этот параметр соответствует CpuShares в разделе «Создание контейнера» API Docker и опции --cpu-shares к docker run. Каждый vCPU эквивалентен 1024 CPU-долям. Для ресурсов EC2 необходимо указать не менее одного vCPU. Это обязательно, но может быть указано в нескольких местах; оно должно быть указано для каждого узла по меньшей мере один раз.

По умолчанию для квоты ресурсов Fargate On-Demand vCPU установлено значение 6 vCPU. Для получения дополнительной информации о квотах Fargate см. Квоты Fargate в Общей справке Amazon Web Services.

Для заданий, выполняемых на ресурсах Fargate, value должно соответствовать одному из поддерживаемых значений, а значения MEMORY должны быть одним из значений, поддерживаемых для этого значения VCPU. Поддерживаемые значения составляют 0.25, 0.5, 1, 2, 4, 8 и 16

value = 0.25

MEMORY = 512, 1024 или 2048

value = 0.5

MEMORY = 1024, 2048, 3072 или 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168 или 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360 или 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696 или 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344 или 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688 или 122880

DependsOn -> (список)

Список зависимостей задания. Задание может зависеть от максимум 20 заданий. Вы можете указать зависимость типа SEQUENTIAL без указания идентификатора задания для заданий массивов, чтобы каждое дочернее задание массива завершалось последовательно, начиная с индекса 0. Вы также можете указать зависимость типа N_TO_N с идентификатором задания для заданий массивов. В этом случае каждое дочернее задание с индексом этого задания должно дождаться завершения соответствующего дочернего задания с индексом каждой зависимости, прежде чем оно сможет начаться.

(структура)

Объект, представляющий зависимость задания Batch.

JobId -> (строка)

Идентификатор задания Batch, связанный с этой зависимостью.

Type -> (строка)

Тип зависимости задания.

Parameters -> (карта)

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

key -> (строка)

value -> (строка)

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

Параметры для использования потока Amazon SQS в качестве целевого объекта.

MessageGroupId -> (строка)

Идентификатор группы сообщений FIFO, который следует использовать в качестве целевого объекта.

MessageDeduplicationId -> (строка)

Этот параметр применим только к очередям FIFO (первый вошел — первый вышел).

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

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

Это пользовательские параметры, которые должны использоваться, когда целевой объект — это API Gateway REST API или EventBridge ApiDestinations.

PathParameterValues -> (список)

Значения параметров пути, которые следует использовать для заполнения шаблонов путей API Gateway REST API или EventBridge ApiDestination («*»).

(строка)

HeaderParameters -> (карта)

Заголовки, которые должны быть отправлены в рамках запроса для вызова API Gateway REST API или EventBridge ApiDestination.

key -> (строка)

value -> (строка)

QueryStringParameters -> (карта)

Ключи/значения строки запроса, которые необходимо отправить в рамках запроса для вызова API Gateway REST API или EventBridge ApiDestination.

key -> (строка)

value -> (строка)

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

Это пользовательские параметры, которые следует использовать, когда целевой объект — кластер Amazon Redshift, для вызова Amazon Redshift Data API BatchExecuteStatement.

SecretManagerArn -> (строка)

Имя или ARN секрета, обеспечивающего доступ к базе данных. Требуется при аутентификации с помощью Secrets Manager.

Database -> (строка)

Имя базы данных. Требуется при аутентификации с использованием временных учетных данных.

DbUser -> (строка)

Имя пользователя базы данных. Требуется при аутентификации с использованием временных учетных данных.

StatementName -> (строка)

Имя SQL-запроса. Вы можете присвоить имя SQL-запросу при его создании, чтобы идентифицировать запрос.

WithEvent -> (булево)

Указывает, следует ли отправлять событие обратно в EventBridge после выполнения SQL-запроса.

Sqls -> (список)

Текст SQL-запроса для выполнения.

(строка)

// Один единственный SQL-запрос для Redshift

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

Параметры для использования SageMaker-пайплайна в качестве целевого объекта.

PipelineParameterList -> (список)

Список имён и значений параметров для запуска пайплайна построения моделей SageMaker.

(структура)

Пара-значение для запуска пайплайна построения моделей SageMaker.

Name -> (строка)

Имя параметра для запуска пайплайна построения моделей SageMaker.

Value -> (строка)

Значение параметра для запуска пайплайна построения моделей SageMaker.

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

Параметры для использования EventBridge-шины событий в качестве целевого объекта.

EndpointId -> (строка)

Субдомен URL-адреса конечной точки. Например, если URL-адрес конечной точки — https://abcde.veo.endpoints.event.amazonaws.com, то EndpointId — abcde.veo .

DetailType -> (строка)

Свободный текст, с максимальной длиной 128 символов, используемый для определения ожидаемых полей в деталях события.

Source -> (строка)

Источник события.

Resources -> (список)

Ресурсы Amazon Web Services, идентифицированные с помощью Amazon Resource Name (ARN), которые в основном связаны с событием. Может присутствовать любое количество, в том числе ноль.

(строка)

Time -> (строка)

Отметка времени события, согласно RFC3339. Если отметка времени не указана, используется отметка времени вызова PutEvents.

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

Параметры для использования потока журнала CloudWatch Logs в качестве целевого объекта.

LogStreamName -> (строка)

Имя потока журнала.

Timestamp -> (строка)

Время наступления события, выраженное в миллисекундах после 00:00:00 1 января 1970 года по UTC.

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

Параметры для использования Timestream для таблицы LiveAnalytics в качестве целевого объекта.

TimeValue -> (строка)

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

EpochTimeUnit -> (строка)

Точность единиц времени. По умолчанию — MILLISECONDS .

Требуется, если TimeFieldType задано как EPOCH .

TimeFieldType -> (строка)

Тип значения времени.

По умолчанию — EPOCH .

TimestampFormat -> (строка)

Формат времени. Например, yyyy-MM-dd'T'HH:mm:ss'Z' .

Требуется, если TimeFieldType задано как TIMESTAMP_FORMAT .

VersionValue -> (строка)

64-битное значение версии или поле исходных данных, представляющее значение версии для ваших данных.

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

Значение по умолчанию — 1.

Timestream for LiveAnalytics не поддерживает обновление частичных значений измерений в записи.

Запросы на запись для дублируемых данных с более высоким номером версии обновят существующее значение измерения и версию. В случае, если значение измерения такое же, Version все равно будет обновлена. Значение по умолчанию — 1 .

Примечание

Version должно быть 1 или больше, иначе вы получите ошибку ValidationException.

DimensionMappings -> (список)

Сопоставление исходных данных с измерениями в целевой таблице Timestream for LiveAnalytics.

Для получения дополнительной информации см. концепции Amazon Timestream for LiveAnalytics

(структура)

Сопоставление исходных данных с измерением в целевой таблице Timestream for LiveAnalytics.

Для получения дополнительной информации см. концепции Amazon Timestream for LiveAnalytics

DimensionValue -> (строка)

Динамический путь к значению измерения в исходном событии.

DimensionValueType -> (строка)

Тип данных измерения для временных данных.

DimensionName -> (строка)

Метаданные атрибутов временного ряда. Например, имя и зона доступности экземпляра Amazon EC2 или имя производителя ветряной турбины являются измерениями.

SingleMeasureMappings -> (список)

Сопоставления отдельных полей исходных данных с отдельными записями в указанной таблице Timestream for LiveAnalytics.

(структура)

Сопоставление одного поля исходных данных с одной записью в указанной таблице Timestream for LiveAnalytics.

Для получения дополнительной информации см. концепции Amazon Timestream for LiveAnalytics

MeasureValue -> (строка)

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

MeasureValueType -> (строка)

Тип данных исходного поля.

MeasureName -> (строка)

Имя целевого измерения для атрибута измерения в таблице Timestream.

MultiMeasureMappings -> (список)

Сопоставления нескольких измерений из исходного события с одной записью в указанной таблице Timestream for LiveAnalytics.

(структура)

Сопоставление нескольких измерений из исходного события с одной записью в указанной таблице Timestream for LiveAnalytics.

Для получения дополнительной информации см. концепции Amazon Timestream for LiveAnalytics

MultiMeasureName -> (строка)

Имя нескольких измерений на запись (многомерное измерение).

MultiMeasureAttributeMappings -> (список)

Сопоставления, представляющие несколько полей исходного события, сопоставленных с измерениями в одной записи Timestream for LiveAnalytics.

(структура)

Сопоставление поля исходного события с измерением в записи Timestream for LiveAnalytics.

MeasureValue -> (строка)

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

MeasureValueType -> (строка)

Тип данных атрибута измерения в исходном событии.

MultiMeasureAttributeName -> (строка)

Используемое целевое имя измерения.

Синтаксис JSON:

{
  "InputTemplate": "string",
  "LambdaFunctionParameters": {
    "InvocationType": "REQUEST_RESPONSE"|"FIRE_AND_FORGET"
  },
  "StepFunctionStateMachineParameters": {
    "InvocationType": "REQUEST_RESPONSE"|"FIRE_AND_FORGET"
  },
  "KinesisStreamParameters": {
    "PartitionKey": "string"
  },
  "EcsTaskParameters": {
    "TaskDefinitionArn": "string",
    "TaskCount": integer,
    "LaunchType": "EC2"|"FARGATE"|"EXTERNAL",
    "NetworkConfiguration": {
      "awsvpcConfiguration": {
        "Subnets": ["string", ...],
        "SecurityGroups": ["string", ...],
        "AssignPublicIp": "ENABLED"|"DISABLED"
      }
    },
    "PlatformVersion": "string",
    "Group": "string",
    "CapacityProviderStrategy": [
      {
        "capacityProvider": "string",
        "weight": integer,
        "base": integer
      }
      ...
    ],
    "EnableECSManagedTags": true|false,
    "EnableExecuteCommand": true|false,
    "PlacementConstraints": [
      {
        "type": "distinctInstance"|"memberOf",
        "expression": "string"
      }
      ...
    ],
    "PlacementStrategy": [
      {
        "type": "random"|"spread"|"binpack",
        "field": "string"
      }
      ...
    ],
    "PropagateTags": "TASK_DEFINITION",
    "ReferenceId": "string",
    "Overrides": {
      "ContainerOverrides": [
        {
          "Command": ["string", ...],
          "Cpu": integer,
          "Environment": [
            {
              "name": "string",
              "value": "string"
            }
            ...
          ],
          "EnvironmentFiles": [
            {
              "type": "s3",
              "value": "string"
            }
            ...
          ],
          "Memory": integer,
          "MemoryReservation": integer,
          "Name": "string",
          "ResourceRequirements": [
            {
              "type": "GPU"|"InferenceAccelerator",
              "value": "string"
            }
            ...
          ]
        }
        ...
      ],
      "Cpu": "string",
      "EphemeralStorage": {
        "sizeInGiB": integer
      },
      "ExecutionRoleArn": "string",
      "InferenceAcceleratorOverrides": [
        {
          "deviceName": "string",
          "deviceType": "string"
        }
        ...
      ],
      "Memory": "string",
      "TaskRoleArn": "string"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  },
  "BatchJobParameters": {
    "JobDefinition": "string",
    "JobName": "string",
    "ArrayProperties": {
      "Size": integer
    },
    "RetryStrategy": {
      "Attempts": integer
    },
    "ContainerOverrides": {
      "Command": ["string", ...],
      "Environment": [
        {
          "Name": "string",
          "Value": "string"
        }
        ...
      ],
      "InstanceType": "string",
      "ResourceRequirements": [
        {
          "Type": "GPU"|"MEMORY"|"VCPU",
          "Value": "string"
        }
        ...
      ]
    },
    "DependsOn": [
      {
        "JobId": "string",
        "Type": "N_TO_N"|"SEQUENTIAL"
      }
      ...
    ],
    "Parameters": {"string": "string"
      ...}
  },
  "SqsQueueParameters": {
    "MessageGroupId": "string",
    "MessageDeduplicationId": "string"
  },
  "HttpParameters": {
    "PathParameterValues": ["string", ...],
    "HeaderParameters": {"string": "string"
      ...},
    "QueryStringParameters": {"string": "string"
      ...}
  },
  "RedshiftDataParameters": {
    "SecretManagerArn": "string",
    "Database": "string",
    "DbUser": "string",
    "StatementName": "string",
    "WithEvent": true|false,
    "Sqls": ["string", ...]
  },
  "SageMakerPipelineParameters": {
    "PipelineParameterList": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ]
  },
  "EventBridgeEventBusParameters": {
    "EndpointId": "string",
    "DetailType": "string",
    "Source": "string",
    "Resources": ["string", ...],
    "Time": "string"
  },
  "CloudWatchLogsParameters": {
    "LogStreamName": "string",
    "Timestamp": "string"
  },
  "TimestreamParameters": {
    "TimeValue": "string",
    "EpochTimeUnit": "MILLISECONDS"|"SECONDS"|"MICROSECONDS"|"NANOSECONDS",
    "TimeFieldType": "EPOCH"|"TIMESTAMP_FORMAT",
    "TimestampFormat": "string",
    "VersionValue": "string",
    "DimensionMappings": [
      {
        "DimensionValue": "string",
        "DimensionValueType": "VARCHAR",
        "DimensionName": "string"
      }
      ...
    ],
    "SingleMeasureMappings": [
      {
        "MeasureValue": "string",
        "MeasureValueType": "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|"TIMESTAMP",
        "MeasureName": "string"
      }
      ...
    ],
    "MultiMeasureMappings": [
      {
        "MultiMeasureName": "string",
        "MultiMeasureAttributeMappings": [
          {
            "MeasureValue": "string",
            "MeasureValueType": "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|"TIMESTAMP",
            "MultiMeasureAttributeName": "string"
          }
          ...
        ]
      }
      ...
    ]
  }
}

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

ARN роли, которая позволяет пайплайну отправлять данные в целевой объект.

--log-configuration (структура)

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

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

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

BucketName -> (строка)

Указывает имя ведра Amazon S3, в которое EventBridge отправляет записи журнала для пайплайна.

BucketOwner -> (строка)

Указывает учётную запись Amazon Web Services, владеющую ведром Amazon S3, в которое EventBridge отправляет записи журнала для пайплайна.

OutputFormat -> (строка)

Как EventBridge должен форматировать записи журнала.

В настоящее время EventBridge поддерживает только форматирование json.

Prefix -> (строка)

Указывает любой префиксный текст, с которого начинаются имена объектов Amazon S3 журнала.

Вы можете использовать префиксы для организации данных, которые вы храните в ведрах Amazon S3. Префикс — это строка символов в начале имени ключа объекта. Длина префикса может быть любой, подчиняясь максимальной длине имени ключа объекта (1024 байта). Дополнительные сведения см. в Руководстве пользователя Amazon Simple Storage Service, раздел Организация объектов с использованием префиксов.

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

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

DeliveryStreamArn -> (строка)

Указывает Amazon Resource Name (ARN) потока доставки Firehose, в который EventBridge отправляет записи журнала пайплайна.

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

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

LogGroupArn -> (строка)

Amazon Web Services Resource Name (ARN) для группы журналов CloudWatch, в которую EventBridge отправляет записи журнала.

Level -> (строка)

Уровень детализации журналов. Это относится ко всем целевым объектам ведения журнала для пайплайна.

Дополнительную информацию см. в Руководстве пользователя Amazon EventBridge, раздел Указание уровня ведения журнала EventBridge Pipes.

IncludeExecutionData -> (список)

Укажите ALL, чтобы включить данные выполнения (в частности, поля payload, awsRequest и awsResponse) в сообщения журнала для этого пайплайна.

Это относится ко всем целевым объектам ведения журнала для пайплайна.

Дополнительную информацию см. в Руководстве пользователя Amazon EventBridge, раздел Включение данных выполнения в журналы. По умолчанию данные выполнения не включаются.

(строка)

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

S3LogDestination={BucketName=string,BucketOwner=string,OutputFormat=string,Prefix=string},FirehoseLogDestination={DeliveryStreamArn=string},CloudwatchLogsLogDestination={LogGroupArn=string},Level=string,IncludeExecutionData=string,string

Синтаксис JSON:

{
  "S3LogDestination": {
    "BucketName": "string",
    "BucketOwner": "string",
    "OutputFormat": "json"|"plain"|"w3c",
    "Prefix": "string"
  },
  "FirehoseLogDestination": {
    "DeliveryStreamArn": "string"
  },
  "CloudwatchLogsLogDestination": {
    "LogGroupArn": "string"
  },
  "Level": "OFF"|"ERROR"|"INFO"|"TRACE",
  "IncludeExecutionData": ["ALL", ...]
}

--kms-key-identifier (строка)

Идентификатор управляемого клиентом ключа KMS для EventBridge, если вы выберете использование управляемого клиентом ключа для шифрования данных пайплайна. Идентификатор может быть именем Amazon Resource Name (ARN), KeyId, псевдонимом ключа или псевдонимом ключа ARN.

Для обновления пайплайна, использующего ключевой объект Amazon Web Services по умолчанию, на использование управляемого клиентом ключа, или обновления пайплайна, использующего управляемый клиентом ключ, на использование другого управляемого клиентом ключа, укажите идентификатор управляемого клиентом ключа.

Для обновления пайплайна, использующего управляемый клиентом ключ, на использование ключевого объекта Amazon Web Services по умолчанию, укажите пустую строку.

Дополнительные сведения см. в Руководстве разработчика Key Management Service, раздел Управление ключами.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладочную регистрацию.

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

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

json
text
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

включить
выключить
автоматически

--no-sign-request (булево)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

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

Отключить пейджер CLI для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для обновления существующей трубы

Следующий update-pipe пример обновляет трубу с именем Demo_Pipe, добавив параметр конфигурации CloudWatch Log, убедитесь, что обновили роль выполнения трубы, чтобы она имела правильные разрешения для назначения журнала.

aws pipes update-pipe \
    --name Demo_Pipe \
    --desired-state RUNNING \
    --log-configuration CloudwatchLogsLogDestination={LogGroupArn=arn:aws:logs:us-east-1:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe},Level=TRACE \
    --role-arn arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f

Вывод:

{
    "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "RUNNING",
    "CurrentState": "UPDATING",
    "CreationTime": "2024-10-08T09:29:10-05:00",
    "LastModifiedTime": "2024-10-08T11:35:48-05:00"
}

Дополнительную информацию см. в разделе Концепции конвейеров Amazon EventBridge в руководстве пользователя Amazon EventBridge.

Вывод

Arn -> (строка)

ARN трубы.

Name -> (строка)

Имя трубы.

DesiredState -> (строка)

Состояние, в котором должна находиться труба.

CurrentState -> (строка)

Текущее состояние трубы.

CreationTime -> (отметка времени)

Время создания трубы.

LastModifiedTime -> (отметка времени)

Время последнего обновления трубы в формате ISO-8601 (ГГГГ-ММ-ДДThч:мм:сс.sTZD).