List<E> subnets
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
List<E> securityGroups
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
String assignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED only when LaunchType in EcsParameters is set to
FARGATE.
Integer size
The size of the array, if this is an array batch job.
List<E> command
The command to send to the container that overrides the default command from the Docker image or the task definition.
List<E> environment
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.
Environment variables cannot start with "Batch". This naming convention is reserved for variables
that Batch sets.
String instanceType
The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
List<E> resourceRequirements
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The
supported resources include GPU, MEMORY, and VCPU.
String type
The type of resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.
String value
The quantity of the specified resource to reserve for the container. The values vary based on the
type specified.
The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs aren't available for jobs that are running on Fargate resources.
The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on
EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This
parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory
for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be
specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must
match one of the supported values and the VCPU values must be one of the values supported for that
memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, 4, or 8
VCPU = 2 or 4
VCPU = 2, 4, or 8
VCPU = 4
VCPU = 4 or 8
VCPU = 8
VCPU = 8 or 16
VCPU = 16
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option
to docker run. Each vCPU is equivalent to 1,024 CPU
shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several
places; it must be specified for each node at least once.
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.
For jobs that are running on Fargate resources, then value must match one of the supported values
and the MEMORY values must be one of the values supported for that VCPU value. The
supported values are 0.25, 0.5, 1, 2, 4, 8, and 16
MEMORY = 512, 1024, or 2048
MEMORY = 1024, 2048, 3072, or 4096
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480,
21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440
MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
Integer attempts
The number of times to move a job to the RUNNABLE status. If the value of attempts is
greater than one, the job is retried on failure the same number of attempts as the value.
String capacityProvider
The short name of the capacity provider.
Integer weight
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
Integer base
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
String logGroupArn
The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
String logGroupArn
The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
String name
The name of the pipe.
String description
A description of the pipe.
String desiredState
The state the pipe should be in.
String source
The ARN of the source resource.
PipeSourceParameters sourceParameters
The parameters required to set up a source for your pipe.
String enrichment
The ARN of the enrichment resource.
PipeEnrichmentParameters enrichmentParameters
The parameters required to set up enrichment on your pipe.
String target
The ARN of the target resource.
PipeTargetParameters targetParameters
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
String roleArn
The ARN of the role that allows the pipe to send data to the target.
Map<K,V> tags
The list of key-value pairs to associate with the pipe.
PipeLogConfigurationParameters logConfiguration
The logging configuration settings for the pipe.
String arn
The ARN of the pipe.
String name
The name of the pipe.
String desiredState
The state the pipe should be in.
String currentState
The state the pipe is in.
Date creationTime
The time the pipe was created.
Date lastModifiedTime
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String arn
The ARN of the specified target for the dead-letter queue.
For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.
String name
The name of the pipe.
String arn
The ARN of the pipe.
String name
The name of the pipe.
String desiredState
The state the pipe should be in.
String currentState
The state the pipe is in.
Date creationTime
The time the pipe was created.
Date lastModifiedTime
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String name
The name of the pipe.
String arn
The ARN of the pipe.
String name
The name of the pipe.
String description
A description of the pipe.
String desiredState
The state the pipe should be in.
String currentState
The state the pipe is in.
String stateReason
The reason the pipe is in its current state.
String source
The ARN of the source resource.
PipeSourceParameters sourceParameters
The parameters required to set up a source for your pipe.
String enrichment
The ARN of the enrichment resource.
PipeEnrichmentParameters enrichmentParameters
The parameters required to set up enrichment on your pipe.
String target
The ARN of the target resource.
PipeTargetParameters targetParameters
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
String roleArn
The ARN of the role that allows the pipe to send data to the target.
Map<K,V> tags
The list of key-value pairs to associate with the pipe.
Date creationTime
The time the pipe was created.
Date lastModifiedTime
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
PipeLogConfiguration logConfiguration
The logging configuration settings for the pipe.
String dimensionValue
Dynamic path to the dimension value in the source event.
String dimensionValueType
The data type of the dimension for the time-series data.
String dimensionName
The metadata attributes of the time series. For example, the name and Availability Zone of an Amazon EC2 instance or the name of the manufacturer of a wind turbine are dimensions.
List<E> command
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
Integer cpu
The number of cpu units reserved for the container, instead of the default value from the task
definition. You must also specify a container name.
List<E> environment
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
List<E> environmentFiles
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
Integer memory
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
Integer memoryReservation
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
String name
The name of the container that receives the override. This parameter is required if any override is specified.
List<E> resourceRequirements
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
Integer sizeInGiB
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
21 GiB and the maximum supported value is 200 GiB.
String type
The type of resource to assign to a container. The supported values are GPU or
InferenceAccelerator.
String value
The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs the Amazon ECS
container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't
exceed the number of available GPUs on the container instance that the task is launched on.
If the InferenceAccelerator type is used, the value matches the deviceName
for an InferenceAccelerator specified in a task definition.
List<E> containerOverrides
One or more container overrides that are sent to a task.
String cpu
The cpu override for the task.
EcsEphemeralStorage ephemeralStorage
The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
String executionRoleArn
The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
List<E> inferenceAcceleratorOverrides
The Elastic Inference accelerator override for the task.
String memory
The memory override for the task.
String taskRoleArn
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.
String pattern
The event pattern.
String deliveryStreamArn
The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
String deliveryStreamArn
Specifies the Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
Integer retryAfterSeconds
The number of seconds to wait before retrying the action that caused the exception.
String namePrefix
A value that will return a subset of the pipes associated with this account. For example,
"NamePrefix": "ABC" will return all endpoints with "ABC" in the name.
String desiredState
The state the pipe should be in.
String currentState
The state the pipe is in.
String sourcePrefix
The prefix matching the pipe source.
String targetPrefix
The prefix matching the pipe target.
String nextToken
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
Integer limit
The maximum number of pipes to include in the response.
List<E> pipes
The pipes returned by the call.
String nextToken
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
String resourceArn
The ARN of the pipe for which you want to view tags.
String basicAuth
The ARN of the Secrets Manager secret.
AwsVpcConfiguration awsvpcConfiguration
Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address
is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
String name
The name of the pipe.
String arn
The ARN of the pipe.
String desiredState
The state the pipe should be in.
String currentState
The state the pipe is in.
String stateReason
The reason the pipe is in its current state.
Date creationTime
The time the pipe was created.
Date lastModifiedTime
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String source
The ARN of the source resource.
String target
The ARN of the target resource.
String enrichment
The ARN of the enrichment resource.
List<E> pathParameterValues
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
Map<K,V> headerParameters
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Map<K,V> queryStringParameters
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
String inputTemplate
Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
To remove an input template, specify an empty string.
PipeEnrichmentHttpParameters httpParameters
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
S3LogDestination s3LogDestination
The Amazon S3 logging configuration settings for the pipe.
FirehoseLogDestination firehoseLogDestination
The Amazon Data Firehose logging configuration settings for the pipe.
CloudwatchLogsLogDestination cloudwatchLogsLogDestination
The Amazon CloudWatch Logs logging configuration settings for the pipe.
String level
The level of logging detail to include. This applies to all log destinations for the pipe.
List<E> includeExecutionData
Whether the execution data (specifically, the payload, awsRequest, and
awsResponse fields) is included in the log messages for this pipe.
This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide.
S3LogDestinationParameters s3LogDestination
The Amazon S3 logging configuration settings for the pipe.
FirehoseLogDestinationParameters firehoseLogDestination
The Amazon Data Firehose logging configuration settings for the pipe.
CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination
The Amazon CloudWatch Logs logging configuration settings for the pipe.
String level
The level of logging detail to include. This applies to all log destinations for the pipe.
For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.
List<E> includeExecutionData
Specify ALL to include the execution data (specifically, the payload,
awsRequest, and awsResponse fields) in the log messages for this pipe.
This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide.
By default, execution data is not included.
MQBrokerAccessCredentials credentials
The credentials needed to access the resource.
String queueName
The name of the destination queue to consume.
Integer batchSize
The maximum number of records to include in each batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
Integer batchSize
The maximum number of records to include in each batch.
DeadLetterConfig deadLetterConfig
Define the target queue to send dead-letter queue events to.
String onPartialBatchItemFailure
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and
retry each half until all the records are processed or there is one failed message left in the batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
String startingPosition
(Streams only) The position in a stream from which to start reading.
Integer batchSize
The maximum number of records to include in each batch.
DeadLetterConfig deadLetterConfig
Define the target queue to send dead-letter queue events to.
String onPartialBatchItemFailure
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and
retry each half until all the records are processed or there is one failed message left in the batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
String startingPosition
(Streams only) The position in a stream from which to start reading.
Date startingPositionTimestamp
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in
Unix time seconds.
String topicName
The name of the topic that the pipe will read from.
String startingPosition
(Streams only) The position in a stream from which to start reading.
Integer batchSize
The maximum number of records to include in each batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
String consumerGroupID
The name of the destination queue to consume.
MSKAccessCredentials credentials
The credentials needed to access the resource.
FilterCriteria filterCriteria
The collection of event patterns used to filter events.
To remove a filter, specify a FilterCriteria object with an empty array of Filter
objects.
For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
PipeSourceKinesisStreamParameters kinesisStreamParameters
The parameters for using a Kinesis stream as a source.
PipeSourceDynamoDBStreamParameters dynamoDBStreamParameters
The parameters for using a DynamoDB stream as a source.
PipeSourceSqsQueueParameters sqsQueueParameters
The parameters for using a Amazon SQS stream as a source.
PipeSourceActiveMQBrokerParameters activeMQBrokerParameters
The parameters for using an Active MQ broker as a source.
PipeSourceRabbitMQBrokerParameters rabbitMQBrokerParameters
The parameters for using a Rabbit MQ broker as a source.
PipeSourceManagedStreamingKafkaParameters managedStreamingKafkaParameters
The parameters for using an MSK stream as a source.
PipeSourceSelfManagedKafkaParameters selfManagedKafkaParameters
The parameters for using a self-managed Apache Kafka stream as a source.
A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.
MQBrokerAccessCredentials credentials
The credentials needed to access the resource.
String queueName
The name of the destination queue to consume.
String virtualHost
The name of the virtual host associated with the source broker.
Integer batchSize
The maximum number of records to include in each batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
String topicName
The name of the topic that the pipe will read from.
String startingPosition
(Streams only) The position in a stream from which to start reading.
List<E> additionalBootstrapServers
An array of server URLs.
Integer batchSize
The maximum number of records to include in each batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
String consumerGroupID
The name of the destination queue to consume.
SelfManagedKafkaAccessConfigurationCredentials credentials
The credentials needed to access the resource.
String serverRootCaCertificate
The ARN of the Secrets Manager secret used for certification.
SelfManagedKafkaAccessConfigurationVpc vpc
This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
String jobDefinition
The job definition used by this job. This value can be one of name, name:revision, or
the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest
active revision is used.
String jobName
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
BatchArrayProperties arrayProperties
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
BatchRetryStrategy retryStrategy
The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
BatchContainerOverrides containerOverrides
The overrides that are sent to a container.
List<E> dependsOn
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job
completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a
job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of
each dependency to complete before it can begin.
Map<K,V> parameters
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
String taskDefinitionArn
The ARN of the task definition to use if the event target is an Amazon ECS task.
Integer taskCount
The number of tasks to create based on TaskDefinition. The default is 1.
String launchType
Specifies the launch type on which your task is running. The launch type that you specify here must match one of
the launch type (compatibilities) of the target task. The FARGATE value is supported only in the
Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in
the Amazon Elastic Container Service Developer Guide.
NetworkConfiguration networkConfiguration
Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the
VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This
structure is required if LaunchType is FARGATE because the awsvpc mode is
required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc
network mode, the task fails.
String platformVersion
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0.
This structure is used only if LaunchType is FARGATE. For more information about valid
platform versions, see Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
String group
Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.
List<E> capacityProviderStrategy
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted.
If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used.
Boolean enableECSManagedTags
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Boolean enableExecuteCommand
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
List<E> placementConstraints
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
List<E> placementStrategy
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
String propagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags
are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after
task creation, use the TagResource API action.
String referenceId
The reference ID to use for the task.
EcsTaskOverride overrides
The overrides that are associated with a task.
List<E> tags
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
String endpointId
The URL subdomain of the endpoint. For example, if the URL for Endpoint is
https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
String detailType
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
String source
The source of the event.
List<E> resources
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
String time
List<E> pathParameterValues
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
Map<K,V> headerParameters
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Map<K,V> queryStringParameters
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
String partitionKey
Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
String invocationType
Specify whether to invoke the function synchronously or asynchronously.
REQUEST_RESPONSE (default) - Invoke synchronously. This corresponds to the
RequestResponse option in the InvocationType parameter for the Lambda Invoke API.
FIRE_AND_FORGET - Invoke asynchronously. This corresponds to the Event option in the
InvocationType parameter for the Lambda Invoke API.
For more information, see Invocation types in the Amazon EventBridge User Guide.
String inputTemplate
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
To remove an input template, specify an empty string.
PipeTargetLambdaFunctionParameters lambdaFunctionParameters
The parameters for using a Lambda function as a target.
PipeTargetStateMachineParameters stepFunctionStateMachineParameters
The parameters for using a Step Functions state machine as a target.
PipeTargetKinesisStreamParameters kinesisStreamParameters
The parameters for using a Kinesis stream as a target.
PipeTargetEcsTaskParameters ecsTaskParameters
The parameters for using an Amazon ECS task as a target.
PipeTargetBatchJobParameters batchJobParameters
The parameters for using an Batch job as a target.
PipeTargetSqsQueueParameters sqsQueueParameters
The parameters for using a Amazon SQS stream as a target.
PipeTargetHttpParameters httpParameters
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
PipeTargetRedshiftDataParameters redshiftDataParameters
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters
The parameters for using a SageMaker pipeline as a target.
PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters
The parameters for using an EventBridge event bus as a target.
PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters
The parameters for using an CloudWatch Logs log stream as a target.
PipeTargetTimestreamParameters timestreamParameters
The parameters for using a Timestream for LiveAnalytics table as a target.
String secretManagerArn
The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.
String database
The name of the database. Required when authenticating using temporary credentials.
String dbUser
The database user name. Required when authenticating using temporary credentials.
String statementName
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
Boolean withEvent
Indicates whether to send an event back to EventBridge after the SQL statement runs.
List<E> sqls
The SQL statement text to run.
String invocationType
Specify whether to invoke the Step Functions state machine synchronously or asynchronously.
REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.
REQUEST_RESPONSE is not supported for STANDARD state machine workflows.
FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution
in the Step Functions API Reference.
For more information, see Invocation types in the Amazon EventBridge User Guide.
String timeValue
Dynamic path to the source data field that represents the time value for your data.
String epochTimeUnit
The granularity of the time units used. Default is MILLISECONDS.
Required if TimeFieldType is specified as EPOCH.
String timeFieldType
The type of time value used.
The default is EPOCH.
String timestampFormat
How to format the timestamps. For example, YYYY-MM-DDThh:mm:ss.sssTZD.
Required if TimeFieldType is specified as TIMESTAMP_FORMAT.
String versionValue
64 bit version value or source data field that represents the version value for your data.
Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.
Default value is 1.
Timestream for LiveAnalytics does not support updating partial measure values in a record.
Write requests for duplicate data with a higher version number will update the existing measure value and
version. In cases where the measure value is the same, Version will still be updated. Default value
is 1.
Version must be 1 or greater, or you will receive a ValidationException
error.
List<E> dimensionMappings
Map source data to dimensions in the target Timestream for LiveAnalytics table.
For more information, see Amazon Timestream for LiveAnalytics concepts
List<E> singleMeasureMappings
Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
List<E> multiMeasureMappings
Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
String type
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
String expression
A cluster query language expression to apply to the constraint. You cannot specify an expression if the
constraint type is distinctInstance. To learn more, see Cluster Query
Language in the Amazon Elastic Container Service Developer Guide.
String type
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
String field
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
String bucketName
The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
String prefix
The prefix text with which to begin Amazon S3 log object names.
For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
String bucketOwner
The Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
String outputFormat
The format EventBridge uses for the log records.
json: JSON
plain: Plain text
String bucketName
Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
String bucketOwner
Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
String outputFormat
How EventBridge should format the log records.
json: JSON
plain: Plain text
String prefix
Specifies any prefix text with which to begin Amazon S3 log object names.
You can use prefixes to organize the data that you store in Amazon S3 buckets. A prefix is a string of characters at the beginning of the object key name. A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
String basicAuth
The ARN of the Secrets Manager secret.
String saslScram512Auth
The ARN of the Secrets Manager secret.
String saslScram256Auth
The ARN of the Secrets Manager secret.
String clientCertificateTlsAuth
The ARN of the Secrets Manager secret.
List<E> subnets
Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
List<E> securityGroup
Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
String resourceId
The ID of the resource that caused the exception.
String resourceType
The type of resource that caused the exception.
String serviceCode
The identifier of the service that caused the exception.
String quotaCode
The identifier of the quota that caused the exception.
String name
The name of the pipe.
String arn
The ARN of the pipe.
String name
The name of the pipe.
String desiredState
The state the pipe should be in.
String currentState
The state the pipe is in.
Date creationTime
The time the pipe was created.
Date lastModifiedTime
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String name
The name of the pipe.
String arn
The ARN of the pipe.
String name
The name of the pipe.
String desiredState
The state the pipe should be in.
String currentState
The state the pipe is in.
Date creationTime
The time the pipe was created.
Date lastModifiedTime
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String name
The name of the pipe.
String description
A description of the pipe.
String desiredState
The state the pipe should be in.
UpdatePipeSourceParameters sourceParameters
The parameters required to set up a source for your pipe.
String enrichment
The ARN of the enrichment resource.
PipeEnrichmentParameters enrichmentParameters
The parameters required to set up enrichment on your pipe.
String target
The ARN of the target resource.
PipeTargetParameters targetParameters
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
String roleArn
The ARN of the role that allows the pipe to send data to the target.
PipeLogConfigurationParameters logConfiguration
The logging configuration settings for the pipe.
String arn
The ARN of the pipe.
String name
The name of the pipe.
String desiredState
The state the pipe should be in.
String currentState
The state the pipe is in.
Date creationTime
The time the pipe was created.
Date lastModifiedTime
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
MQBrokerAccessCredentials credentials
The credentials needed to access the resource.
Integer batchSize
The maximum number of records to include in each batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
Integer batchSize
The maximum number of records to include in each batch.
DeadLetterConfig deadLetterConfig
Define the target queue to send dead-letter queue events to.
String onPartialBatchItemFailure
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and
retry each half until all the records are processed or there is one failed message left in the batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
Integer batchSize
The maximum number of records to include in each batch.
DeadLetterConfig deadLetterConfig
Define the target queue to send dead-letter queue events to.
String onPartialBatchItemFailure
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and
retry each half until all the records are processed or there is one failed message left in the batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
Integer maximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
Integer maximumRetryAttempts
(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
Integer parallelizationFactor
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
Integer batchSize
The maximum number of records to include in each batch.
MSKAccessCredentials credentials
The credentials needed to access the resource.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
FilterCriteria filterCriteria
The collection of event patterns used to filter events.
To remove a filter, specify a FilterCriteria object with an empty array of Filter
objects.
For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
UpdatePipeSourceKinesisStreamParameters kinesisStreamParameters
The parameters for using a Kinesis stream as a source.
UpdatePipeSourceDynamoDBStreamParameters dynamoDBStreamParameters
The parameters for using a DynamoDB stream as a source.
UpdatePipeSourceSqsQueueParameters sqsQueueParameters
The parameters for using a Amazon SQS stream as a source.
UpdatePipeSourceActiveMQBrokerParameters activeMQBrokerParameters
The parameters for using an Active MQ broker as a source.
UpdatePipeSourceRabbitMQBrokerParameters rabbitMQBrokerParameters
The parameters for using a Rabbit MQ broker as a source.
UpdatePipeSourceManagedStreamingKafkaParameters managedStreamingKafkaParameters
The parameters for using an MSK stream as a source.
UpdatePipeSourceSelfManagedKafkaParameters selfManagedKafkaParameters
The parameters for using a self-managed Apache Kafka stream as a source.
A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.
MQBrokerAccessCredentials credentials
The credentials needed to access the resource.
Integer batchSize
The maximum number of records to include in each batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
Integer batchSize
The maximum number of records to include in each batch.
Integer maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
SelfManagedKafkaAccessConfigurationCredentials credentials
The credentials needed to access the resource.
String serverRootCaCertificate
The ARN of the Secrets Manager secret used for certification.
SelfManagedKafkaAccessConfigurationVpc vpc
This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
Copyright © 2025. All rights reserved.