/AWS1/CL_EVBENDPOINT¶
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 .
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
IV_NAME
TYPE /AWS1/EVBENDPOINTNAME
/AWS1/EVBENDPOINTNAME
¶
The name of the endpoint.
IV_DESCRIPTION
TYPE /AWS1/EVBENDPOINTDESCRIPTION
/AWS1/EVBENDPOINTDESCRIPTION
¶
A description for the endpoint.
IV_ARN
TYPE /AWS1/EVBENDPOINTARN
/AWS1/EVBENDPOINTARN
¶
The ARN of the endpoint.
IO_ROUTINGCONFIG
TYPE REF TO /AWS1/CL_EVBROUTINGCONFIG
/AWS1/CL_EVBROUTINGCONFIG
¶
The routing configuration of the endpoint.
IO_REPLICATIONCONFIG
TYPE REF TO /AWS1/CL_EVBREPLICATIONCONFIG
/AWS1/CL_EVBREPLICATIONCONFIG
¶
Whether event replication was enabled or disabled for this endpoint. The default state is
ENABLED
which means you must supply aRoleArn
. If you don't have aRoleArn
or you don't want event replication enabled, set the state toDISABLED
.
IT_EVENTBUSES
TYPE /AWS1/CL_EVBENDPOINTEVENTBUS=>TT_ENDPOINTEVENTBUSLIST
TT_ENDPOINTEVENTBUSLIST
¶
The event buses being used by the endpoint.
IV_ROLEARN
TYPE /AWS1/EVBIAMROLEARN
/AWS1/EVBIAMROLEARN
¶
The ARN of the role used by event replication for the endpoint.
IV_ENDPOINTID
TYPE /AWS1/EVBENDPOINTID
/AWS1/EVBENDPOINTID
¶
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
.
IV_ENDPOINTURL
TYPE /AWS1/EVBENDPOINTURL
/AWS1/EVBENDPOINTURL
¶
The URL of the endpoint.
IV_STATE
TYPE /AWS1/EVBENDPOINTSTATE
/AWS1/EVBENDPOINTSTATE
¶
The current state of the endpoint.
IV_STATEREASON
TYPE /AWS1/EVBENDPOINTSTATEREASON
/AWS1/EVBENDPOINTSTATEREASON
¶
The reason the endpoint is in its current state.
IV_CREATIONTIME
TYPE /AWS1/EVBTIMESTAMP
/AWS1/EVBTIMESTAMP
¶
The time the endpoint was created.
IV_LASTMODIFIEDTIME
TYPE /AWS1/EVBTIMESTAMP
/AWS1/EVBTIMESTAMP
¶
The last time the endpoint was modified.
Queryable Attributes¶
Name¶
The name of the endpoint.
Accessible with the following methods¶
Method | Description |
---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Description¶
A description for the endpoint.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
Arn¶
The ARN of the endpoint.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
RoutingConfig¶
The routing configuration of the endpoint.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ROUTINGCONFIG() |
Getter for ROUTINGCONFIG |
ReplicationConfig¶
Whether event replication was enabled or disabled for this endpoint. The default state is
ENABLED
which means you must supply aRoleArn
. If you don't have aRoleArn
or you don't want event replication enabled, set the state toDISABLED
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REPLICATIONCONFIG() |
Getter for REPLICATIONCONFIG |
EventBuses¶
The event buses being used by the endpoint.
Accessible with the following methods¶
Method | Description |
---|---|
GET_EVENTBUSES() |
Getter for EVENTBUSES, with configurable default |
ASK_EVENTBUSES() |
Getter for EVENTBUSES w/ exceptions if field has no value |
HAS_EVENTBUSES() |
Determine if EVENTBUSES has a value |
RoleArn¶
The ARN of the role used by event replication for the endpoint.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
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
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ENDPOINTID() |
Getter for ENDPOINTID, with configurable default |
ASK_ENDPOINTID() |
Getter for ENDPOINTID w/ exceptions if field has no value |
HAS_ENDPOINTID() |
Determine if ENDPOINTID has a value |
EndpointUrl¶
The URL of the endpoint.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ENDPOINTURL() |
Getter for ENDPOINTURL, with configurable default |
ASK_ENDPOINTURL() |
Getter for ENDPOINTURL w/ exceptions if field has no value |
HAS_ENDPOINTURL() |
Determine if ENDPOINTURL has a value |
State¶
The current state of the endpoint.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
StateReason¶
The reason the endpoint is in its current state.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STATEREASON() |
Getter for STATEREASON, with configurable default |
ASK_STATEREASON() |
Getter for STATEREASON w/ exceptions if field has no value |
HAS_STATEREASON() |
Determine if STATEREASON has a value |
CreationTime¶
The time the endpoint was created.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
LastModifiedTime¶
The last time the endpoint was modified.
Accessible with the following methods¶
Method | Description |
---|---|
GET_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME, with configurable default |
ASK_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME w/ exceptions if field has no va |
HAS_LASTMODIFIEDTIME() |
Determine if LASTMODIFIEDTIME has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_ENDPOINTLIST
¶
TYPES TT_ENDPOINTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_EVBENDPOINT WITH DEFAULT KEY
.