aws-sdk-eventbridge 1.35.0 → 1.38.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-eventbridge/client.rb +419 -35
- data/lib/aws-sdk-eventbridge/client_api.rb +193 -0
- data/lib/aws-sdk-eventbridge/plugins/multi_region_endpoint.rb +75 -0
- data/lib/aws-sdk-eventbridge/types.rb +697 -11
- data/lib/aws-sdk-eventbridge.rb +1 -1
- metadata +5 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1d9dd8cf3ffed6760382c18cc55013f00a22e986d42003b681b9458c5a679d8f
|
4
|
+
data.tar.gz: 58e8e310b12e2babfc149dc3ad5245b96ba1da7d6a6a85f29a810572c64bb297
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e8c220c302bc8f6ba5cbb5ea6d2cefb40b702138e0c07d63a88536d056695697f28881e63a2646093ca270be1d04a6b1f6b170fdddd3035820c37e7c9b0ef9c5
|
7
|
+
data.tar.gz: 2cd58fb80016587c58617ad0440edb3df3b3b78e4651a7004026dd7663116adc31b634f9bbb993f583319f65a4855d3ec85b1edfa9029a38dd346ce999c251ef
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.38.0 (2022-04-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adds new EventBridge Endpoint resources for disaster recovery, multi-region failover, and cross-region replication capabilities to help you build resilient event-driven applications.
|
8
|
+
|
9
|
+
1.37.0 (2022-02-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.36.0 (2022-02-07)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Documentation updates for EventBridge
|
18
|
+
|
4
19
|
1.35.0 (2022-02-03)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.38.0
|
@@ -27,10 +27,12 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
33
34
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
35
|
+
require 'aws-sdk-eventbridge/plugins/multi_region_endpoint.rb'
|
34
36
|
|
35
37
|
Aws::Plugins::GlobalConfiguration.add_identifier(:eventbridge)
|
36
38
|
|
@@ -75,10 +77,12 @@ module Aws::EventBridge
|
|
75
77
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
78
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
79
|
add_plugin(Aws::Plugins::HttpChecksum)
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
81
|
add_plugin(Aws::Plugins::DefaultsMode)
|
79
82
|
add_plugin(Aws::Plugins::RecursionDetection)
|
80
83
|
add_plugin(Aws::Plugins::SignatureV4)
|
81
84
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
85
|
+
add_plugin(Aws::EventBridge::Plugins::MultiRegionEndpoint)
|
82
86
|
|
83
87
|
# @overload initialize(options)
|
84
88
|
# @param [Hash] options
|
@@ -641,6 +645,93 @@ module Aws::EventBridge
|
|
641
645
|
req.send_request(options)
|
642
646
|
end
|
643
647
|
|
648
|
+
# Creates a global endpoint. Global endpoints improve your
|
649
|
+
# application's availability by making it regional-fault tolerant. To
|
650
|
+
# do this, you define a primary and secondary Region with event buses in
|
651
|
+
# each Region. You also create a Amazon Route 53 health check that will
|
652
|
+
# tell EventBridge to route events to the secondary Region when an
|
653
|
+
# "unhealthy" state is encountered and events will be routed back to
|
654
|
+
# the primary Region when the health check reports a "healthy" state.
|
655
|
+
#
|
656
|
+
# @option params [required, String] :name
|
657
|
+
# The name of the global endpoint. For example,
|
658
|
+
# `"Name":"us-east-2-custom_bus_A-endpoint"`.
|
659
|
+
#
|
660
|
+
# @option params [String] :description
|
661
|
+
# A description of the global endpoint.
|
662
|
+
#
|
663
|
+
# @option params [required, Types::RoutingConfig] :routing_config
|
664
|
+
# Configure the routing policy, including the health check and secondary
|
665
|
+
# Region..
|
666
|
+
#
|
667
|
+
# @option params [Types::ReplicationConfig] :replication_config
|
668
|
+
# Enable or disable event replication.
|
669
|
+
#
|
670
|
+
# @option params [required, Array<Types::EndpointEventBus>] :event_buses
|
671
|
+
# Define the event buses used.
|
672
|
+
#
|
673
|
+
# The names of the event buses must be identical in each Region.
|
674
|
+
#
|
675
|
+
# @option params [String] :role_arn
|
676
|
+
# The ARN of the role used for replication.
|
677
|
+
#
|
678
|
+
# @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
679
|
+
#
|
680
|
+
# * {Types::CreateEndpointResponse#name #name} => String
|
681
|
+
# * {Types::CreateEndpointResponse#arn #arn} => String
|
682
|
+
# * {Types::CreateEndpointResponse#routing_config #routing_config} => Types::RoutingConfig
|
683
|
+
# * {Types::CreateEndpointResponse#replication_config #replication_config} => Types::ReplicationConfig
|
684
|
+
# * {Types::CreateEndpointResponse#event_buses #event_buses} => Array<Types::EndpointEventBus>
|
685
|
+
# * {Types::CreateEndpointResponse#role_arn #role_arn} => String
|
686
|
+
# * {Types::CreateEndpointResponse#state #state} => String
|
687
|
+
#
|
688
|
+
# @example Request syntax with placeholder values
|
689
|
+
#
|
690
|
+
# resp = client.create_endpoint({
|
691
|
+
# name: "EndpointName", # required
|
692
|
+
# description: "EndpointDescription",
|
693
|
+
# routing_config: { # required
|
694
|
+
# failover_config: { # required
|
695
|
+
# primary: { # required
|
696
|
+
# health_check: "HealthCheck", # required
|
697
|
+
# },
|
698
|
+
# secondary: { # required
|
699
|
+
# route: "Route", # required
|
700
|
+
# },
|
701
|
+
# },
|
702
|
+
# },
|
703
|
+
# replication_config: {
|
704
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
705
|
+
# },
|
706
|
+
# event_buses: [ # required
|
707
|
+
# {
|
708
|
+
# event_bus_arn: "NonPartnerEventBusArn", # required
|
709
|
+
# },
|
710
|
+
# ],
|
711
|
+
# role_arn: "IamRoleArn",
|
712
|
+
# })
|
713
|
+
#
|
714
|
+
# @example Response structure
|
715
|
+
#
|
716
|
+
# resp.name #=> String
|
717
|
+
# resp.arn #=> String
|
718
|
+
# resp.routing_config.failover_config.primary.health_check #=> String
|
719
|
+
# resp.routing_config.failover_config.secondary.route #=> String
|
720
|
+
# resp.replication_config.state #=> String, one of "ENABLED", "DISABLED"
|
721
|
+
# resp.event_buses #=> Array
|
722
|
+
# resp.event_buses[0].event_bus_arn #=> String
|
723
|
+
# resp.role_arn #=> String
|
724
|
+
# resp.state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
725
|
+
#
|
726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEndpoint AWS API Documentation
|
727
|
+
#
|
728
|
+
# @overload create_endpoint(params = {})
|
729
|
+
# @param [Hash] params ({})
|
730
|
+
def create_endpoint(params = {}, options = {})
|
731
|
+
req = build_request(:create_endpoint, params)
|
732
|
+
req.send_request(options)
|
733
|
+
end
|
734
|
+
|
644
735
|
# Creates a new event bus within your account. This can be a custom
|
645
736
|
# event bus which you can use to receive events from your custom
|
646
737
|
# applications and services, or it can be a partner event bus which can
|
@@ -911,6 +1002,36 @@ module Aws::EventBridge
|
|
911
1002
|
req.send_request(options)
|
912
1003
|
end
|
913
1004
|
|
1005
|
+
# Delete an existing global endpoint. For more information about global
|
1006
|
+
# endpoints, see [Making applications Regional-fault tolerant with
|
1007
|
+
# global endpoints and event replication][1] in the Amazon EventBridge
|
1008
|
+
# User Guide.
|
1009
|
+
#
|
1010
|
+
#
|
1011
|
+
#
|
1012
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html
|
1013
|
+
#
|
1014
|
+
# @option params [required, String] :name
|
1015
|
+
# The name of the endpoint you want to delete. For example,
|
1016
|
+
# `"Name":"us-east-2-custom_bus_A-endpoint"`..
|
1017
|
+
#
|
1018
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1019
|
+
#
|
1020
|
+
# @example Request syntax with placeholder values
|
1021
|
+
#
|
1022
|
+
# resp = client.delete_endpoint({
|
1023
|
+
# name: "EndpointName", # required
|
1024
|
+
# })
|
1025
|
+
#
|
1026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteEndpoint AWS API Documentation
|
1027
|
+
#
|
1028
|
+
# @overload delete_endpoint(params = {})
|
1029
|
+
# @param [Hash] params ({})
|
1030
|
+
def delete_endpoint(params = {}, options = {})
|
1031
|
+
req = build_request(:delete_endpoint, params)
|
1032
|
+
req.send_request(options)
|
1033
|
+
end
|
1034
|
+
|
914
1035
|
# Deletes the specified custom event bus or partner event bus. All rules
|
915
1036
|
# associated with this event bus need to be deleted. You can't delete
|
916
1037
|
# your account's default event bus.
|
@@ -1193,6 +1314,73 @@ module Aws::EventBridge
|
|
1193
1314
|
req.send_request(options)
|
1194
1315
|
end
|
1195
1316
|
|
1317
|
+
# Get the information about an existing global endpoint. For more
|
1318
|
+
# information about global endpoints, see [Making applications
|
1319
|
+
# Regional-fault tolerant with global endpoints and event
|
1320
|
+
# replication][1] in the Amazon EventBridge User Guide..
|
1321
|
+
#
|
1322
|
+
#
|
1323
|
+
#
|
1324
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html
|
1325
|
+
#
|
1326
|
+
# @option params [required, String] :name
|
1327
|
+
# The name of the endpoint you want to get information about. For
|
1328
|
+
# example, `"Name":"us-east-2-custom_bus_A-endpoint"`.
|
1329
|
+
#
|
1330
|
+
# @option params [String] :home_region
|
1331
|
+
# The primary Region of the endpoint you want to get information about.
|
1332
|
+
# For example `"HomeRegion": "us-east-1"`.
|
1333
|
+
#
|
1334
|
+
# @return [Types::DescribeEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1335
|
+
#
|
1336
|
+
# * {Types::DescribeEndpointResponse#name #name} => String
|
1337
|
+
# * {Types::DescribeEndpointResponse#description #description} => String
|
1338
|
+
# * {Types::DescribeEndpointResponse#arn #arn} => String
|
1339
|
+
# * {Types::DescribeEndpointResponse#routing_config #routing_config} => Types::RoutingConfig
|
1340
|
+
# * {Types::DescribeEndpointResponse#replication_config #replication_config} => Types::ReplicationConfig
|
1341
|
+
# * {Types::DescribeEndpointResponse#event_buses #event_buses} => Array<Types::EndpointEventBus>
|
1342
|
+
# * {Types::DescribeEndpointResponse#role_arn #role_arn} => String
|
1343
|
+
# * {Types::DescribeEndpointResponse#endpoint_id #endpoint_id} => String
|
1344
|
+
# * {Types::DescribeEndpointResponse#endpoint_url #endpoint_url} => String
|
1345
|
+
# * {Types::DescribeEndpointResponse#state #state} => String
|
1346
|
+
# * {Types::DescribeEndpointResponse#state_reason #state_reason} => String
|
1347
|
+
# * {Types::DescribeEndpointResponse#creation_time #creation_time} => Time
|
1348
|
+
# * {Types::DescribeEndpointResponse#last_modified_time #last_modified_time} => Time
|
1349
|
+
#
|
1350
|
+
# @example Request syntax with placeholder values
|
1351
|
+
#
|
1352
|
+
# resp = client.describe_endpoint({
|
1353
|
+
# name: "EndpointName", # required
|
1354
|
+
# home_region: "HomeRegion",
|
1355
|
+
# })
|
1356
|
+
#
|
1357
|
+
# @example Response structure
|
1358
|
+
#
|
1359
|
+
# resp.name #=> String
|
1360
|
+
# resp.description #=> String
|
1361
|
+
# resp.arn #=> String
|
1362
|
+
# resp.routing_config.failover_config.primary.health_check #=> String
|
1363
|
+
# resp.routing_config.failover_config.secondary.route #=> String
|
1364
|
+
# resp.replication_config.state #=> String, one of "ENABLED", "DISABLED"
|
1365
|
+
# resp.event_buses #=> Array
|
1366
|
+
# resp.event_buses[0].event_bus_arn #=> String
|
1367
|
+
# resp.role_arn #=> String
|
1368
|
+
# resp.endpoint_id #=> String
|
1369
|
+
# resp.endpoint_url #=> String
|
1370
|
+
# resp.state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
1371
|
+
# resp.state_reason #=> String
|
1372
|
+
# resp.creation_time #=> Time
|
1373
|
+
# resp.last_modified_time #=> Time
|
1374
|
+
#
|
1375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeEndpoint AWS API Documentation
|
1376
|
+
#
|
1377
|
+
# @overload describe_endpoint(params = {})
|
1378
|
+
# @param [Hash] params ({})
|
1379
|
+
def describe_endpoint(params = {}, options = {})
|
1380
|
+
req = build_request(:describe_endpoint, params)
|
1381
|
+
req.send_request(options)
|
1382
|
+
end
|
1383
|
+
|
1196
1384
|
# Displays details about an event bus in your account. This can include
|
1197
1385
|
# the external Amazon Web Services accounts that are permitted to write
|
1198
1386
|
# events to your default event bus, and the associated policy. For
|
@@ -1665,6 +1853,78 @@ module Aws::EventBridge
|
|
1665
1853
|
req.send_request(options)
|
1666
1854
|
end
|
1667
1855
|
|
1856
|
+
# List the global endpoints associated with this account. For more
|
1857
|
+
# information about global endpoints, see [Making applications
|
1858
|
+
# Regional-fault tolerant with global endpoints and event
|
1859
|
+
# replication][1] in the Amazon EventBridge User Guide..
|
1860
|
+
#
|
1861
|
+
#
|
1862
|
+
#
|
1863
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html
|
1864
|
+
#
|
1865
|
+
# @option params [String] :name_prefix
|
1866
|
+
# A value that will return a subset of the endpoints associated with
|
1867
|
+
# this account. For example, `"NamePrefix": "ABC"` will return all
|
1868
|
+
# endpoints with "ABC" in the name.
|
1869
|
+
#
|
1870
|
+
# @option params [String] :home_region
|
1871
|
+
# The primary Region of the endpoints associated with this account. For
|
1872
|
+
# example `"HomeRegion": "us-east-1"`.
|
1873
|
+
#
|
1874
|
+
# @option params [String] :next_token
|
1875
|
+
# If `nextToken` is returned, there are more results available. The
|
1876
|
+
# value of nextToken is a unique pagination token for each page. Make
|
1877
|
+
# the call again using the returned token to retrieve the next page.
|
1878
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1879
|
+
# after 24 hours. Using an expired pagination token will return an HTTP
|
1880
|
+
# 400 InvalidToken error.
|
1881
|
+
#
|
1882
|
+
# @option params [Integer] :max_results
|
1883
|
+
# The maximum number of results returned by the call.
|
1884
|
+
#
|
1885
|
+
# @return [Types::ListEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1886
|
+
#
|
1887
|
+
# * {Types::ListEndpointsResponse#endpoints #endpoints} => Array<Types::Endpoint>
|
1888
|
+
# * {Types::ListEndpointsResponse#next_token #next_token} => String
|
1889
|
+
#
|
1890
|
+
# @example Request syntax with placeholder values
|
1891
|
+
#
|
1892
|
+
# resp = client.list_endpoints({
|
1893
|
+
# name_prefix: "EndpointName",
|
1894
|
+
# home_region: "HomeRegion",
|
1895
|
+
# next_token: "NextToken",
|
1896
|
+
# max_results: 1,
|
1897
|
+
# })
|
1898
|
+
#
|
1899
|
+
# @example Response structure
|
1900
|
+
#
|
1901
|
+
# resp.endpoints #=> Array
|
1902
|
+
# resp.endpoints[0].name #=> String
|
1903
|
+
# resp.endpoints[0].description #=> String
|
1904
|
+
# resp.endpoints[0].arn #=> String
|
1905
|
+
# resp.endpoints[0].routing_config.failover_config.primary.health_check #=> String
|
1906
|
+
# resp.endpoints[0].routing_config.failover_config.secondary.route #=> String
|
1907
|
+
# resp.endpoints[0].replication_config.state #=> String, one of "ENABLED", "DISABLED"
|
1908
|
+
# resp.endpoints[0].event_buses #=> Array
|
1909
|
+
# resp.endpoints[0].event_buses[0].event_bus_arn #=> String
|
1910
|
+
# resp.endpoints[0].role_arn #=> String
|
1911
|
+
# resp.endpoints[0].endpoint_id #=> String
|
1912
|
+
# resp.endpoints[0].endpoint_url #=> String
|
1913
|
+
# resp.endpoints[0].state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
1914
|
+
# resp.endpoints[0].state_reason #=> String
|
1915
|
+
# resp.endpoints[0].creation_time #=> Time
|
1916
|
+
# resp.endpoints[0].last_modified_time #=> Time
|
1917
|
+
# resp.next_token #=> String
|
1918
|
+
#
|
1919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListEndpoints AWS API Documentation
|
1920
|
+
#
|
1921
|
+
# @overload list_endpoints(params = {})
|
1922
|
+
# @param [Hash] params ({})
|
1923
|
+
def list_endpoints(params = {}, options = {})
|
1924
|
+
req = build_request(:list_endpoints, params)
|
1925
|
+
req.send_request(options)
|
1926
|
+
end
|
1927
|
+
|
1668
1928
|
# Lists all the event buses in your account, including the default event
|
1669
1929
|
# bus, custom event buses, and partner event buses.
|
1670
1930
|
#
|
@@ -2168,11 +2428,22 @@ module Aws::EventBridge
|
|
2168
2428
|
# Sends custom events to Amazon EventBridge so that they can be matched
|
2169
2429
|
# to rules.
|
2170
2430
|
#
|
2431
|
+
# <note markdown="1"> PutEvents will only process nested JSON up to 1100 levels deep.
|
2432
|
+
#
|
2433
|
+
# </note>
|
2434
|
+
#
|
2171
2435
|
# @option params [required, Array<Types::PutEventsRequestEntry>] :entries
|
2172
2436
|
# The entry that defines an event in your system. You can specify
|
2173
2437
|
# several parameters for the entry such as the source and type of the
|
2174
2438
|
# event, resources associated with the event, and so on.
|
2175
2439
|
#
|
2440
|
+
# @option params [String] :endpoint_id
|
2441
|
+
# The URL subdomain of the endpoint. For example, if the URL for
|
2442
|
+
# Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the
|
2443
|
+
# EndpointId is `abcde.veo`.
|
2444
|
+
#
|
2445
|
+
# When using Java, you must include `auth-crt` on the class path.
|
2446
|
+
#
|
2176
2447
|
# @return [Types::PutEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2177
2448
|
#
|
2178
2449
|
# * {Types::PutEventsResponse#failed_entry_count #failed_entry_count} => Integer
|
@@ -2192,6 +2463,7 @@ module Aws::EventBridge
|
|
2192
2463
|
# trace_header: "TraceHeader",
|
2193
2464
|
# },
|
2194
2465
|
# ],
|
2466
|
+
# endpoint_id: "EndpointId",
|
2195
2467
|
# })
|
2196
2468
|
#
|
2197
2469
|
# @example Response structure
|
@@ -2308,6 +2580,10 @@ module Aws::EventBridge
|
|
2308
2580
|
# external account, specify this `StatementId` when you run
|
2309
2581
|
# [RemovePermission][1].
|
2310
2582
|
#
|
2583
|
+
# <note markdown="1"> Each `StatementId` must be unique.
|
2584
|
+
#
|
2585
|
+
# </note>
|
2586
|
+
#
|
2311
2587
|
#
|
2312
2588
|
#
|
2313
2589
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html
|
@@ -2439,12 +2715,12 @@ module Aws::EventBridge
|
|
2439
2715
|
# "rate(5 minutes)".
|
2440
2716
|
#
|
2441
2717
|
# @option params [String] :event_pattern
|
2442
|
-
# The event pattern. For more information, see [
|
2443
|
-
#
|
2718
|
+
# The event pattern. For more information, see [EventBridge event
|
2719
|
+
# patterns][1] in the *Amazon EventBridge User Guide*.
|
2444
2720
|
#
|
2445
2721
|
#
|
2446
2722
|
#
|
2447
|
-
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/
|
2723
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html.html
|
2448
2724
|
#
|
2449
2725
|
# @option params [String] :state
|
2450
2726
|
# Indicates whether the rule is enabled or disabled.
|
@@ -2509,59 +2785,68 @@ module Aws::EventBridge
|
|
2509
2785
|
#
|
2510
2786
|
# Targets are the resources that are invoked when a rule is triggered.
|
2511
2787
|
#
|
2788
|
+
# <note markdown="1"> Each rule can have up to five (5) targets associated with it at one
|
2789
|
+
# time.
|
2790
|
+
#
|
2791
|
+
# </note>
|
2792
|
+
#
|
2512
2793
|
# You can configure the following as targets for Events:
|
2513
2794
|
#
|
2514
2795
|
# * [API destination][1]
|
2515
2796
|
#
|
2516
|
-
# *
|
2517
|
-
#
|
2518
|
-
# * API Gateway
|
2797
|
+
# * [API Gateway][2]
|
2519
2798
|
#
|
2520
2799
|
# * Batch job queue
|
2521
2800
|
#
|
2522
|
-
# * CloudWatch
|
2801
|
+
# * CloudWatch group
|
2523
2802
|
#
|
2524
2803
|
# * CodeBuild project
|
2525
2804
|
#
|
2526
2805
|
# * CodePipeline
|
2527
2806
|
#
|
2528
|
-
# *
|
2807
|
+
# * EC2 `CreateSnapshot` API call
|
2529
2808
|
#
|
2530
|
-
# *
|
2809
|
+
# * EC2 Image Builder
|
2531
2810
|
#
|
2532
|
-
# *
|
2811
|
+
# * EC2 `RebootInstances` API call
|
2533
2812
|
#
|
2534
|
-
# *
|
2813
|
+
# * EC2 `StopInstances` API call
|
2535
2814
|
#
|
2536
|
-
# *
|
2815
|
+
# * EC2 `TerminateInstances` API call
|
2537
2816
|
#
|
2538
|
-
# *
|
2817
|
+
# * ECS task
|
2539
2818
|
#
|
2540
|
-
#
|
2541
|
-
# West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a
|
2542
|
-
# target for a rule.
|
2819
|
+
# * [Event bus in a different account or Region][3]
|
2543
2820
|
#
|
2544
|
-
# *
|
2821
|
+
# * [Event bus in the same account and Region][4]
|
2545
2822
|
#
|
2546
|
-
# *
|
2823
|
+
# * Firehose delivery stream
|
2547
2824
|
#
|
2548
|
-
# *
|
2825
|
+
# * Glue workflow
|
2826
|
+
#
|
2827
|
+
# * [Incident Manager response plan][5]
|
2828
|
+
#
|
2829
|
+
# * Inspector assessment template
|
2830
|
+
#
|
2831
|
+
# * Kinesis stream
|
2549
2832
|
#
|
2550
2833
|
# * Lambda function
|
2551
2834
|
#
|
2552
|
-
# * Redshift
|
2835
|
+
# * Redshift cluster
|
2553
2836
|
#
|
2554
|
-
# *
|
2837
|
+
# * SageMaker Pipeline
|
2555
2838
|
#
|
2556
|
-
# *
|
2839
|
+
# * SNS topic
|
2557
2840
|
#
|
2558
|
-
# *
|
2841
|
+
# * SQS queue
|
2559
2842
|
#
|
2560
|
-
# *
|
2843
|
+
# * Step Functions state machine
|
2561
2844
|
#
|
2562
|
-
# *
|
2845
|
+
# * Systems Manager Automation
|
2563
2846
|
#
|
2564
|
-
# *
|
2847
|
+
# * Systems Manager OpsItem
|
2848
|
+
#
|
2849
|
+
# * Systems Manager Run Command
|
2565
2850
|
#
|
2566
2851
|
# Creating rules with built-in targets is supported only in the Amazon
|
2567
2852
|
# Web Services Management Console. The built-in targets are `EC2
|
@@ -2580,7 +2865,7 @@ module Aws::EventBridge
|
|
2580
2865
|
# For EC2 instances, Kinesis Data Streams, Step Functions state machines
|
2581
2866
|
# and API Gateway REST APIs, EventBridge relies on IAM roles that you
|
2582
2867
|
# specify in the `RoleARN` argument in `PutTargets`. For more
|
2583
|
-
# information, see [Authentication and Access Control][
|
2868
|
+
# information, see [Authentication and Access Control][6] in the *Amazon
|
2584
2869
|
# EventBridge User Guide*.
|
2585
2870
|
#
|
2586
2871
|
# If another Amazon Web Services account is in the same region and has
|
@@ -2592,7 +2877,7 @@ module Aws::EventBridge
|
|
2592
2877
|
# account is charged for each sent event. Each event sent to another
|
2593
2878
|
# account is charged as a custom event. The account receiving the event
|
2594
2879
|
# is not charged. For more information, see [Amazon EventBridge
|
2595
|
-
# Pricing][
|
2880
|
+
# Pricing][7].
|
2596
2881
|
#
|
2597
2882
|
# <note markdown="1"> `Input`, `InputPath`, and `InputTransformer` are not available with
|
2598
2883
|
# `PutTarget` if the target is an event bus of a different Amazon Web
|
@@ -2605,10 +2890,10 @@ module Aws::EventBridge
|
|
2605
2890
|
# organization instead of directly by the account ID, then you must
|
2606
2891
|
# specify a `RoleArn` with proper permissions in the `Target` structure.
|
2607
2892
|
# For more information, see [Sending and Receiving Events Between Amazon
|
2608
|
-
# Web Services Accounts][
|
2893
|
+
# Web Services Accounts][8] in the *Amazon EventBridge User Guide*.
|
2609
2894
|
#
|
2610
2895
|
# For more information about enabling cross-account events, see
|
2611
|
-
# [PutPermission][
|
2896
|
+
# [PutPermission][9].
|
2612
2897
|
#
|
2613
2898
|
# **Input**, **InputPath**, and **InputTransformer** are mutually
|
2614
2899
|
# exclusive and optional parameters of a target. When a rule is
|
@@ -2646,10 +2931,14 @@ module Aws::EventBridge
|
|
2646
2931
|
#
|
2647
2932
|
#
|
2648
2933
|
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html
|
2649
|
-
# [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/
|
2650
|
-
# [3]:
|
2651
|
-
# [4]: https://docs.aws.amazon.com/eventbridge/latest/userguide/
|
2652
|
-
# [5]: https://docs.aws.amazon.com/
|
2934
|
+
# [2]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html
|
2935
|
+
# [3]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html
|
2936
|
+
# [4]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html
|
2937
|
+
# [5]: https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge
|
2938
|
+
# [6]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html
|
2939
|
+
# [7]: http://aws.amazon.com/eventbridge/pricing/
|
2940
|
+
# [8]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html
|
2941
|
+
# [9]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html
|
2653
2942
|
#
|
2654
2943
|
# @option params [required, String] :rule
|
2655
2944
|
# The name of the rule.
|
@@ -2847,6 +3136,12 @@ module Aws::EventBridge
|
|
2847
3136
|
# Removes the specified targets from the specified rule. When the rule
|
2848
3137
|
# is triggered, those targets are no longer be invoked.
|
2849
3138
|
#
|
3139
|
+
# <note markdown="1"> A successful execution of `RemoveTargets` doesn't guarantee all
|
3140
|
+
# targets are removed from the rule, it means that the target(s) listed
|
3141
|
+
# in the request are removed.
|
3142
|
+
#
|
3143
|
+
# </note>
|
3144
|
+
#
|
2850
3145
|
# When you remove a target, when the associated rule triggers, removed
|
2851
3146
|
# targets might continue to be invoked. Allow a short period of time for
|
2852
3147
|
# changes to take effect.
|
@@ -3322,6 +3617,95 @@ module Aws::EventBridge
|
|
3322
3617
|
req.send_request(options)
|
3323
3618
|
end
|
3324
3619
|
|
3620
|
+
# Update an existing endpoint. For more information about global
|
3621
|
+
# endpoints, see [Making applications Regional-fault tolerant with
|
3622
|
+
# global endpoints and event replication][1] in the Amazon EventBridge
|
3623
|
+
# User Guide..
|
3624
|
+
#
|
3625
|
+
#
|
3626
|
+
#
|
3627
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html
|
3628
|
+
#
|
3629
|
+
# @option params [required, String] :name
|
3630
|
+
# The name of the endpoint you want to update.
|
3631
|
+
#
|
3632
|
+
# @option params [String] :description
|
3633
|
+
# A description for the endpoint.
|
3634
|
+
#
|
3635
|
+
# @option params [Types::RoutingConfig] :routing_config
|
3636
|
+
# Configure the routing policy, including the health check and secondary
|
3637
|
+
# Region..
|
3638
|
+
#
|
3639
|
+
# @option params [Types::ReplicationConfig] :replication_config
|
3640
|
+
# Whether event replication was enabled or disabled by this request.
|
3641
|
+
#
|
3642
|
+
# @option params [Array<Types::EndpointEventBus>] :event_buses
|
3643
|
+
# Define event buses used for replication.
|
3644
|
+
#
|
3645
|
+
# @option params [String] :role_arn
|
3646
|
+
# The ARN of the role used by event replication for this request.
|
3647
|
+
#
|
3648
|
+
# @return [Types::UpdateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3649
|
+
#
|
3650
|
+
# * {Types::UpdateEndpointResponse#name #name} => String
|
3651
|
+
# * {Types::UpdateEndpointResponse#arn #arn} => String
|
3652
|
+
# * {Types::UpdateEndpointResponse#routing_config #routing_config} => Types::RoutingConfig
|
3653
|
+
# * {Types::UpdateEndpointResponse#replication_config #replication_config} => Types::ReplicationConfig
|
3654
|
+
# * {Types::UpdateEndpointResponse#event_buses #event_buses} => Array<Types::EndpointEventBus>
|
3655
|
+
# * {Types::UpdateEndpointResponse#role_arn #role_arn} => String
|
3656
|
+
# * {Types::UpdateEndpointResponse#endpoint_id #endpoint_id} => String
|
3657
|
+
# * {Types::UpdateEndpointResponse#endpoint_url #endpoint_url} => String
|
3658
|
+
# * {Types::UpdateEndpointResponse#state #state} => String
|
3659
|
+
#
|
3660
|
+
# @example Request syntax with placeholder values
|
3661
|
+
#
|
3662
|
+
# resp = client.update_endpoint({
|
3663
|
+
# name: "EndpointName", # required
|
3664
|
+
# description: "EndpointDescription",
|
3665
|
+
# routing_config: {
|
3666
|
+
# failover_config: { # required
|
3667
|
+
# primary: { # required
|
3668
|
+
# health_check: "HealthCheck", # required
|
3669
|
+
# },
|
3670
|
+
# secondary: { # required
|
3671
|
+
# route: "Route", # required
|
3672
|
+
# },
|
3673
|
+
# },
|
3674
|
+
# },
|
3675
|
+
# replication_config: {
|
3676
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
3677
|
+
# },
|
3678
|
+
# event_buses: [
|
3679
|
+
# {
|
3680
|
+
# event_bus_arn: "NonPartnerEventBusArn", # required
|
3681
|
+
# },
|
3682
|
+
# ],
|
3683
|
+
# role_arn: "IamRoleArn",
|
3684
|
+
# })
|
3685
|
+
#
|
3686
|
+
# @example Response structure
|
3687
|
+
#
|
3688
|
+
# resp.name #=> String
|
3689
|
+
# resp.arn #=> String
|
3690
|
+
# resp.routing_config.failover_config.primary.health_check #=> String
|
3691
|
+
# resp.routing_config.failover_config.secondary.route #=> String
|
3692
|
+
# resp.replication_config.state #=> String, one of "ENABLED", "DISABLED"
|
3693
|
+
# resp.event_buses #=> Array
|
3694
|
+
# resp.event_buses[0].event_bus_arn #=> String
|
3695
|
+
# resp.role_arn #=> String
|
3696
|
+
# resp.endpoint_id #=> String
|
3697
|
+
# resp.endpoint_url #=> String
|
3698
|
+
# resp.state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
3699
|
+
#
|
3700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateEndpoint AWS API Documentation
|
3701
|
+
#
|
3702
|
+
# @overload update_endpoint(params = {})
|
3703
|
+
# @param [Hash] params ({})
|
3704
|
+
def update_endpoint(params = {}, options = {})
|
3705
|
+
req = build_request(:update_endpoint, params)
|
3706
|
+
req.send_request(options)
|
3707
|
+
end
|
3708
|
+
|
3325
3709
|
# @!endgroup
|
3326
3710
|
|
3327
3711
|
# @param params ({})
|
@@ -3335,7 +3719,7 @@ module Aws::EventBridge
|
|
3335
3719
|
params: params,
|
3336
3720
|
config: config)
|
3337
3721
|
context[:gem_name] = 'aws-sdk-eventbridge'
|
3338
|
-
context[:gem_version] = '1.
|
3722
|
+
context[:gem_version] = '1.38.0'
|
3339
3723
|
Seahorse::Client::Request.new(handlers, context)
|
3340
3724
|
end
|
3341
3725
|
|