aws-sdk-cloudwatchevents 1.4.0 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a4785dfedddee8180f6c411dc8404f51f116c3ba
4
- data.tar.gz: b7c9625038407e851f119c34082e325d704ef8ee
3
+ metadata.gz: 7ce92a75a1402a027d7359c0884e94077fdde072
4
+ data.tar.gz: 24caacebf41e4c9cf8e758347e994124e03783a4
5
5
  SHA512:
6
- metadata.gz: 90f2bb6d90d1158a40439dd447f971b026bd92185c94cd4e20651da50e6fe6fe3db606f3252b4a7c97c72d4a418e2287f2bbb93bb1f6c33325dcdff7d3d3f4d9
7
- data.tar.gz: 326bd430ca3c18bf8430db03ed0b18c27f5ae58707a7a2c9e0a1b2c3a94557a187c454e335516495513bbd9998b9e5a30d425889d9bf31cb84f3b9493126f3c2
6
+ metadata.gz: 63a2154669de88eeae01616a21cdba19ca77ecca2d3404833a9c86fb078a311eda1032fc987cfe3952e12d4cb60ec4e9150500b1267a4e4c3ce748c82df89eb4
7
+ data.tar.gz: 2194b2962e0dafd2a0d641e378a860b0a6d9351811241ca4112266762e3efd4faf142ec929a294e71555b35cc5922e60d5b3ac9cd450a0b3c329f949e8f62674
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cloudwatchevents/customizations'
42
42
  # @service
43
43
  module Aws::CloudWatchEvents
44
44
 
45
- GEM_VERSION = '1.4.0'
45
+ GEM_VERSION = '1.5.0'
46
46
 
47
47
  end
@@ -168,12 +168,11 @@ module Aws::CloudWatchEvents
168
168
 
169
169
  # Deletes the specified rule.
170
170
  #
171
- # You must remove all targets from a rule using RemoveTargets before you
172
- # can delete the rule.
171
+ # Before you can delete the rule, you must remove all targets, using
172
+ # RemoveTargets.
173
173
  #
174
174
  # When you delete a rule, incoming events might continue to match to the
175
- # deleted rule. Please allow a short period of time for changes to take
176
- # effect.
175
+ # deleted rule. Allow a short period of time for changes to take effect.
177
176
  #
178
177
  # @option params [required, String] :name
179
178
  # The name of the rule.
@@ -223,6 +222,9 @@ module Aws::CloudWatchEvents
223
222
 
224
223
  # Describes the specified rule.
225
224
  #
225
+ # DescribeRule does not list the targets of a rule. To see the targets
226
+ # associated with a rule, use ListTargetsByRule.
227
+ #
226
228
  # @option params [required, String] :name
227
229
  # The name of the rule.
228
230
  #
@@ -265,8 +267,8 @@ module Aws::CloudWatchEvents
265
267
  # and won't self-trigger if it has a schedule expression.
266
268
  #
267
269
  # When you disable a rule, incoming events might continue to match to
268
- # the disabled rule. Please allow a short period of time for changes to
269
- # take effect.
270
+ # the disabled rule. Allow a short period of time for changes to take
271
+ # effect.
270
272
  #
271
273
  # @option params [required, String] :name
272
274
  # The name of the rule.
@@ -292,8 +294,8 @@ module Aws::CloudWatchEvents
292
294
  # fails.
293
295
  #
294
296
  # When you enable a rule, incoming events might not immediately start
295
- # matching to a newly enabled rule. Please allow a short period of time
296
- # for changes to take effect.
297
+ # matching to a newly enabled rule. Allow a short period of time for
298
+ # changes to take effect.
297
299
  #
298
300
  # @option params [required, String] :name
299
301
  # The name of the rule.
@@ -360,6 +362,9 @@ module Aws::CloudWatchEvents
360
362
  # Lists your Amazon CloudWatch Events rules. You can either list all the
361
363
  # rules or you can provide a prefix to match to the rule names.
362
364
  #
365
+ # ListRules does not list the targets of a rule. To see the targets
366
+ # associated with a rule, use ListTargetsByRule.
367
+ #
363
368
  # @option params [String] :name_prefix
364
369
  # The prefix matching the rule name.
365
370
  #
@@ -447,6 +452,14 @@ module Aws::CloudWatchEvents
447
452
  # resp.targets[0].run_command_parameters.run_command_targets[0].values[0] #=> String
448
453
  # resp.targets[0].ecs_parameters.task_definition_arn #=> String
