Spec-Zone.ru › AWS CLI v2

[ aws . pipes ]

создание-трубы

Описание

Создайте трубу. Amazon EventBridge Pipes соединяют источники событий с целевыми объектами и уменьшают необходимость в специализированных знаниях и коде интеграции.

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

Синтаксис

  create-pipe
--name <value>
[--description <value>]
[--desired-state <value>]
--source <value>
[--source-parameters <value>]
[--enrichment <value>]
[--enrichment-parameters <value>]
--target <value>
[--target-parameters <value>]
--role-arn <value>
[--tags <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 (строка)

ARN ресурса-источника.

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

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

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

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

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

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

Filters -> (список)

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

(структура)

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

Pattern -> (строка)

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

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

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

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

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

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

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

Arn -> (строка)

ARN указанной цели для очереди с "письмами-неудачниками".

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

OnPartialBatchItemFailure -> (строка)

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

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

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

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

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

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

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

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

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

StartingPosition -> (строка)

Позиция в потоке, с которой начать чтение.

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

При StartingPosition заданном как AT_TIMESTAMP , время, с которого начать чтение, в секундах времени Unix.

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

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

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

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

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

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

Arn -> (строка)

ARN указанной цели для очереди с "письмами-неудачниками".

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

OnPartialBatchItemFailure -> (строка)

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

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

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

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

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

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

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

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

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

StartingPosition -> (строка)

Позиция в потоке, с которой начать чтение.

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

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

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

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

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

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

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

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

Credentials -> (структура тэгированного союза)

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

Примечание

Это структура тэгированного союза. Только один из следующих верхних ключей может быть задан: BasicAuth.

BasicAuth -> (строка)

ARN секрета Secrets Manager.

QueueName -> (строка)

Имя целевой очереди для потребления.

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

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

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

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

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

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

Credentials -> (структура тэгированного союза)

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

Примечание

Это структура тэгированного союза. Только один из следующих верхних ключей может быть задан: BasicAuth.

BasicAuth -> (строка)

ARN секрета Secrets Manager.

QueueName -> (строка)

Имя целевой очереди для потребления.

VirtualHost -> (строка)

Имя виртуального хоста, связанного с источником брокера.

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

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

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

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

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

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

TopicName -> (строка)

Имя темы, из которой будет читать труба.

StartingPosition -> (строка)

Позиция в потоке, с которой начать чтение.

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

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

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

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

ConsumerGroupID -> (строка)

Имя целевой очереди для потребления.

Credentials -> (структура тэгированного союза)

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

Примечание

Это структура тэгированного союза. Только один из следующих верхних ключей может быть задан: SaslScram512Auth, ClientCertificateTlsAuth.

SaslScram512Auth -> (строка)

ARN секрета Secrets Manager.

ClientCertificateTlsAuth -> (строка)

ARN секрета Secrets Manager.

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

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

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

TopicName -> (строка)

Имя темы, из которой будет читать труба.

StartingPosition -> (строка)

Позиция в потоке, с которой начать чтение.

AdditionalBootstrapServers -> (список)

Массив URL-адресов серверов.

(строка)

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

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

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

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

ConsumerGroupID -> (строка)

Имя целевой очереди для потребления.

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,
    "StartingPosition": "TRIM_HORIZON"|"LATEST"|"AT_TIMESTAMP",
    "StartingPositionTimestamp": timestamp
  },
  "DynamoDBStreamParameters": {
    "BatchSize": integer,
    "DeadLetterConfig": {
      "Arn": "string"
    },
    "OnPartialBatchItemFailure": "AUTOMATIC_BISECT",
    "MaximumBatchingWindowInSeconds": integer,
    "MaximumRecordAgeInSeconds": integer,
    "MaximumRetryAttempts": integer,
    "ParallelizationFactor": integer,
    "StartingPosition": "TRIM_HORIZON"|"LATEST"
  },
  "SqsQueueParameters": {
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer
  },
  "ActiveMQBrokerParameters": {
    "Credentials": {
      "BasicAuth": "string"
    },
    "QueueName": "string",
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer
  },
  "RabbitMQBrokerParameters": {
    "Credentials": {
      "BasicAuth": "string"
    },
    "QueueName": "string",
    "VirtualHost": "string",
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer
  },
  "ManagedStreamingKafkaParameters": {
    "TopicName": "string",
    "StartingPosition": "TRIM_HORIZON"|"LATEST",
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer,
    "ConsumerGroupID": "string",
    "Credentials": {
      "SaslScram512Auth": "string",
      "ClientCertificateTlsAuth": "string"
    }
  },
  "SelfManagedKafkaParameters": {
    "TopicName": "string",
    "StartingPosition": "TRIM_HORIZON"|"LATEST",
    "AdditionalBootstrapServers": ["string", ...],
    "BatchSize": integer,
    "MaximumBatchingWindowInSeconds": integer,
    "ConsumerGroupID": "string",
    "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 шлюзе REST или EventBridge ApiDestination.

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

PathParameterValues -> (список)

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

(строка)

HeaderParameters -> (карта)

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

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

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

QueryStringParameters -> (карта)

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

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

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

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

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, переданный целевому объекту. В данном случае ничего из события не передаётся целевому объекту. Дополнительную информацию см. в разделе Формат обмена данными с использованием JSON.

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

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

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

InvocationType -> (строка)

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

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

Дополнительную информацию см. в разделе Типы вызовов в руководстве пользователя 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 -> (строка)

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

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-изображения или определения задачи. Также необходимо указать имя контейнера.

(структура)

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

name -> (строка)

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

value -> (строка)

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

EnvironmentFiles -> (список)

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

(структура)

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

Если переменные среды указаны с помощью параметра environment в определении контейнера, они имеют приоритет над переменными, содержащимися в файле среды. Если несколько файлов среды содержат одну и ту же переменную, они обрабатываются сверху вниз. Рекомендуется использовать уникальные имена переменных. Дополнительную информацию см. в разделе Specifying environment variables в Руководстве разработчика 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. Дополнительную информацию см. в разделах Работа с GPU в Amazon ECS и Работа с Amazon Elastic Inference в Amazon ECS в Руководстве разработчика Amazon Elastic Container Service.

type -> (строка)

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

value -> (строка)

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

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

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

Cpu -> (строка)

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

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

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

Примечание

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

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

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

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

ExecutionRoleArn -> (строка)

Amazon Resource Name (ARN) переопределяемой IAM-роли выполнения задачи для задачи. Дополнительную информацию см. в разделе Amazon ECS task execution IAM role в Руководстве разработчика 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 Role for Tasks в Руководстве разработчика 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.

(структура)

Переменные среды, отправляемые контейнеру. Вы можете добавлять новые переменные среды, которые добавляются в контейнер при запуске, или переопределять существующие переменные среды из 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 в разделе «Создание контейнера» в Docker Remote API и параметру --memory команды docker run. Вы должны указать как минимум 4 МБ памяти для задания. Это обязательно, но может быть указано в нескольких местах для многоузловых параллельных (MNP) заданий. Оно должно быть указано для каждого узла как минимум один раз. Этот параметр соответствует Memory в разделе «Создание контейнера» в Docker Remote API и параметру --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 в разделе «Создание контейнера» в Docker Remote API и параметру --cpu-shares команды docker run. Каждое vCPU эквивалентно 1024 долям процессора. Для ресурсов EC2 вы должны указать как минимум одно vCPU. Это обязательно, но может быть указано в нескольких местах; оно должно быть указано для каждого узла как минимум один раз.

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

Для заданий, выполняющихся на ресурсах 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 ApiDestination.

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, для вызова API Amazon Redshift Data API BatchExecuteStatement.

SecretManagerArn -> (строка)

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

Database -> (строка)

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

DbUser -> (строка)

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

StatementName -> (строка)

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

WithEvent -> (булево)

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

Sqls -> (список)

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

(строка)

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

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

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

PipelineParameterList -> (список)

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

(структура)

Пара имя/значение для запуска SageMaker Model Building Pipeline.

Name -> (строка)

Имя параметра для запуска SageMaker Model Building Pipeline.

Value -> (строка)

Значение параметра для запуска SageMaker Model Building Pipeline.

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

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

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 for 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 роли, которая позволяет конвейеру отправлять данные в целевой объект.

--tags (массив)

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

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

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

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

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

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

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

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 псевдонима ключа.

Если вы не укажете идентификатор управляемого пользователем ключа, EventBridge будет использовать управляемый 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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (логическое значение)

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

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

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

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

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

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

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

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

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

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Создание канала

Следующий create-pipe пример создаёт канал с именем Demo_Pipe, используя SQS в качестве источника и группу журналов CloudWatch в качестве целевого назначения для канала.

aws pipes create-pipe \
    --name Demo_Pipe \
    --desired-state RUNNING \
    --role-arn arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f \
    --source arn:aws:sqs:us-east-1:123456789012:Demo_Queue \
    --target arn:aws:logs:us-east-1:123456789012:log-group:/aws/pipes/Demo_LogGroup

Вывод:

{
    "Arn": "arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "RUNNING",
    "CurrentState": "CREATING",
    "CreationTime": "2024-10-08T12:33:59-05:00",
    "LastModifiedTime": "2024-10-08T12:33:59.684839-05:00"
}

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

Вывод

Arn -> (строка)

ARN канала.

Name -> (строка)

Имя канала.

DesiredState -> (строка)

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

CurrentState -> (строка)

Текущее состояние канала.

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

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

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

Время последнего обновления канала в формате ISO-8601 (YYYY-MM-DDThh:mm:ss.sTZD).

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

Spec-Zone.ru

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