Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateEndpoint

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.

Request Syntax


{
   "Description": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

A description of the global endpoint.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

EventBuses

Define the event buses used.

Important

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

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

Required: Yes

Name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

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.

Type: ReplicationConfig object

Required: No

RoleArn

The ARN of the role used for replication.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$

Required: No

RoutingConfig

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

Type: RoutingConfig object

Required: Yes

Response Syntax


{
   "Arn": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   },
   "State": "string"
}