449
454
  # resp.targets[0].ecs_parameters.task_count #=> Integer
455
+ # resp.targets[0].ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE"
456
+ # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
457
+ # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
458
+ # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
459
+ # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.security_groups[0] #=> String
460
+ # resp.targets[0].ecs_parameters.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
461
+ # resp.targets[0].ecs_parameters.platform_version #=> String
462
+ # resp.targets[0].ecs_parameters.group #=> String
450
463
  # resp.targets[0].batch_parameters.job_definition #=> String
451
464
  # resp.targets[0].batch_parameters.job_name #=> String
452
465
  # resp.targets[0].batch_parameters.array_properties.size #=> Integer
@@ -519,7 +532,7 @@ module Aws::CloudWatchEvents
519
532
  # To enable multiple AWS accounts to put events to your default event
520
533
  # bus, run `PutPermission` once for each of these accounts.
521
534
  #
522
- # The permission policy on the default event bus cannot exceed 10KB in
535
+ # The permission policy on the default event bus cannot exceed 10 KB in
523
536
  # size.
524
537
  #
525
538
  # @option params [required, String] :action
@@ -566,14 +579,14 @@ module Aws::CloudWatchEvents
566
579
  # or based on value of the state. You can disable a rule using
567
580
  # DisableRule.
568
581
  #
569
- # If you are updating an existing rule, the rule is completely replaced
570
- # with what you specify in this `PutRule` command. If you omit arguments
571
- # in `PutRule`, the old values for those arguments are not kept.
572
- # Instead, they are replaced with null values.
582
+ # If you are updating an existing rule, the rule is replaced with what
583
+ # you specify in this `PutRule` command. If you omit arguments in
584
+ # `PutRule`, the old values for those arguments are not kept. Instead,
585
+ # they are replaced with null values.
573
586
  #
574
587
  # When you create or update a rule, incoming events might not
575
- # immediately start matching to new or updated rules. Please allow a
576
- # short period of time for changes to take effect.
588
+ # immediately start matching to new or updated rules. Allow a short
589
+ # period of time for changes to take effect.
577
590
  #
578
591
  # A rule must contain at least an EventPattern or ScheduleExpression.
579
592
  # Rules with EventPatterns are triggered when a matching event is
@@ -650,11 +663,15 @@ module Aws::CloudWatchEvents
650
663
  #
651
664
  # * EC2 instances
652
665
  #
666
+ # * SSM Run Command
667
+ #
668
+ # * SSM Automation
669
+ #
653
670
  # * AWS Lambda functions
654
671
  #
655
- # * Streams in Amazon Kinesis Streams
672
+ # * Data streams in Amazon Kinesis Data Streams
656
673
  #
657
- # * Delivery streams in Amazon Kinesis Firehose
674
+ # * Data delivery streams in Amazon Kinesis Data Firehose
658
675
  #
659
676
  # * Amazon ECS tasks
660
677
  #
@@ -662,7 +679,9 @@ module Aws::CloudWatchEvents
662
679
  #
663
680
  # * AWS Batch jobs
664
681
  #
665
- # * Pipelines in Amazon Code Pipeline
682
+ # * AWS CodeBuild projects
683
+ #
684
+ # * Pipelines in AWS CodePipeline
666
685
  #
667
686
  # * Amazon Inspector assessment templates
668
687
  #
@@ -672,44 +691,46 @@ module Aws::CloudWatchEvents
672
691
  #
673
692
  # * The default event bus of another AWS account
674
693
  #
675
- # Note that creating rules with built-in targets is supported only in
676
- # the AWS Management Console.
694
+ # Creating rules with built-in targets is supported only in the AWS
695
+ # Management Console. The built-in targets are `EC2 CreateSnapshot API
696
+ # call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`,
697
+ # and `EC2 TerminateInstances API call`.
677
698
  #
678
699
  # For some target types, `PutTargets` provides target-specific
679
- # parameters. If the target is an Amazon Kinesis stream, you can
680
- # optionally specify which shard the event goes to by using the
681
- # `KinesisParameters` argument. To invoke a command on multiple EC2
682
- # instances with one rule, you can use the `RunCommandParameters` field.
700
+ # parameters. If the target is a Kinesis data stream, you can optionally
701
+ # specify which shard the event goes to by using the `KinesisParameters`
702
+ # argument. To invoke a command on multiple EC2 instances with one rule,
703
+ # you can use the `RunCommandParameters` field.
683
704
  #
684
705
  # To be able to make API calls against the resources that you own,
685
706
  # Amazon CloudWatch Events needs the appropriate permissions. For AWS
686
707
  # Lambda and Amazon SNS resources, CloudWatch Events relies on
687
- # resource-based policies. For EC2 instances, Amazon Kinesis streams,
688
- # and AWS Step Functions state machines, CloudWatch Events relies on IAM
708
+ # resource-based policies. For EC2 instances, Kinesis data streams, and
709
+ # AWS Step Functions state machines, CloudWatch Events relies on IAM
689
710
  # roles that you specify in the `RoleARN` argument in `PutTargets`. For
690
711
  # more information, see [Authentication and Access Control][1] in the
691
712
  # *Amazon CloudWatch Events User Guide*.
692
713
  #
693
714
  # If another AWS account is in the same region and has granted you
694
715
  # permission (using `PutPermission`), you can send events to that
695
- # account by setting that account's event bus as a target of the rules
696
- # in your account. To send the matched events to the other account,
697
- # specify that account's event bus as the `Arn` when you run
716
+ # account. Set that account's event bus as a target of the rules in
717
+ # your account. To send the matched events to the other account, specify
718
+ # that account's event bus as the `Arn` value when you run
698
719
  # `PutTargets`. If your account sends events to another account, your
699
- # account is charged for each sent event. Each event sent to antoher
720
+ # account is charged for each sent event. Each event sent to another
700
721
  # account is charged as a custom event. The account receiving the event
701
- # is not charged. For more information on pricing, see [Amazon
702
- # CloudWatch Pricing][2].
722
+ # is not charged. For more information, see [Amazon CloudWatch
723
+ # Pricing][2].
703
724
  #
704
725
  # For more information about enabling cross-account events, see
705
726
  # PutPermission.
706
727
  #
707
- # **Input**, **InputPath** and **InputTransformer** are mutually
728
+ # **Input**, **InputPath**, and **InputTransformer** are mutually
708
729
  # exclusive and optional parameters of a target. When a rule is
709
730
  # triggered due to a matched event:
710
731
  #
711
732
  # * If none of the following arguments are specified for a target, then
712
- # the entire event is passed to the target in JSON form (unless the
733
+ # the entire event is passed to the target in JSON format (unless the
713
734
  # target is Amazon EC2 Run Command or Amazon ECS task, in which case
714
735
  # nothing from the event is passed to the target).
715
736
  #
@@ -729,8 +750,8 @@ module Aws::CloudWatchEvents
729
750
  # dot notation, not bracket notation.
730
751
  #
731
752
  # When you add targets to a rule and the associated rule triggers soon
732
- # after, new or updated targets might not be immediately invoked. Please
733
- # allow a short period of time for changes to take effect.
753
+ # after, new or updated targets might not be immediately invoked. Allow
754
+ # a short period of time for changes to take effect.
734
755
  #
735
756
  # This action can partially fail if too many requests are made at the
736
757
  # same time. If that happens, `FailedEntryCount` is non-zero in the
@@ -784,6 +805,16 @@ module Aws::CloudWatchEvents
784
805
  # ecs_parameters: {
785
806
  # task_definition_arn: "Arn", # required
786
807
  # task_count: 1,
808
+ # launch_type: "EC2", # accepts EC2, FARGATE
809
+ # network_configuration: {
810
+ # awsvpc_configuration: {
811
+ # subnets: ["String"], # required
812
+ # security_groups: ["String"],
813
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
814
+ # },
815
+ # },
816
+ # platform_version: "String",
817
+ # group: "String",
787
818
  # },
788
819
  # batch_parameters: {
789
820
  # job_definition: "String", # required
@@ -850,8 +881,8 @@ module Aws::CloudWatchEvents
850
881
  # is triggered, those targets are no longer be invoked.
851
882
  #
852
883
  # When you remove a target, when the associated rule triggers, removed
853
- # targets might continue to be invoked. Please allow a short period of
854
- # time for changes to take effect.
884
+ # targets might continue to be invoked. Allow a short period of time for
885
+ # changes to take effect.
855
886
  #
856
887
  # This action can partially fail if too many requests are made at the
857
888
  # same time. If that happens, `FailedEntryCount` is non-zero in the
@@ -949,7 +980,7 @@ module Aws::CloudWatchEvents
949
980
  params: params,
950
981
  config: config)
951
982
  context[:gem_name] = 'aws-sdk-cloudwatchevents'
952
- context[:gem_version] = '1.4.0'
983
+ context[:gem_version] = '1.5.0'
953
984
  Seahorse::Client::Request.new(handlers, context)
