Endpoint - Amazon EventBridge

Endpoint

A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

Contents

Arn

The ARN of the endpoint.

Type: String

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

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/[/\.\-_A-Za-z0-9]+$

Required: No

CreationTime

The time the endpoint was created.

Type: Timestamp

Required: No

Description

A description for the endpoint.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

EndpointId

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

Type: String

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

Pattern: ^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$

Required: No

EndpointUrl

The URL of the endpoint.

Type: String

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

Pattern: ^(https://)?[\.\-a-z0-9]+$

Required: No

EventBuses

The event buses being used by the endpoint.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

Required: No

LastModifiedTime

The last time the endpoint was modified.

Type: Timestamp

Required: No

Name

The name of the endpoint.

Type: String

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

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

Required: No

ReplicationConfig

Whether event replication was enabled or disabled for this endpoint. 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 by event replication for the endpoint.

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

The routing configuration of the endpoint.

Type: RoutingConfig object

Required: No

State

The current state of the endpoint.

Type: String

Valid Values: ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED

Required: No

StateReason

The reason the endpoint is in its current state.

Type: String

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

Pattern: .*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: