Method: Aws::EventBridge::Client#update_endpoint

Defined in:

lib/aws-sdk-eventbridge/client.rb

#update_endpoint(params = {}) ⇒ Types::UpdateEndpointResponse

Update an existing endpoint. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication] in the Amazon EventBridge User Guide .

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html

Examples:

Request syntax with placeholder values

resp = client.update_endpoint({
  name: "EndpointName", # required
  description: "EndpointDescription",
  routing_config: {
    failover_config: { # required
      primary: { # required
        health_check: "HealthCheck", # required
      },
      secondary: { # required
        route: "Route", # required
      },
    },
  },
  replication_config: {
    state: "ENABLED", # accepts ENABLED, DISABLED
  },
  event_buses: [
    {
      event_bus_arn: "NonPartnerEventBusArn", # required
    },
  ],
  role_arn: "IamRoleArn",
})

Response structure

resp.name #=> String
resp.arn #=> String
resp.routing_config.failover_config.primary.health_check #=> String
resp.routing_config.failover_config.secondary.route #=> String
resp.replication_config.state #=> String, one of "ENABLED", "DISABLED"
resp.event_buses #=> Array
resp.event_buses[0].event_bus_arn #=> String
resp.role_arn #=> String
resp.endpoint_id #=> String
resp.endpoint_url #=> String
resp.state #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the endpoint you want to update.

• :description (String) —

  A description for the endpoint.

• :routing_config (Types::RoutingConfig) —

  Configure the routing policy, including the health check and secondary Region.

• :replication_config (Types::ReplicationConfig) —

  Whether event replication was enabled or disabled by this request.

• :event_buses (Array<Types::EndpointEventBus>) —

  Define event buses used for replication.

• :role_arn (String) —

  The ARN of the role used by event replication for this request.

Returns:

• (Types::UpdateEndpointResponse) —

  Returns a response object which responds to the following methods:

  • #name => String

  • #arn => String

  • #routing_config => Types::RoutingConfig

  • #replication_config => Types::ReplicationConfig

  • #event_buses => Array&lt;Types::EndpointEventBus&gt;

  • #role_arn => String

  • #endpoint_id => String

  • #endpoint_url => String

  • #state => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-eventbridge/client.rb', line 4223

def update_endpoint(params = {}, options = {})
  req = build_request(:update_endpoint, params)
  req.send_request(options)
end