954
985
  end
955
986
 
@@ -13,6 +13,8 @@ module Aws::CloudWatchEvents
13
13
 
14
14
  Action = Shapes::StringShape.new(name: 'Action')
15
15
  Arn = Shapes::StringShape.new(name: 'Arn')
16
+ AssignPublicIp = Shapes::StringShape.new(name: 'AssignPublicIp')
17
+ AwsVpcConfiguration = Shapes::StructureShape.new(name: 'AwsVpcConfiguration')
16
18
  BatchArrayProperties = Shapes::StructureShape.new(name: 'BatchArrayProperties')
17
19
  BatchParameters = Shapes::StructureShape.new(name: 'BatchParameters')
18
20
  BatchRetryStrategy = Shapes::StructureShape.new(name: 'BatchRetryStrategy')
@@ -39,6 +41,7 @@ module Aws::CloudWatchEvents
39
41
  InternalException = Shapes::StructureShape.new(name: 'InternalException')
40
42
  InvalidEventPatternException = Shapes::StructureShape.new(name: 'InvalidEventPatternException')
41
43
  KinesisParameters = Shapes::StructureShape.new(name: 'KinesisParameters')
44
+ LaunchType = Shapes::StringShape.new(name: 'LaunchType')
42
45
  LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
43
46
  LimitMax100 = Shapes::IntegerShape.new(name: 'LimitMax100')
44
47
  LimitMin1 = Shapes::IntegerShape.new(name: 'LimitMin1')
@@ -49,6 +52,7 @@ module Aws::CloudWatchEvents
49
52
  ListTargetsByRuleRequest = Shapes::StructureShape.new(name: 'ListTargetsByRuleRequest')
50
53
  ListTargetsByRuleResponse = Shapes::StructureShape.new(name: 'ListTargetsByRuleResponse')
51
54
  MessageGroupId = Shapes::StringShape.new(name: 'MessageGroupId')
55
+ NetworkConfiguration = Shapes::StructureShape.new(name: 'NetworkConfiguration')
52
56
  NextToken = Shapes::StringShape.new(name: 'NextToken')
53
57
  PolicyLengthExceededException = Shapes::StructureShape.new(name: 'PolicyLengthExceededException')
54
58
  Principal = Shapes::StringShape.new(name: 'Principal')
@@ -89,6 +93,7 @@ module Aws::CloudWatchEvents
89
93
  SqsParameters = Shapes::StructureShape.new(name: 'SqsParameters')
90
94
  StatementId = Shapes::StringShape.new(name: 'StatementId')
91
95
  String = Shapes::StringShape.new(name: 'String')
96
+ StringList = Shapes::ListShape.new(name: 'StringList')
92
97
  Target = Shapes::StructureShape.new(name: 'Target')
93
98
  TargetArn = Shapes::StringShape.new(name: 'TargetArn')
94
99
  TargetId = Shapes::StringShape.new(name: 'TargetId')
@@ -102,6 +107,11 @@ module Aws::CloudWatchEvents
102
107
  TransformerInput = Shapes::StringShape.new(name: 'TransformerInput')
103
108
  TransformerPaths = Shapes::MapShape.new(name: 'TransformerPaths')
104
109
 
110
+ AwsVpcConfiguration.add_member(:subnets, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "Subnets"))
111
+ AwsVpcConfiguration.add_member(:security_groups, Shapes::ShapeRef.new(shape: StringList, location_name: "SecurityGroups"))
112
+ AwsVpcConfiguration.add_member(:assign_public_ip, Shapes::ShapeRef.new(shape: AssignPublicIp, location_name: "AssignPublicIp"))
113
+ AwsVpcConfiguration.struct_class = Types::AwsVpcConfiguration
114
+
105
115
  BatchArrayProperties.add_member(:size, Shapes::ShapeRef.new(shape: Integer, location_name: "Size"))
106
116
  BatchArrayProperties.struct_class = Types::BatchArrayProperties
107
117
 
@@ -141,6 +151,10 @@ module Aws::CloudWatchEvents
141
151
 
142
152
  EcsParameters.add_member(:task_definition_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "TaskDefinitionArn"))
143
153
  EcsParameters.add_member(:task_count, Shapes::ShapeRef.new(shape: LimitMin1, location_name: "TaskCount"))
