aws-sdk-eventbridge 1.24.0 → 1.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-eventbridge.rb +1 -1
- data/lib/aws-sdk-eventbridge/client.rb +296 -171
- data/lib/aws-sdk-eventbridge/client_api.rb +42 -0
- data/lib/aws-sdk-eventbridge/types.rb +428 -113
- metadata +4 -4
@@ -41,6 +41,11 @@ module Aws::EventBridge
|
|
41
41
|
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
42
42
|
CancelReplayRequest = Shapes::StructureShape.new(name: 'CancelReplayRequest')
|
43
43
|
CancelReplayResponse = Shapes::StructureShape.new(name: 'CancelReplayResponse')
|
44
|
+
CapacityProvider = Shapes::StringShape.new(name: 'CapacityProvider')
|
45
|
+
CapacityProviderStrategy = Shapes::ListShape.new(name: 'CapacityProviderStrategy')
|
46
|
+
CapacityProviderStrategyItem = Shapes::StructureShape.new(name: 'CapacityProviderStrategyItem')
|
47
|
+
CapacityProviderStrategyItemBase = Shapes::IntegerShape.new(name: 'CapacityProviderStrategyItemBase')
|
48
|
+
CapacityProviderStrategyItemWeight = Shapes::IntegerShape.new(name: 'CapacityProviderStrategyItemWeight')
|
44
49
|
ConcurrentModificationException = Shapes::StructureShape.new(name: 'ConcurrentModificationException')
|
45
50
|
Condition = Shapes::StructureShape.new(name: 'Condition')
|
46
51
|
Connection = Shapes::StructureShape.new(name: 'Connection')
|
@@ -189,8 +194,17 @@ module Aws::EventBridge
|
|
189
194
|
PartnerEventSourceNamePrefix = Shapes::StringShape.new(name: 'PartnerEventSourceNamePrefix')
|
190
195
|
PathParameter = Shapes::StringShape.new(name: 'PathParameter')
|
191
196
|
PathParameterList = Shapes::ListShape.new(name: 'PathParameterList')
|
197
|
+
PlacementConstraint = Shapes::StructureShape.new(name: 'PlacementConstraint')
|
198
|
+
PlacementConstraintExpression = Shapes::StringShape.new(name: 'PlacementConstraintExpression')
|
199
|
+
PlacementConstraintType = Shapes::StringShape.new(name: 'PlacementConstraintType')
|
200
|
+
PlacementConstraints = Shapes::ListShape.new(name: 'PlacementConstraints')
|
201
|
+
PlacementStrategies = Shapes::ListShape.new(name: 'PlacementStrategies')
|
202
|
+
PlacementStrategy = Shapes::StructureShape.new(name: 'PlacementStrategy')
|
203
|
+
PlacementStrategyField = Shapes::StringShape.new(name: 'PlacementStrategyField')
|
204
|
+
PlacementStrategyType = Shapes::StringShape.new(name: 'PlacementStrategyType')
|
192
205
|
PolicyLengthExceededException = Shapes::StructureShape.new(name: 'PolicyLengthExceededException')
|
193
206
|
Principal = Shapes::StringShape.new(name: 'Principal')
|
207
|
+
PropagateTags = Shapes::StringShape.new(name: 'PropagateTags')
|
194
208
|
PutEventsRequest = Shapes::StructureShape.new(name: 'PutEventsRequest')
|
195
209
|
PutEventsRequestEntry = Shapes::StructureShape.new(name: 'PutEventsRequestEntry')
|
196
210
|
PutEventsRequestEntryList = Shapes::ListShape.new(name: 'PutEventsRequestEntryList')
|
@@ -215,6 +229,7 @@ module Aws::EventBridge
|
|
215
229
|
QueryStringValue = Shapes::StringShape.new(name: 'QueryStringValue')
|
216
230
|
RedshiftDataParameters = Shapes::StructureShape.new(name: 'RedshiftDataParameters')
|
217
231
|
RedshiftSecretManagerArn = Shapes::StringShape.new(name: 'RedshiftSecretManagerArn')
|
232
|
+
ReferenceId = Shapes::StringShape.new(name: 'ReferenceId')
|
218
233
|
RemovePermissionRequest = Shapes::StructureShape.new(name: 'RemovePermissionRequest')
|
219
234
|
RemoveTargetsRequest = Shapes::StructureShape.new(name: 'RemoveTargetsRequest')
|
220
235
|
RemoveTargetsResponse = Shapes::StructureShape.new(name: 'RemoveTargetsResponse')
|
@@ -351,6 +366,13 @@ module Aws::EventBridge
|
|
351
366
|
CancelReplayResponse.add_member(:state_reason, Shapes::ShapeRef.new(shape: ReplayStateReason, location_name: "StateReason"))
|
352
367
|
CancelReplayResponse.struct_class = Types::CancelReplayResponse
|
353
368
|
|
369
|
+
CapacityProviderStrategy.member = Shapes::ShapeRef.new(shape: CapacityProviderStrategyItem)
|
370
|
+
|
371
|
+
CapacityProviderStrategyItem.add_member(:capacity_provider, Shapes::ShapeRef.new(shape: CapacityProvider, required: true, location_name: "capacityProvider"))
|
372
|
+
CapacityProviderStrategyItem.add_member(:weight, Shapes::ShapeRef.new(shape: CapacityProviderStrategyItemWeight, location_name: "weight"))
|
373
|
+
CapacityProviderStrategyItem.add_member(:base, Shapes::ShapeRef.new(shape: CapacityProviderStrategyItemBase, location_name: "base"))
|
374
|
+
CapacityProviderStrategyItem.struct_class = Types::CapacityProviderStrategyItem
|
375
|
+
|
354
376
|
ConcurrentModificationException.struct_class = Types::ConcurrentModificationException
|
355
377
|
|
356
378
|
Condition.add_member(:type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Type"))
|
@@ -659,6 +681,14 @@ module Aws::EventBridge
|
|
659
681
|
EcsParameters.add_member(:network_configuration, Shapes::ShapeRef.new(shape: NetworkConfiguration, location_name: "NetworkConfiguration"))
|
660
682
|
EcsParameters.add_member(:platform_version, Shapes::ShapeRef.new(shape: String, location_name: "PlatformVersion"))
|
661
683
|
EcsParameters.add_member(:group, Shapes::ShapeRef.new(shape: String, location_name: "Group"))
|
684
|
+
EcsParameters.add_member(:capacity_provider_strategy, Shapes::ShapeRef.new(shape: CapacityProviderStrategy, location_name: "CapacityProviderStrategy"))
|
685
|
+
EcsParameters.add_member(:enable_ecs_managed_tags, Shapes::ShapeRef.new(shape: Boolean, location_name: "EnableECSManagedTags"))
|
686
|
+
EcsParameters.add_member(:enable_execute_command, Shapes::ShapeRef.new(shape: Boolean, location_name: "EnableExecuteCommand"))
|
687
|
+
EcsParameters.add_member(:placement_constraints, Shapes::ShapeRef.new(shape: PlacementConstraints, location_name: "PlacementConstraints"))
|
688
|
+
EcsParameters.add_member(:placement_strategy, Shapes::ShapeRef.new(shape: PlacementStrategies, location_name: "PlacementStrategy"))
|
689
|
+
EcsParameters.add_member(:propagate_tags, Shapes::ShapeRef.new(shape: PropagateTags, location_name: "PropagateTags"))
|
690
|
+
EcsParameters.add_member(:reference_id, Shapes::ShapeRef.new(shape: ReferenceId, location_name: "ReferenceId"))
|
691
|
+
EcsParameters.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
662
692
|
EcsParameters.struct_class = Types::EcsParameters
|
663
693
|
|
664
694
|
EnableRuleRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleName, required: true, location_name: "Name"))
|
@@ -846,6 +876,18 @@ module Aws::EventBridge
|
|
846
876
|
|
847
877
|
PathParameterList.member = Shapes::ShapeRef.new(shape: PathParameter)
|
848
878
|
|
879
|
+
PlacementConstraint.add_member(:type, Shapes::ShapeRef.new(shape: PlacementConstraintType, location_name: "type"))
|
880
|
+
PlacementConstraint.add_member(:expression, Shapes::ShapeRef.new(shape: PlacementConstraintExpression, location_name: "expression"))
|
881
|
+
PlacementConstraint.struct_class = Types::PlacementConstraint
|
882
|
+
|
883
|
+
PlacementConstraints.member = Shapes::ShapeRef.new(shape: PlacementConstraint)
|
884
|
+
|
885
|
+
PlacementStrategies.member = Shapes::ShapeRef.new(shape: PlacementStrategy)
|
886
|
+
|
887
|
+
PlacementStrategy.add_member(:type, Shapes::ShapeRef.new(shape: PlacementStrategyType, location_name: "type"))
|
888
|
+
PlacementStrategy.add_member(:field, Shapes::ShapeRef.new(shape: PlacementStrategyField, location_name: "field"))
|
889
|
+
PlacementStrategy.struct_class = Types::PlacementStrategy
|
890
|
+
|
849
891
|
PolicyLengthExceededException.struct_class = Types::PolicyLengthExceededException
|
850
892
|
|
851
893
|
PutEventsRequest.add_member(:entries, Shapes::ShapeRef.new(shape: PutEventsRequestEntryList, required: true, location_name: "Entries"))
|
@@ -181,7 +181,7 @@ module Aws::EventBridge
|
|
181
181
|
# The array properties for the submitted job, such as the size of the
|
182
182
|
# array. The array size can be between 2 and 10,000. If you specify
|
183
183
|
# array properties for a job, it becomes an array job. This parameter is
|
184
|
-
# used only if the target is an
|
184
|
+
# used only if the target is an Batch job.
|
185
185
|
#
|
186
186
|
# @note When making an API call, you may pass BatchArrayProperties
|
187
187
|
# data as a hash:
|
@@ -203,7 +203,7 @@ module Aws::EventBridge
|
|
203
203
|
include Aws::Structure
|
204
204
|
end
|
205
205
|
|
206
|
-
# The custom parameters to be used when the target is an
|
206
|
+
# The custom parameters to be used when the target is an Batch job.
|
207
207
|
#
|
208
208
|
# @note When making an API call, you may pass BatchParameters
|
209
209
|
# data as a hash:
|
@@ -221,27 +221,27 @@ module Aws::EventBridge
|
|
221
221
|
#
|
222
222
|
# @!attribute [rw] job_definition
|
223
223
|
# The ARN or name of the job definition to use if the event target is
|
224
|
-
# an
|
224
|
+
# an Batch job. This job definition must already exist.
|
225
225
|
# @return [String]
|
226
226
|
#
|
227
227
|
# @!attribute [rw] job_name
|
228
228
|
# The name to use for this execution of the job, if the target is an
|
229
|
-
#
|
229
|
+
# Batch job.
|
230
230
|
# @return [String]
|
231
231
|
#
|
232
232
|
# @!attribute [rw] array_properties
|
233
233
|
# The array properties for the submitted job, such as the size of the
|
234
234
|
# array. The array size can be between 2 and 10,000. If you specify
|
235
235
|
# array properties for a job, it becomes an array job. This parameter
|
236
|
-
# is used only if the target is an
|
236
|
+
# is used only if the target is an Batch job.
|
237
237
|
# @return [Types::BatchArrayProperties]
|
238
238
|
#
|
239
239
|
# @!attribute [rw] retry_strategy
|
240
|
-
# The retry strategy to use for failed jobs, if the target is an
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
240
|
+
# The retry strategy to use for failed jobs, if the target is an Batch
|
241
|
+
# job. The retry strategy is the number of times to retry the failed
|
242
|
+
# job execution. Valid values are 1–10. When you specify a retry
|
243
|
+
# strategy here, it overrides the retry strategy defined in the job
|
244
|
+
# definition.
|
245
245
|
# @return [Types::BatchRetryStrategy]
|
246
246
|
#
|
247
247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/BatchParameters AWS API Documentation
|
@@ -255,9 +255,9 @@ module Aws::EventBridge
|
|
255
255
|
include Aws::Structure
|
256
256
|
end
|
257
257
|
|
258
|
-
# The retry strategy to use for failed jobs, if the target is an
|
259
|
-
#
|
260
|
-
#
|
258
|
+
# The retry strategy to use for failed jobs, if the target is an Batch
|
259
|
+
# job. If you specify a retry strategy here, it overrides the retry
|
260
|
+
# strategy defined in the job definition.
|
261
261
|
#
|
262
262
|
# @note When making an API call, you may pass BatchRetryStrategy
|
263
263
|
# data as a hash:
|
@@ -320,6 +320,50 @@ module Aws::EventBridge
|
|
320
320
|
include Aws::Structure
|
321
321
|
end
|
322
322
|
|
323
|
+
# The details of a capacity provider strategy. To learn more, see
|
324
|
+
# [CapacityProviderStrategyItem][1] in the Amazon ECS API Reference.
|
325
|
+
#
|
326
|
+
#
|
327
|
+
#
|
328
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html
|
329
|
+
#
|
330
|
+
# @note When making an API call, you may pass CapacityProviderStrategyItem
|
331
|
+
# data as a hash:
|
332
|
+
#
|
333
|
+
# {
|
334
|
+
# capacity_provider: "CapacityProvider", # required
|
335
|
+
# weight: 1,
|
336
|
+
# base: 1,
|
337
|
+
# }
|
338
|
+
#
|
339
|
+
# @!attribute [rw] capacity_provider
|
340
|
+
# The short name of the capacity provider.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] weight
|
344
|
+
# The weight value designates the relative percentage of the total
|
345
|
+
# number of tasks launched that should use the specified capacity
|
346
|
+
# provider. The weight value is taken into consideration after the
|
347
|
+
# base value, if defined, is satisfied.
|
348
|
+
# @return [Integer]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] base
|
351
|
+
# The base value designates how many tasks, at a minimum, to run on
|
352
|
+
# the specified capacity provider. Only one capacity provider in a
|
353
|
+
# capacity provider strategy can have a base defined. If no value is
|
354
|
+
# specified, the default value of 0 is used.
|
355
|
+
# @return [Integer]
|
356
|
+
#
|
357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CapacityProviderStrategyItem AWS API Documentation
|
358
|
+
#
|
359
|
+
class CapacityProviderStrategyItem < Struct.new(
|
360
|
+
:capacity_provider,
|
361
|
+
:weight,
|
362
|
+
:base)
|
363
|
+
SENSITIVE = []
|
364
|
+
include Aws::Structure
|
365
|
+
end
|
366
|
+
|
323
367
|
# There is concurrent modification on a rule, target, archive, or
|
324
368
|
# replay.
|
325
369
|
#
|
@@ -329,10 +373,10 @@ module Aws::EventBridge
|
|
329
373
|
|
330
374
|
# A JSON string which you can use to limit the event bus permissions you
|
331
375
|
# are granting to only accounts that fulfill the condition. Currently,
|
332
|
-
# the only supported condition is membership in a certain
|
333
|
-
# organization. The string must contain `Type`, `Key`, and
|
334
|
-
# fields. The `Value` field specifies the ID of the
|
335
|
-
# Following is an example value for `Condition`\:
|
376
|
+
# the only supported condition is membership in a certain Amazon Web
|
377
|
+
# Services organization. The string must contain `Type`, `Key`, and
|
378
|
+
# `Value` fields. The `Value` field specifies the ID of the Amazon Web
|
379
|
+
# Services organization. Following is an example value for `Condition`\:
|
336
380
|
#
|
337
381
|
# `'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
|
338
382
|
# "o-1234567890"\}'`
|
@@ -784,7 +828,7 @@ module Aws::EventBridge
|
|
784
828
|
# @return [String]
|
785
829
|
#
|
786
830
|
# @!attribute [rw] event_source_arn
|
787
|
-
# The ARN of the event
|
831
|
+
# The ARN of the event bus that sends events to the archive.
|
788
832
|
# @return [String]
|
789
833
|
#
|
790
834
|
# @!attribute [rw] description
|
@@ -1288,14 +1332,14 @@ module Aws::EventBridge
|
|
1288
1332
|
# @!attribute [rw] name
|
1289
1333
|
# The name of the partner event source. This name must be unique and
|
1290
1334
|
# must be in the format ` partner_name/event_namespace/event_name `.
|
1291
|
-
# The
|
1292
|
-
# create a partner event bus with a name that matches the
|
1293
|
-
# partner event source.
|
1335
|
+
# The Amazon Web Services account that wants to use this partner event
|
1336
|
+
# source must create a partner event bus with a name that matches the
|
1337
|
+
# name of the partner event source.
|
1294
1338
|
# @return [String]
|
1295
1339
|
#
|
1296
1340
|
# @!attribute [rw] account
|
1297
|
-
# The
|
1298
|
-
# event bus for this partner event source.
|
1341
|
+
# The Amazon Web Services account ID that is permitted to create a
|
1342
|
+
# matching partner event bus for this partner event source.
|
1299
1343
|
# @return [String]
|
1300
1344
|
#
|
1301
1345
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreatePartnerEventSourceRequest AWS API Documentation
|
@@ -1543,8 +1587,8 @@ module Aws::EventBridge
|
|
1543
1587
|
# @return [String]
|
1544
1588
|
#
|
1545
1589
|
# @!attribute [rw] account
|
1546
|
-
# The
|
1547
|
-
# created for.
|
1590
|
+
# The Amazon Web Services account ID of the Amazon Web Services
|
1591
|
+
# customer that the event source was created for.
|
1548
1592
|
# @return [String]
|
1549
1593
|
#
|
1550
1594
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeletePartnerEventSourceRequest AWS API Documentation
|
@@ -1575,11 +1619,12 @@ module Aws::EventBridge
|
|
1575
1619
|
# @return [String]
|
1576
1620
|
#
|
1577
1621
|
# @!attribute [rw] force
|
1578
|
-
# If this is a managed rule, created by an
|
1579
|
-
# you must specify `Force` as `True` to delete the
|
1580
|
-
# parameter is ignored for rules that are not managed
|
1581
|
-
# check whether a rule is a managed rule by using
|
1582
|
-
# `ListRules` and checking the `ManagedBy` field of
|
1622
|
+
# If this is a managed rule, created by an Amazon Web Services service
|
1623
|
+
# on your behalf, you must specify `Force` as `True` to delete the
|
1624
|
+
# rule. This parameter is ignored for rules that are not managed
|
1625
|
+
# rules. You can check whether a rule is a managed rule by using
|
1626
|
+
# `DescribeRule` or `ListRules` and checking the `ManagedBy` field of
|
1627
|
+
# the response.
|
1583
1628
|
# @return [Boolean]
|
1584
1629
|
#
|
1585
1630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteRuleRequest AWS API Documentation
|
@@ -2132,9 +2177,9 @@ module Aws::EventBridge
|
|
2132
2177
|
# @return [String]
|
2133
2178
|
#
|
2134
2179
|
# @!attribute [rw] managed_by
|
2135
|
-
# If this is a managed rule, created by an
|
2136
|
-
# this field displays the principal name of the
|
2137
|
-
# created the rule.
|
2180
|
+
# If this is a managed rule, created by an Amazon Web Services service
|
2181
|
+
# on your behalf, this field displays the principal name of the Amazon
|
2182
|
+
# Web Services service that created the rule.
|
2138
2183
|
# @return [String]
|
2139
2184
|
#
|
2140
2185
|
# @!attribute [rw] event_bus_name
|
@@ -2212,6 +2257,35 @@ module Aws::EventBridge
|
|
2212
2257
|
# },
|
2213
2258
|
# platform_version: "String",
|
2214
2259
|
# group: "String",
|
2260
|
+
# capacity_provider_strategy: [
|
2261
|
+
# {
|
2262
|
+
# capacity_provider: "CapacityProvider", # required
|
2263
|
+
# weight: 1,
|
2264
|
+
# base: 1,
|
2265
|
+
# },
|
2266
|
+
# ],
|
2267
|
+
# enable_ecs_managed_tags: false,
|
2268
|
+
# enable_execute_command: false,
|
2269
|
+
# placement_constraints: [
|
2270
|
+
# {
|
2271
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
2272
|
+
# expression: "PlacementConstraintExpression",
|
2273
|
+
# },
|
2274
|
+
# ],
|
2275
|
+
# placement_strategy: [
|
2276
|
+
# {
|
2277
|
+
# type: "random", # accepts random, spread, binpack
|
2278
|
+
# field: "PlacementStrategyField",
|
2279
|
+
# },
|
2280
|
+
# ],
|
2281
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
|
2282
|
+
# reference_id: "ReferenceId",
|
2283
|
+
# tags: [
|
2284
|
+
# {
|
2285
|
+
# key: "TagKey", # required
|
2286
|
+
# value: "TagValue", # required
|
2287
|
+
# },
|
2288
|
+
# ],
|
2215
2289
|
# }
|
2216
2290
|
#
|
2217
2291
|
# @!attribute [rw] task_definition_arn
|
@@ -2228,9 +2302,9 @@ module Aws::EventBridge
|
|
2228
2302
|
# Specifies the launch type on which your task is running. The launch
|
2229
2303
|
# type that you specify here must match one of the launch type
|
2230
2304
|
# (compatibilities) of the target task. The `FARGATE` value is
|
2231
|
-
# supported only in the Regions where
|
2232
|
-
# supported. For more information, see [
|
2233
|
-
#
|
2305
|
+
# supported only in the Regions where Fargate witt Amazon ECS is
|
2306
|
+
# supported. For more information, see [Fargate on Amazon ECS][1] in
|
2307
|
+
# the *Amazon Elastic Container Service Developer Guide*.
|
2234
2308
|
#
|
2235
2309
|
#
|
2236
2310
|
#
|
@@ -2238,8 +2312,8 @@ module Aws::EventBridge
|
|
2238
2312
|
# @return [String]
|
2239
2313
|
#
|
2240
2314
|
# @!attribute [rw] network_configuration
|
2241
|
-
# Use this structure if the ECS task uses the `awsvpc` network
|
2242
|
-
# This structure specifies the VPC subnets and security groups
|
2315
|
+
# Use this structure if the Amazon ECS task uses the `awsvpc` network
|
2316
|
+
# mode. This structure specifies the VPC subnets and security groups
|
2243
2317
|
# associated with the task, and whether a public IP address is to be
|
2244
2318
|
# used. This structure is required if `LaunchType` is `FARGATE`
|
2245
2319
|
# because the `awsvpc` mode is required for Fargate tasks.
|
@@ -2253,7 +2327,7 @@ module Aws::EventBridge
|
|
2253
2327
|
# numeric portion of the platform version, such as `1.1.0`.
|
2254
2328
|
#
|
2255
2329
|
# This structure is used only if `LaunchType` is `FARGATE`. For more
|
2256
|
-
# information about valid platform versions, see [
|
2330
|
+
# information about valid platform versions, see [Fargate Platform
|
2257
2331
|
# Versions][1] in the *Amazon Elastic Container Service Developer
|
2258
2332
|
# Guide*.
|
2259
2333
|
#
|
@@ -2267,6 +2341,64 @@ module Aws::EventBridge
|
|
2267
2341
|
# characters.
|
2268
2342
|
# @return [String]
|
2269
2343
|
#
|
2344
|
+
# @!attribute [rw] capacity_provider_strategy
|
2345
|
+
# The capacity provider strategy to use for the task.
|
2346
|
+
#
|
2347
|
+
# If a `capacityProviderStrategy` is specified, the `launchType`
|
2348
|
+
# parameter must be omitted. If no `capacityProviderStrategy` or
|
2349
|
+
# launchType is specified, the `defaultCapacityProviderStrategy` for
|
2350
|
+
# the cluster is used.
|
2351
|
+
# @return [Array<Types::CapacityProviderStrategyItem>]
|
2352
|
+
#
|
2353
|
+
# @!attribute [rw] enable_ecs_managed_tags
|
2354
|
+
# Specifies whether to enable Amazon ECS managed tags for the task.
|
2355
|
+
# For more information, see [Tagging Your Amazon ECS Resources][1] in
|
2356
|
+
# the Amazon Elastic Container Service Developer Guide.
|
2357
|
+
#
|
2358
|
+
#
|
2359
|
+
#
|
2360
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
2361
|
+
# @return [Boolean]
|
2362
|
+
#
|
2363
|
+
# @!attribute [rw] enable_execute_command
|
2364
|
+
# Whether or not to enable the execute command functionality for the
|
2365
|
+
# containers in this task. If true, this enables execute command
|
2366
|
+
# functionality on all containers in the task.
|
2367
|
+
# @return [Boolean]
|
2368
|
+
#
|
2369
|
+
# @!attribute [rw] placement_constraints
|
2370
|
+
# An array of placement constraint objects to use for the task. You
|
2371
|
+
# can specify up to 10 constraints per task (including constraints in
|
2372
|
+
# the task definition and those specified at runtime).
|
2373
|
+
# @return [Array<Types::PlacementConstraint>]
|
2374
|
+
#
|
2375
|
+
# @!attribute [rw] placement_strategy
|
2376
|
+
# The placement strategy objects to use for the task. You can specify
|
2377
|
+
# a maximum of five strategy rules per task.
|
2378
|
+
# @return [Array<Types::PlacementStrategy>]
|
2379
|
+
#
|
2380
|
+
# @!attribute [rw] propagate_tags
|
2381
|
+
# Specifies whether to propagate the tags from the task definition to
|
2382
|
+
# the task. If no value is specified, the tags are not propagated.
|
2383
|
+
# Tags can only be propagated to the task during task creation. To add
|
2384
|
+
# tags to a task after task creation, use the TagResource API action.
|
2385
|
+
# @return [String]
|
2386
|
+
#
|
2387
|
+
# @!attribute [rw] reference_id
|
2388
|
+
# The reference ID to use for the task.
|
2389
|
+
# @return [String]
|
2390
|
+
#
|
2391
|
+
# @!attribute [rw] tags
|
2392
|
+
# The metadata that you apply to the task to help you categorize and
|
2393
|
+
# organize them. Each tag consists of a key and an optional value,
|
2394
|
+
# both of which you define. To learn more, see [RunTask][1] in the
|
2395
|
+
# Amazon ECS API Reference.
|
2396
|
+
#
|
2397
|
+
#
|
2398
|
+
#
|
2399
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags
|
2400
|
+
# @return [Array<Types::Tag>]
|
2401
|
+
#
|
2270
2402
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EcsParameters AWS API Documentation
|
2271
2403
|
#
|
2272
2404
|
class EcsParameters < Struct.new(
|
@@ -2275,7 +2407,15 @@ module Aws::EventBridge
|
|
2275
2407
|
:launch_type,
|
2276
2408
|
:network_configuration,
|
2277
2409
|
:platform_version,
|
2278
|
-
:group
|
2410
|
+
:group,
|
2411
|
+
:capacity_provider_strategy,
|
2412
|
+
:enable_ecs_managed_tags,
|
2413
|
+
:enable_execute_command,
|
2414
|
+
:placement_constraints,
|
2415
|
+
:placement_strategy,
|
2416
|
+
:propagate_tags,
|
2417
|
+
:reference_id,
|
2418
|
+
:tags)
|
2279
2419
|
SENSITIVE = []
|
2280
2420
|
include Aws::Structure
|
2281
2421
|
end
|
@@ -2308,8 +2448,8 @@ module Aws::EventBridge
|
|
2308
2448
|
|
2309
2449
|
# An event bus receives events from a source and routes them to rules
|
2310
2450
|
# associated with that event bus. Your account's default event bus
|
2311
|
-
# receives
|
2312
|
-
#
|
2451
|
+
# receives events from Amazon Web Services services. A custom event bus
|
2452
|
+
# can receive events from your custom applications and services. A
|
2313
2453
|
# partner event bus receives events from an event source created by an
|
2314
2454
|
# SaaS partner. These events come from the partners services or
|
2315
2455
|
# applications.
|
@@ -2323,8 +2463,8 @@ module Aws::EventBridge
|
|
2323
2463
|
# @return [String]
|
2324
2464
|
#
|
2325
2465
|
# @!attribute [rw] policy
|
2326
|
-
# The permissions policy of the event bus, describing which other
|
2327
|
-
# accounts can write events to this event bus.
|
2466
|
+
# The permissions policy of the event bus, describing which other
|
2467
|
+
# Amazon Web Services accounts can write events to this event bus.
|
2328
2468
|
# @return [String]
|
2329
2469
|
#
|
2330
2470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EventBus AWS API Documentation
|
@@ -2338,9 +2478,9 @@ module Aws::EventBridge
|
|
2338
2478
|
end
|
2339
2479
|
|
2340
2480
|
# A partner event source is created by an SaaS partner. If a customer
|
2341
|
-
# creates a partner event bus that matches this event source, that
|
2342
|
-
# account can receive events from the partner's
|
2343
|
-
# services.
|
2481
|
+
# creates a partner event bus that matches this event source, that
|
2482
|
+
# Amazon Web Services account can receive events from the partner's
|
2483
|
+
# applications or services.
|
2344
2484
|
#
|
2345
2485
|
# @!attribute [rw] arn
|
2346
2486
|
# The ARN of the event source.
|
@@ -2355,8 +2495,8 @@ module Aws::EventBridge
|
|
2355
2495
|
# @return [Time]
|
2356
2496
|
#
|
2357
2497
|
# @!attribute [rw] expiration_time
|
2358
|
-
# The date and time that the event source will expire, if the
|
2359
|
-
# account doesn't create a matching event bus for it.
|
2498
|
+
# The date and time that the event source will expire, if the Amazon
|
2499
|
+
# Web Services account doesn't create a matching event bus for it.
|
2360
2500
|
# @return [Time]
|
2361
2501
|
#
|
2362
2502
|
# @!attribute [rw] name
|
@@ -2457,7 +2597,7 @@ module Aws::EventBridge
|
|
2457
2597
|
# valid JSON path. You can have as many as 100 key-value pairs. You
|
2458
2598
|
# must use JSON dot notation, not bracket notation.
|
2459
2599
|
#
|
2460
|
-
# The keys cannot start with "
|
2600
|
+
# The keys cannot start with "Amazon Web Services."
|
2461
2601
|
# @return [Hash<String,String>]
|
2462
2602
|
#
|
2463
2603
|
# @!attribute [rw] input_template
|
@@ -2995,7 +3135,7 @@ module Aws::EventBridge
|
|
2995
3135
|
# @return [String]
|
2996
3136
|
#
|
2997
3137
|
# @!attribute [rw] event_source_arn
|
2998
|
-
# The ARN of the
|
3138
|
+
# The ARN of the archive from which the events are replayed.
|
2999
3139
|
# @return [String]
|
3000
3140
|
#
|
3001
3141
|
# @!attribute [rw] next_token
|
@@ -3241,11 +3381,11 @@ module Aws::EventBridge
|
|
3241
3381
|
include Aws::Structure
|
3242
3382
|
end
|
3243
3383
|
|
3244
|
-
# This rule was created by an
|
3245
|
-
# is managed by that service. If you see this error in
|
3246
|
-
# `DeleteRule` or `RemoveTargets`, you can use the `Force`
|
3247
|
-
# those calls to delete the rule or remove targets from the
|
3248
|
-
# cannot modify these managed rules by using `DisableRule`,
|
3384
|
+
# This rule was created by an Amazon Web Services service on behalf of
|
3385
|
+
# your account. It is managed by that service. If you see this error in
|
3386
|
+
# response to `DeleteRule` or `RemoveTargets`, you can use the `Force`
|
3387
|
+
# parameter in those calls to delete the rule or remove targets from the
|
3388
|
+
# rule. You cannot modify these managed rules by using `DisableRule`,
|
3249
3389
|
# `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or
|
3250
3390
|
# `UntagResource`.
|
3251
3391
|
#
|
@@ -3288,9 +3428,9 @@ module Aws::EventBridge
|
|
3288
3428
|
class OperationDisabledException < Aws::EmptyStructure; end
|
3289
3429
|
|
3290
3430
|
# A partner event source is created by an SaaS partner. If a customer
|
3291
|
-
# creates a partner event bus that matches this event source, that
|
3292
|
-
# account can receive events from the partner's
|
3293
|
-
# services.
|
3431
|
+
# creates a partner event bus that matches this event source, that
|
3432
|
+
# Amazon Web Services account can receive events from the partner's
|
3433
|
+
# applications or services.
|
3294
3434
|
#
|
3295
3435
|
# @!attribute [rw] arn
|
3296
3436
|
# The ARN of the partner event source.
|
@@ -3309,10 +3449,12 @@ module Aws::EventBridge
|
|
3309
3449
|
include Aws::Structure
|
3310
3450
|
end
|
3311
3451
|
|
3312
|
-
# The
|
3452
|
+
# The Amazon Web Services account that a partner event source has been
|
3453
|
+
# offered to.
|
3313
3454
|
#
|
3314
3455
|
# @!attribute [rw] account
|
3315
|
-
# The
|
3456
|
+
# The Amazon Web Services account ID that the partner event source was
|
3457
|
+
# offered to.
|
3316
3458
|
# @return [String]
|
3317
3459
|
#
|
3318
3460
|
# @!attribute [rw] creation_time
|
@@ -3320,8 +3462,8 @@ module Aws::EventBridge
|
|
3320
3462
|
# @return [Time]
|
3321
3463
|
#
|
3322
3464
|
# @!attribute [rw] expiration_time
|
3323
|
-
# The date and time that the event source will expire, if the
|
3324
|
-
# account doesn't create a matching event bus for it.
|
3465
|
+
# The date and time that the event source will expire, if the Amazon
|
3466
|
+
# Web Services account doesn't create a matching event bus for it.
|
3325
3467
|
# @return [Time]
|
3326
3468
|
#
|
3327
3469
|
# @!attribute [rw] state
|
@@ -3344,6 +3486,95 @@ module Aws::EventBridge
|
|
3344
3486
|
include Aws::Structure
|
3345
3487
|
end
|
3346
3488
|
|
3489
|
+
# An object representing a constraint on task placement. To learn more,
|
3490
|
+
# see [Task Placement Constraints][1] in the Amazon Elastic Container
|
3491
|
+
# Service Developer Guide.
|
3492
|
+
#
|
3493
|
+
#
|
3494
|
+
#
|
3495
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html
|
3496
|
+
#
|
3497
|
+
# @note When making an API call, you may pass PlacementConstraint
|
3498
|
+
# data as a hash:
|
3499
|
+
#
|
3500
|
+
# {
|
3501
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
3502
|
+
# expression: "PlacementConstraintExpression",
|
3503
|
+
# }
|
3504
|
+
#
|
3505
|
+
# @!attribute [rw] type
|
3506
|
+
# The type of constraint. Use distinctInstance to ensure that each
|
3507
|
+
# task in a particular group is running on a different container
|
3508
|
+
# instance. Use memberOf to restrict the selection to a group of valid
|
3509
|
+
# candidates.
|
3510
|
+
# @return [String]
|
3511
|
+
#
|
3512
|
+
# @!attribute [rw] expression
|
3513
|
+
# A cluster query language expression to apply to the constraint. You
|
3514
|
+
# cannot specify an expression if the constraint type is
|
3515
|
+
# `distinctInstance`. To learn more, see [Cluster Query Language][1]
|
3516
|
+
# in the Amazon Elastic Container Service Developer Guide.
|
3517
|
+
#
|
3518
|
+
#
|
3519
|
+
#
|
3520
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html
|
3521
|
+
# @return [String]
|
3522
|
+
#
|
3523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PlacementConstraint AWS API Documentation
|
3524
|
+
#
|
3525
|
+
class PlacementConstraint < Struct.new(
|
3526
|
+
:type,
|
3527
|
+
:expression)
|
3528
|
+
SENSITIVE = []
|
3529
|
+
include Aws::Structure
|
3530
|
+
end
|
3531
|
+
|
3532
|
+
# The task placement strategy for a task or service. To learn more, see
|
3533
|
+
# [Task Placement Strategies][1] in the Amazon Elastic Container Service
|
3534
|
+
# Service Developer Guide.
|
3535
|
+
#
|
3536
|
+
#
|
3537
|
+
#
|
3538
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html
|
3539
|
+
#
|
3540
|
+
# @note When making an API call, you may pass PlacementStrategy
|
3541
|
+
# data as a hash:
|
3542
|
+
#
|
3543
|
+
# {
|
3544
|
+
# type: "random", # accepts random, spread, binpack
|
3545
|
+
# field: "PlacementStrategyField",
|
3546
|
+
# }
|
3547
|
+
#
|
3548
|
+
# @!attribute [rw] type
|
3549
|
+
# The type of placement strategy. The random placement strategy
|
3550
|
+
# randomly places tasks on available candidates. The spread placement
|
3551
|
+
# strategy spreads placement across available candidates evenly based
|
3552
|
+
# on the field parameter. The binpack strategy places tasks on
|
3553
|
+
# available candidates that have the least available amount of the
|
3554
|
+
# resource that is specified with the field parameter. For example, if
|
3555
|
+
# you binpack on memory, a task is placed on the instance with the
|
3556
|
+
# least amount of remaining memory (but still enough to run the task).
|
3557
|
+
# @return [String]
|
3558
|
+
#
|
3559
|
+
# @!attribute [rw] field
|
3560
|
+
# The field to apply the placement strategy against. For the spread
|
3561
|
+
# placement strategy, valid values are instanceId (or host, which has
|
3562
|
+
# the same effect), or any platform or custom attribute that is
|
3563
|
+
# applied to a container instance, such as
|
3564
|
+
# attribute:ecs.availability-zone. For the binpack placement strategy,
|
3565
|
+
# valid values are cpu and memory. For the random placement strategy,
|
3566
|
+
# this field is not used.
|
3567
|
+
# @return [String]
|
3568
|
+
#
|
3569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PlacementStrategy AWS API Documentation
|
3570
|
+
#
|
3571
|
+
class PlacementStrategy < Struct.new(
|
3572
|
+
:type,
|
3573
|
+
:field)
|
3574
|
+
SENSITIVE = []
|
3575
|
+
include Aws::Structure
|
3576
|
+
end
|
3577
|
+
|
3347
3578
|
# The event bus policy is too long. For more information, see the
|
3348
3579
|
# limits.
|
3349
3580
|
#
|
@@ -3399,11 +3630,12 @@ module Aws::EventBridge
|
|
3399
3630
|
#
|
3400
3631
|
# @!attribute [rw] time
|
3401
3632
|
# The time stamp of the event, per [RFC3339][1]. If no time stamp is
|
3402
|
-
# provided, the time stamp of the PutEvents call is used.
|
3633
|
+
# provided, the time stamp of the [PutEvents][2] call is used.
|
3403
3634
|
#
|
3404
3635
|
#
|
3405
3636
|
#
|
3406
3637
|
# [1]: https://www.rfc-editor.org/rfc/rfc3339.txt
|
3638
|
+
# [2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html
|
3407
3639
|
# @return [Time]
|
3408
3640
|
#
|
3409
3641
|
# @!attribute [rw] source
|
@@ -3411,9 +3643,9 @@ module Aws::EventBridge
|
|
3411
3643
|
# @return [String]
|
3412
3644
|
#
|
3413
3645
|
# @!attribute [rw] resources
|
3414
|
-
#
|
3415
|
-
# event primarily concerns. Any number, including
|
3416
|
-
# present.
|
3646
|
+
# Amazon Web Services resources, identified by Amazon Resource Name
|
3647
|
+
# (ARN), which the event primarily concerns. Any number, including
|
3648
|
+
# zero, may be present.
|
3417
3649
|
# @return [Array<String>]
|
3418
3650
|
#
|
3419
3651
|
# @!attribute [rw] detail_type
|
@@ -3433,11 +3665,11 @@ module Aws::EventBridge
|
|
3433
3665
|
# @return [String]
|
3434
3666
|
#
|
3435
3667
|
# @!attribute [rw] trace_header
|
3436
|
-
# An
|
3668
|
+
# An X-Ray trade header, which is an http header (X-Amzn-Trace-Id)
|
3437
3669
|
# that contains the trace-id associated with the event.
|
3438
3670
|
#
|
3439
3671
|
# To learn more about X-Ray trace headers, see [Tracing header][1] in
|
3440
|
-
# the
|
3672
|
+
# the X-Ray Developer Guide.
|
3441
3673
|
#
|
3442
3674
|
#
|
3443
3675
|
#
|
@@ -3547,13 +3779,13 @@ module Aws::EventBridge
|
|
3547
3779
|
# @return [Time]
|
3548
3780
|
#
|
3549
3781
|
# @!attribute [rw] source
|
3550
|
-
# The event source that is generating the
|
3782
|
+
# The event source that is generating the entry.
|
3551
3783
|
# @return [String]
|
3552
3784
|
#
|
3553
3785
|
# @!attribute [rw] resources
|
3554
|
-
#
|
3555
|
-
# event primarily concerns. Any number, including
|
3556
|
-
# present.
|
3786
|
+
# Amazon Web Services resources, identified by Amazon Resource Name
|
3787
|
+
# (ARN), which the event primarily concerns. Any number, including
|
3788
|
+
# zero, may be present.
|
3557
3789
|
# @return [Array<String>]
|
3558
3790
|
#
|
3559
3791
|
# @!attribute [rw] detail_type
|
@@ -3644,13 +3876,12 @@ module Aws::EventBridge
|
|
3644
3876
|
#
|
3645
3877
|
# @!attribute [rw] action
|
3646
3878
|
# The action that you are enabling the other account to perform.
|
3647
|
-
# Currently, this must be `events:PutEvents`.
|
3648
3879
|
# @return [String]
|
3649
3880
|
#
|
3650
3881
|
# @!attribute [rw] principal
|
3651
|
-
# The 12-digit
|
3652
|
-
# your default event bus. Specify "*" to permit
|
3653
|
-
# events to your default event bus.
|
3882
|
+
# The 12-digit Amazon Web Services account ID that you are permitting
|
3883
|
+
# to put events to your default event bus. Specify "*" to permit
|
3884
|
+
# any account to put events to your default event bus.
|
3654
3885
|
#
|
3655
3886
|
# If you specify "*" without specifying `Condition`, avoid creating
|
3656
3887
|
# rules that may match undesirable events. To create more secure
|
@@ -3664,19 +3895,24 @@ module Aws::EventBridge
|
|
3664
3895
|
# An identifier string for the external account that you are granting
|
3665
3896
|
# permissions to. If you later want to revoke the permission for this
|
3666
3897
|
# external account, specify this `StatementId` when you run
|
3667
|
-
# RemovePermission.
|
3898
|
+
# [RemovePermission][1].
|
3899
|
+
#
|
3900
|
+
#
|
3901
|
+
#
|
3902
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html
|
3668
3903
|
# @return [String]
|
3669
3904
|
#
|
3670
3905
|
# @!attribute [rw] condition
|
3671
3906
|
# This parameter enables you to limit the permission to accounts that
|
3672
|
-
# fulfill a certain condition, such as being a member of a certain
|
3673
|
-
# organization. For more information about
|
3674
|
-
#
|
3907
|
+
# fulfill a certain condition, such as being a member of a certain
|
3908
|
+
# Amazon Web Services organization. For more information about Amazon
|
3909
|
+
# Web Services Organizations, see [What Is Amazon Web Services
|
3910
|
+
# Organizations][1] in the *Amazon Web Services Organizations User
|
3675
3911
|
# Guide*.
|
3676
3912
|
#
|
3677
|
-
# If you specify `Condition` with an
|
3678
|
-
# "*" as the value for `Principal`, you grant
|
3679
|
-
# accounts in the named organization.
|
3913
|
+
# If you specify `Condition` with an Amazon Web Services organization
|
3914
|
+
# ID, and specify "*" as the value for `Principal`, you grant
|
3915
|
+
# permission to all the accounts in the named organization.
|
3680
3916
|
#
|
3681
3917
|
# The `Condition` is a JSON string which must contain `Type`, `Key`,
|
3682
3918
|
# and `Value` fields.
|
@@ -3753,6 +3989,12 @@ module Aws::EventBridge
|
|
3753
3989
|
# @!attribute [rw] role_arn
|
3754
3990
|
# The Amazon Resource Name (ARN) of the IAM role associated with the
|
3755
3991
|
# rule.
|
3992
|
+
#
|
3993
|
+
# If you're setting an event bus in another account as the target and
|
3994
|
+
# that account granted permission to your account through an
|
3995
|
+
# organization instead of directly by the account ID, you must specify
|
3996
|
+
# a `RoleArn` with proper permissions in the `Target` structure,
|
3997
|
+
# instead of here in this parameter.
|
3756
3998
|
# @return [String]
|
3757
3999
|
#
|
3758
4000
|
# @!attribute [rw] tags
|
@@ -3834,6 +4076,35 @@ module Aws::EventBridge
|
|
3834
4076
|
# },
|
3835
4077
|
# platform_version: "String",
|
3836
4078
|
# group: "String",
|
4079
|
+
# capacity_provider_strategy: [
|
4080
|
+
# {
|
4081
|
+
# capacity_provider: "CapacityProvider", # required
|
4082
|
+
# weight: 1,
|
4083
|
+
# base: 1,
|
4084
|
+
# },
|
4085
|
+
# ],
|
4086
|
+
# enable_ecs_managed_tags: false,
|
4087
|
+
# enable_execute_command: false,
|
4088
|
+
# placement_constraints: [
|
4089
|
+
# {
|
4090
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
4091
|
+
# expression: "PlacementConstraintExpression",
|
4092
|
+
# },
|
4093
|
+
# ],
|
4094
|
+
# placement_strategy: [
|
4095
|
+
# {
|
4096
|
+
# type: "random", # accepts random, spread, binpack
|
4097
|
+
# field: "PlacementStrategyField",
|
4098
|
+
# },
|
4099
|
+
# ],
|
4100
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
|
4101
|
+
# reference_id: "ReferenceId",
|
4102
|
+
# tags: [
|
4103
|
+
# {
|
4104
|
+
# key: "TagKey", # required
|
4105
|
+
# value: "TagValue", # required
|
4106
|
+
# },
|
4107
|
+
# ],
|
3837
4108
|
# },
|
3838
4109
|
# batch_parameters: {
|
3839
4110
|
# job_definition: "String", # required
|
@@ -3950,9 +4221,9 @@ module Aws::EventBridge
|
|
3950
4221
|
include Aws::Structure
|
3951
4222
|
end
|
3952
4223
|
|
3953
|
-
# These are custom parameters to be used when the target is a
|
3954
|
-
# cluster to invoke the Redshift Data API
|
3955
|
-
# EventBridge events.
|
4224
|
+
# These are custom parameters to be used when the target is a Amazon
|
4225
|
+
# Redshift cluster to invoke the Amazon Redshift Data API
|
4226
|
+
# ExecuteStatement based on EventBridge events.
|
3956
4227
|
#
|
3957
4228
|
# @note When making an API call, you may pass RedshiftDataParameters
|
3958
4229
|
# data as a hash:
|
@@ -3968,7 +4239,8 @@ module Aws::EventBridge
|
|
3968
4239
|
#
|
3969
4240
|
# @!attribute [rw] secret_manager_arn
|
3970
4241
|
# The name or ARN of the secret that enables access to the database.
|
3971
|
-
# Required when authenticating using
|
4242
|
+
# Required when authenticating using Amazon Web Services Secrets
|
4243
|
+
# Manager.
|
3972
4244
|
# @return [String]
|
3973
4245
|
#
|
3974
4246
|
# @!attribute [rw] database
|
@@ -4065,11 +4337,12 @@ module Aws::EventBridge
|
|
4065
4337
|
# @return [Array<String>]
|
4066
4338
|
#
|
4067
4339
|
# @!attribute [rw] force
|
4068
|
-
# If this is a managed rule, created by an
|
4069
|
-
# you must specify `Force` as `True` to remove
|
4070
|
-
# is ignored for rules that are not managed
|
4071
|
-
# whether a rule is a managed rule by using
|
4072
|
-
# `ListRules` and checking the `ManagedBy` field of
|
4340
|
+
# If this is a managed rule, created by an Amazon Web Services service
|
4341
|
+
# on your behalf, you must specify `Force` as `True` to remove
|
4342
|
+
# targets. This parameter is ignored for rules that are not managed
|
4343
|
+
# rules. You can check whether a rule is a managed rule by using
|
4344
|
+
# `DescribeRule` or `ListRules` and checking the `ManagedBy` field of
|
4345
|
+
# the response.
|
4073
4346
|
# @return [Boolean]
|
4074
4347
|
#
|
4075
4348
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RemoveTargetsRequest AWS API Documentation
|
@@ -4287,18 +4560,29 @@ module Aws::EventBridge
|
|
4287
4560
|
#
|
4288
4561
|
# @!attribute [rw] schedule_expression
|
4289
4562
|
# The scheduling expression. For example, "cron(0 20 * * ? *)",
|
4290
|
-
# "rate(5 minutes)".
|
4563
|
+
# "rate(5 minutes)". For more information, see [Creating an Amazon
|
4564
|
+
# EventBridge rule that runs on a schedule][1].
|
4565
|
+
#
|
4566
|
+
#
|
4567
|
+
#
|
4568
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html
|
4291
4569
|
# @return [String]
|
4292
4570
|
#
|
4293
4571
|
# @!attribute [rw] role_arn
|
4294
4572
|
# The Amazon Resource Name (ARN) of the role that is used for target
|
4295
4573
|
# invocation.
|
4574
|
+
#
|
4575
|
+
# If you're setting an event bus in another account as the target and
|
4576
|
+
# that account granted permission to your account through an
|
4577
|
+
# organization instead of directly by the account ID, you must specify
|
4578
|
+
# a `RoleArn` with proper permissions in the `Target` structure,
|
4579
|
+
# instead of here in this parameter.
|
4296
4580
|
# @return [String]
|
4297
4581
|
#
|
4298
4582
|
# @!attribute [rw] managed_by
|
4299
|
-
# If the rule was created on behalf of your account by an
|
4300
|
-
# this field displays the principal name of the
|
4301
|
-
# the rule.
|
4583
|
+
# If the rule was created on behalf of your account by an Amazon Web
|
4584
|
+
# Services service, this field displays the principal name of the
|
4585
|
+
# service that created the rule.
|
4302
4586
|
# @return [String]
|
4303
4587
|
#
|
4304
4588
|
# @!attribute [rw] event_bus_name
|
@@ -4545,8 +4829,8 @@ module Aws::EventBridge
|
|
4545
4829
|
include Aws::Structure
|
4546
4830
|
end
|
4547
4831
|
|
4548
|
-
# A key-value pair associated with an
|
4549
|
-
# rules and event buses support tagging.
|
4832
|
+
# A key-value pair associated with an Amazon Web Services resource. In
|
4833
|
+
# EventBridge, rules and event buses support tagging.
|
4550
4834
|
#
|
4551
4835
|
# @note When making an API call, you may pass Tag
|
4552
4836
|
# data as a hash:
|
@@ -4610,18 +4894,19 @@ module Aws::EventBridge
|
|
4610
4894
|
|
4611
4895
|
# Targets are the resources to be invoked when a rule is triggered. For
|
4612
4896
|
# a complete list of services and resources that can be set as a target,
|
4613
|
-
# see PutTargets.
|
4897
|
+
# see [PutTargets][1].
|
4614
4898
|
#
|
4615
4899
|
# If you are setting the event bus of another account as the target, and
|
4616
4900
|
# that account granted permission to your account through an
|
4617
4901
|
# organization instead of directly by the account ID, then you must
|
4618
4902
|
# specify a `RoleArn` with proper permissions in the `Target` structure.
|
4619
|
-
# For more information, see [Sending and Receiving Events Between
|
4620
|
-
# Accounts][
|
4903
|
+
# For more information, see [Sending and Receiving Events Between Amazon
|
4904
|
+
# Web Services Accounts][2] in the *Amazon EventBridge User Guide*.
|
4621
4905
|
#
|
4622
4906
|
#
|
4623
4907
|
#
|
4624
|
-
# [1]: https://docs.aws.amazon.com/eventbridge/latest/
|
4908
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html
|
4909
|
+
# [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
4625
4910
|
#
|
4626
4911
|
# @note When making an API call, you may pass Target
|
4627
4912
|
# data as a hash:
|
@@ -4662,6 +4947,35 @@ module Aws::EventBridge
|
|
4662
4947
|
# },
|
4663
4948
|
# platform_version: "String",
|
4664
4949
|
# group: "String",
|
4950
|
+
# capacity_provider_strategy: [
|
4951
|
+
# {
|
4952
|
+
# capacity_provider: "CapacityProvider", # required
|
4953
|
+
# weight: 1,
|
4954
|
+
# base: 1,
|
4955
|
+
# },
|
4956
|
+
# ],
|
4957
|
+
# enable_ecs_managed_tags: false,
|
4958
|
+
# enable_execute_command: false,
|
4959
|
+
# placement_constraints: [
|
4960
|
+
# {
|
4961
|
+
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
4962
|
+
# expression: "PlacementConstraintExpression",
|
4963
|
+
# },
|
4964
|
+
# ],
|
4965
|
+
# placement_strategy: [
|
4966
|
+
# {
|
4967
|
+
# type: "random", # accepts random, spread, binpack
|
4968
|
+
# field: "PlacementStrategyField",
|
4969
|
+
# },
|
4970
|
+
# ],
|
4971
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
|
4972
|
+
# reference_id: "ReferenceId",
|
4973
|
+
# tags: [
|
4974
|
+
# {
|
4975
|
+
# key: "TagKey", # required
|
4976
|
+
# value: "TagValue", # required
|
4977
|
+
# },
|
4978
|
+
# ],
|
4665
4979
|
# },
|
4666
4980
|
# batch_parameters: {
|
4667
4981
|
# job_definition: "String", # required
|
@@ -4711,7 +5025,8 @@ module Aws::EventBridge
|
|
4711
5025
|
# }
|
4712
5026
|
#
|
4713
5027
|
# @!attribute [rw] id
|
4714
|
-
# The ID of the target.
|
5028
|
+
# The ID of the target. We recommend using a memorable and unique
|
5029
|
+
# string.
|
4715
5030
|
# @return [String]
|
4716
5031
|
#
|
4717
5032
|
# @!attribute [rw] arn
|
@@ -4775,9 +5090,9 @@ module Aws::EventBridge
|
|
4775
5090
|
# @return [Types::EcsParameters]
|
4776
5091
|
#
|
4777
5092
|
# @!attribute [rw] batch_parameters
|
4778
|
-
# If the event target is an
|
5093
|
+
# If the event target is an Batch job, this contains the job
|
4779
5094
|
# definition, job name, and other parameters. For more information,
|
4780
|
-
# see [Jobs][1] in the *
|
5095
|
+
# see [Jobs][1] in the *Batch User Guide*.
|
4781
5096
|
#
|
4782
5097
|
#
|
4783
5098
|
#
|
@@ -4806,12 +5121,12 @@ module Aws::EventBridge
|
|
4806
5121
|
# @return [Types::HttpParameters]
|
4807
5122
|
#
|
4808
5123
|
# @!attribute [rw] redshift_data_parameters
|
4809
|
-
# Contains the Redshift Data API parameters to use when the
|
4810
|
-
# a Redshift cluster.
|
5124
|
+
# Contains the Amazon Redshift Data API parameters to use when the
|
5125
|
+
# target is a Amazon Redshift cluster.
|
4811
5126
|
#
|
4812
|
-
# If you specify a Redshift Cluster as a Target, you can use
|
4813
|
-
# specify parameters to invoke the Redshift Data API
|
4814
|
-
# based on EventBridge events.
|
5127
|
+
# If you specify a Amazon Redshift Cluster as a Target, you can use
|
5128
|
+
# this to specify parameters to invoke the Amazon Redshift Data API
|
5129
|
+
# ExecuteStatement based on EventBridge events.
|
4815
5130
|
# @return [Types::RedshiftDataParameters]
|
4816
5131
|
#
|
4817
5132
|
# @!attribute [rw] sage_maker_pipeline_parameters
|
@@ -4875,8 +5190,8 @@ module Aws::EventBridge
|
|
4875
5190
|
#
|
4876
5191
|
# @!attribute [rw] event
|
4877
5192
|
# The event, in JSON format, to test against the event pattern. The
|
4878
|
-
# JSON must follow the format specified in [
|
4879
|
-
# following fields are mandatory:
|
5193
|
+
# JSON must follow the format specified in [Amazon Web Services
|
5194
|
+
# Events][1], and the following fields are mandatory:
|
4880
5195
|
#
|
4881
5196
|
# * `id`
|
4882
5197
|
#
|