class Amazonite::EventBridge::Endpoint

Overview

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 *.

Included Modules

Defined in:

eventbridge/endpoint.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(name : String | Nil = nil, description : String | Nil = nil, arn : String | Nil = nil, routing_config : RoutingConfig | Nil = nil, replication_config : ReplicationConfig | Nil = nil, event_buses : Array(EndpointEventBus) | Nil = nil, role_arn : String | Nil = nil, endpoint_id : String | Nil = nil, endpoint_url : String | Nil = nil, state : EndpointState | Nil = nil, state_reason : String | Nil = nil, creation_time : Time | Nil = nil, last_modified_time : Time | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def arn : String | Nil #

The ARN of the endpoint.


[View source]
def arn=(arn : String | Nil) #

The ARN of the endpoint.


[View source]
def creation_time : Time | Nil #

The time the endpoint was created.


[View source]
def creation_time=(creation_time : Time | Nil) #

The time the endpoint was created.


[View source]
def description : String | Nil #

A description for the endpoint.


[View source]
def description=(description : String | Nil) #

A description for the endpoint.


[View source]
def endpoint_id : String | Nil #

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.


[View source]
def endpoint_id=(endpoint_id : String | Nil) #

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.


[View source]
def endpoint_url : String | Nil #

The URL of the endpoint.


[View source]
def endpoint_url=(endpoint_url : String | Nil) #

The URL of the endpoint.


[View source]
def event_buses : Array(EndpointEventBus) | Nil #

The event buses being used by the endpoint.


[View source]
def event_buses=(event_buses : Array(EndpointEventBus) | Nil) #

The event buses being used by the endpoint.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def last_modified_time : Time | Nil #

The last time the endpoint was modified.


[View source]
def last_modified_time=(last_modified_time : Time | Nil) #

The last time the endpoint was modified.


[View source]
def name : String | Nil #

The name of the endpoint.


[View source]
def name=(name : String | Nil) #

The name of the endpoint.


[View source]
def replication_config : ReplicationConfig | Nil #

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.


[View source]
def replication_config=(replication_config : ReplicationConfig | Nil) #

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.


[View source]
def role_arn : String | Nil #

The ARN of the role used by event replication for the endpoint.


[View source]
def role_arn=(role_arn : String | Nil) #

The ARN of the role used by event replication for the endpoint.


[View source]
def routing_config : RoutingConfig | Nil #

The routing configuration of the endpoint.


[View source]
def routing_config=(routing_config : RoutingConfig | Nil) #

The routing configuration of the endpoint.


[View source]
def state : EndpointState | Nil #

The current state of the endpoint.


[View source]
def state=(state : EndpointState | Nil) #

The current state of the endpoint.


[View source]
def state_reason : String | Nil #

The reason the endpoint is in its current state.


[View source]
def state_reason=(state_reason : String | Nil) #

The reason the endpoint is in its current state.


[View source]
def validate! : Nil #

[View source]