154
+ EcsParameters.add_member(:launch_type, Shapes::ShapeRef.new(shape: LaunchType, location_name: "LaunchType"))
155
+ EcsParameters.add_member(:network_configuration, Shapes::ShapeRef.new(shape: NetworkConfiguration, location_name: "NetworkConfiguration"))
156
+ EcsParameters.add_member(:platform_version, Shapes::ShapeRef.new(shape: String, location_name: "PlatformVersion"))
157
+ EcsParameters.add_member(:group, Shapes::ShapeRef.new(shape: String, location_name: "Group"))
144
158
  EcsParameters.struct_class = Types::EcsParameters
145
159
 
146
160
  EnableRuleRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleName, required: true, location_name: "Name"))
@@ -182,6 +196,9 @@ module Aws::CloudWatchEvents
182
196
  ListTargetsByRuleResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
183
197
  ListTargetsByRuleResponse.struct_class = Types::ListTargetsByRuleResponse
184
198
 
199
+ NetworkConfiguration.add_member(:awsvpc_configuration, Shapes::ShapeRef.new(shape: AwsVpcConfiguration, location_name: "awsvpcConfiguration"))
200
+ NetworkConfiguration.struct_class = Types::NetworkConfiguration
201
+
185
202
  PutEventsRequest.add_member(:entries, Shapes::ShapeRef.new(shape: PutEventsRequestEntryList, required: true, location_name: "Entries"))
186
203
  PutEventsRequest.struct_class = Types::PutEventsRequest
187
204
 
@@ -281,6 +298,8 @@ module Aws::CloudWatchEvents
281
298
  SqsParameters.add_member(:message_group_id, Shapes::ShapeRef.new(shape: MessageGroupId, location_name: "MessageGroupId"))
282
299
  SqsParameters.struct_class = Types::SqsParameters
283
300
 
301
+ StringList.member = Shapes::ShapeRef.new(shape: String)
302
+
284
303
  Target.add_member(:id, Shapes::ShapeRef.new(shape: TargetId, required: true, location_name: "Id"))
285
304
  Target.add_member(:arn, Shapes::ShapeRef.new(shape: TargetArn, required: true, location_name: "Arn"))
286
305
  Target.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
@@ -8,6 +8,46 @@
8
8
  module Aws::CloudWatchEvents
9
9
  module Types
10
10
 
11
+ # This structure specifies the VPC subnets and security groups for the
12
+ # task, and whether a public IP address is to be used. This structure is
13
+ # relevant only for ECS tasks that use the `awsvpc` network mode.
14
+ #
15
+ # @note When making an API call, you may pass AwsVpcConfiguration
16
+ # data as a hash:
17
+ #
18
+ # {
19
+ # subnets: ["String"], # required
20
+ # security_groups: ["String"],
21
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
22
+ # }
23
+ #
24
+ # @!attribute [rw] subnets
25
+ # Specifies the subnets associated with the task. These subnets must
26
+ # all be in the same VPC. You can specify as many as 16 subnets.
27
+ # @return [Array<String>]
28
+ #
29
+ # @!attribute [rw] security_groups
30
+ # Specifies the security groups associated with the task. These
31
+ # security groups must all be in the same VPC. You can specify as many
32
+ # as five security groups. If you do not specify a security group, the
33
+ # default security group for the VPC is used.
34
+ # @return [Array<String>]
35
+ #
36
+ # @!attribute [rw] assign_public_ip
37
+ # Specifies whether the task's elastic network interface receives a
38
+ # public IP address. You can specify `ENABLED` only when `LaunchType`
39
+ # in `EcsParameters` is set to `FARGATE`.
40
+ # @return [String]
41
+ #
42
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/AwsVpcConfiguration AWS API Documentation
43
+ #
44
+ class AwsVpcConfiguration < Struct.new(
45
+ :subnets,
46
+ :security_groups,
47
+ :assign_public_ip)
48
+ include Aws::Structure
49
+ end
50
+
11
51
  # The array properties for the submitted job, such as the size of the
12
52
  # array. The array size can be between 2 and 10,000. If you specify
13
53
  # array properties for a job, it becomes an array job. This parameter is
@@ -68,7 +108,7 @@ module Aws::CloudWatchEvents
68
108
  # @!attribute [rw] retry_strategy
69
109
  # The retry strategy to use for failed jobs, if the target is an AWS
70
110
  # Batch job. The retry strategy is the number of times to retry the
71
- # failed job execution. Valid values are 1 to 10. When you specify a
111
+ # failed job execution. Valid values are 110. When you specify a
72
112
  # retry strategy here, it overrides the retry strategy defined in the
73
113
  # job definition.
74
114
  # @return [Types::BatchRetryStrategy]
