Struct aws_sdk_eventbridge::types::Endpoint

#[non_exhaustive]
pub struct Endpoint {

    pub name: Option<String>,
    pub description: Option<String>,
    pub arn: Option<String>,
    pub routing_config: Option<RoutingConfig>,
    pub replication_config: Option<ReplicationConfig>,
    pub event_buses: Option<Vec<EndpointEventBus>>,
    pub role_arn: Option<String>,
    pub endpoint_id: Option<String>,
    pub endpoint_url: Option<String>,
    pub state: Option<EndpointState>,
    pub state_reason: Option<String>,
    pub creation_time: Option<DateTime>,
    pub last_modified_time: Option<DateTime>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the endpoint.

description: Option<String>

A description for the endpoint.

arn: Option<String>

The ARN of the endpoint.

routing_config: Option<RoutingConfig>

The routing configuration of the endpoint.

replication_config: Option<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.

event_buses: Option<Vec<EndpointEventBus>>

The event buses being used by the endpoint.

role_arn: Option<String>

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

endpoint_id: Option<String>

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.

endpoint_url: Option<String>

The URL of the endpoint.

state: Option<EndpointState>

The current state of the endpoint.

state_reason: Option<String>

The reason the endpoint is in its current state.

creation_time: Option<DateTime>

The time the endpoint was created.

last_modified_time: Option<DateTime>

The last time the endpoint was modified.

Implementations

impl Endpoint

pub fn name(&self) -> Option<&str>

The name of the endpoint.

pub fn description(&self) -> Option<&str>

A description for the endpoint.

pub fn arn(&self) -> Option<&str>

The ARN of the endpoint.

pub fn routing_config(&self) -> Option<&RoutingConfig>

The routing configuration of the endpoint.

pub fn replication_config(&self) -> Option<&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.

pub fn event_buses(&self) -> &[EndpointEventBus]

The event buses being used by the endpoint.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .event_buses.is_none().

pub fn role_arn(&self) -> Option<&str>

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

pub fn endpoint_id(&self) -> Option<&str>

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.

pub fn endpoint_url(&self) -> Option<&str>

The URL of the endpoint.

pub fn state(&self) -> Option<&EndpointState>

The current state of the endpoint.

pub fn state_reason(&self) -> Option<&str>

The reason the endpoint is in its current state.

pub fn creation_time(&self) -> Option<&DateTime>

The time the endpoint was created.

pub fn last_modified_time(&self) -> Option<&DateTime>

The last time the endpoint was modified.

impl Endpoint

pub fn builder() -> EndpointBuilder

Creates a new builder-style object to manufacture Endpoint.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Endpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Endpoint

fn eq(&self, other: &Endpoint) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Endpoint