Create Endpoint

eventbridge_create_endpoint

R Documentation

Creates a global endpoint

Description

Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.

Usage

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

Arguments

Name

[required] The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

Description

A description of the global endpoint.

RoutingConfig

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

ReplicationConfig

Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

EventBuses

[required] Define the event buses used.

The names of the event buses must be identical in each Region.

RoleArn

The ARN of the role used for replication.

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",
  State = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED"
)

Request syntax

svc$create_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"
)