@@ -96,7 +136,7 @@ module Aws::CloudWatchEvents
96
136
  #
97
137
  # @!attribute [rw] attempts
98
138
  # The number of times to attempt to retry, if the job fails. Valid
99
- # values are 1 to 10.
139
+ # values are 110.
100
140
  # @return [Integer]
101
141
  #
102
142
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/BatchRetryStrategy AWS API Documentation
@@ -238,7 +278,7 @@ module Aws::CloudWatchEvents
238
278
  end
239
279
 
240
280
  # The custom parameters to be used when the target is an Amazon ECS
241
- # cluster.
281
+ # task.
242
282
  #
243
283
  # @note When making an API call, you may pass EcsParameters
244
284
  # data as a hash:
@@ -246,23 +286,80 @@ module Aws::CloudWatchEvents
246
286
  # {
247
287
  # task_definition_arn: "Arn", # required
248
288
  # task_count: 1,
289
+ # launch_type: "EC2", # accepts EC2, FARGATE
290
+ # network_configuration: {
291
+ # awsvpc_configuration: {
292
+ # subnets: ["String"], # required
293
+ # security_groups: ["String"],
294
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
295
+ # },
296
+ # },
297
+ # platform_version: "String",
298
+ # group: "String",
249
299
  # }
250
300
  #
251
301
  # @!attribute [rw] task_definition_arn
252
302
  # The ARN of the task definition to use if the event target is an
253
- # Amazon ECS cluster.
303
+ # Amazon ECS task.
254
304
  # @return [String]
255
305
  #
256
306
  # @!attribute [rw] task_count
257
- # The number of tasks to create based on the `TaskDefinition`. The
258
- # default is one.
307
+ # The number of tasks to create based on `TaskDefinition`. The default
308
+ # is 1.
259
309
  # @return [Integer]
260
310
  #
311
+ # @!attribute [rw] launch_type
312
+ # Specifies the launch type on which your task is running. The launch
313
+ # type that you specify here must match one of the launch type
314
+ # (compatibilities) of the target task. The `FARGATE` value is
315
+ # supported only in the Regions where AWS Fargate with Amazon ECS is
316
+ # supported. For more information, see [AWS Fargate on Amazon ECS][1]
317
+ # in the *Amazon Elastic Container Service Developer Guide*.
318
+ #
319
+ #
320
+ #
321
+ # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html
322
+ # @return [String]
323
+ #
324
+ # @!attribute [rw] network_configuration
325
+ # Use this structure if the ECS task uses the `awsvpc` network mode.
326
+ # This structure specifies the VPC subnets and security groups
327
+ # associated with the task, and whether a public IP address is to be
328
+ # used. This structure is required if `LaunchType` is `FARGATE`
329
+ # because the `awsvpc` mode is required for Fargate tasks.
330
+ #
331
+ # If you specify `NetworkConfiguration` when the target ECS task does
332
+ # not use the `awsvpc` network mode, the task fails.
333
+ # @return [Types::NetworkConfiguration]
334
+ #
335
+ # @!attribute [rw] platform_version
336
+ # Specifies the platform version for the task. Specify only the
337
+ # numeric portion of the platform version, such as `1.1.0`.
338
+ #
339
+ # This structure is used only if `LaunchType` is `FARGATE`. For more
340
+ # information about valid platform versions, see [AWS Fargate Platform
341
+ # Versions][1] in the *Amazon Elastic Container Service Developer
342
+ # Guide*.
343
+ #
344
+ #
345
+ #
346
+ # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
347
+ # @return [String]
348
+ #
349
+ # @!attribute [rw] group
350
+ # Specifies an ECS task group for the task. The maximum length is 255
351
+ # characters.
352
+ # @return [String]
353
+ #
261
354
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EcsParameters AWS API Documentation
262
355
  #
263
356
  class EcsParameters < Struct.new(
264
357
  :task_definition_arn,
265
- :task_count)
358
+ :task_count,
359
+ :launch_type,
360
+ :network_configuration,
361
+ :platform_version,
362
+ :group)
266
363
  include Aws::Structure
267
364
  end
268
365
 
@@ -298,14 +395,58 @@ module Aws::CloudWatchEvents
298
395
  # }
299
396
  #
300
397
  # @!attribute [rw] input_paths_map
