aws-sdk-eventbridge 1.37.0 → 1.38.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-eventbridge/client.rb +400 -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 +682 -6
- data/lib/aws-sdk-eventbridge.rb +1 -1
- metadata +3 -2
@@ -1265,6 +1265,116 @@ module Aws::EventBridge
|
|
1265
1265
|
include Aws::Structure
|
1266
1266
|
end
|
1267
1267
|
|
1268
|
+
# @note When making an API call, you may pass CreateEndpointRequest
|
1269
|
+
# data as a hash:
|
1270
|
+
#
|
1271
|
+
# {
|
1272
|
+
# name: "EndpointName", # required
|
1273
|
+
# description: "EndpointDescription",
|
1274
|
+
# routing_config: { # required
|
1275
|
+
# failover_config: { # required
|
1276
|
+
# primary: { # required
|
1277
|
+
# health_check: "HealthCheck", # required
|
1278
|
+
# },
|
1279
|
+
# secondary: { # required
|
1280
|
+
# route: "Route", # required
|
1281
|
+
# },
|
1282
|
+
# },
|
1283
|
+
# },
|
1284
|
+
# replication_config: {
|
1285
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
1286
|
+
# },
|
1287
|
+
# event_buses: [ # required
|
1288
|
+
# {
|
1289
|
+
# event_bus_arn: "NonPartnerEventBusArn", # required
|
1290
|
+
# },
|
1291
|
+
# ],
|
1292
|
+
# role_arn: "IamRoleArn",
|
1293
|
+
# }
|
1294
|
+
#
|
1295
|
+
# @!attribute [rw] name
|
1296
|
+
# The name of the global endpoint. For example,
|
1297
|
+
# `"Name":"us-east-2-custom_bus_A-endpoint"`.
|
1298
|
+
# @return [String]
|
1299
|
+
#
|
1300
|
+
# @!attribute [rw] description
|
1301
|
+
# A description of the global endpoint.
|
1302
|
+
# @return [String]
|
1303
|
+
#
|
1304
|
+
# @!attribute [rw] routing_config
|
1305
|
+
# Configure the routing policy, including the health check and
|
1306
|
+
# secondary Region..
|
1307
|
+
# @return [Types::RoutingConfig]
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] replication_config
|
1310
|
+
# Enable or disable event replication.
|
1311
|
+
# @return [Types::ReplicationConfig]
|
1312
|
+
#
|
1313
|
+
# @!attribute [rw] event_buses
|
1314
|
+
# Define the event buses used.
|
1315
|
+
#
|
1316
|
+
# The names of the event buses must be identical in each Region.
|
1317
|
+
# @return [Array<Types::EndpointEventBus>]
|
1318
|
+
#
|
1319
|
+
# @!attribute [rw] role_arn
|
1320
|
+
# The ARN of the role used for replication.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEndpointRequest AWS API Documentation
|
1324
|
+
#
|
1325
|
+
class CreateEndpointRequest < Struct.new(
|
1326
|
+
:name,
|
1327
|
+
:description,
|
1328
|
+
:routing_config,
|
1329
|
+
:replication_config,
|
1330
|
+
:event_buses,
|
1331
|
+
:role_arn)
|
1332
|
+
SENSITIVE = []
|
1333
|
+
include Aws::Structure
|
1334
|
+
end
|
1335
|
+
|
1336
|
+
# @!attribute [rw] name
|
1337
|
+
# The name of the endpoint that was created by this request.
|
1338
|
+
# @return [String]
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] arn
|
1341
|
+
# The ARN of the endpoint that was created by this request.
|
1342
|
+
# @return [String]
|
1343
|
+
#
|
1344
|
+
# @!attribute [rw] routing_config
|
1345
|
+
# The routing configuration defined by this request.
|
1346
|
+
# @return [Types::RoutingConfig]
|
1347
|
+
#
|
1348
|
+
# @!attribute [rw] replication_config
|
1349
|
+
# Whether event replication was enabled or disabled by this request.
|
1350
|
+
# @return [Types::ReplicationConfig]
|
1351
|
+
#
|
1352
|
+
# @!attribute [rw] event_buses
|
1353
|
+
# The event buses used by this request.
|
1354
|
+
# @return [Array<Types::EndpointEventBus>]
|
1355
|
+
#
|
1356
|
+
# @!attribute [rw] role_arn
|
1357
|
+
# The ARN of the role used by event replication for this request.
|
1358
|
+
# @return [String]
|
1359
|
+
#
|
1360
|
+
# @!attribute [rw] state
|
1361
|
+
# The state of the endpoint that was created by this request.
|
1362
|
+
# @return [String]
|
1363
|
+
#
|
1364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/CreateEndpointResponse AWS API Documentation
|
1365
|
+
#
|
1366
|
+
class CreateEndpointResponse < Struct.new(
|
1367
|
+
:name,
|
1368
|
+
:arn,
|
1369
|
+
:routing_config,
|
1370
|
+
:replication_config,
|
1371
|
+
:event_buses,
|
1372
|
+
:role_arn,
|
1373
|
+
:state)
|
1374
|
+
SENSITIVE = []
|
1375
|
+
include Aws::Structure
|
1376
|
+
end
|
1377
|
+
|
1268
1378
|
# @note When making an API call, you may pass CreateEventBusRequest
|
1269
1379
|
# data as a hash:
|
1270
1380
|
#
|
@@ -1555,6 +1665,30 @@ module Aws::EventBridge
|
|
1555
1665
|
include Aws::Structure
|
1556
1666
|
end
|
1557
1667
|
|
1668
|
+
# @note When making an API call, you may pass DeleteEndpointRequest
|
1669
|
+
# data as a hash:
|
1670
|
+
#
|
1671
|
+
# {
|
1672
|
+
# name: "EndpointName", # required
|
1673
|
+
# }
|
1674
|
+
#
|
1675
|
+
# @!attribute [rw] name
|
1676
|
+
# The name of the endpoint you want to delete. For example,
|
1677
|
+
# `"Name":"us-east-2-custom_bus_A-endpoint"`..
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteEndpointRequest AWS API Documentation
|
1681
|
+
#
|
1682
|
+
class DeleteEndpointRequest < Struct.new(
|
1683
|
+
:name)
|
1684
|
+
SENSITIVE = []
|
1685
|
+
include Aws::Structure
|
1686
|
+
end
|
1687
|
+
|
1688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DeleteEndpointResponse AWS API Documentation
|
1689
|
+
#
|
1690
|
+
class DeleteEndpointResponse < Aws::EmptyStructure; end
|
1691
|
+
|
1558
1692
|
# @note When making an API call, you may pass DeleteEventBusRequest
|
1559
1693
|
# data as a hash:
|
1560
1694
|
#
|
@@ -1885,6 +2019,111 @@ module Aws::EventBridge
|
|
1885
2019
|
include Aws::Structure
|
1886
2020
|
end
|
1887
2021
|
|
2022
|
+
# @note When making an API call, you may pass DescribeEndpointRequest
|
2023
|
+
# data as a hash:
|
2024
|
+
#
|
2025
|
+
# {
|
2026
|
+
# name: "EndpointName", # required
|
2027
|
+
# home_region: "HomeRegion",
|
2028
|
+
# }
|
2029
|
+
#
|
2030
|
+
# @!attribute [rw] name
|
2031
|
+
# The name of the endpoint you want to get information about. For
|
2032
|
+
# example, `"Name":"us-east-2-custom_bus_A-endpoint"`.
|
2033
|
+
# @return [String]
|
2034
|
+
#
|
2035
|
+
# @!attribute [rw] home_region
|
2036
|
+
# The primary Region of the endpoint you want to get information
|
2037
|
+
# about. For example `"HomeRegion": "us-east-1"`.
|
2038
|
+
# @return [String]
|
2039
|
+
#
|
2040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeEndpointRequest AWS API Documentation
|
2041
|
+
#
|
2042
|
+
class DescribeEndpointRequest < Struct.new(
|
2043
|
+
:name,
|
2044
|
+
:home_region)
|
2045
|
+
SENSITIVE = []
|
2046
|
+
include Aws::Structure
|
2047
|
+
end
|
2048
|
+
|
2049
|
+
# @!attribute [rw] name
|
2050
|
+
# The name of the endpoint you asked for information about.
|
2051
|
+
# @return [String]
|
2052
|
+
#
|
2053
|
+
# @!attribute [rw] description
|
2054
|
+
# The description of the endpoint you asked for information about.
|
2055
|
+
# @return [String]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] arn
|
2058
|
+
# The ARN of the endpoint you asked for information about.
|
2059
|
+
# @return [String]
|
2060
|
+
#
|
2061
|
+
# @!attribute [rw] routing_config
|
2062
|
+
# The routing configuration of the endpoint you asked for information
|
2063
|
+
# about.
|
2064
|
+
# @return [Types::RoutingConfig]
|
2065
|
+
#
|
2066
|
+
# @!attribute [rw] replication_config
|
2067
|
+
# Whether replication is enabled or disabled for the endpoint you
|
2068
|
+
# asked for information about.
|
2069
|
+
# @return [Types::ReplicationConfig]
|
2070
|
+
#
|
2071
|
+
# @!attribute [rw] event_buses
|
2072
|
+
# The event buses being used by the endpoint you asked for information
|
2073
|
+
# about.
|
2074
|
+
# @return [Array<Types::EndpointEventBus>]
|
2075
|
+
#
|
2076
|
+
# @!attribute [rw] role_arn
|
2077
|
+
# The ARN of the role used by the endpoint you asked for information
|
2078
|
+
# about.
|
2079
|
+
# @return [String]
|
2080
|
+
#
|
2081
|
+
# @!attribute [rw] endpoint_id
|
2082
|
+
# The ID of the endpoint you asked for information about.
|
2083
|
+
# @return [String]
|
2084
|
+
#
|
2085
|
+
# @!attribute [rw] endpoint_url
|
2086
|
+
# The URL of the endpoint you asked for information about.
|
2087
|
+
# @return [String]
|
2088
|
+
#
|
2089
|
+
# @!attribute [rw] state
|
2090
|
+
# The current state of the endpoint you asked for information about.
|
2091
|
+
# @return [String]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] state_reason
|
2094
|
+
# The reason the endpoint you asked for information about is in its
|
2095
|
+
# current state.
|
2096
|
+
# @return [String]
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] creation_time
|
2099
|
+
# The time the endpoint you asked for information about was created.
|
2100
|
+
# @return [Time]
|
2101
|
+
#
|
2102
|
+
# @!attribute [rw] last_modified_time
|
2103
|
+
# The last time the endpoint you asked for information about was
|
2104
|
+
# modified.
|
2105
|
+
# @return [Time]
|
2106
|
+
#
|
2107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/DescribeEndpointResponse AWS API Documentation
|
2108
|
+
#
|
2109
|
+
class DescribeEndpointResponse < Struct.new(
|
2110
|
+
:name,
|
2111
|
+
:description,
|
2112
|
+
:arn,
|
2113
|
+
:routing_config,
|
2114
|
+
:replication_config,
|
2115
|
+
:event_buses,
|
2116
|
+
:role_arn,
|
2117
|
+
:endpoint_id,
|
2118
|
+
:endpoint_url,
|
2119
|
+
:state,
|
2120
|
+
:state_reason,
|
2121
|
+
:creation_time,
|
2122
|
+
:last_modified_time)
|
2123
|
+
SENSITIVE = []
|
2124
|
+
include Aws::Structure
|
2125
|
+
end
|
2126
|
+
|
1888
2127
|
# @note When making an API call, you may pass DescribeEventBusRequest
|
1889
2128
|
# data as a hash:
|
1890
2129
|
#
|
@@ -2446,6 +2685,111 @@ module Aws::EventBridge
|
|
2446
2685
|
include Aws::Structure
|
2447
2686
|
end
|
2448
2687
|
|
2688
|
+
# An global endpoint used to improve your application's availability by
|
2689
|
+
# making it regional-fault tolerant. For more information about global
|
2690
|
+
# endpoints, see [Making applications Regional-fault tolerant with
|
2691
|
+
# global endpoints and event replication][1] in the Amazon EventBridge
|
2692
|
+
# User Guide..
|
2693
|
+
#
|
2694
|
+
#
|
2695
|
+
#
|
2696
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html
|
2697
|
+
#
|
2698
|
+
# @!attribute [rw] name
|
2699
|
+
# The name of the endpoint.
|
2700
|
+
# @return [String]
|
2701
|
+
#
|
2702
|
+
# @!attribute [rw] description
|
2703
|
+
# A description for the endpoint.
|
2704
|
+
# @return [String]
|
2705
|
+
#
|
2706
|
+
# @!attribute [rw] arn
|
2707
|
+
# The ARN of the endpoint.
|
2708
|
+
# @return [String]
|
2709
|
+
#
|
2710
|
+
# @!attribute [rw] routing_config
|
2711
|
+
# The routing configuration of the endpoint.
|
2712
|
+
# @return [Types::RoutingConfig]
|
2713
|
+
#
|
2714
|
+
# @!attribute [rw] replication_config
|
2715
|
+
# Whether event replication was enabled or disabled for this endpoint.
|
2716
|
+
# @return [Types::ReplicationConfig]
|
2717
|
+
#
|
2718
|
+
# @!attribute [rw] event_buses
|
2719
|
+
# The event buses being used by the endpoint.
|
2720
|
+
# @return [Array<Types::EndpointEventBus>]
|
2721
|
+
#
|
2722
|
+
# @!attribute [rw] role_arn
|
2723
|
+
# The ARN of the role used by event replication for the endpoint.
|
2724
|
+
# @return [String]
|
2725
|
+
#
|
2726
|
+
# @!attribute [rw] endpoint_id
|
2727
|
+
# The URL subdomain of the endpoint. For example, if the URL for
|
2728
|
+
# Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the
|
2729
|
+
# EndpointId is `abcde.veo`.
|
2730
|
+
# @return [String]
|
2731
|
+
#
|
2732
|
+
# @!attribute [rw] endpoint_url
|
2733
|
+
# The URL of the endpoint.
|
2734
|
+
# @return [String]
|
2735
|
+
#
|
2736
|
+
# @!attribute [rw] state
|
2737
|
+
# The current state of the endpoint.
|
2738
|
+
# @return [String]
|
2739
|
+
#
|
2740
|
+
# @!attribute [rw] state_reason
|
2741
|
+
# The reason the endpoint is in its current state.
|
2742
|
+
# @return [String]
|
2743
|
+
#
|
2744
|
+
# @!attribute [rw] creation_time
|
2745
|
+
# The time the endpoint was created.
|
2746
|
+
# @return [Time]
|
2747
|
+
#
|
2748
|
+
# @!attribute [rw] last_modified_time
|
2749
|
+
# The last time the endpoint was modified.
|
2750
|
+
# @return [Time]
|
2751
|
+
#
|
2752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Endpoint AWS API Documentation
|
2753
|
+
#
|
2754
|
+
class Endpoint < Struct.new(
|
2755
|
+
:name,
|
2756
|
+
:description,
|
2757
|
+
:arn,
|
2758
|
+
:routing_config,
|
2759
|
+
:replication_config,
|
2760
|
+
:event_buses,
|
2761
|
+
:role_arn,
|
2762
|
+
:endpoint_id,
|
2763
|
+
:endpoint_url,
|
2764
|
+
:state,
|
2765
|
+
:state_reason,
|
2766
|
+
:creation_time,
|
2767
|
+
:last_modified_time)
|
2768
|
+
SENSITIVE = []
|
2769
|
+
include Aws::Structure
|
2770
|
+
end
|
2771
|
+
|
2772
|
+
# The event buses the endpoint is associated with.
|
2773
|
+
#
|
2774
|
+
# @note When making an API call, you may pass EndpointEventBus
|
2775
|
+
# data as a hash:
|
2776
|
+
#
|
2777
|
+
# {
|
2778
|
+
# event_bus_arn: "NonPartnerEventBusArn", # required
|
2779
|
+
# }
|
2780
|
+
#
|
2781
|
+
# @!attribute [rw] event_bus_arn
|
2782
|
+
# The ARN of the event bus the endpoint is associated with.
|
2783
|
+
# @return [String]
|
2784
|
+
#
|
2785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/EndpointEventBus AWS API Documentation
|
2786
|
+
#
|
2787
|
+
class EndpointEventBus < Struct.new(
|
2788
|
+
:event_bus_arn)
|
2789
|
+
SENSITIVE = []
|
2790
|
+
include Aws::Structure
|
2791
|
+
end
|
2792
|
+
|
2449
2793
|
# An event bus receives events from a source and routes them to rules
|
2450
2794
|
# associated with that event bus. Your account's default event bus
|
2451
2795
|
# receives events from Amazon Web Services services. A custom event bus
|
@@ -2525,6 +2869,39 @@ module Aws::EventBridge
|
|
2525
2869
|
include Aws::Structure
|
2526
2870
|
end
|
2527
2871
|
|
2872
|
+
# The failover configuration for an endpoint. This includes what
|
2873
|
+
# triggers failover and what happens when it's triggered.
|
2874
|
+
#
|
2875
|
+
# @note When making an API call, you may pass FailoverConfig
|
2876
|
+
# data as a hash:
|
2877
|
+
#
|
2878
|
+
# {
|
2879
|
+
# primary: { # required
|
2880
|
+
# health_check: "HealthCheck", # required
|
2881
|
+
# },
|
2882
|
+
# secondary: { # required
|
2883
|
+
# route: "Route", # required
|
2884
|
+
# },
|
2885
|
+
# }
|
2886
|
+
#
|
2887
|
+
# @!attribute [rw] primary
|
2888
|
+
# The main Region of the endpoint.
|
2889
|
+
# @return [Types::Primary]
|
2890
|
+
#
|
2891
|
+
# @!attribute [rw] secondary
|
2892
|
+
# The Region that events are routed to when failover is triggered or
|
2893
|
+
# event replication is enabled.
|
2894
|
+
# @return [Types::Secondary]
|
2895
|
+
#
|
2896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/FailoverConfig AWS API Documentation
|
2897
|
+
#
|
2898
|
+
class FailoverConfig < Struct.new(
|
2899
|
+
:primary,
|
2900
|
+
:secondary)
|
2901
|
+
SENSITIVE = []
|
2902
|
+
include Aws::Structure
|
2903
|
+
end
|
2904
|
+
|
2528
2905
|
# These are custom parameter to be used when the target is an API
|
2529
2906
|
# Gateway REST APIs or EventBridge ApiDestinations. In the latter case,
|
2530
2907
|
# these are merged with any InvocationParameters specified on the
|
@@ -2902,6 +3279,73 @@ module Aws::EventBridge
|
|
2902
3279
|
include Aws::Structure
|
2903
3280
|
end
|
2904
3281
|
|
3282
|
+
# @note When making an API call, you may pass ListEndpointsRequest
|
3283
|
+
# data as a hash:
|
3284
|
+
#
|
3285
|
+
# {
|
3286
|
+
# name_prefix: "EndpointName",
|
3287
|
+
# home_region: "HomeRegion",
|
3288
|
+
# next_token: "NextToken",
|
3289
|
+
# max_results: 1,
|
3290
|
+
# }
|
3291
|
+
#
|
3292
|
+
# @!attribute [rw] name_prefix
|
3293
|
+
# A value that will return a subset of the endpoints associated with
|
3294
|
+
# this account. For example, `"NamePrefix": "ABC"` will return all
|
3295
|
+
# endpoints with "ABC" in the name.
|
3296
|
+
# @return [String]
|
3297
|
+
#
|
3298
|
+
# @!attribute [rw] home_region
|
3299
|
+
# The primary Region of the endpoints associated with this account.
|
3300
|
+
# For example `"HomeRegion": "us-east-1"`.
|
3301
|
+
# @return [String]
|
3302
|
+
#
|
3303
|
+
# @!attribute [rw] next_token
|
3304
|
+
# If `nextToken` is returned, there are more results available. The
|
3305
|
+
# value of nextToken is a unique pagination token for each page. Make
|
3306
|
+
# the call again using the returned token to retrieve the next page.
|
3307
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
3308
|
+
# after 24 hours. Using an expired pagination token will return an
|
3309
|
+
# HTTP 400 InvalidToken error.
|
3310
|
+
# @return [String]
|
3311
|
+
#
|
3312
|
+
# @!attribute [rw] max_results
|
3313
|
+
# The maximum number of results returned by the call.
|
3314
|
+
# @return [Integer]
|
3315
|
+
#
|
3316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListEndpointsRequest AWS API Documentation
|
3317
|
+
#
|
3318
|
+
class ListEndpointsRequest < Struct.new(
|
3319
|
+
:name_prefix,
|
3320
|
+
:home_region,
|
3321
|
+
:next_token,
|
3322
|
+
:max_results)
|
3323
|
+
SENSITIVE = []
|
3324
|
+
include Aws::Structure
|
3325
|
+
end
|
3326
|
+
|
3327
|
+
# @!attribute [rw] endpoints
|
3328
|
+
# The endpoints returned by the call.
|
3329
|
+
# @return [Array<Types::Endpoint>]
|
3330
|
+
#
|
3331
|
+
# @!attribute [rw] next_token
|
3332
|
+
# If `nextToken` is returned, there are more results available. The
|
3333
|
+
# value of nextToken is a unique pagination token for each page. Make
|
3334
|
+
# the call again using the returned token to retrieve the next page.
|
3335
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
3336
|
+
# after 24 hours. Using an expired pagination token will return an
|
3337
|
+
# HTTP 400 InvalidToken error.
|
3338
|
+
# @return [String]
|
3339
|
+
#
|
3340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ListEndpointsResponse AWS API Documentation
|
3341
|
+
#
|
3342
|
+
class ListEndpointsResponse < Struct.new(
|
3343
|
+
:endpoints,
|
3344
|
+
:next_token)
|
3345
|
+
SENSITIVE = []
|
3346
|
+
include Aws::Structure
|
3347
|
+
end
|
3348
|
+
|
2905
3349
|
# @note When making an API call, you may pass ListEventBusesRequest
|
2906
3350
|
# data as a hash:
|
2907
3351
|
#
|
@@ -3582,6 +4026,28 @@ module Aws::EventBridge
|
|
3582
4026
|
#
|
3583
4027
|
class PolicyLengthExceededException < Aws::EmptyStructure; end
|
3584
4028
|
|
4029
|
+
# The primary Region of the endpoint.
|
4030
|
+
#
|
4031
|
+
# @note When making an API call, you may pass Primary
|
4032
|
+
# data as a hash:
|
4033
|
+
#
|
4034
|
+
# {
|
4035
|
+
# health_check: "HealthCheck", # required
|
4036
|
+
# }
|
4037
|
+
#
|
4038
|
+
# @!attribute [rw] health_check
|
4039
|
+
# The ARN of the health check used by the endpoint to determine
|
4040
|
+
# whether failover is triggered.
|
4041
|
+
# @return [String]
|
4042
|
+
#
|
4043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Primary AWS API Documentation
|
4044
|
+
#
|
4045
|
+
class Primary < Struct.new(
|
4046
|
+
:health_check)
|
4047
|
+
SENSITIVE = []
|
4048
|
+
include Aws::Structure
|
4049
|
+
end
|
4050
|
+
|
3585
4051
|
# @note When making an API call, you may pass PutEventsRequest
|
3586
4052
|
# data as a hash:
|
3587
4053
|
#
|
@@ -3597,6 +4063,7 @@ module Aws::EventBridge
|
|
3597
4063
|
# trace_header: "TraceHeader",
|
3598
4064
|
# },
|
3599
4065
|
# ],
|
4066
|
+
# endpoint_id: "EndpointId",
|
3600
4067
|
# }
|
3601
4068
|
#
|
3602
4069
|
# @!attribute [rw] entries
|
@@ -3605,10 +4072,19 @@ module Aws::EventBridge
|
|
3605
4072
|
# event, resources associated with the event, and so on.
|
3606
4073
|
# @return [Array<Types::PutEventsRequestEntry>]
|
3607
4074
|
#
|
4075
|
+
# @!attribute [rw] endpoint_id
|
4076
|
+
# The URL subdomain of the endpoint. For example, if the URL for
|
4077
|
+
# Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the
|
4078
|
+
# EndpointId is `abcde.veo`.
|
4079
|
+
#
|
4080
|
+
# When using Java, you must include `auth-crt` on the class path.
|
4081
|
+
# @return [String]
|
4082
|
+
#
|
3608
4083
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/PutEventsRequest AWS API Documentation
|
3609
4084
|
#
|
3610
4085
|
class PutEventsRequest < Struct.new(
|
3611
|
-
:entries
|
4086
|
+
:entries,
|
4087
|
+
:endpoint_id)
|
3612
4088
|
SENSITIVE = []
|
3613
4089
|
include Aws::Structure
|
3614
4090
|
end
|
@@ -3654,14 +4130,22 @@ module Aws::EventBridge
|
|
3654
4130
|
# @return [String]
|
3655
4131
|
#
|
3656
4132
|
# @!attribute [rw] detail
|
3657
|
-
# A valid JSON
|
3658
|
-
#
|
4133
|
+
# A valid JSON object. There is no other schema imposed. The JSON
|
4134
|
+
# object may contain fields and nested subobjects.
|
3659
4135
|
# @return [String]
|
3660
4136
|
#
|
3661
4137
|
# @!attribute [rw] event_bus_name
|
3662
4138
|
# The name or ARN of the event bus to receive the event. Only the
|
3663
4139
|
# rules that are associated with this event bus are used to match the
|
3664
4140
|
# event. If you omit this, the default event bus is used.
|
4141
|
+
#
|
4142
|
+
# <note markdown="1"> If you're using a global endpoint with a custom bus, you must enter
|
4143
|
+
# the name, not the ARN, of the event bus in either the primary or
|
4144
|
+
# secondary Region here and the corresponding event bus in the other
|
4145
|
+
# Region will be determined based on the endpoint referenced by the
|
4146
|
+
# `EndpointId`.
|
4147
|
+
#
|
4148
|
+
# </note>
|
3665
4149
|
# @return [String]
|
3666
4150
|
#
|
3667
4151
|
# @!attribute [rw] trace_header
|
@@ -3979,12 +4463,12 @@ module Aws::EventBridge
|
|
3979
4463
|
# @return [String]
|
3980
4464
|
#
|
3981
4465
|
# @!attribute [rw] event_pattern
|
3982
|
-
# The event pattern. For more information, see [
|
3983
|
-
#
|
4466
|
+
# The event pattern. For more information, see [EventBridge event
|
4467
|
+
# patterns][1] in the *Amazon EventBridge User Guide*.
|
3984
4468
|
#
|
3985
4469
|
#
|
3986
4470
|
#
|
3987
|
-
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/
|
4471
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html.html
|
3988
4472
|
# @return [String]
|
3989
4473
|
#
|
3990
4474
|
# @!attribute [rw] state
|
@@ -4496,6 +4980,27 @@ module Aws::EventBridge
|
|
4496
4980
|
include Aws::Structure
|
4497
4981
|
end
|
4498
4982
|
|
4983
|
+
# Endpoints can replicate all events to the secondary Region.
|
4984
|
+
#
|
4985
|
+
# @note When making an API call, you may pass ReplicationConfig
|
4986
|
+
# data as a hash:
|
4987
|
+
#
|
4988
|
+
# {
|
4989
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
4990
|
+
# }
|
4991
|
+
#
|
4992
|
+
# @!attribute [rw] state
|
4993
|
+
# The state of event replication.
|
4994
|
+
# @return [String]
|
4995
|
+
#
|
4996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ReplicationConfig AWS API Documentation
|
4997
|
+
#
|
4998
|
+
class ReplicationConfig < Struct.new(
|
4999
|
+
:state)
|
5000
|
+
SENSITIVE = []
|
5001
|
+
include Aws::Structure
|
5002
|
+
end
|
5003
|
+
|
4499
5004
|
# The resource you are trying to create already exists.
|
4500
5005
|
#
|
4501
5006
|
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/ResourceAlreadyExistsException AWS API Documentation
|
@@ -4540,6 +5045,35 @@ module Aws::EventBridge
|
|
4540
5045
|
include Aws::Structure
|
4541
5046
|
end
|
4542
5047
|
|
5048
|
+
# The routing configuration of the endpoint.
|
5049
|
+
#
|
5050
|
+
# @note When making an API call, you may pass RoutingConfig
|
5051
|
+
# data as a hash:
|
5052
|
+
#
|
5053
|
+
# {
|
5054
|
+
# failover_config: { # required
|
5055
|
+
# primary: { # required
|
5056
|
+
# health_check: "HealthCheck", # required
|
5057
|
+
# },
|
5058
|
+
# secondary: { # required
|
5059
|
+
# route: "Route", # required
|
5060
|
+
# },
|
5061
|
+
# },
|
5062
|
+
# }
|
5063
|
+
#
|
5064
|
+
# @!attribute [rw] failover_config
|
5065
|
+
# The failover configuration for an endpoint. This includes what
|
5066
|
+
# triggers failover and what happens when it's triggered.
|
5067
|
+
# @return [Types::FailoverConfig]
|
5068
|
+
#
|
5069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/RoutingConfig AWS API Documentation
|
5070
|
+
#
|
5071
|
+
class RoutingConfig < Struct.new(
|
5072
|
+
:failover_config)
|
5073
|
+
SENSITIVE = []
|
5074
|
+
include Aws::Structure
|
5075
|
+
end
|
5076
|
+
|
4543
5077
|
# Contains information about a rule in Amazon EventBridge.
|
4544
5078
|
#
|
4545
5079
|
# @!attribute [rw] name
|
@@ -4732,6 +5266,28 @@ module Aws::EventBridge
|
|
4732
5266
|
include Aws::Structure
|
4733
5267
|
end
|
4734
5268
|
|
5269
|
+
# The secondary Region that processes events when failover is triggered
|
5270
|
+
# or replication is enabled.
|
5271
|
+
#
|
5272
|
+
# @note When making an API call, you may pass Secondary
|
5273
|
+
# data as a hash:
|
5274
|
+
#
|
5275
|
+
# {
|
5276
|
+
# route: "Route", # required
|
5277
|
+
# }
|
5278
|
+
#
|
5279
|
+
# @!attribute [rw] route
|
5280
|
+
# Defines the secondary Region.
|
5281
|
+
# @return [String]
|
5282
|
+
#
|
5283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Secondary AWS API Documentation
|
5284
|
+
#
|
5285
|
+
class Secondary < Struct.new(
|
5286
|
+
:route)
|
5287
|
+
SENSITIVE = []
|
5288
|
+
include Aws::Structure
|
5289
|
+
end
|
5290
|
+
|
4735
5291
|
# This structure includes the custom parameter to be used when the
|
4736
5292
|
# target is an SQS FIFO queue.
|
4737
5293
|
#
|
@@ -5800,5 +6356,125 @@ module Aws::EventBridge
|
|
5800
6356
|
include Aws::Structure
|
5801
6357
|
end
|
5802
6358
|
|
6359
|
+
# @note When making an API call, you may pass UpdateEndpointRequest
|
6360
|
+
# data as a hash:
|
6361
|
+
#
|
6362
|
+
# {
|
6363
|
+
# name: "EndpointName", # required
|
6364
|
+
# description: "EndpointDescription",
|
6365
|
+
# routing_config: {
|
6366
|
+
# failover_config: { # required
|
6367
|
+
# primary: { # required
|
6368
|
+
# health_check: "HealthCheck", # required
|
6369
|
+
# },
|
6370
|
+
# secondary: { # required
|
6371
|
+
# route: "Route", # required
|
6372
|
+
# },
|
6373
|
+
# },
|
6374
|
+
# },
|
6375
|
+
# replication_config: {
|
6376
|
+
# state: "ENABLED", # accepts ENABLED, DISABLED
|
6377
|
+
# },
|
6378
|
+
# event_buses: [
|
6379
|
+
# {
|
6380
|
+
# event_bus_arn: "NonPartnerEventBusArn", # required
|
6381
|
+
# },
|
6382
|
+
# ],
|
6383
|
+
# role_arn: "IamRoleArn",
|
6384
|
+
# }
|
6385
|
+
#
|
6386
|
+
# @!attribute [rw] name
|
6387
|
+
# The name of the endpoint you want to update.
|
6388
|
+
# @return [String]
|
6389
|
+
#
|
6390
|
+
# @!attribute [rw] description
|
6391
|
+
# A description for the endpoint.
|
6392
|
+
# @return [String]
|
6393
|
+
#
|
6394
|
+
# @!attribute [rw] routing_config
|
6395
|
+
# Configure the routing policy, including the health check and
|
6396
|
+
# secondary Region..
|
6397
|
+
# @return [Types::RoutingConfig]
|
6398
|
+
#
|
6399
|
+
# @!attribute [rw] replication_config
|
6400
|
+
# Whether event replication was enabled or disabled by this request.
|
6401
|
+
# @return [Types::ReplicationConfig]
|
6402
|
+
#
|
6403
|
+
# @!attribute [rw] event_buses
|
6404
|
+
# Define event buses used for replication.
|
6405
|
+
# @return [Array<Types::EndpointEventBus>]
|
6406
|
+
#
|
6407
|
+
# @!attribute [rw] role_arn
|
6408
|
+
# The ARN of the role used by event replication for this request.
|
6409
|
+
# @return [String]
|
6410
|
+
#
|
6411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateEndpointRequest AWS API Documentation
|
6412
|
+
#
|
6413
|
+
class UpdateEndpointRequest < Struct.new(
|
6414
|
+
:name,
|
6415
|
+
:description,
|
6416
|
+
:routing_config,
|
6417
|
+
:replication_config,
|
6418
|
+
:event_buses,
|
6419
|
+
:role_arn)
|
6420
|
+
SENSITIVE = []
|
6421
|
+
include Aws::Structure
|
6422
|
+
end
|
6423
|
+
|
6424
|
+
# @!attribute [rw] name
|
6425
|
+
# The name of the endpoint you updated in this request.
|
6426
|
+
# @return [String]
|
6427
|
+
#
|
6428
|
+
# @!attribute [rw] arn
|
6429
|
+
# The ARN of the endpoint you updated in this request.
|
6430
|
+
# @return [String]
|
6431
|
+
#
|
6432
|
+
# @!attribute [rw] routing_config
|
6433
|
+
# The routing configuration you updated in this request.
|
6434
|
+
# @return [Types::RoutingConfig]
|
6435
|
+
#
|
6436
|
+
# @!attribute [rw] replication_config
|
6437
|
+
# Whether event replication was enabled or disabled for the endpoint
|
6438
|
+
# you updated in this request.
|
6439
|
+
# @return [Types::ReplicationConfig]
|
6440
|
+
#
|
6441
|
+
# @!attribute [rw] event_buses
|
6442
|
+
# The event buses used for replication for the endpoint you updated in
|
6443
|
+
# this request.
|
6444
|
+
# @return [Array<Types::EndpointEventBus>]
|
6445
|
+
#
|
6446
|
+
# @!attribute [rw] role_arn
|
6447
|
+
# The ARN of the role used by event replication for the endpoint you
|
6448
|
+
# updated in this request.
|
6449
|
+
# @return [String]
|
6450
|
+
#
|
6451
|
+
# @!attribute [rw] endpoint_id
|
6452
|
+
# The ID of the endpoint you updated in this request.
|
6453
|
+
# @return [String]
|
6454
|
+
#
|
6455
|
+
# @!attribute [rw] endpoint_url
|
6456
|
+
# The URL of the endpoint you updated in this request.
|
6457
|
+
# @return [String]
|
6458
|
+
#
|
6459
|
+
# @!attribute [rw] state
|
6460
|
+
# The state of the endpoint you updated in this request.
|
6461
|
+
# @return [String]
|
6462
|
+
#
|
6463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/UpdateEndpointResponse AWS API Documentation
|
6464
|
+
#
|
6465
|
+
class UpdateEndpointResponse < Struct.new(
|
6466
|
+
:name,
|
6467
|
+
:arn,
|
6468
|
+
:routing_config,
|
6469
|
+
:replication_config,
|
6470
|
+
:event_buses,
|
6471
|
+
:role_arn,
|
6472
|
+
:endpoint_id,
|
6473
|
+
:endpoint_url,
|
6474
|
+
:state)
|
6475
|
+
SENSITIVE = []
|
6476
|
+
include Aws::Structure
|
6477
|
+
end
|
6478
|
+
|
5803
6479
|
end
|
5804
6480
|
end
|