Skip to content

Update Endpoint

eventbridge_update_endpoint R Documentation

Update an existing endpoint

Description

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 .

Usage

eventbridge_update_endpoint(Name, Description, RoutingConfig,
  ReplicationConfig, EventBuses, RoleArn)

Arguments

Name

[required] The name of the endpoint you want to update.

Description

A description for the endpoint.

RoutingConfig

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

ReplicationConfig

Whether event replication was enabled or disabled by this request.

EventBuses

Define event buses used for replication.

RoleArn

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

Value

A list with the following syntax:

list(
  Name = "string",
  Arn = "string",
  RoutingConfig = list(
    FailoverConfig = list(
      Primary = list(
        HealthCheck = "string"
      ),
      Secondary = list(
        Route = "string"
      )
    )
  ),
  ReplicationConfig = list(
    State = "ENABLED"|"DISABLED"
  ),
  EventBuses = list(
    list(
      EventBusArn = "string"
    )
  ),
  RoleArn = "string",
  EndpointId = "string",
  EndpointUrl = "string",
  State = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED"
)

Request syntax

svc$update_endpoint(
  Name = "string",
  Description = "string",
  RoutingConfig = list(
    FailoverConfig = list(
      Primary = list(
        HealthCheck = "string"
      ),
      Secondary = list(
        Route = "string"
      )
    )
  ),
  ReplicationConfig = list(
    State = "ENABLED"|"DISABLED"
  ),
  EventBuses = list(
    list(
      EventBusArn = "string"
    )
  ),
  RoleArn = "string"
)