301
- # Map of JSON paths to be extracted from the event. These are
302
- # key-value pairs, where each value is a JSON path. You must use JSON
303
- # dot notation, not bracket notation.
398
+ # Map of JSON paths to be extracted from the event. You can then
399
+ # insert these in the template in `InputTemplate` to produce the
400
+ # output you want to be sent to the target.
401
+ #
402
+ # `InputPathsMap` is an array key-value pairs, where each value is a
403
+ # valid JSON path. You can have as many as 10 key-value pairs. You
404
+ # must use JSON dot notation, not bracket notation.
405
+ #
406
+ # The keys cannot start with "AWS."
304
407
  # @return [Hash<String,String>]
305
408
  #
306
409
  # @!attribute [rw] input_template
307
- # Input template where you can use the values of the keys from
308
- # `InputPathsMap` to customize the data sent to the target.
410
+ # Input template where you specify placeholders that will be filled
411
+ # with the values of the keys from `InputPathsMap` to customize the
412
+ # data sent to the target. Enclose each `InputPathsMaps` value in
413
+ # brackets: &lt;*value*&gt; The InputTemplate must be valid JSON.
414
+ #
415
+ # If `InputTemplate` is a JSON object (surrounded by curly braces),
416
+ # the following restrictions apply:
417
+ #
418
+ # * The placeholder cannot be used as an object key.
419
+ #
420
+ # * Object values cannot include quote marks.
421
+ #
422
+ # The following example shows the syntax for using `InputPathsMap` and
423
+ # `InputTemplate`.
424
+ #
425
+ # ` "InputTransformer":`
426
+ #
427
+ # `\{`
428
+ #
429
+ # `"InputPathsMap": \{"instance": "$.detail.instance","status":
430
+ # "$.detail.status"\},`
431
+ #
432
+ # `"InputTemplate": "<instance> is in state <status>"`
433
+ #
434
+ # `\}`
435
+ #
436
+ # To have the `InputTemplate` include quote marks within a JSON
437
+ # string, escape each quote marks with a slash, as in the following
438
+ # example:
439
+ #
440
+ # ` "InputTransformer":`
441
+ #
442
+ # `\{`
443
+ #
444
+ # `"InputPathsMap": \{"instance": "$.detail.instance","status":
445
+ # "$.detail.status"\},`
446
+ #
447
+ # `"InputTemplate": "<instance> is in state "<status>""`
448
+ #
449
+ # `\}`
309
450
  # @return [String]
310
451
  #
311
452
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/InputTransformer AWS API Documentation
@@ -317,9 +458,9 @@ module Aws::CloudWatchEvents
317
458
  end
318
459
 
319
460
  # This object enables you to specify a JSON path to extract from the
320
- # event and use as the partition key for the Amazon Kinesis stream, so
321
- # that you can control the shard to which the event goes. If you do not
322
- # include this parameter, the default is to use the `eventId` as the
461
+ # event and use as the partition key for the Amazon Kinesis data stream,
462
+ # so that you can control the shard to which the event goes. If you do
463
+ # not include this parameter, the default is to use the `eventId` as the
323
464
  # partition key.
324
465
  #
325
466
  # @note When making an API call, you may pass KinesisParameters
@@ -490,6 +631,33 @@ module Aws::CloudWatchEvents
490
631
  include Aws::Structure
491
632
  end
492
633
 
634
+ # This structure specifies the network configuration for an ECS task.
635
+ #
636
+ # @note When making an API call, you may pass NetworkConfiguration
637
+ # data as a hash:
638
+ #
639
+ # {
640
+ # awsvpc_configuration: {
641
+ # subnets: ["String"], # required
642
+ # security_groups: ["String"],
643
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
644
+ # },
645
+ # }
646
+ #
647
+ # @!attribute [rw] awsvpc_configuration
648
+ # Use this structure to specify the VPC subnets and security groups
649
+ # for the task, and whether a public IP address is to be used. This
650
+ # structure is relevant only for ECS tasks that use the `awsvpc`
651
+ # network mode.
652
+ # @return [Types::AwsVpcConfiguration]
653
+ #
654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/NetworkConfiguration AWS API Documentation
655
+ #
656
+ class NetworkConfiguration < Struct.new(
657
+ :awsvpc_configuration)
658
+ include Aws::Structure
659
+ end
660
+
493
661
  # @note When making an API call, you may pass PutEventsRequest
494
662
  # data as a hash:
495
663
  #
@@ -532,8 +700,8 @@ module Aws::CloudWatchEvents
532
700
  # }
533
701
  #
534
702
  # @!attribute [rw] time
535
- # The timestamp of the event, per [RFC3339][1]. If no timestamp is
536
- # provided, the timestamp of the PutEvents call is used.
703
+ # The time stamp of the event, per [RFC3339][1]. If no time stamp is
704
+ # provided, the time stamp of the PutEvents call is used.
537
705
  #
