aws-sdk-pipes 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,3051 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Pipes
11
+ module Types
12
+
13
+ # This structure specifies the VPC subnets and security groups for the
14
+ # task, and whether a public IP address is to be used. This structure is
15
+ # relevant only for ECS tasks that use the `awsvpc` network mode.
16
+ #
17
+ # @!attribute [rw] assign_public_ip
18
+ # Specifies whether the task's elastic network interface receives a
19
+ # public IP address. You can specify `ENABLED` only when `LaunchType`
20
+ # in `EcsParameters` is set to `FARGATE`.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] security_groups
24
+ # Specifies the security groups associated with the task. These
25
+ # security groups must all be in the same VPC. You can specify as many
26
+ # as five security groups. If you do not specify a security group, the
27
+ # default security group for the VPC is used.
28
+ # @return [Array<String>]
29
+ #
30
+ # @!attribute [rw] subnets
31
+ # Specifies the subnets associated with the task. These subnets must
32
+ # all be in the same VPC. You can specify as many as 16 subnets.
33
+ # @return [Array<String>]
34
+ #
35
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/AwsVpcConfiguration AWS API Documentation
36
+ #
37
+ class AwsVpcConfiguration < Struct.new(
38
+ :assign_public_ip,
39
+ :security_groups,
40
+ :subnets)
41
+ SENSITIVE = []
42
+ include Aws::Structure
43
+ end
44
+
45
+ # The array properties for the submitted job, such as the size of the
46
+ # array. The array size can be between 2 and 10,000. If you specify
47
+ # array properties for a job, it becomes an array job. This parameter is
48
+ # used only if the target is an Batch job.
49
+ #
50
+ # @!attribute [rw] size
51
+ # The size of the array, if this is an array batch job.
52
+ # @return [Integer]
53
+ #
54
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/BatchArrayProperties AWS API Documentation
55
+ #
56
+ class BatchArrayProperties < Struct.new(
57
+ :size)
58
+ SENSITIVE = []
59
+ include Aws::Structure
60
+ end
61
+
62
+ # The overrides that are sent to a container.
63
+ #
64
+ # @!attribute [rw] command
65
+ # The command to send to the container that overrides the default
66
+ # command from the Docker image or the task definition.
67
+ # @return [Array<String>]
68
+ #
69
+ # @!attribute [rw] environment
70
+ # The environment variables to send to the container. You can add new
71
+ # environment variables, which are added to the container at launch,
72
+ # or you can override the existing environment variables from the
73
+ # Docker image or the task definition.
74
+ #
75
+ # <note markdown="1"> Environment variables cannot start with "`Batch`". This naming
76
+ # convention is reserved for variables that Batch sets.
77
+ #
78
+ # </note>
79
+ # @return [Array<Types::BatchEnvironmentVariable>]
80
+ #
81
+ # @!attribute [rw] instance_type
82
+ # The instance type to use for a multi-node parallel job.
83
+ #
84
+ # <note markdown="1"> This parameter isn't applicable to single-node container jobs or
85
+ # jobs that run on Fargate resources, and shouldn't be provided.
86
+ #
87
+ # </note>
88
+ # @return [String]
89
+ #
90
+ # @!attribute [rw] resource_requirements
91
+ # The type and amount of resources to assign to a container. This
92
+ # overrides the settings in the job definition. The supported
93
+ # resources include `GPU`, `MEMORY`, and `VCPU`.
94
+ # @return [Array<Types::BatchResourceRequirement>]
95
+ #
96
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/BatchContainerOverrides AWS API Documentation
97
+ #
98
+ class BatchContainerOverrides < Struct.new(
99
+ :command,
100
+ :environment,
101
+ :instance_type,
102
+ :resource_requirements)
103
+ SENSITIVE = []
104
+ include Aws::Structure
105
+ end
106
+
107
+ # The environment variables to send to the container. You can add new
108
+ # environment variables, which are added to the container at launch, or
109
+ # you can override the existing environment variables from the Docker
110
+ # image or the task definition.
111
+ #
112
+ # <note markdown="1"> Environment variables cannot start with "`Batch`". This naming
113
+ # convention is reserved for variables that Batch sets.
114
+ #
115
+ # </note>
116
+ #
117
+ # @!attribute [rw] name
118
+ # The name of the key-value pair. For environment variables, this is
119
+ # the name of the environment variable.
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] value
123
+ # The value of the key-value pair. For environment variables, this is
124
+ # the value of the environment variable.
125
+ # @return [String]
126
+ #
127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/BatchEnvironmentVariable AWS API Documentation
128
+ #
129
+ class BatchEnvironmentVariable < Struct.new(
130
+ :name,
131
+ :value)
132
+ SENSITIVE = []
133
+ include Aws::Structure
134
+ end
135
+
136
+ # An object that represents an Batch job dependency.
137
+ #
138
+ # @!attribute [rw] job_id
139
+ # The job ID of the Batch job that's associated with this dependency.
140
+ # @return [String]
141
+ #
142
+ # @!attribute [rw] type
143
+ # The type of the job dependency.
144
+ # @return [String]
145
+ #
146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/BatchJobDependency AWS API Documentation
147
+ #
148
+ class BatchJobDependency < Struct.new(
149
+ :job_id,
150
+ :type)
151
+ SENSITIVE = []
152
+ include Aws::Structure
153
+ end
154
+
155
+ # The type and amount of a resource to assign to a container. The
156
+ # supported resources include `GPU`, `MEMORY`, and `VCPU`.
157
+ #
158
+ # @!attribute [rw] type
159
+ # The type of resource to assign to a container. The supported
160
+ # resources include `GPU`, `MEMORY`, and `VCPU`.
161
+ # @return [String]
162
+ #
163
+ # @!attribute [rw] value
164
+ # The quantity of the specified resource to reserve for the container.
165
+ # The values vary based on the `type` specified.
166
+ #
167
+ # type="GPU"
168
+ #
169
+ # : The number of physical GPUs to reserve for the container. Make
170
+ # sure that the number of GPUs reserved for all containers in a job
171
+ # doesn't exceed the number of available GPUs on the compute
172
+ # resource that the job is launched on.
173
+ #
174
+ # <note markdown="1"> GPUs aren't available for jobs that are running on Fargate
175
+ # resources.
176
+ #
177
+ # </note>
178
+ #
179
+ # type="MEMORY"
180
+ #
181
+ # : The memory hard limit (in MiB) present to the container. This
182
+ # parameter is supported for jobs that are running on EC2 resources.
183
+ # If your container attempts to exceed the memory specified, the
184
+ # container is terminated. This parameter maps to `Memory` in the [
185
+ # Create a container][1] section of the [Docker Remote API][2] and
186
+ # the `--memory` option to [docker run][3]. You must specify at
187
+ # least 4 MiB of memory for a job. This is required but can be
188
+ # specified in several places for multi-node parallel (MNP) jobs. It
189
+ # must be specified for each node at least once. This parameter maps
190
+ # to `Memory` in the [ Create a container][1] section of the [Docker
191
+ # Remote API][2] and the `--memory` option to [docker run][3].
192
+ #
193
+ # <note markdown="1"> If you're trying to maximize your resource utilization by
194
+ # providing your jobs as much memory as possible for a particular
195
+ # instance type, see [Memory management][4] in the *Batch User
196
+ # Guide*.
197
+ #
198
+ # </note>
199
+ #
200
+ # For jobs that are running on Fargate resources, then `value` is
201
+ # the hard limit (in MiB), and must match one of the supported
202
+ # values and the `VCPU` values must be one of the values supported
203
+ # for that memory value.
204
+ #
205
+ # value = 512
206
+ #
207
+ # : `VCPU` = 0.25
208
+ #
209
+ # value = 1024
210
+ #
211
+ # : `VCPU` = 0.25 or 0.5
212
+ #
213
+ # value = 2048
214
+ #
215
+ # : `VCPU` = 0.25, 0.5, or 1
216
+ #
217
+ # value = 3072
218
+ #
219
+ # : `VCPU` = 0.5, or 1
220
+ #
221
+ # value = 4096
222
+ #
223
+ # : `VCPU` = 0.5, 1, or 2
224
+ #
225
+ # value = 5120, 6144, or 7168
226
+ #
227
+ # : `VCPU` = 1 or 2
228
+ #
229
+ # value = 8192
230
+ #
231
+ # : `VCPU` = 1, 2, 4, or 8
232
+ #
233
+ # value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360
234
+ #
235
+ # : `VCPU` = 2 or 4
236
+ #
237
+ # value = 16384
238
+ #
239
+ # : `VCPU` = 2, 4, or 8
240
+ #
241
+ # value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720
242
+ #
243
+ # : `VCPU` = 4
244
+ #
245
+ # value = 20480, 24576, or 28672
246
+ #
247
+ # : `VCPU` = 4 or 8
248
+ #
249
+ # value = 36864, 45056, 53248, or 61440
250
+ #
251
+ # : `VCPU` = 8
252
+ #
253
+ # value = 32768, 40960, 49152, or 57344
254
+ #
255
+ # : `VCPU` = 8 or 16
256
+ #
257
+ # value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
258
+ #
259
+ # : `VCPU` = 16
260
+ #
261
+ # type="VCPU"
262
+ #
263
+ # : The number of vCPUs reserved for the container. This parameter
264
+ # maps to `CpuShares` in the [ Create a container][1] section of the
265
+ # [Docker Remote API][2] and the `--cpu-shares` option to [docker
266
+ # run][3]. Each vCPU is equivalent to 1,024 CPU shares. For EC2
267
+ # resources, you must specify at least one vCPU. This is required
268
+ # but can be specified in several places; it must be specified for
269
+ # each node at least once.
270
+ #
271
+ # The default for the Fargate On-Demand vCPU resource count quota is
272
+ # 6 vCPUs. For more information about Fargate quotas, see [Fargate
273
+ # quotas][5] in the *Amazon Web Services General Reference*.
274
+ #
275
+ # For jobs that are running on Fargate resources, then `value` must
276
+ # match one of the supported values and the `MEMORY` values must be
277
+ # one of the values supported for that `VCPU` value. The supported
278
+ # values are 0.25, 0.5, 1, 2, 4, 8, and 16
279
+ #
280
+ # value = 0.25
281
+ #
282
+ # : `MEMORY` = 512, 1024, or 2048
283
+ #
284
+ # value = 0.5
285
+ #
286
+ # : `MEMORY` = 1024, 2048, 3072, or 4096
287
+ #
288
+ # value = 1
289
+ #
290
+ # : `MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
291
+ #
292
+ # value = 2
293
+ #
294
+ # : `MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264,
295
+ # 12288, 13312, 14336, 15360, or 16384
296
+ #
297
+ # value = 4
298
+ #
299
+ # : `MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360,
300
+ # 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576,
301
+ # 25600, 26624, 27648, 28672, 29696, or 30720
302
+ #
303
+ # value = 8
304
+ #
305
+ # : `MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960,
306
+ # 45056, 49152, 53248, 57344, or 61440
307
+ #
308
+ # value = 16
309
+ #
310
+ # : `MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920,
311
+ # 90112, 98304, 106496, 114688, or 122880
312
+ #
313
+ #
314
+ #
315
+ # [1]: https://docs.docker.com/engine/api/v1.23/#create-a-container
316
+ # [2]: https://docs.docker.com/engine/api/v1.23/
317
+ # [3]: https://docs.docker.com/engine/reference/run/
318
+ # [4]: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html
319
+ # [5]: https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate
320
+ # @return [String]
321
+ #
322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/BatchResourceRequirement AWS API Documentation
323
+ #
324
+ class BatchResourceRequirement < Struct.new(
325
+ :type,
326
+ :value)
327
+ SENSITIVE = []
328
+ include Aws::Structure
329
+ end
330
+
331
+ # The retry strategy that's associated with a job. For more
332
+ # information, see [ Automated job retries][1] in the *Batch User
333
+ # Guide*.
334
+ #
335
+ #
336
+ #
337
+ # [1]: https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html
338
+ #
339
+ # @!attribute [rw] attempts
340
+ # The number of times to move a job to the `RUNNABLE` status. If the
341
+ # value of `attempts` is greater than one, the job is retried on
342
+ # failure the same number of attempts as the value.
343
+ # @return [Integer]
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/BatchRetryStrategy AWS API Documentation
346
+ #
347
+ class BatchRetryStrategy < Struct.new(
348
+ :attempts)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # The details of a capacity provider strategy. To learn more, see
354
+ # [CapacityProviderStrategyItem][1] in the Amazon ECS API Reference.
355
+ #
356
+ #
357
+ #
358
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html
359
+ #
360
+ # @!attribute [rw] base
361
+ # The base value designates how many tasks, at a minimum, to run on
362
+ # the specified capacity provider. Only one capacity provider in a
363
+ # capacity provider strategy can have a base defined. If no value is
364
+ # specified, the default value of 0 is used.
365
+ # @return [Integer]
366
+ #
367
+ # @!attribute [rw] capacity_provider
368
+ # The short name of the capacity provider.
369
+ # @return [String]
370
+ #
371
+ # @!attribute [rw] weight
372
+ # The weight value designates the relative percentage of the total
373
+ # number of tasks launched that should use the specified capacity
374
+ # provider. The weight value is taken into consideration after the
375
+ # base value, if defined, is satisfied.
376
+ # @return [Integer]
377
+ #
378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/CapacityProviderStrategyItem AWS API Documentation
379
+ #
380
+ class CapacityProviderStrategyItem < Struct.new(
381
+ :base,
382
+ :capacity_provider,
383
+ :weight)
384
+ SENSITIVE = [:capacity_provider]
385
+ include Aws::Structure
386
+ end
387
+
388
+ # An action you attempted resulted in an exception.
389
+ #
390
+ # @!attribute [rw] message
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] resource_id
394
+ # The ID of the resource that caused the exception.
395
+ # @return [String]
396
+ #
397
+ # @!attribute [rw] resource_type
398
+ # The type of resource that caused the exception.
399
+ # @return [String]
400
+ #
401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ConflictException AWS API Documentation
402
+ #
403
+ class ConflictException < Struct.new(
404
+ :message,
405
+ :resource_id,
406
+ :resource_type)
407
+ SENSITIVE = []
408
+ include Aws::Structure
409
+ end
410
+
411
+ # @!attribute [rw] description
412
+ # A description of the pipe.
413
+ # @return [String]
414
+ #
415
+ # @!attribute [rw] desired_state
416
+ # The state the pipe should be in.
417
+ # @return [String]
418
+ #
419
+ # @!attribute [rw] enrichment
420
+ # The ARN of the enrichment resource.
421
+ # @return [String]
422
+ #
423
+ # @!attribute [rw] enrichment_parameters
424
+ # The parameters required to set up enrichment on your pipe.
425
+ # @return [Types::PipeEnrichmentParameters]
426
+ #
427
+ # @!attribute [rw] name
428
+ # The name of the pipe.
429
+ # @return [String]
430
+ #
431
+ # @!attribute [rw] role_arn
432
+ # The ARN of the role that allows the pipe to send data to the target.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] source
436
+ # The ARN of the source resource.
437
+ # @return [String]
438
+ #
439
+ # @!attribute [rw] source_parameters
440
+ # The parameters required to set up a source for your pipe.
441
+ # @return [Types::PipeSourceParameters]
442
+ #
443
+ # @!attribute [rw] tags
444
+ # The list of key-value pairs to associate with the pipe.
445
+ # @return [Hash<String,String>]
446
+ #
447
+ # @!attribute [rw] target
448
+ # The ARN of the target resource.
449
+ # @return [String]
450
+ #
451
+ # @!attribute [rw] target_parameters
452
+ # The parameters required to set up a target for your pipe.
453
+ # @return [Types::PipeTargetParameters]
454
+ #
455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/CreatePipeRequest AWS API Documentation
456
+ #
457
+ class CreatePipeRequest < Struct.new(
458
+ :description,
459
+ :desired_state,
460
+ :enrichment,
461
+ :enrichment_parameters,
462
+ :name,
463
+ :role_arn,
464
+ :source,
465
+ :source_parameters,
466
+ :tags,
467
+ :target,
468
+ :target_parameters)
469
+ SENSITIVE = [:description]
470
+ include Aws::Structure
471
+ end
472
+
473
+ # @!attribute [rw] arn
474
+ # The ARN of the pipe.
475
+ # @return [String]
476
+ #
477
+ # @!attribute [rw] creation_time
478
+ # The time the pipe was created.
479
+ # @return [Time]
480
+ #
481
+ # @!attribute [rw] current_state
482
+ # The state the pipe is in.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] desired_state
486
+ # The state the pipe should be in.
487
+ # @return [String]
488
+ #
489
+ # @!attribute [rw] last_modified_time
490
+ # When the pipe was last updated, in [ISO-8601 format][1]
491
+ # (YYYY-MM-DDThh:mm:ss.sTZD).
492
+ #
493
+ #
494
+ #
495
+ # [1]: https://www.w3.org/TR/NOTE-datetime
496
+ # @return [Time]
497
+ #
498
+ # @!attribute [rw] name
499
+ # The name of the pipe.
500
+ # @return [String]
501
+ #
502
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/CreatePipeResponse AWS API Documentation
503
+ #
504
+ class CreatePipeResponse < Struct.new(
505
+ :arn,
506
+ :creation_time,
507
+ :current_state,
508
+ :desired_state,
509
+ :last_modified_time,
510
+ :name)
511
+ SENSITIVE = []
512
+ include Aws::Structure
513
+ end
514
+
515
+ # A `DeadLetterConfig` object that contains information about a
516
+ # dead-letter queue configuration.
517
+ #
518
+ # @!attribute [rw] arn
519
+ # The ARN of the Amazon SQS queue specified as the target for the
520
+ # dead-letter queue.
521
+ # @return [String]
522
+ #
523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/DeadLetterConfig AWS API Documentation
524
+ #
525
+ class DeadLetterConfig < Struct.new(
526
+ :arn)
527
+ SENSITIVE = []
528
+ include Aws::Structure
529
+ end
530
+
531
+ # @!attribute [rw] name
532
+ # The name of the pipe.
533
+ # @return [String]
534
+ #
535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/DeletePipeRequest AWS API Documentation
536
+ #
537
+ class DeletePipeRequest < Struct.new(
538
+ :name)
539
+ SENSITIVE = []
540
+ include Aws::Structure
541
+ end
542
+
543
+ # @!attribute [rw] arn
544
+ # The ARN of the pipe.
545
+ # @return [String]
546
+ #
547
+ # @!attribute [rw] creation_time
548
+ # The time the pipe was created.
549
+ # @return [Time]
550
+ #
551
+ # @!attribute [rw] current_state
552
+ # The state the pipe is in.
553
+ # @return [String]
554
+ #
555
+ # @!attribute [rw] desired_state
556
+ # The state the pipe should be in.
557
+ # @return [String]
558
+ #
559
+ # @!attribute [rw] last_modified_time
560
+ # When the pipe was last updated, in [ISO-8601 format][1]
561
+ # (YYYY-MM-DDThh:mm:ss.sTZD).
562
+ #
563
+ #
564
+ #
565
+ # [1]: https://www.w3.org/TR/NOTE-datetime
566
+ # @return [Time]
567
+ #
568
+ # @!attribute [rw] name
569
+ # The name of the pipe.
570
+ # @return [String]
571
+ #
572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/DeletePipeResponse AWS API Documentation
573
+ #
574
+ class DeletePipeResponse < Struct.new(
575
+ :arn,
576
+ :creation_time,
577
+ :current_state,
578
+ :desired_state,
579
+ :last_modified_time,
580
+ :name)
581
+ SENSITIVE = []
582
+ include Aws::Structure
583
+ end
584
+
585
+ # @!attribute [rw] name
586
+ # The name of the pipe.
587
+ # @return [String]
588
+ #
589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/DescribePipeRequest AWS API Documentation
590
+ #
591
+ class DescribePipeRequest < Struct.new(
592
+ :name)
593
+ SENSITIVE = []
594
+ include Aws::Structure
595
+ end
596
+
597
+ # @!attribute [rw] arn
598
+ # The ARN of the pipe.
599
+ # @return [String]
600
+ #
601
+ # @!attribute [rw] creation_time
602
+ # The time the pipe was created.
603
+ # @return [Time]
604
+ #
605
+ # @!attribute [rw] current_state
606
+ # The state the pipe is in.
607
+ # @return [String]
608
+ #
609
+ # @!attribute [rw] description
610
+ # A description of the pipe.
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] desired_state
614
+ # The state the pipe should be in.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] enrichment
618
+ # The ARN of the enrichment resource.
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] enrichment_parameters
622
+ # The parameters required to set up enrichment on your pipe.
623
+ # @return [Types::PipeEnrichmentParameters]
624
+ #
625
+ # @!attribute [rw] last_modified_time
626
+ # When the pipe was last updated, in [ISO-8601 format][1]
627
+ # (YYYY-MM-DDThh:mm:ss.sTZD).
628
+ #
629
+ #
630
+ #
631
+ # [1]: https://www.w3.org/TR/NOTE-datetime
632
+ # @return [Time]
633
+ #
634
+ # @!attribute [rw] name
635
+ # The name of the pipe.
636
+ # @return [String]
637
+ #
638
+ # @!attribute [rw] role_arn
639
+ # The ARN of the role that allows the pipe to send data to the target.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] source
643
+ # The ARN of the source resource.
644
+ # @return [String]
645
+ #
646
+ # @!attribute [rw] source_parameters
647
+ # The parameters required to set up a source for your pipe.
648
+ # @return [Types::PipeSourceParameters]
649
+ #
650
+ # @!attribute [rw] state_reason
651
+ # The reason the pipe is in its current state.
652
+ # @return [String]
653
+ #
654
+ # @!attribute [rw] tags
655
+ # The list of key-value pairs to associate with the pipe.
656
+ # @return [Hash<String,String>]
657
+ #
658
+ # @!attribute [rw] target
659
+ # The ARN of the target resource.
660
+ # @return [String]
661
+ #
662
+ # @!attribute [rw] target_parameters
663
+ # The parameters required to set up a target for your pipe.
664
+ # @return [Types::PipeTargetParameters]
665
+ #
666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/DescribePipeResponse AWS API Documentation
667
+ #
668
+ class DescribePipeResponse < Struct.new(
669
+ :arn,
670
+ :creation_time,
671
+ :current_state,
672
+ :description,
673
+ :desired_state,
674
+ :enrichment,
675
+ :enrichment_parameters,
676
+ :last_modified_time,
677
+ :name,
678
+ :role_arn,
679
+ :source,
680
+ :source_parameters,
681
+ :state_reason,
682
+ :tags,
683
+ :target,
684
+ :target_parameters)
685
+ SENSITIVE = [:description]
686
+ include Aws::Structure
687
+ end
688
+
689
+ # The overrides that are sent to a container. An empty container
690
+ # override can be passed in. An example of an empty container override
691
+ # is `\{"containerOverrides": [ ] \}`. If a non-empty container override
692
+ # is specified, the `name` parameter must be included.
693
+ #
694
+ # @!attribute [rw] command
695
+ # The command to send to the container that overrides the default
696
+ # command from the Docker image or the task definition. You must also
697
+ # specify a container name.
698
+ # @return [Array<String>]
699
+ #
700
+ # @!attribute [rw] cpu
701
+ # The number of `cpu` units reserved for the container, instead of the
702
+ # default value from the task definition. You must also specify a
703
+ # container name.
704
+ # @return [Integer]
705
+ #
706
+ # @!attribute [rw] environment
707
+ # The environment variables to send to the container. You can add new
708
+ # environment variables, which are added to the container at launch,
709
+ # or you can override the existing environment variables from the
710
+ # Docker image or the task definition. You must also specify a
711
+ # container name.
712
+ # @return [Array<Types::EcsEnvironmentVariable>]
713
+ #
714
+ # @!attribute [rw] environment_files
715
+ # A list of files containing the environment variables to pass to a
716
+ # container, instead of the value from the container definition.
717
+ # @return [Array<Types::EcsEnvironmentFile>]
718
+ #
719
+ # @!attribute [rw] memory
720
+ # The hard limit (in MiB) of memory to present to the container,
721
+ # instead of the default value from the task definition. If your
722
+ # container attempts to exceed the memory specified here, the
723
+ # container is killed. You must also specify a container name.
724
+ # @return [Integer]
725
+ #
726
+ # @!attribute [rw] memory_reservation
727
+ # The soft limit (in MiB) of memory to reserve for the container,
728
+ # instead of the default value from the task definition. You must also
729
+ # specify a container name.
730
+ # @return [Integer]
731
+ #
732
+ # @!attribute [rw] name
733
+ # The name of the container that receives the override. This parameter
734
+ # is required if any override is specified.
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] resource_requirements
738
+ # The type and amount of a resource to assign to a container, instead
739
+ # of the default value from the task definition. The only supported
740
+ # resource is a GPU.
741
+ # @return [Array<Types::EcsResourceRequirement>]
742
+ #
743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/EcsContainerOverride AWS API Documentation
744
+ #
745
+ class EcsContainerOverride < Struct.new(
746
+ :command,
747
+ :cpu,
748
+ :environment,
749
+ :environment_files,
750
+ :memory,
751
+ :memory_reservation,
752
+ :name,
753
+ :resource_requirements)
754
+ SENSITIVE = []
755
+ include Aws::Structure
756
+ end
757
+
758
+ # A list of files containing the environment variables to pass to a
759
+ # container. You can specify up to ten environment files. The file must
760
+ # have a `.env` file extension. Each line in an environment file should
761
+ # contain an environment variable in `VARIABLE=VALUE` format. Lines
762
+ # beginning with `#` are treated as comments and are ignored. For more
763
+ # information about the environment variable file syntax, see [Declare
764
+ # default environment variables in file][1].
765
+ #
766
+ # If there are environment variables specified using the `environment`
767
+ # parameter in a container definition, they take precedence over the
768
+ # variables contained within an environment file. If multiple
769
+ # environment files are specified that contain the same variable,
770
+ # they're processed from the top down. We recommend that you use unique
771
+ # variable names. For more information, see [Specifying environment
772
+ # variables][2] in the *Amazon Elastic Container Service Developer
773
+ # Guide*.
774
+ #
775
+ # This parameter is only supported for tasks hosted on Fargate using the
776
+ # following platform versions:
777
+ #
778
+ # * Linux platform version `1.4.0` or later.
779
+ #
780
+ # * Windows platform version `1.0.0` or later.
781
+ #
782
+ #
783
+ #
784
+ # [1]: https://docs.docker.com/compose/env-file/
785
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html
786
+ #
787
+ # @!attribute [rw] type
788
+ # The file type to use. The only supported value is `s3`.
789
+ # @return [String]
790
+ #
791
+ # @!attribute [rw] value
792
+ # The Amazon Resource Name (ARN) of the Amazon S3 object containing
793
+ # the environment variable file.
794
+ # @return [String]
795
+ #
796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/EcsEnvironmentFile AWS API Documentation
797
+ #
798
+ class EcsEnvironmentFile < Struct.new(
799
+ :type,
800
+ :value)
801
+ SENSITIVE = []
802
+ include Aws::Structure
803
+ end
804
+
805
+ # The environment variables to send to the container. You can add new
806
+ # environment variables, which are added to the container at launch, or
807
+ # you can override the existing environment variables from the Docker
808
+ # image or the task definition. You must also specify a container name.
809
+ #
810
+ # @!attribute [rw] name
811
+ # The name of the key-value pair. For environment variables, this is
812
+ # the name of the environment variable.
813
+ # @return [String]
814
+ #
815
+ # @!attribute [rw] value
816
+ # The value of the key-value pair. For environment variables, this is
817
+ # the value of the environment variable.
818
+ # @return [String]
819
+ #
820
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/EcsEnvironmentVariable AWS API Documentation
821
+ #
822
+ class EcsEnvironmentVariable < Struct.new(
823
+ :name,
824
+ :value)
825
+ SENSITIVE = []
826
+ include Aws::Structure
827
+ end
828
+
829
+ # The amount of ephemeral storage to allocate for the task. This
830
+ # parameter is used to expand the total amount of ephemeral storage
831
+ # available, beyond the default amount, for tasks hosted on Fargate. For
832
+ # more information, see [Fargate task storage][1] in the *Amazon ECS
833
+ # User Guide for Fargate*.
834
+ #
835
+ # <note markdown="1"> This parameter is only supported for tasks hosted on Fargate using
836
+ # Linux platform version `1.4.0` or later. This parameter is not
837
+ # supported for Windows containers on Fargate.
838
+ #
839
+ # </note>
840
+ #
841
+ #
842
+ #
843
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html
844
+ #
845
+ # @!attribute [rw] size_in_gi_b
846
+ # The total amount, in GiB, of ephemeral storage to set for the task.
847
+ # The minimum supported value is `21` GiB and the maximum supported
848
+ # value is `200` GiB.
849
+ # @return [Integer]
850
+ #
851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/EcsEphemeralStorage AWS API Documentation
852
+ #
853
+ class EcsEphemeralStorage < Struct.new(
854
+ :size_in_gi_b)
855
+ SENSITIVE = []
856
+ include Aws::Structure
857
+ end
858
+
859
+ # Details on an Elastic Inference accelerator task override. This
860
+ # parameter is used to override the Elastic Inference accelerator
861
+ # specified in the task definition. For more information, see [Working
862
+ # with Amazon Elastic Inference on Amazon ECS][1] in the *Amazon Elastic
863
+ # Container Service Developer Guide*.
864
+ #
865
+ #
866
+ #
867
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html
868
+ #
869
+ # @!attribute [rw] device_name
870
+ # The Elastic Inference accelerator device name to override for the
871
+ # task. This parameter must match a `deviceName` specified in the task
872
+ # definition.
873
+ # @return [String]
874
+ #
875
+ # @!attribute [rw] device_type
876
+ # The Elastic Inference accelerator type to use.
877
+ # @return [String]
878
+ #
879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/EcsInferenceAcceleratorOverride AWS API Documentation
880
+ #
881
+ class EcsInferenceAcceleratorOverride < Struct.new(
882
+ :device_name,
883
+ :device_type)
884
+ SENSITIVE = []
885
+ include Aws::Structure
886
+ end
887
+
888
+ # The type and amount of a resource to assign to a container. The
889
+ # supported resource types are GPUs and Elastic Inference accelerators.
890
+ # For more information, see [Working with GPUs on Amazon ECS][1] or
891
+ # [Working with Amazon Elastic Inference on Amazon ECS][2] in the
892
+ # *Amazon Elastic Container Service Developer Guide*
893
+ #
894
+ #
895
+ #
896
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html
897
+ # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html
898
+ #
899
+ # @!attribute [rw] type
900
+ # The type of resource to assign to a container. The supported values
901
+ # are `GPU` or `InferenceAccelerator`.
902
+ # @return [String]
903
+ #
904
+ # @!attribute [rw] value
905
+ # The value for the specified resource type.
906
+ #
907
+ # If the `GPU` type is used, the value is the number of physical
908
+ # `GPUs` the Amazon ECS container agent reserves for the container.
909
+ # The number of GPUs that's reserved for all containers in a task
910
+ # can't exceed the number of available GPUs on the container instance
911
+ # that the task is launched on.
912
+ #
913
+ # If the `InferenceAccelerator` type is used, the `value` matches the
914
+ # `deviceName` for an InferenceAccelerator specified in a task
915
+ # definition.
916
+ # @return [String]
917
+ #
918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/EcsResourceRequirement AWS API Documentation
919
+ #
920
+ class EcsResourceRequirement < Struct.new(
921
+ :type,
922
+ :value)
923
+ SENSITIVE = []
924
+ include Aws::Structure
925
+ end
926
+
927
+ # The overrides that are associated with a task.
928
+ #
929
+ # @!attribute [rw] container_overrides
930
+ # One or more container overrides that are sent to a task.
931
+ # @return [Array<Types::EcsContainerOverride>]
932
+ #
933
+ # @!attribute [rw] cpu
934
+ # The cpu override for the task.
935
+ # @return [String]
936
+ #
937
+ # @!attribute [rw] ephemeral_storage
938
+ # The ephemeral storage setting override for the task.
939
+ #
940
+ # <note markdown="1"> This parameter is only supported for tasks hosted on Fargate that
941
+ # use the following platform versions:
942
+ #
943
+ # * Linux platform version `1.4.0` or later.
944
+ #
945
+ # * Windows platform version `1.0.0` or later.
946
+ #
947
+ # </note>
948
+ # @return [Types::EcsEphemeralStorage]
949
+ #
950
+ # @!attribute [rw] execution_role_arn
951
+ # The Amazon Resource Name (ARN) of the task execution IAM role
952
+ # override for the task. For more information, see [Amazon ECS task
953
+ # execution IAM role][1] in the *Amazon Elastic Container Service
954
+ # Developer Guide*.
955
+ #
956
+ #
957
+ #
958
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html
959
+ # @return [String]
960
+ #
961
+ # @!attribute [rw] inference_accelerator_overrides
962
+ # The Elastic Inference accelerator override for the task.
963
+ # @return [Array<Types::EcsInferenceAcceleratorOverride>]
964
+ #
965
+ # @!attribute [rw] memory
966
+ # The memory override for the task.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] task_role_arn
970
+ # The Amazon Resource Name (ARN) of the IAM role that containers in
971
+ # this task can assume. All containers in this task are granted the
972
+ # permissions that are specified in this role. For more information,
973
+ # see [IAM Role for Tasks][1] in the *Amazon Elastic Container Service
974
+ # Developer Guide*.
975
+ #
976
+ #
977
+ #
978
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
979
+ # @return [String]
980
+ #
981
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/EcsTaskOverride AWS API Documentation
982
+ #
983
+ class EcsTaskOverride < Struct.new(
984
+ :container_overrides,
985
+ :cpu,
986
+ :ephemeral_storage,
987
+ :execution_role_arn,
988
+ :inference_accelerator_overrides,
989
+ :memory,
990
+ :task_role_arn)
991
+ SENSITIVE = []
992
+ include Aws::Structure
993
+ end
994
+
995
+ # Filter events using an event pattern. For more information, see
996
+ # [Events and Event Patterns][1] in the *Amazon EventBridge User Guide*.
997
+ #
998
+ #
999
+ #
1000
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
1001
+ #
1002
+ # @!attribute [rw] pattern
1003
+ # The event pattern.
1004
+ # @return [String]
1005
+ #
1006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/Filter AWS API Documentation
1007
+ #
1008
+ class Filter < Struct.new(
1009
+ :pattern)
1010
+ SENSITIVE = [:pattern]
1011
+ include Aws::Structure
1012
+ end
1013
+
1014
+ # The collection of event patterns used to filter events. For more
1015
+ # information, see [Events and Event Patterns][1] in the *Amazon
1016
+ # EventBridge User Guide*.
1017
+ #
1018
+ #
1019
+ #
1020
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
1021
+ #
1022
+ # @!attribute [rw] filters
1023
+ # The event patterns.
1024
+ # @return [Array<Types::Filter>]
1025
+ #
1026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/FilterCriteria AWS API Documentation
1027
+ #
1028
+ class FilterCriteria < Struct.new(
1029
+ :filters)
1030
+ SENSITIVE = []
1031
+ include Aws::Structure
1032
+ end
1033
+
1034
+ # This exception occurs due to unexpected causes.
1035
+ #
1036
+ # @!attribute [rw] message
1037
+ # @return [String]
1038
+ #
1039
+ # @!attribute [rw] retry_after_seconds
1040
+ # The number of seconds to wait before retrying the action that caused
1041
+ # the exception.
1042
+ # @return [Integer]
1043
+ #
1044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/InternalException AWS API Documentation
1045
+ #
1046
+ class InternalException < Struct.new(
1047
+ :message,
1048
+ :retry_after_seconds)
1049
+ SENSITIVE = []
1050
+ include Aws::Structure
1051
+ end
1052
+
1053
+ # @!attribute [rw] current_state
1054
+ # The state the pipe is in.
1055
+ # @return [String]
1056
+ #
1057
+ # @!attribute [rw] desired_state
1058
+ # The state the pipe should be in.
1059
+ # @return [String]
1060
+ #
1061
+ # @!attribute [rw] limit
1062
+ # The maximum number of pipes to include in the response.
1063
+ # @return [Integer]
1064
+ #
1065
+ # @!attribute [rw] name_prefix
1066
+ # A value that will return a subset of the pipes associated with this
1067
+ # account. For example, `"NamePrefix": "ABC"` will return all
1068
+ # endpoints with "ABC" in the name.
1069
+ # @return [String]
1070
+ #
1071
+ # @!attribute [rw] next_token
1072
+ # If `nextToken` is returned, there are more results available. The
1073
+ # value of `nextToken` is a unique pagination token for each page.
1074
+ # Make the call again using the returned token to retrieve the next
1075
+ # page. Keep all other arguments unchanged. Each pagination token
1076
+ # expires after 24 hours. Using an expired pagination token will
1077
+ # return an HTTP 400 InvalidToken error.
1078
+ # @return [String]
1079
+ #
1080
+ # @!attribute [rw] source_prefix
1081
+ # The prefix matching the pipe source.
1082
+ # @return [String]
1083
+ #
1084
+ # @!attribute [rw] target_prefix
1085
+ # The prefix matching the pipe target.
1086
+ # @return [String]
1087
+ #
1088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ListPipesRequest AWS API Documentation
1089
+ #
1090
+ class ListPipesRequest < Struct.new(
1091
+ :current_state,
1092
+ :desired_state,
1093
+ :limit,
1094
+ :name_prefix,
1095
+ :next_token,
1096
+ :source_prefix,
1097
+ :target_prefix)
1098
+ SENSITIVE = [:next_token]
1099
+ include Aws::Structure
1100
+ end
1101
+
1102
+ # @!attribute [rw] next_token
1103
+ # If `nextToken` is returned, there are more results available. The
1104
+ # value of `nextToken` is a unique pagination token for each page.
1105
+ # Make the call again using the returned token to retrieve the next
1106
+ # page. Keep all other arguments unchanged. Each pagination token
1107
+ # expires after 24 hours. Using an expired pagination token will
1108
+ # return an HTTP 400 InvalidToken error.
1109
+ # @return [String]
1110
+ #
1111
+ # @!attribute [rw] pipes
1112
+ # The pipes returned by the call.
1113
+ # @return [Array<Types::Pipe>]
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ListPipesResponse AWS API Documentation
1116
+ #
1117
+ class ListPipesResponse < Struct.new(
1118
+ :next_token,
1119
+ :pipes)
1120
+ SENSITIVE = [:next_token]
1121
+ include Aws::Structure
1122
+ end
1123
+
1124
+ # @!attribute [rw] resource_arn
1125
+ # The ARN of the pipe for which you want to view tags.
1126
+ # @return [String]
1127
+ #
1128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ListTagsForResourceRequest AWS API Documentation
1129
+ #
1130
+ class ListTagsForResourceRequest < Struct.new(
1131
+ :resource_arn)
1132
+ SENSITIVE = []
1133
+ include Aws::Structure
1134
+ end
1135
+
1136
+ # @!attribute [rw] tags
1137
+ # The list of key-value pairs to associate with the pipe.
1138
+ # @return [Hash<String,String>]
1139
+ #
1140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ListTagsForResourceResponse AWS API Documentation
1141
+ #
1142
+ class ListTagsForResourceResponse < Struct.new(
1143
+ :tags)
1144
+ SENSITIVE = []
1145
+ include Aws::Structure
1146
+ end
1147
+
1148
+ # The Secrets Manager secret that stores your broker credentials.
1149
+ #
1150
+ # @!attribute [rw] basic_auth
1151
+ # The ARN of the Secrets Manager secret.
1152
+ # @return [String]
1153
+ #
1154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/MQBrokerAccessCredentials AWS API Documentation
1155
+ #
1156
+ class MQBrokerAccessCredentials < Struct.new(
1157
+ :basic_auth,
1158
+ :unknown)
1159
+ SENSITIVE = []
1160
+ include Aws::Structure
1161
+ include Aws::Structure::Union
1162
+
1163
+ class BasicAuth < MQBrokerAccessCredentials; end
1164
+ class Unknown < MQBrokerAccessCredentials; end
1165
+ end
1166
+
1167
+ # The Secrets Manager secret that stores your stream credentials.
1168
+ #
1169
+ # @!attribute [rw] client_certificate_tls_auth
1170
+ # The ARN of the Secrets Manager secret.
1171
+ # @return [String]
1172
+ #
1173
+ # @!attribute [rw] sasl_scram_512_auth
1174
+ # The ARN of the Secrets Manager secret.
1175
+ # @return [String]
1176
+ #
1177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/MSKAccessCredentials AWS API Documentation
1178
+ #
1179
+ class MSKAccessCredentials < Struct.new(
1180
+ :client_certificate_tls_auth,
1181
+ :sasl_scram_512_auth,
1182
+ :unknown)
1183
+ SENSITIVE = []
1184
+ include Aws::Structure
1185
+ include Aws::Structure::Union
1186
+
1187
+ class ClientCertificateTlsAuth < MSKAccessCredentials; end
1188
+ class SaslScram512Auth < MSKAccessCredentials; end
1189
+ class Unknown < MSKAccessCredentials; end
1190
+ end
1191
+
1192
+ # This structure specifies the network configuration for an Amazon ECS
1193
+ # task.
1194
+ #
1195
+ # @!attribute [rw] awsvpc_configuration
1196
+ # Use this structure to specify the VPC subnets and security groups
1197
+ # for the task, and whether a public IP address is to be used. This
1198
+ # structure is relevant only for ECS tasks that use the `awsvpc`
1199
+ # network mode.
1200
+ # @return [Types::AwsVpcConfiguration]
1201
+ #
1202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/NetworkConfiguration AWS API Documentation
1203
+ #
1204
+ class NetworkConfiguration < Struct.new(
1205
+ :awsvpc_configuration)
1206
+ SENSITIVE = []
1207
+ include Aws::Structure
1208
+ end
1209
+
1210
+ # An entity that you specified does not exist.
1211
+ #
1212
+ # @!attribute [rw] message
1213
+ # @return [String]
1214
+ #
1215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/NotFoundException AWS API Documentation
1216
+ #
1217
+ class NotFoundException < Struct.new(
1218
+ :message)
1219
+ SENSITIVE = []
1220
+ include Aws::Structure
1221
+ end
1222
+
1223
+ # An object that represents a pipe. Amazon EventBridgePipes connect
1224
+ # event sources to targets and reduces the need for specialized
1225
+ # knowledge and integration code.
1226
+ #
1227
+ # @!attribute [rw] arn
1228
+ # The ARN of the pipe.
1229
+ # @return [String]
1230
+ #
1231
+ # @!attribute [rw] creation_time
1232
+ # The time the pipe was created.
1233
+ # @return [Time]
1234
+ #
1235
+ # @!attribute [rw] current_state
1236
+ # The state the pipe is in.
1237
+ # @return [String]
1238
+ #
1239
+ # @!attribute [rw] desired_state
1240
+ # The state the pipe should be in.
1241
+ # @return [String]
1242
+ #
1243
+ # @!attribute [rw] enrichment
1244
+ # The ARN of the enrichment resource.
1245
+ # @return [String]
1246
+ #
1247
+ # @!attribute [rw] last_modified_time
1248
+ # When the pipe was last updated, in [ISO-8601 format][1]
1249
+ # (YYYY-MM-DDThh:mm:ss.sTZD).
1250
+ #
1251
+ #
1252
+ #
1253
+ # [1]: https://www.w3.org/TR/NOTE-datetime
1254
+ # @return [Time]
1255
+ #
1256
+ # @!attribute [rw] name
1257
+ # The name of the pipe.
1258
+ # @return [String]
1259
+ #
1260
+ # @!attribute [rw] source
1261
+ # The ARN of the source resource.
1262
+ # @return [String]
1263
+ #
1264
+ # @!attribute [rw] state_reason
1265
+ # The reason the pipe is in its current state.
1266
+ # @return [String]
1267
+ #
1268
+ # @!attribute [rw] target
1269
+ # The ARN of the target resource.
1270
+ # @return [String]
1271
+ #
1272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/Pipe AWS API Documentation
1273
+ #
1274
+ class Pipe < Struct.new(
1275
+ :arn,
1276
+ :creation_time,
1277
+ :current_state,
1278
+ :desired_state,
1279
+ :enrichment,
1280
+ :last_modified_time,
1281
+ :name,
1282
+ :source,
1283
+ :state_reason,
1284
+ :target)
1285
+ SENSITIVE = []
1286
+ include Aws::Structure
1287
+ end
1288
+
1289
+ # These are custom parameter to be used when the target is an API
1290
+ # Gateway REST APIs or EventBridge ApiDestinations. In the latter case,
1291
+ # these are merged with any InvocationParameters specified on the
1292
+ # Connection, with any values from the Connection taking precedence.
1293
+ #
1294
+ # @!attribute [rw] header_parameters
1295
+ # The headers that need to be sent as part of request invoking the API
1296
+ # Gateway REST API or EventBridge ApiDestination.
1297
+ # @return [Hash<String,String>]
1298
+ #
1299
+ # @!attribute [rw] path_parameter_values
1300
+ # The path parameter values to be used to populate API Gateway REST
1301
+ # API or EventBridge ApiDestination path wildcards ("*").
1302
+ # @return [Array<String>]
1303
+ #
1304
+ # @!attribute [rw] query_string_parameters
1305
+ # The query string keys/values that need to be sent as part of request
1306
+ # invoking the API Gateway REST API or EventBridge ApiDestination.
1307
+ # @return [Hash<String,String>]
1308
+ #
1309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeEnrichmentHttpParameters AWS API Documentation
1310
+ #
1311
+ class PipeEnrichmentHttpParameters < Struct.new(
1312
+ :header_parameters,
1313
+ :path_parameter_values,
1314
+ :query_string_parameters)
1315
+ SENSITIVE = []
1316
+ include Aws::Structure
1317
+ end
1318
+
1319
+ # The parameters required to set up enrichment on your pipe.
1320
+ #
1321
+ # @!attribute [rw] http_parameters
1322
+ # Contains the HTTP parameters to use when the target is a API Gateway
1323
+ # REST endpoint or EventBridge ApiDestination.
1324
+ #
1325
+ # If you specify an API Gateway REST API or EventBridge ApiDestination
1326
+ # as a target, you can use this parameter to specify headers, path
1327
+ # parameters, and query string keys/values as part of your target
1328
+ # invoking request. If you're using ApiDestinations, the
1329
+ # corresponding Connection can also have these values configured. In
1330
+ # case of any conflicting keys, values from the Connection take
1331
+ # precedence.
1332
+ # @return [Types::PipeEnrichmentHttpParameters]
1333
+ #
1334
+ # @!attribute [rw] input_template
1335
+ # Valid JSON text passed to the enrichment. In this case, nothing from
1336
+ # the event itself is passed to the enrichment. For more information,
1337
+ # see [The JavaScript Object Notation (JSON) Data Interchange
1338
+ # Format][1].
1339
+ #
1340
+ #
1341
+ #
1342
+ # [1]: http://www.rfc-editor.org/rfc/rfc7159.txt
1343
+ # @return [String]
1344
+ #
1345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeEnrichmentParameters AWS API Documentation
1346
+ #
1347
+ class PipeEnrichmentParameters < Struct.new(
1348
+ :http_parameters,
1349
+ :input_template)
1350
+ SENSITIVE = [:input_template]
1351
+ include Aws::Structure
1352
+ end
1353
+
1354
+ # The parameters for using an Active MQ broker as a source.
1355
+ #
1356
+ # @!attribute [rw] batch_size
1357
+ # The maximum number of records to include in each batch.
1358
+ # @return [Integer]
1359
+ #
1360
+ # @!attribute [rw] credentials
1361
+ # The credentials needed to access the resource.
1362
+ # @return [Types::MQBrokerAccessCredentials]
1363
+ #
1364
+ # @!attribute [rw] maximum_batching_window_in_seconds
1365
+ # The maximum length of a time to wait for events.
1366
+ # @return [Integer]
1367
+ #
1368
+ # @!attribute [rw] queue_name
1369
+ # The name of the destination queue to consume.
1370
+ # @return [String]
1371
+ #
1372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeSourceActiveMQBrokerParameters AWS API Documentation
1373
+ #
1374
+ class PipeSourceActiveMQBrokerParameters < Struct.new(
1375
+ :batch_size,
1376
+ :credentials,
1377
+ :maximum_batching_window_in_seconds,
1378
+ :queue_name)
1379
+ SENSITIVE = [:queue_name]
1380
+ include Aws::Structure
1381
+ end
1382
+
1383
+ # The parameters for using a DynamoDB stream as a source.
1384
+ #
1385
+ # @!attribute [rw] batch_size
1386
+ # The maximum number of records to include in each batch.
1387
+ # @return [Integer]
1388
+ #
1389
+ # @!attribute [rw] dead_letter_config
1390
+ # Define the target queue to send dead-letter queue events to.
1391
+ # @return [Types::DeadLetterConfig]
1392
+ #
1393
+ # @!attribute [rw] maximum_batching_window_in_seconds
1394
+ # The maximum length of a time to wait for events.
1395
+ # @return [Integer]
1396
+ #
1397
+ # @!attribute [rw] maximum_record_age_in_seconds
1398
+ # (Streams only) Discard records older than the specified age. The
1399
+ # default value is -1, which sets the maximum age to infinite. When
1400
+ # the value is set to infinite, EventBridge never discards old
1401
+ # records.
1402
+ # @return [Integer]
1403
+ #
1404
+ # @!attribute [rw] maximum_retry_attempts
1405
+ # (Streams only) Discard records after the specified number of
1406
+ # retries. The default value is -1, which sets the maximum number of
1407
+ # retries to infinite. When MaximumRetryAttempts is infinite,
1408
+ # EventBridge retries failed records until the record expires in the
1409
+ # event source.
1410
+ # @return [Integer]
1411
+ #
1412
+ # @!attribute [rw] on_partial_batch_item_failure
1413
+ # (Streams only) Define how to handle item process failures.
1414
+ # `AUTOMATIC_BISECT` halves each batch and retry each half until all
1415
+ # the records are processed or there is one failed message left in the
1416
+ # batch.
1417
+ # @return [String]
1418
+ #
1419
+ # @!attribute [rw] parallelization_factor
1420
+ # (Streams only) The number of batches to process concurrently from
1421
+ # each shard. The default value is 1.
1422
+ # @return [Integer]
1423
+ #
1424
+ # @!attribute [rw] starting_position
1425
+ # (Streams only) The position in a stream from which to start reading.
1426
+ # @return [String]
1427
+ #
1428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeSourceDynamoDBStreamParameters AWS API Documentation
1429
+ #
1430
+ class PipeSourceDynamoDBStreamParameters < Struct.new(
1431
+ :batch_size,
1432
+ :dead_letter_config,
1433
+ :maximum_batching_window_in_seconds,
1434
+ :maximum_record_age_in_seconds,
1435
+ :maximum_retry_attempts,
1436
+ :on_partial_batch_item_failure,
1437
+ :parallelization_factor,
1438
+ :starting_position)
1439
+ SENSITIVE = []
1440
+ include Aws::Structure
1441
+ end
1442
+
1443
+ # The parameters for using a Kinesis stream as a source.
1444
+ #
1445
+ # @!attribute [rw] batch_size
1446
+ # The maximum number of records to include in each batch.
1447
+ # @return [Integer]
1448
+ #
1449
+ # @!attribute [rw] dead_letter_config
1450
+ # Define the target queue to send dead-letter queue events to.
1451
+ # @return [Types::DeadLetterConfig]
1452
+ #
1453
+ # @!attribute [rw] maximum_batching_window_in_seconds
1454
+ # The maximum length of a time to wait for events.
1455
+ # @return [Integer]
1456
+ #
1457
+ # @!attribute [rw] maximum_record_age_in_seconds
1458
+ # (Streams only) Discard records older than the specified age. The
1459
+ # default value is -1, which sets the maximum age to infinite. When
1460
+ # the value is set to infinite, EventBridge never discards old
1461
+ # records.
1462
+ # @return [Integer]
1463
+ #
1464
+ # @!attribute [rw] maximum_retry_attempts
1465
+ # (Streams only) Discard records after the specified number of
1466
+ # retries. The default value is -1, which sets the maximum number of
1467
+ # retries to infinite. When MaximumRetryAttempts is infinite,
1468
+ # EventBridge retries failed records until the record expires in the
1469
+ # event source.
1470
+ # @return [Integer]
1471
+ #
1472
+ # @!attribute [rw] on_partial_batch_item_failure
1473
+ # (Streams only) Define how to handle item process failures.
1474
+ # `AUTOMATIC_BISECT` halves each batch and retry each half until all
1475
+ # the records are processed or there is one failed message left in the
1476
+ # batch.
1477
+ # @return [String]
1478
+ #
1479
+ # @!attribute [rw] parallelization_factor
1480
+ # (Streams only) The number of batches to process concurrently from
1481
+ # each shard. The default value is 1.
1482
+ # @return [Integer]
1483
+ #
1484
+ # @!attribute [rw] starting_position
1485
+ # (Streams only) The position in a stream from which to start reading.
1486
+ # @return [String]
1487
+ #
1488
+ # @!attribute [rw] starting_position_timestamp
1489
+ # With `StartingPosition` set to `AT_TIMESTAMP`, the time from which
1490
+ # to start reading, in Unix time seconds.
1491
+ # @return [Time]
1492
+ #
1493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeSourceKinesisStreamParameters AWS API Documentation
1494
+ #
1495
+ class PipeSourceKinesisStreamParameters < Struct.new(
1496
+ :batch_size,
1497
+ :dead_letter_config,
1498
+ :maximum_batching_window_in_seconds,
1499
+ :maximum_record_age_in_seconds,
1500
+ :maximum_retry_attempts,
1501
+ :on_partial_batch_item_failure,
1502
+ :parallelization_factor,
1503
+ :starting_position,
1504
+ :starting_position_timestamp)
1505
+ SENSITIVE = []
1506
+ include Aws::Structure
1507
+ end
1508
+
1509
+ # The parameters for using an MSK stream as a source.
1510
+ #
1511
+ # @!attribute [rw] batch_size
1512
+ # The maximum number of records to include in each batch.
1513
+ # @return [Integer]
1514
+ #
1515
+ # @!attribute [rw] consumer_group_id
1516
+ # The name of the destination queue to consume.
1517
+ # @return [String]
1518
+ #
1519
+ # @!attribute [rw] credentials
1520
+ # The credentials needed to access the resource.
1521
+ # @return [Types::MSKAccessCredentials]
1522
+ #
1523
+ # @!attribute [rw] maximum_batching_window_in_seconds
1524
+ # The maximum length of a time to wait for events.
1525
+ # @return [Integer]
1526
+ #
1527
+ # @!attribute [rw] starting_position
1528
+ # (Streams only) The position in a stream from which to start reading.
1529
+ # @return [String]
1530
+ #
1531
+ # @!attribute [rw] topic_name
1532
+ # The name of the topic that the pipe will read from.
1533
+ # @return [String]
1534
+ #
1535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeSourceManagedStreamingKafkaParameters AWS API Documentation
1536
+ #
1537
+ class PipeSourceManagedStreamingKafkaParameters < Struct.new(
1538
+ :batch_size,
1539
+ :consumer_group_id,
1540
+ :credentials,
1541
+ :maximum_batching_window_in_seconds,
1542
+ :starting_position,
1543
+ :topic_name)
1544
+ SENSITIVE = [:consumer_group_id, :topic_name]
1545
+ include Aws::Structure
1546
+ end
1547
+
1548
+ # The parameters required to set up a source for your pipe.
1549
+ #
1550
+ # @!attribute [rw] active_mq_broker_parameters
1551
+ # The parameters for using an Active MQ broker as a source.
1552
+ # @return [Types::PipeSourceActiveMQBrokerParameters]
1553
+ #
1554
+ # @!attribute [rw] dynamo_db_stream_parameters
1555
+ # The parameters for using a DynamoDB stream as a source.
1556
+ # @return [Types::PipeSourceDynamoDBStreamParameters]
1557
+ #
1558
+ # @!attribute [rw] filter_criteria
1559
+ # The collection of event patterns used to filter events. For more
1560
+ # information, see [Events and Event Patterns][1] in the *Amazon
1561
+ # EventBridge User Guide*.
1562
+ #
1563
+ #
1564
+ #
1565
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
1566
+ # @return [Types::FilterCriteria]
1567
+ #
1568
+ # @!attribute [rw] kinesis_stream_parameters
1569
+ # The parameters for using a Kinesis stream as a source.
1570
+ # @return [Types::PipeSourceKinesisStreamParameters]
1571
+ #
1572
+ # @!attribute [rw] managed_streaming_kafka_parameters
1573
+ # The parameters for using an MSK stream as a source.
1574
+ # @return [Types::PipeSourceManagedStreamingKafkaParameters]
1575
+ #
1576
+ # @!attribute [rw] rabbit_mq_broker_parameters
1577
+ # The parameters for using a Rabbit MQ broker as a source.
1578
+ # @return [Types::PipeSourceRabbitMQBrokerParameters]
1579
+ #
1580
+ # @!attribute [rw] self_managed_kafka_parameters
1581
+ # The parameters for using a self-managed Apache Kafka stream as a
1582
+ # source.
1583
+ # @return [Types::PipeSourceSelfManagedKafkaParameters]
1584
+ #
1585
+ # @!attribute [rw] sqs_queue_parameters
1586
+ # The parameters for using a Amazon SQS stream as a source.
1587
+ # @return [Types::PipeSourceSqsQueueParameters]
1588
+ #
1589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeSourceParameters AWS API Documentation
1590
+ #
1591
+ class PipeSourceParameters < Struct.new(
1592
+ :active_mq_broker_parameters,
1593
+ :dynamo_db_stream_parameters,
1594
+ :filter_criteria,
1595
+ :kinesis_stream_parameters,
1596
+ :managed_streaming_kafka_parameters,
1597
+ :rabbit_mq_broker_parameters,
1598
+ :self_managed_kafka_parameters,
1599
+ :sqs_queue_parameters)
1600
+ SENSITIVE = []
1601
+ include Aws::Structure
1602
+ end
1603
+
1604
+ # The parameters for using a Rabbit MQ broker as a source.
1605
+ #
1606
+ # @!attribute [rw] batch_size
1607
+ # The maximum number of records to include in each batch.
1608
+ # @return [Integer]
1609
+ #
1610
+ # @!attribute [rw] credentials
1611
+ # The credentials needed to access the resource.
1612
+ # @return [Types::MQBrokerAccessCredentials]
1613
+ #
1614
+ # @!attribute [rw] maximum_batching_window_in_seconds
1615
+ # The maximum length of a time to wait for events.
1616
+ # @return [Integer]
1617
+ #
1618
+ # @!attribute [rw] queue_name
1619
+ # The name of the destination queue to consume.
1620
+ # @return [String]
1621
+ #
1622
+ # @!attribute [rw] virtual_host
1623
+ # The name of the virtual host associated with the source broker.
1624
+ # @return [String]
1625
+ #
1626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeSourceRabbitMQBrokerParameters AWS API Documentation
1627
+ #
1628
+ class PipeSourceRabbitMQBrokerParameters < Struct.new(
1629
+ :batch_size,
1630
+ :credentials,
1631
+ :maximum_batching_window_in_seconds,
1632
+ :queue_name,
1633
+ :virtual_host)
1634
+ SENSITIVE = [:queue_name, :virtual_host]
1635
+ include Aws::Structure
1636
+ end
1637
+
1638
+ # The parameters for using a self-managed Apache Kafka stream as a
1639
+ # source.
1640
+ #
1641
+ # @!attribute [rw] additional_bootstrap_servers
1642
+ # An array of server URLs.
1643
+ # @return [Array<String>]
1644
+ #
1645
+ # @!attribute [rw] batch_size
1646
+ # The maximum number of records to include in each batch.
1647
+ # @return [Integer]
1648
+ #
1649
+ # @!attribute [rw] consumer_group_id
1650
+ # The name of the destination queue to consume.
1651
+ # @return [String]
1652
+ #
1653
+ # @!attribute [rw] credentials
1654
+ # The credentials needed to access the resource.
1655
+ # @return [Types::SelfManagedKafkaAccessConfigurationCredentials]
1656
+ #
1657
+ # @!attribute [rw] maximum_batching_window_in_seconds
1658
+ # The maximum length of a time to wait for events.
1659
+ # @return [Integer]
1660
+ #
1661
+ # @!attribute [rw] server_root_ca_certificate
1662
+ # The ARN of the Secrets Manager secret used for certification.
1663
+ # @return [String]
1664
+ #
1665
+ # @!attribute [rw] starting_position
1666
+ # (Streams only) The position in a stream from which to start reading.
1667
+ # @return [String]
1668
+ #
1669
+ # @!attribute [rw] topic_name
1670
+ # The name of the topic that the pipe will read from.
1671
+ # @return [String]
1672
+ #
1673
+ # @!attribute [rw] vpc
1674
+ # This structure specifies the VPC subnets and security groups for the
1675
+ # stream, and whether a public IP address is to be used.
1676
+ # @return [Types::SelfManagedKafkaAccessConfigurationVpc]
1677
+ #
1678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeSourceSelfManagedKafkaParameters AWS API Documentation
1679
+ #
1680
+ class PipeSourceSelfManagedKafkaParameters < Struct.new(
1681
+ :additional_bootstrap_servers,
1682
+ :batch_size,
1683
+ :consumer_group_id,
1684
+ :credentials,
1685
+ :maximum_batching_window_in_seconds,
1686
+ :server_root_ca_certificate,
1687
+ :starting_position,
1688
+ :topic_name,
1689
+ :vpc)
1690
+ SENSITIVE = [:consumer_group_id, :topic_name]
1691
+ include Aws::Structure
1692
+ end
1693
+
1694
+ # The parameters for using a Amazon SQS stream as a source.
1695
+ #
1696
+ # @!attribute [rw] batch_size
1697
+ # The maximum number of records to include in each batch.
1698
+ # @return [Integer]
1699
+ #
1700
+ # @!attribute [rw] maximum_batching_window_in_seconds
1701
+ # The maximum length of a time to wait for events.
1702
+ # @return [Integer]
1703
+ #
1704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeSourceSqsQueueParameters AWS API Documentation
1705
+ #
1706
+ class PipeSourceSqsQueueParameters < Struct.new(
1707
+ :batch_size,
1708
+ :maximum_batching_window_in_seconds)
1709
+ SENSITIVE = []
1710
+ include Aws::Structure
1711
+ end
1712
+
1713
+ # The parameters for using an Batch job as a target.
1714
+ #
1715
+ # @!attribute [rw] array_properties
1716
+ # The array properties for the submitted job, such as the size of the
1717
+ # array. The array size can be between 2 and 10,000. If you specify
1718
+ # array properties for a job, it becomes an array job. This parameter
1719
+ # is used only if the target is an Batch job.
1720
+ # @return [Types::BatchArrayProperties]
1721
+ #
1722
+ # @!attribute [rw] container_overrides
1723
+ # The overrides that are sent to a container.
1724
+ # @return [Types::BatchContainerOverrides]
1725
+ #
1726
+ # @!attribute [rw] depends_on
1727
+ # A list of dependencies for the job. A job can depend upon a maximum
1728
+ # of 20 jobs. You can specify a `SEQUENTIAL` type dependency without
1729
+ # specifying a job ID for array jobs so that each child array job
1730
+ # completes sequentially, starting at index 0. You can also specify an
1731
+ # `N_TO_N` type dependency with a job ID for array jobs. In that case,
1732
+ # each index child of this job must wait for the corresponding index
1733
+ # child of each dependency to complete before it can begin.
1734
+ # @return [Array<Types::BatchJobDependency>]
1735
+ #
1736
+ # @!attribute [rw] job_definition
1737
+ # The job definition used by this job. This value can be one of
1738
+ # `name`, `name:revision`, or the Amazon Resource Name (ARN) for the
1739
+ # job definition. If name is specified without a revision then the
1740
+ # latest active revision is used.
1741
+ # @return [String]
1742
+ #
1743
+ # @!attribute [rw] job_name
1744
+ # The name of the job. It can be up to 128 letters long. The first
1745
+ # character must be alphanumeric, can contain uppercase and lowercase
1746
+ # letters, numbers, hyphens (-), and underscores (\_).
1747
+ # @return [String]
1748
+ #
1749
+ # @!attribute [rw] parameters
1750
+ # Additional parameters passed to the job that replace parameter
1751
+ # substitution placeholders that are set in the job definition.
1752
+ # Parameters are specified as a key and value pair mapping. Parameters
1753
+ # included here override any corresponding parameter defaults from the
1754
+ # job definition.
1755
+ # @return [Hash<String,String>]
1756
+ #
1757
+ # @!attribute [rw] retry_strategy
1758
+ # The retry strategy to use for failed jobs. When a retry strategy is
1759
+ # specified here, it overrides the retry strategy defined in the job
1760
+ # definition.
1761
+ # @return [Types::BatchRetryStrategy]
1762
+ #
1763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetBatchJobParameters AWS API Documentation
1764
+ #
1765
+ class PipeTargetBatchJobParameters < Struct.new(
1766
+ :array_properties,
1767
+ :container_overrides,
1768
+ :depends_on,
1769
+ :job_definition,
1770
+ :job_name,
1771
+ :parameters,
1772
+ :retry_strategy)
1773
+ SENSITIVE = []
1774
+ include Aws::Structure
1775
+ end
1776
+
1777
+ # The parameters for using an CloudWatch Logs log stream as a target.
1778
+ #
1779
+ # @!attribute [rw] log_stream_name
1780
+ # The name of the log stream.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] timestamp
1784
+ # The time the event occurred, expressed as the number of milliseconds
1785
+ # after Jan 1, 1970 00:00:00 UTC.
1786
+ # @return [String]
1787
+ #
1788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetCloudWatchLogsParameters AWS API Documentation
1789
+ #
1790
+ class PipeTargetCloudWatchLogsParameters < Struct.new(
1791
+ :log_stream_name,
1792
+ :timestamp)
1793
+ SENSITIVE = []
1794
+ include Aws::Structure
1795
+ end
1796
+
1797
+ # The parameters for using an Amazon ECS task as a target.
1798
+ #
1799
+ # @!attribute [rw] capacity_provider_strategy
1800
+ # The capacity provider strategy to use for the task.
1801
+ #
1802
+ # If a `capacityProviderStrategy` is specified, the `launchType`
1803
+ # parameter must be omitted. If no `capacityProviderStrategy` or
1804
+ # launchType is specified, the `defaultCapacityProviderStrategy` for
1805
+ # the cluster is used.
1806
+ # @return [Array<Types::CapacityProviderStrategyItem>]
1807
+ #
1808
+ # @!attribute [rw] enable_ecs_managed_tags
1809
+ # Specifies whether to enable Amazon ECS managed tags for the task.
1810
+ # For more information, see [Tagging Your Amazon ECS Resources][1] in
1811
+ # the Amazon Elastic Container Service Developer Guide.
1812
+ #
1813
+ #
1814
+ #
1815
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
1816
+ # @return [Boolean]
1817
+ #
1818
+ # @!attribute [rw] enable_execute_command
1819
+ # Whether or not to enable the execute command functionality for the
1820
+ # containers in this task. If true, this enables execute command
1821
+ # functionality on all containers in the task.
1822
+ # @return [Boolean]
1823
+ #
1824
+ # @!attribute [rw] group
1825
+ # Specifies an Amazon ECS task group for the task. The maximum length
1826
+ # is 255 characters.
1827
+ # @return [String]
1828
+ #
1829
+ # @!attribute [rw] launch_type
1830
+ # Specifies the launch type on which your task is running. The launch
1831
+ # type that you specify here must match one of the launch type
1832
+ # (compatibilities) of the target task. The `FARGATE` value is
1833
+ # supported only in the Regions where Fargate with Amazon ECS is
1834
+ # supported. For more information, see [Fargate on Amazon ECS][1] in
1835
+ # the *Amazon Elastic Container Service Developer Guide*.
1836
+ #
1837
+ #
1838
+ #
1839
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html
1840
+ # @return [String]
1841
+ #
1842
+ # @!attribute [rw] network_configuration
1843
+ # Use this structure if the Amazon ECS task uses the `awsvpc` network
1844
+ # mode. This structure specifies the VPC subnets and security groups
1845
+ # associated with the task, and whether a public IP address is to be
1846
+ # used. This structure is required if `LaunchType` is `FARGATE`
1847
+ # because the `awsvpc` mode is required for Fargate tasks.
1848
+ #
1849
+ # If you specify `NetworkConfiguration` when the target ECS task does
1850
+ # not use the `awsvpc` network mode, the task fails.
1851
+ # @return [Types::NetworkConfiguration]
1852
+ #
1853
+ # @!attribute [rw] overrides
1854
+ # The overrides that are associated with a task.
1855
+ # @return [Types::EcsTaskOverride]
1856
+ #
1857
+ # @!attribute [rw] placement_constraints
1858
+ # An array of placement constraint objects to use for the task. You
1859
+ # can specify up to 10 constraints per task (including constraints in
1860
+ # the task definition and those specified at runtime).
1861
+ # @return [Array<Types::PlacementConstraint>]
1862
+ #
1863
+ # @!attribute [rw] placement_strategy
1864
+ # The placement strategy objects to use for the task. You can specify
1865
+ # a maximum of five strategy rules per task.
1866
+ # @return [Array<Types::PlacementStrategy>]
1867
+ #
1868
+ # @!attribute [rw] platform_version
1869
+ # Specifies the platform version for the task. Specify only the
1870
+ # numeric portion of the platform version, such as `1.1.0`.
1871
+ #
1872
+ # This structure is used only if `LaunchType` is `FARGATE`. For more
1873
+ # information about valid platform versions, see [Fargate Platform
1874
+ # Versions][1] in the *Amazon Elastic Container Service Developer
1875
+ # Guide*.
1876
+ #
1877
+ #
1878
+ #
1879
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
1880
+ # @return [String]
1881
+ #
1882
+ # @!attribute [rw] propagate_tags
1883
+ # Specifies whether to propagate the tags from the task definition to
1884
+ # the task. If no value is specified, the tags are not propagated.
1885
+ # Tags can only be propagated to the task during task creation. To add
1886
+ # tags to a task after task creation, use the `TagResource` API
1887
+ # action.
1888
+ # @return [String]
1889
+ #
1890
+ # @!attribute [rw] reference_id
1891
+ # The reference ID to use for the task.
1892
+ # @return [String]
1893
+ #
1894
+ # @!attribute [rw] tags
1895
+ # The metadata that you apply to the task to help you categorize and
1896
+ # organize them. Each tag consists of a key and an optional value,
1897
+ # both of which you define. To learn more, see [RunTask][1] in the
1898
+ # Amazon ECS API Reference.
1899
+ #
1900
+ #
1901
+ #
1902
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags
1903
+ # @return [Array<Types::Tag>]
1904
+ #
1905
+ # @!attribute [rw] task_count
1906
+ # The number of tasks to create based on `TaskDefinition`. The default
1907
+ # is 1.
1908
+ # @return [Integer]
1909
+ #
1910
+ # @!attribute [rw] task_definition_arn
1911
+ # The ARN of the task definition to use if the event target is an
1912
+ # Amazon ECS task.
1913
+ # @return [String]
1914
+ #
1915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetEcsTaskParameters AWS API Documentation
1916
+ #
1917
+ class PipeTargetEcsTaskParameters < Struct.new(
1918
+ :capacity_provider_strategy,
1919
+ :enable_ecs_managed_tags,
1920
+ :enable_execute_command,
1921
+ :group,
1922
+ :launch_type,
1923
+ :network_configuration,
1924
+ :overrides,
1925
+ :placement_constraints,
1926
+ :placement_strategy,
1927
+ :platform_version,
1928
+ :propagate_tags,
1929
+ :reference_id,
1930
+ :tags,
1931
+ :task_count,
1932
+ :task_definition_arn)
1933
+ SENSITIVE = [:reference_id]
1934
+ include Aws::Structure
1935
+ end
1936
+
1937
+ # The parameters for using an EventBridge event bus as a target.
1938
+ #
1939
+ # @!attribute [rw] detail_type
1940
+ # A free-form string, with a maximum of 128 characters, used to decide
1941
+ # what fields to expect in the event detail.
1942
+ # @return [String]
1943
+ #
1944
+ # @!attribute [rw] endpoint_id
1945
+ # The URL subdomain of the endpoint. For example, if the URL for
1946
+ # Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then
1947
+ # the EndpointId is `abcde.veo`.
1948
+ #
1949
+ # When using Java, you must include `auth-crt` on the class path.
1950
+ # @return [String]
1951
+ #
1952
+ # @!attribute [rw] resources
1953
+ # Amazon Web Services resources, identified by Amazon Resource Name
1954
+ # (ARN), which the event primarily concerns. Any number, including
1955
+ # zero, may be present.
1956
+ # @return [Array<String>]
1957
+ #
1958
+ # @!attribute [rw] source
1959
+ # The source of the event.
1960
+ # @return [String]
1961
+ #
1962
+ # @!attribute [rw] time
1963
+ # The time stamp of the event, per [RFC3339][1]. If no time stamp is
1964
+ # provided, the time stamp of the [PutEvents][2] call is used.
1965
+ #
1966
+ #
1967
+ #
1968
+ # [1]: https://www.rfc-editor.org/rfc/rfc3339.txt
1969
+ # [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html
1970
+ # @return [String]
1971
+ #
1972
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetEventBridgeEventBusParameters AWS API Documentation
1973
+ #
1974
+ class PipeTargetEventBridgeEventBusParameters < Struct.new(
1975
+ :detail_type,
1976
+ :endpoint_id,
1977
+ :resources,
1978
+ :source,
1979
+ :time)
1980
+ SENSITIVE = [:detail_type, :endpoint_id, :source]
1981
+ include Aws::Structure
1982
+ end
1983
+
1984
+ # These are custom parameter to be used when the target is an API
1985
+ # Gateway REST APIs or EventBridge ApiDestinations.
1986
+ #
1987
+ # @!attribute [rw] header_parameters
1988
+ # The headers that need to be sent as part of request invoking the API
1989
+ # Gateway REST API or EventBridge ApiDestination.
1990
+ # @return [Hash<String,String>]
1991
+ #
1992
+ # @!attribute [rw] path_parameter_values
1993
+ # The path parameter values to be used to populate API Gateway REST
1994
+ # API or EventBridge ApiDestination path wildcards ("*").
1995
+ # @return [Array<String>]
1996
+ #
1997
+ # @!attribute [rw] query_string_parameters
1998
+ # The query string keys/values that need to be sent as part of request
1999
+ # invoking the API Gateway REST API or EventBridge ApiDestination.
2000
+ # @return [Hash<String,String>]
2001
+ #
2002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetHttpParameters AWS API Documentation
2003
+ #
2004
+ class PipeTargetHttpParameters < Struct.new(
2005
+ :header_parameters,
2006
+ :path_parameter_values,
2007
+ :query_string_parameters)
2008
+ SENSITIVE = []
2009
+ include Aws::Structure
2010
+ end
2011
+
2012
+ # The parameters for using a Kinesis stream as a source.
2013
+ #
2014
+ # @!attribute [rw] partition_key
2015
+ # Determines which shard in the stream the data record is assigned to.
2016
+ # Partition keys are Unicode strings with a maximum length limit of
2017
+ # 256 characters for each key. Amazon Kinesis Data Streams uses the
2018
+ # partition key as input to a hash function that maps the partition
2019
+ # key and associated data to a specific shard. Specifically, an MD5
2020
+ # hash function is used to map partition keys to 128-bit integer
2021
+ # values and to map associated data records to shards. As a result of
2022
+ # this hashing mechanism, all data records with the same partition key
2023
+ # map to the same shard within the stream.
2024
+ # @return [String]
2025
+ #
2026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetKinesisStreamParameters AWS API Documentation
2027
+ #
2028
+ class PipeTargetKinesisStreamParameters < Struct.new(
2029
+ :partition_key)
2030
+ SENSITIVE = [:partition_key]
2031
+ include Aws::Structure
2032
+ end
2033
+
2034
+ # The parameters for using a Lambda function as a target.
2035
+ #
2036
+ # @!attribute [rw] invocation_type
2037
+ # Choose from the following options.
2038
+ #
2039
+ # * `RequestResponse` (default) - Invoke the function synchronously.
2040
+ # Keep the connection open until the function returns a response or
2041
+ # times out. The API response includes the function response and
2042
+ # additional data.
2043
+ #
2044
+ # * `Event` - Invoke the function asynchronously. Send events that
2045
+ # fail multiple times to the function's dead-letter queue (if it's
2046
+ # configured). The API response only includes a status code.
2047
+ #
2048
+ # * `DryRun` - Validate parameter values and verify that the user or
2049
+ # role has permission to invoke the function.
2050
+ # @return [String]
2051
+ #
2052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetLambdaFunctionParameters AWS API Documentation
2053
+ #
2054
+ class PipeTargetLambdaFunctionParameters < Struct.new(
2055
+ :invocation_type)
2056
+ SENSITIVE = []
2057
+ include Aws::Structure
2058
+ end
2059
+
2060
+ # The parameters required to set up a target for your pipe.
2061
+ #
2062
+ # @!attribute [rw] batch_job_parameters
2063
+ # The parameters for using an Batch job as a target.
2064
+ # @return [Types::PipeTargetBatchJobParameters]
2065
+ #
2066
+ # @!attribute [rw] cloud_watch_logs_parameters
2067
+ # The parameters for using an CloudWatch Logs log stream as a target.
2068
+ # @return [Types::PipeTargetCloudWatchLogsParameters]
2069
+ #
2070
+ # @!attribute [rw] ecs_task_parameters
2071
+ # The parameters for using an Amazon ECS task as a target.
2072
+ # @return [Types::PipeTargetEcsTaskParameters]
2073
+ #
2074
+ # @!attribute [rw] event_bridge_event_bus_parameters
2075
+ # The parameters for using an EventBridge event bus as a target.
2076
+ # @return [Types::PipeTargetEventBridgeEventBusParameters]
2077
+ #
2078
+ # @!attribute [rw] http_parameters
2079
+ # These are custom parameter to be used when the target is an API
2080
+ # Gateway REST APIs or EventBridge ApiDestinations.
2081
+ # @return [Types::PipeTargetHttpParameters]
2082
+ #
2083
+ # @!attribute [rw] input_template
2084
+ # Valid JSON text passed to the target. In this case, nothing from the
2085
+ # event itself is passed to the target. For more information, see [The
2086
+ # JavaScript Object Notation (JSON) Data Interchange Format][1].
2087
+ #
2088
+ #
2089
+ #
2090
+ # [1]: http://www.rfc-editor.org/rfc/rfc7159.txt
2091
+ # @return [String]
2092
+ #
2093
+ # @!attribute [rw] kinesis_stream_parameters
2094
+ # The parameters for using a Kinesis stream as a source.
2095
+ # @return [Types::PipeTargetKinesisStreamParameters]
2096
+ #
2097
+ # @!attribute [rw] lambda_function_parameters
2098
+ # The parameters for using a Lambda function as a target.
2099
+ # @return [Types::PipeTargetLambdaFunctionParameters]
2100
+ #
2101
+ # @!attribute [rw] redshift_data_parameters
2102
+ # These are custom parameters to be used when the target is a Amazon
2103
+ # Redshift cluster to invoke the Amazon Redshift Data API
2104
+ # ExecuteStatement.
2105
+ # @return [Types::PipeTargetRedshiftDataParameters]
2106
+ #
2107
+ # @!attribute [rw] sage_maker_pipeline_parameters
2108
+ # The parameters for using a SageMaker pipeline as a target.
2109
+ # @return [Types::PipeTargetSageMakerPipelineParameters]
2110
+ #
2111
+ # @!attribute [rw] sqs_queue_parameters
2112
+ # The parameters for using a Amazon SQS stream as a source.
2113
+ # @return [Types::PipeTargetSqsQueueParameters]
2114
+ #
2115
+ # @!attribute [rw] step_function_state_machine_parameters
2116
+ # The parameters for using a Step Functions state machine as a target.
2117
+ # @return [Types::PipeTargetStateMachineParameters]
2118
+ #
2119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetParameters AWS API Documentation
2120
+ #
2121
+ class PipeTargetParameters < Struct.new(
2122
+ :batch_job_parameters,
2123
+ :cloud_watch_logs_parameters,
2124
+ :ecs_task_parameters,
2125
+ :event_bridge_event_bus_parameters,
2126
+ :http_parameters,
2127
+ :input_template,
2128
+ :kinesis_stream_parameters,
2129
+ :lambda_function_parameters,
2130
+ :redshift_data_parameters,
2131
+ :sage_maker_pipeline_parameters,
2132
+ :sqs_queue_parameters,
2133
+ :step_function_state_machine_parameters)
2134
+ SENSITIVE = [:input_template]
2135
+ include Aws::Structure
2136
+ end
2137
+
2138
+ # These are custom parameters to be used when the target is a Amazon
2139
+ # Redshift cluster to invoke the Amazon Redshift Data API
2140
+ # ExecuteStatement.
2141
+ #
2142
+ # @!attribute [rw] database
2143
+ # The name of the database. Required when authenticating using
2144
+ # temporary credentials.
2145
+ # @return [String]
2146
+ #
2147
+ # @!attribute [rw] db_user
2148
+ # The database user name. Required when authenticating using temporary
2149
+ # credentials.
2150
+ # @return [String]
2151
+ #
2152
+ # @!attribute [rw] secret_manager_arn
2153
+ # The name or ARN of the secret that enables access to the database.
2154
+ # Required when authenticating using SageMaker.
2155
+ # @return [String]
2156
+ #
2157
+ # @!attribute [rw] sqls
2158
+ # The SQL statement text to run.
2159
+ # @return [Array<String>]
2160
+ #
2161
+ # @!attribute [rw] statement_name
2162
+ # The name of the SQL statement. You can name the SQL statement when
2163
+ # you create it to identify the query.
2164
+ # @return [String]
2165
+ #
2166
+ # @!attribute [rw] with_event
2167
+ # Indicates whether to send an event back to EventBridge after the SQL
2168
+ # statement runs.
2169
+ # @return [Boolean]
2170
+ #
2171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetRedshiftDataParameters AWS API Documentation
2172
+ #
2173
+ class PipeTargetRedshiftDataParameters < Struct.new(
2174
+ :database,
2175
+ :db_user,
2176
+ :secret_manager_arn,
2177
+ :sqls,
2178
+ :statement_name,
2179
+ :with_event)
2180
+ SENSITIVE = [:database, :db_user, :statement_name]
2181
+ include Aws::Structure
2182
+ end
2183
+
2184
+ # The parameters for using a SageMaker pipeline as a target.
2185
+ #
2186
+ # @!attribute [rw] pipeline_parameter_list
2187
+ # List of Parameter names and values for SageMaker Model Building
2188
+ # Pipeline execution.
2189
+ # @return [Array<Types::SageMakerPipelineParameter>]
2190
+ #
2191
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetSageMakerPipelineParameters AWS API Documentation
2192
+ #
2193
+ class PipeTargetSageMakerPipelineParameters < Struct.new(
2194
+ :pipeline_parameter_list)
2195
+ SENSITIVE = []
2196
+ include Aws::Structure
2197
+ end
2198
+
2199
+ # The parameters for using a Amazon SQS stream as a source.
2200
+ #
2201
+ # @!attribute [rw] message_deduplication_id
2202
+ # This parameter applies only to FIFO (first-in-first-out) queues.
2203
+ #
2204
+ # The token used for deduplication of sent messages.
2205
+ # @return [String]
2206
+ #
2207
+ # @!attribute [rw] message_group_id
2208
+ # The FIFO message group ID to use as the target.
2209
+ # @return [String]
2210
+ #
2211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetSqsQueueParameters AWS API Documentation
2212
+ #
2213
+ class PipeTargetSqsQueueParameters < Struct.new(
2214
+ :message_deduplication_id,
2215
+ :message_group_id)
2216
+ SENSITIVE = [:message_deduplication_id, :message_group_id]
2217
+ include Aws::Structure
2218
+ end
2219
+
2220
+ # The parameters for using a Step Functions state machine as a target.
2221
+ #
2222
+ # @!attribute [rw] invocation_type
2223
+ # Specify whether to wait for the state machine to finish or not.
2224
+ # @return [String]
2225
+ #
2226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PipeTargetStateMachineParameters AWS API Documentation
2227
+ #
2228
+ class PipeTargetStateMachineParameters < Struct.new(
2229
+ :invocation_type)
2230
+ SENSITIVE = []
2231
+ include Aws::Structure
2232
+ end
2233
+
2234
+ # An object representing a constraint on task placement. To learn more,
2235
+ # see [Task Placement Constraints][1] in the Amazon Elastic Container
2236
+ # Service Developer Guide.
2237
+ #
2238
+ #
2239
+ #
2240
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html
2241
+ #
2242
+ # @!attribute [rw] expression
2243
+ # A cluster query language expression to apply to the constraint. You
2244
+ # cannot specify an expression if the constraint type is
2245
+ # `distinctInstance`. To learn more, see [Cluster Query Language][1]
2246
+ # in the Amazon Elastic Container Service Developer Guide.
2247
+ #
2248
+ #
2249
+ #
2250
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html
2251
+ # @return [String]
2252
+ #
2253
+ # @!attribute [rw] type
2254
+ # The type of constraint. Use distinctInstance to ensure that each
2255
+ # task in a particular group is running on a different container
2256
+ # instance. Use memberOf to restrict the selection to a group of valid
2257
+ # candidates.
2258
+ # @return [String]
2259
+ #
2260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PlacementConstraint AWS API Documentation
2261
+ #
2262
+ class PlacementConstraint < Struct.new(
2263
+ :expression,
2264
+ :type)
2265
+ SENSITIVE = [:expression]
2266
+ include Aws::Structure
2267
+ end
2268
+
2269
+ # The task placement strategy for a task or service. To learn more, see
2270
+ # [Task Placement Strategies][1] in the Amazon Elastic Container Service
2271
+ # Service Developer Guide.
2272
+ #
2273
+ #
2274
+ #
2275
+ # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html
2276
+ #
2277
+ # @!attribute [rw] field
2278
+ # The field to apply the placement strategy against. For the spread
2279
+ # placement strategy, valid values are instanceId (or host, which has
2280
+ # the same effect), or any platform or custom attribute that is
2281
+ # applied to a container instance, such as
2282
+ # attribute:ecs.availability-zone. For the binpack placement strategy,
2283
+ # valid values are cpu and memory. For the random placement strategy,
2284
+ # this field is not used.
2285
+ # @return [String]
2286
+ #
2287
+ # @!attribute [rw] type
2288
+ # The type of placement strategy. The random placement strategy
2289
+ # randomly places tasks on available candidates. The spread placement
2290
+ # strategy spreads placement across available candidates evenly based
2291
+ # on the field parameter. The binpack strategy places tasks on
2292
+ # available candidates that have the least available amount of the
2293
+ # resource that is specified with the field parameter. For example, if
2294
+ # you binpack on memory, a task is placed on the instance with the
2295
+ # least amount of remaining memory (but still enough to run the task).
2296
+ # @return [String]
2297
+ #
2298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/PlacementStrategy AWS API Documentation
2299
+ #
2300
+ class PlacementStrategy < Struct.new(
2301
+ :field,
2302
+ :type)
2303
+ SENSITIVE = [:field]
2304
+ include Aws::Structure
2305
+ end
2306
+
2307
+ # Name/Value pair of a parameter to start execution of a SageMaker Model
2308
+ # Building Pipeline.
2309
+ #
2310
+ # @!attribute [rw] name
2311
+ # Name of parameter to start execution of a SageMaker Model Building
2312
+ # Pipeline.
2313
+ # @return [String]
2314
+ #
2315
+ # @!attribute [rw] value
2316
+ # Value of parameter to start execution of a SageMaker Model Building
2317
+ # Pipeline.
2318
+ # @return [String]
2319
+ #
2320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/SageMakerPipelineParameter AWS API Documentation
2321
+ #
2322
+ class SageMakerPipelineParameter < Struct.new(
2323
+ :name,
2324
+ :value)
2325
+ SENSITIVE = [:name, :value]
2326
+ include Aws::Structure
2327
+ end
2328
+
2329
+ # The Secrets Manager secret that stores your stream credentials.
2330
+ #
2331
+ # @!attribute [rw] basic_auth
2332
+ # The ARN of the Secrets Manager secret.
2333
+ # @return [String]
2334
+ #
2335
+ # @!attribute [rw] client_certificate_tls_auth
2336
+ # The ARN of the Secrets Manager secret.
2337
+ # @return [String]
2338
+ #
2339
+ # @!attribute [rw] sasl_scram_256_auth
2340
+ # The ARN of the Secrets Manager secret.
2341
+ # @return [String]
2342
+ #
2343
+ # @!attribute [rw] sasl_scram_512_auth
2344
+ # The ARN of the Secrets Manager secret.
2345
+ # @return [String]
2346
+ #
2347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/SelfManagedKafkaAccessConfigurationCredentials AWS API Documentation
2348
+ #
2349
+ class SelfManagedKafkaAccessConfigurationCredentials < Struct.new(
2350
+ :basic_auth,
2351
+ :client_certificate_tls_auth,
2352
+ :sasl_scram_256_auth,
2353
+ :sasl_scram_512_auth,
2354
+ :unknown)
2355
+ SENSITIVE = []
2356
+ include Aws::Structure
2357
+ include Aws::Structure::Union
2358
+
2359
+ class BasicAuth < SelfManagedKafkaAccessConfigurationCredentials; end
2360
+ class ClientCertificateTlsAuth < SelfManagedKafkaAccessConfigurationCredentials; end
2361
+ class SaslScram256Auth < SelfManagedKafkaAccessConfigurationCredentials; end
2362
+ class SaslScram512Auth < SelfManagedKafkaAccessConfigurationCredentials; end
2363
+ class Unknown < SelfManagedKafkaAccessConfigurationCredentials; end
2364
+ end
2365
+
2366
+ # This structure specifies the VPC subnets and security groups for the
2367
+ # stream, and whether a public IP address is to be used.
2368
+ #
2369
+ # @!attribute [rw] security_group
2370
+ # Specifies the security groups associated with the stream. These
2371
+ # security groups must all be in the same VPC. You can specify as many
2372
+ # as five security groups. If you do not specify a security group, the
2373
+ # default security group for the VPC is used.
2374
+ # @return [Array<String>]
2375
+ #
2376
+ # @!attribute [rw] subnets
2377
+ # Specifies the subnets associated with the stream. These subnets must
2378
+ # all be in the same VPC. You can specify as many as 16 subnets.
2379
+ # @return [Array<String>]
2380
+ #
2381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/SelfManagedKafkaAccessConfigurationVpc AWS API Documentation
2382
+ #
2383
+ class SelfManagedKafkaAccessConfigurationVpc < Struct.new(
2384
+ :security_group,
2385
+ :subnets)
2386
+ SENSITIVE = []
2387
+ include Aws::Structure
2388
+ end
2389
+
2390
+ # A quota has been exceeded.
2391
+ #
2392
+ # @!attribute [rw] message
2393
+ # @return [String]
2394
+ #
2395
+ # @!attribute [rw] quota_code
2396
+ # The identifier of the quota that caused the exception.
2397
+ # @return [String]
2398
+ #
2399
+ # @!attribute [rw] resource_id
2400
+ # The ID of the resource that caused the exception.
2401
+ # @return [String]
2402
+ #
2403
+ # @!attribute [rw] resource_type
2404
+ # The type of resource that caused the exception.
2405
+ # @return [String]
2406
+ #
2407
+ # @!attribute [rw] service_code
2408
+ # The identifier of the service that caused the exception.
2409
+ # @return [String]
2410
+ #
2411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ServiceQuotaExceededException AWS API Documentation
2412
+ #
2413
+ class ServiceQuotaExceededException < Struct.new(
2414
+ :message,
2415
+ :quota_code,
2416
+ :resource_id,
2417
+ :resource_type,
2418
+ :service_code)
2419
+ SENSITIVE = []
2420
+ include Aws::Structure
2421
+ end
2422
+
2423
+ # @!attribute [rw] name
2424
+ # The name of the pipe.
2425
+ # @return [String]
2426
+ #
2427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/StartPipeRequest AWS API Documentation
2428
+ #
2429
+ class StartPipeRequest < Struct.new(
2430
+ :name)
2431
+ SENSITIVE = []
2432
+ include Aws::Structure
2433
+ end
2434
+
2435
+ # @!attribute [rw] arn
2436
+ # The ARN of the pipe.
2437
+ # @return [String]
2438
+ #
2439
+ # @!attribute [rw] creation_time
2440
+ # The time the pipe was created.
2441
+ # @return [Time]
2442
+ #
2443
+ # @!attribute [rw] current_state
2444
+ # The state the pipe is in.
2445
+ # @return [String]
2446
+ #
2447
+ # @!attribute [rw] desired_state
2448
+ # The state the pipe should be in.
2449
+ # @return [String]
2450
+ #
2451
+ # @!attribute [rw] last_modified_time
2452
+ # When the pipe was last updated, in [ISO-8601 format][1]
2453
+ # (YYYY-MM-DDThh:mm:ss.sTZD).
2454
+ #
2455
+ #
2456
+ #
2457
+ # [1]: https://www.w3.org/TR/NOTE-datetime
2458
+ # @return [Time]
2459
+ #
2460
+ # @!attribute [rw] name
2461
+ # The name of the pipe.
2462
+ # @return [String]
2463
+ #
2464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/StartPipeResponse AWS API Documentation
2465
+ #
2466
+ class StartPipeResponse < Struct.new(
2467
+ :arn,
2468
+ :creation_time,
2469
+ :current_state,
2470
+ :desired_state,
2471
+ :last_modified_time,
2472
+ :name)
2473
+ SENSITIVE = []
2474
+ include Aws::Structure
2475
+ end
2476
+
2477
+ # @!attribute [rw] name
2478
+ # The name of the pipe.
2479
+ # @return [String]
2480
+ #
2481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/StopPipeRequest AWS API Documentation
2482
+ #
2483
+ class StopPipeRequest < Struct.new(
2484
+ :name)
2485
+ SENSITIVE = []
2486
+ include Aws::Structure
2487
+ end
2488
+
2489
+ # @!attribute [rw] arn
2490
+ # The ARN of the pipe.
2491
+ # @return [String]
2492
+ #
2493
+ # @!attribute [rw] creation_time
2494
+ # The time the pipe was created.
2495
+ # @return [Time]
2496
+ #
2497
+ # @!attribute [rw] current_state
2498
+ # The state the pipe is in.
2499
+ # @return [String]
2500
+ #
2501
+ # @!attribute [rw] desired_state
2502
+ # The state the pipe should be in.
2503
+ # @return [String]
2504
+ #
2505
+ # @!attribute [rw] last_modified_time
2506
+ # When the pipe was last updated, in [ISO-8601 format][1]
2507
+ # (YYYY-MM-DDThh:mm:ss.sTZD).
2508
+ #
2509
+ #
2510
+ #
2511
+ # [1]: https://www.w3.org/TR/NOTE-datetime
2512
+ # @return [Time]
2513
+ #
2514
+ # @!attribute [rw] name
2515
+ # The name of the pipe.
2516
+ # @return [String]
2517
+ #
2518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/StopPipeResponse AWS API Documentation
2519
+ #
2520
+ class StopPipeResponse < Struct.new(
2521
+ :arn,
2522
+ :creation_time,
2523
+ :current_state,
2524
+ :desired_state,
2525
+ :last_modified_time,
2526
+ :name)
2527
+ SENSITIVE = []
2528
+ include Aws::Structure
2529
+ end
2530
+
2531
+ # A key-value pair associated with an Amazon Web Services resource. In
2532
+ # EventBridge, rules and event buses support tagging.
2533
+ #
2534
+ # @!attribute [rw] key
2535
+ # A string you can use to assign a value. The combination of tag keys
2536
+ # and values can help you organize and categorize your resources.
2537
+ # @return [String]
2538
+ #
2539
+ # @!attribute [rw] value
2540
+ # The value for the specified tag key.
2541
+ # @return [String]
2542
+ #
2543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/Tag AWS API Documentation
2544
+ #
2545
+ class Tag < Struct.new(
2546
+ :key,
2547
+ :value)
2548
+ SENSITIVE = [:value]
2549
+ include Aws::Structure
2550
+ end
2551
+
2552
+ # @!attribute [rw] resource_arn
2553
+ # The ARN of the pipe.
2554
+ # @return [String]
2555
+ #
2556
+ # @!attribute [rw] tags
2557
+ # The list of key-value pairs associated with the pipe.
2558
+ # @return [Hash<String,String>]
2559
+ #
2560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/TagResourceRequest AWS API Documentation
2561
+ #
2562
+ class TagResourceRequest < Struct.new(
2563
+ :resource_arn,
2564
+ :tags)
2565
+ SENSITIVE = []
2566
+ include Aws::Structure
2567
+ end
2568
+
2569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/TagResourceResponse AWS API Documentation
2570
+ #
2571
+ class TagResourceResponse < Aws::EmptyStructure; end
2572
+
2573
+ # An action was throttled.
2574
+ #
2575
+ # @!attribute [rw] message
2576
+ # @return [String]
2577
+ #
2578
+ # @!attribute [rw] quota_code
2579
+ # The identifier of the quota that caused the exception.
2580
+ # @return [String]
2581
+ #
2582
+ # @!attribute [rw] retry_after_seconds
2583
+ # The number of seconds to wait before retrying the action that caused
2584
+ # the exception.
2585
+ # @return [Integer]
2586
+ #
2587
+ # @!attribute [rw] service_code
2588
+ # The identifier of the service that caused the exception.
2589
+ # @return [String]
2590
+ #
2591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ThrottlingException AWS API Documentation
2592
+ #
2593
+ class ThrottlingException < Struct.new(
2594
+ :message,
2595
+ :quota_code,
2596
+ :retry_after_seconds,
2597
+ :service_code)
2598
+ SENSITIVE = []
2599
+ include Aws::Structure
2600
+ end
2601
+
2602
+ # @!attribute [rw] resource_arn
2603
+ # The ARN of the pipe.
2604
+ # @return [String]
2605
+ #
2606
+ # @!attribute [rw] tag_keys
2607
+ # The list of tag keys to remove from the pipe.
2608
+ # @return [Array<String>]
2609
+ #
2610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UntagResourceRequest AWS API Documentation
2611
+ #
2612
+ class UntagResourceRequest < Struct.new(
2613
+ :resource_arn,
2614
+ :tag_keys)
2615
+ SENSITIVE = []
2616
+ include Aws::Structure
2617
+ end
2618
+
2619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UntagResourceResponse AWS API Documentation
2620
+ #
2621
+ class UntagResourceResponse < Aws::EmptyStructure; end
2622
+
2623
+ # @!attribute [rw] description
2624
+ # A description of the pipe.
2625
+ # @return [String]
2626
+ #
2627
+ # @!attribute [rw] desired_state
2628
+ # The state the pipe should be in.
2629
+ # @return [String]
2630
+ #
2631
+ # @!attribute [rw] enrichment
2632
+ # The ARN of the enrichment resource.
2633
+ # @return [String]
2634
+ #
2635
+ # @!attribute [rw] enrichment_parameters
2636
+ # The parameters required to set up enrichment on your pipe.
2637
+ # @return [Types::PipeEnrichmentParameters]
2638
+ #
2639
+ # @!attribute [rw] name
2640
+ # The name of the pipe.
2641
+ # @return [String]
2642
+ #
2643
+ # @!attribute [rw] role_arn
2644
+ # The ARN of the role that allows the pipe to send data to the target.
2645
+ # @return [String]
2646
+ #
2647
+ # @!attribute [rw] source_parameters
2648
+ # The parameters required to set up a source for your pipe.
2649
+ # @return [Types::UpdatePipeSourceParameters]
2650
+ #
2651
+ # @!attribute [rw] target
2652
+ # The ARN of the target resource.
2653
+ # @return [String]
2654
+ #
2655
+ # @!attribute [rw] target_parameters
2656
+ # The parameters required to set up a target for your pipe.
2657
+ # @return [Types::PipeTargetParameters]
2658
+ #
2659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeRequest AWS API Documentation
2660
+ #
2661
+ class UpdatePipeRequest < Struct.new(
2662
+ :description,
2663
+ :desired_state,
2664
+ :enrichment,
2665
+ :enrichment_parameters,
2666
+ :name,
2667
+ :role_arn,
2668
+ :source_parameters,
2669
+ :target,
2670
+ :target_parameters)
2671
+ SENSITIVE = [:description]
2672
+ include Aws::Structure
2673
+ end
2674
+
2675
+ # @!attribute [rw] arn
2676
+ # The ARN of the pipe.
2677
+ # @return [String]
2678
+ #
2679
+ # @!attribute [rw] creation_time
2680
+ # The time the pipe was created.
2681
+ # @return [Time]
2682
+ #
2683
+ # @!attribute [rw] current_state
2684
+ # The state the pipe is in.
2685
+ # @return [String]
2686
+ #
2687
+ # @!attribute [rw] desired_state
2688
+ # The state the pipe should be in.
2689
+ # @return [String]
2690
+ #
2691
+ # @!attribute [rw] last_modified_time
2692
+ # When the pipe was last updated, in [ISO-8601 format][1]
2693
+ # (YYYY-MM-DDThh:mm:ss.sTZD).
2694
+ #
2695
+ #
2696
+ #
2697
+ # [1]: https://www.w3.org/TR/NOTE-datetime
2698
+ # @return [Time]
2699
+ #
2700
+ # @!attribute [rw] name
2701
+ # The name of the pipe.
2702
+ # @return [String]
2703
+ #
2704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeResponse AWS API Documentation
2705
+ #
2706
+ class UpdatePipeResponse < Struct.new(
2707
+ :arn,
2708
+ :creation_time,
2709
+ :current_state,
2710
+ :desired_state,
2711
+ :last_modified_time,
2712
+ :name)
2713
+ SENSITIVE = []
2714
+ include Aws::Structure
2715
+ end
2716
+
2717
+ # The parameters for using an Active MQ broker as a source.
2718
+ #
2719
+ # @!attribute [rw] batch_size
2720
+ # The maximum number of records to include in each batch.
2721
+ # @return [Integer]
2722
+ #
2723
+ # @!attribute [rw] credentials
2724
+ # The credentials needed to access the resource.
2725
+ # @return [Types::MQBrokerAccessCredentials]
2726
+ #
2727
+ # @!attribute [rw] maximum_batching_window_in_seconds
2728
+ # The maximum length of a time to wait for events.
2729
+ # @return [Integer]
2730
+ #
2731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeSourceActiveMQBrokerParameters AWS API Documentation
2732
+ #
2733
+ class UpdatePipeSourceActiveMQBrokerParameters < Struct.new(
2734
+ :batch_size,
2735
+ :credentials,
2736
+ :maximum_batching_window_in_seconds)
2737
+ SENSITIVE = []
2738
+ include Aws::Structure
2739
+ end
2740
+
2741
+ # The parameters for using a DynamoDB stream as a source.
2742
+ #
2743
+ # @!attribute [rw] batch_size
2744
+ # The maximum number of records to include in each batch.
2745
+ # @return [Integer]
2746
+ #
2747
+ # @!attribute [rw] dead_letter_config
2748
+ # Define the target queue to send dead-letter queue events to.
2749
+ # @return [Types::DeadLetterConfig]
2750
+ #
2751
+ # @!attribute [rw] maximum_batching_window_in_seconds
2752
+ # The maximum length of a time to wait for events.
2753
+ # @return [Integer]
2754
+ #
2755
+ # @!attribute [rw] maximum_record_age_in_seconds
2756
+ # (Streams only) Discard records older than the specified age. The
2757
+ # default value is -1, which sets the maximum age to infinite. When
2758
+ # the value is set to infinite, EventBridge never discards old
2759
+ # records.
2760
+ # @return [Integer]
2761
+ #
2762
+ # @!attribute [rw] maximum_retry_attempts
2763
+ # (Streams only) Discard records after the specified number of
2764
+ # retries. The default value is -1, which sets the maximum number of
2765
+ # retries to infinite. When MaximumRetryAttempts is infinite,
2766
+ # EventBridge retries failed records until the record expires in the
2767
+ # event source.
2768
+ # @return [Integer]
2769
+ #
2770
+ # @!attribute [rw] on_partial_batch_item_failure
2771
+ # (Streams only) Define how to handle item process failures.
2772
+ # `AUTOMATIC_BISECT` halves each batch and retry each half until all
2773
+ # the records are processed or there is one failed message left in the
2774
+ # batch.
2775
+ # @return [String]
2776
+ #
2777
+ # @!attribute [rw] parallelization_factor
2778
+ # (Streams only) The number of batches to process concurrently from
2779
+ # each shard. The default value is 1.
2780
+ # @return [Integer]
2781
+ #
2782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeSourceDynamoDBStreamParameters AWS API Documentation
2783
+ #
2784
+ class UpdatePipeSourceDynamoDBStreamParameters < Struct.new(
2785
+ :batch_size,
2786
+ :dead_letter_config,
2787
+ :maximum_batching_window_in_seconds,
2788
+ :maximum_record_age_in_seconds,
2789
+ :maximum_retry_attempts,
2790
+ :on_partial_batch_item_failure,
2791
+ :parallelization_factor)
2792
+ SENSITIVE = []
2793
+ include Aws::Structure
2794
+ end
2795
+
2796
+ # The parameters for using a Kinesis stream as a source.
2797
+ #
2798
+ # @!attribute [rw] batch_size
2799
+ # The maximum number of records to include in each batch.
2800
+ # @return [Integer]
2801
+ #
2802
+ # @!attribute [rw] dead_letter_config
2803
+ # Define the target queue to send dead-letter queue events to.
2804
+ # @return [Types::DeadLetterConfig]
2805
+ #
2806
+ # @!attribute [rw] maximum_batching_window_in_seconds
2807
+ # The maximum length of a time to wait for events.
2808
+ # @return [Integer]
2809
+ #
2810
+ # @!attribute [rw] maximum_record_age_in_seconds
2811
+ # (Streams only) Discard records older than the specified age. The
2812
+ # default value is -1, which sets the maximum age to infinite. When
2813
+ # the value is set to infinite, EventBridge never discards old
2814
+ # records.
2815
+ # @return [Integer]
2816
+ #
2817
+ # @!attribute [rw] maximum_retry_attempts
2818
+ # (Streams only) Discard records after the specified number of
2819
+ # retries. The default value is -1, which sets the maximum number of
2820
+ # retries to infinite. When MaximumRetryAttempts is infinite,
2821
+ # EventBridge retries failed records until the record expires in the
2822
+ # event source.
2823
+ # @return [Integer]
2824
+ #
2825
+ # @!attribute [rw] on_partial_batch_item_failure
2826
+ # (Streams only) Define how to handle item process failures.
2827
+ # `AUTOMATIC_BISECT` halves each batch and retry each half until all
2828
+ # the records are processed or there is one failed message left in the
2829
+ # batch.
2830
+ # @return [String]
2831
+ #
2832
+ # @!attribute [rw] parallelization_factor
2833
+ # (Streams only) The number of batches to process concurrently from
2834
+ # each shard. The default value is 1.
2835
+ # @return [Integer]
2836
+ #
2837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeSourceKinesisStreamParameters AWS API Documentation
2838
+ #
2839
+ class UpdatePipeSourceKinesisStreamParameters < Struct.new(
2840
+ :batch_size,
2841
+ :dead_letter_config,
2842
+ :maximum_batching_window_in_seconds,
2843
+ :maximum_record_age_in_seconds,
2844
+ :maximum_retry_attempts,
2845
+ :on_partial_batch_item_failure,
2846
+ :parallelization_factor)
2847
+ SENSITIVE = []
2848
+ include Aws::Structure
2849
+ end
2850
+
2851
+ # The parameters for using an MSK stream as a source.
2852
+ #
2853
+ # @!attribute [rw] batch_size
2854
+ # The maximum number of records to include in each batch.
2855
+ # @return [Integer]
2856
+ #
2857
+ # @!attribute [rw] credentials
2858
+ # The credentials needed to access the resource.
2859
+ # @return [Types::MSKAccessCredentials]
2860
+ #
2861
+ # @!attribute [rw] maximum_batching_window_in_seconds
2862
+ # The maximum length of a time to wait for events.
2863
+ # @return [Integer]
2864
+ #
2865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeSourceManagedStreamingKafkaParameters AWS API Documentation
2866
+ #
2867
+ class UpdatePipeSourceManagedStreamingKafkaParameters < Struct.new(
2868
+ :batch_size,
2869
+ :credentials,
2870
+ :maximum_batching_window_in_seconds)
2871
+ SENSITIVE = []
2872
+ include Aws::Structure
2873
+ end
2874
+
2875
+ # The parameters required to set up a source for your pipe.
2876
+ #
2877
+ # @!attribute [rw] active_mq_broker_parameters
2878
+ # The parameters for using an Active MQ broker as a source.
2879
+ # @return [Types::UpdatePipeSourceActiveMQBrokerParameters]
2880
+ #
2881
+ # @!attribute [rw] dynamo_db_stream_parameters
2882
+ # The parameters for using a DynamoDB stream as a source.
2883
+ # @return [Types::UpdatePipeSourceDynamoDBStreamParameters]
2884
+ #
2885
+ # @!attribute [rw] filter_criteria
2886
+ # The collection of event patterns used to filter events. For more
2887
+ # information, see [Events and Event Patterns][1] in the *Amazon
2888
+ # EventBridge User Guide*.
2889
+ #
2890
+ #
2891
+ #
2892
+ # [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
2893
+ # @return [Types::FilterCriteria]
2894
+ #
2895
+ # @!attribute [rw] kinesis_stream_parameters
2896
+ # The parameters for using a Kinesis stream as a source.
2897
+ # @return [Types::UpdatePipeSourceKinesisStreamParameters]
2898
+ #
2899
+ # @!attribute [rw] managed_streaming_kafka_parameters
2900
+ # The parameters for using an MSK stream as a source.
2901
+ # @return [Types::UpdatePipeSourceManagedStreamingKafkaParameters]
2902
+ #
2903
+ # @!attribute [rw] rabbit_mq_broker_parameters
2904
+ # The parameters for using a Rabbit MQ broker as a source.
2905
+ # @return [Types::UpdatePipeSourceRabbitMQBrokerParameters]
2906
+ #
2907
+ # @!attribute [rw] self_managed_kafka_parameters
2908
+ # The parameters for using a self-managed Apache Kafka stream as a
2909
+ # source.
2910
+ # @return [Types::UpdatePipeSourceSelfManagedKafkaParameters]
2911
+ #
2912
+ # @!attribute [rw] sqs_queue_parameters
2913
+ # The parameters for using a Amazon SQS stream as a source.
2914
+ # @return [Types::UpdatePipeSourceSqsQueueParameters]
2915
+ #
2916
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeSourceParameters AWS API Documentation
2917
+ #
2918
+ class UpdatePipeSourceParameters < Struct.new(
2919
+ :active_mq_broker_parameters,
2920
+ :dynamo_db_stream_parameters,
2921
+ :filter_criteria,
2922
+ :kinesis_stream_parameters,
2923
+ :managed_streaming_kafka_parameters,
2924
+ :rabbit_mq_broker_parameters,
2925
+ :self_managed_kafka_parameters,
2926
+ :sqs_queue_parameters)
2927
+ SENSITIVE = []
2928
+ include Aws::Structure
2929
+ end
2930
+
2931
+ # The parameters for using a Rabbit MQ broker as a source.
2932
+ #
2933
+ # @!attribute [rw] batch_size
2934
+ # The maximum number of records to include in each batch.
2935
+ # @return [Integer]
2936
+ #
2937
+ # @!attribute [rw] credentials
2938
+ # The credentials needed to access the resource.
2939
+ # @return [Types::MQBrokerAccessCredentials]
2940
+ #
2941
+ # @!attribute [rw] maximum_batching_window_in_seconds
2942
+ # The maximum length of a time to wait for events.
2943
+ # @return [Integer]
2944
+ #
2945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeSourceRabbitMQBrokerParameters AWS API Documentation
2946
+ #
2947
+ class UpdatePipeSourceRabbitMQBrokerParameters < Struct.new(
2948
+ :batch_size,
2949
+ :credentials,
2950
+ :maximum_batching_window_in_seconds)
2951
+ SENSITIVE = []
2952
+ include Aws::Structure
2953
+ end
2954
+
2955
+ # The parameters for using a self-managed Apache Kafka stream as a
2956
+ # source.
2957
+ #
2958
+ # @!attribute [rw] batch_size
2959
+ # The maximum number of records to include in each batch.
2960
+ # @return [Integer]
2961
+ #
2962
+ # @!attribute [rw] credentials
2963
+ # The credentials needed to access the resource.
2964
+ # @return [Types::SelfManagedKafkaAccessConfigurationCredentials]
2965
+ #
2966
+ # @!attribute [rw] maximum_batching_window_in_seconds
2967
+ # The maximum length of a time to wait for events.
2968
+ # @return [Integer]
2969
+ #
2970
+ # @!attribute [rw] server_root_ca_certificate
2971
+ # The ARN of the Secrets Manager secret used for certification.
2972
+ # @return [String]
2973
+ #
2974
+ # @!attribute [rw] vpc
2975
+ # This structure specifies the VPC subnets and security groups for the
2976
+ # stream, and whether a public IP address is to be used.
2977
+ # @return [Types::SelfManagedKafkaAccessConfigurationVpc]
2978
+ #
2979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeSourceSelfManagedKafkaParameters AWS API Documentation
2980
+ #
2981
+ class UpdatePipeSourceSelfManagedKafkaParameters < Struct.new(
2982
+ :batch_size,
2983
+ :credentials,
2984
+ :maximum_batching_window_in_seconds,
2985
+ :server_root_ca_certificate,
2986
+ :vpc)
2987
+ SENSITIVE = []
2988
+ include Aws::Structure
2989
+ end
2990
+
2991
+ # The parameters for using a Amazon SQS stream as a source.
2992
+ #
2993
+ # @!attribute [rw] batch_size
2994
+ # The maximum number of records to include in each batch.
2995
+ # @return [Integer]
2996
+ #
2997
+ # @!attribute [rw] maximum_batching_window_in_seconds
2998
+ # The maximum length of a time to wait for events.
2999
+ # @return [Integer]
3000
+ #
3001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/UpdatePipeSourceSqsQueueParameters AWS API Documentation
3002
+ #
3003
+ class UpdatePipeSourceSqsQueueParameters < Struct.new(
3004
+ :batch_size,
3005
+ :maximum_batching_window_in_seconds)
3006
+ SENSITIVE = []
3007
+ include Aws::Structure
3008
+ end
3009
+
3010
+ # Indicates that an error has occurred while performing a validate
3011
+ # operation.
3012
+ #
3013
+ # @!attribute [rw] field_list
3014
+ # The list of fields for which validation failed and the corresponding
3015
+ # failure messages.
3016
+ # @return [Array<Types::ValidationExceptionField>]
3017
+ #
3018
+ # @!attribute [rw] message
3019
+ # @return [String]
3020
+ #
3021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ValidationException AWS API Documentation
3022
+ #
3023
+ class ValidationException < Struct.new(
3024
+ :field_list,
3025
+ :message)
3026
+ SENSITIVE = []
3027
+ include Aws::Structure
3028
+ end
3029
+
3030
+ # Indicates that an error has occurred while performing a validate
3031
+ # operation.
3032
+ #
3033
+ # @!attribute [rw] message
3034
+ # The message of the exception.
3035
+ # @return [String]
3036
+ #
3037
+ # @!attribute [rw] name
3038
+ # The name of the exception.
3039
+ # @return [String]
3040
+ #
3041
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ValidationExceptionField AWS API Documentation
3042
+ #
3043
+ class ValidationExceptionField < Struct.new(
3044
+ :message,
3045
+ :name)
3046
+ SENSITIVE = []
3047
+ include Aws::Structure
3048
+ end
3049
+
3050
+ end
3051
+ end