538
706
  #
539
707
  #
@@ -541,7 +709,7 @@ module Aws::CloudWatchEvents
541
709
  # @return [Time]
542
710
  #
543
711
  # @!attribute [rw] source
544
- # The source of the event.
712
+ # The source of the event. This field is required.
545
713
  # @return [String]
546
714
  #
547
715
  # @!attribute [rw] resources
@@ -753,6 +921,16 @@ module Aws::CloudWatchEvents
753
921
  # ecs_parameters: {
754
922
  # task_definition_arn: "Arn", # required
755
923
  # task_count: 1,
924
+ # launch_type: "EC2", # accepts EC2, FARGATE
925
+ # network_configuration: {
926
+ # awsvpc_configuration: {
927
+ # subnets: ["String"], # required
928
+ # security_groups: ["String"],
929
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
930
+ # },
931
+ # },
932
+ # platform_version: "String",
933
+ # group: "String",
756
934
  # },
757
935
  # batch_parameters: {
758
936
  # job_definition: "String", # required
@@ -1040,10 +1218,9 @@ module Aws::CloudWatchEvents
1040
1218
  include Aws::Structure
1041
1219
  end
1042
1220
 
1043
- # Targets are the resources to be invoked when a rule is triggered.
1044
- # Target types include EC2 instances, AWS Lambda functions, Amazon
1045
- # Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines,
1046
- # Run Command, and built-in targets.
1221
+ # Targets are the resources to be invoked when a rule is triggered. For
1222
+ # a complete list of services and resources that can be set as a target,
1223
+ # see PutTargets.
1047
1224
  #
1048
1225
  # @note When making an API call, you may pass Target
1049
1226
  # data as a hash:
@@ -1074,6 +1251,16 @@ module Aws::CloudWatchEvents
1074
1251
  # ecs_parameters: {
1075
1252
  # task_definition_arn: "Arn", # required
1076
1253
  # task_count: 1,
1254
+ # launch_type: "EC2", # accepts EC2, FARGATE
1255
+ # network_configuration: {
1256
+ # awsvpc_configuration: {
1257
+ # subnets: ["String"], # required
1258
+ # security_groups: ["String"],
1259
+ # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
1260
+ # },
1261
+ # },
1262
+ # platform_version: "String",
1263
+ # group: "String",
1077
1264
  # },
1078
1265
  # batch_parameters: {
1079
1266
  # job_definition: "String", # required
@@ -1133,8 +1320,8 @@ module Aws::CloudWatchEvents
1133
1320
  # @return [Types::InputTransformer]
1134
1321
  #
1135
1322
  # @!attribute [rw] kinesis_parameters
1136
- # The custom parameter you can use to control shard assignment, when
1137
- # the target is an Amazon Kinesis stream. If you do not include this
1323
+ # The custom parameter you can use to control the shard assignment,
1324
+ # when the target is a Kinesis data stream. If you do not include this
1138
1325
  # parameter, the default is to use the `eventId` as the partition key.
1139
1326
  # @return [Types::KinesisParameters]
1140
1327
  #
@@ -1155,9 +1342,9 @@ module Aws::CloudWatchEvents
1155
1342
  # @return [Types::EcsParameters]
1156
1343
  #
1157
1344
  # @!attribute [rw] batch_parameters
1158
- # Contains the job definition, job name, and other parameters if the
1159
- # event target is an AWS Batch job. For more information about AWS
1160
- # Batch, see [Jobs][1] in the *AWS Batch User Guide*.
1345
+ # If the event target is an AWS Batch job, this contains the job
1346
+ # definition, job name, and other parameters. For more information,
1347
+ # see [Jobs][1] in the *AWS Batch User Guide*.
1161
1348
  #
1162
1349
  #
1163
1350
  #
@@ -1167,6 +1354,9 @@ module Aws::CloudWatchEvents
1167
1354
  # @!attribute [rw] sqs_parameters
1168
1355
  # Contains the message group ID to use when the target is a FIFO
1169
1356
  # queue.
1357
+ #
1358
+ # If you specify an SQS FIFO queue as a target, the queue must have
1359
+ # content-based deduplication enabled.
1170
1360
  # @return [Types::SqsParameters]
1171
1361
  #
1172
1362
  # @see http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/Target AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cloudwatchevents
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 1.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-06-26 00:00:00.000000000 Z
11
+ date: 2018-08-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core