Class: Aws::EventBridge::Types::Endpoint

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::Endpoint

Defined in:

gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

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 .

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the endpoint.

• #creation_time ⇒ Time

  The time the endpoint was created.

• #description ⇒ String

  A description for the endpoint.

• #endpoint_id ⇒ String

  The URL subdomain of the endpoint.

• #endpoint_url ⇒ String

  The URL of the endpoint.

• #event_buses ⇒ Array<Types::EndpointEventBus>

  The event buses being used by the endpoint.

• #last_modified_time ⇒ Time

  The last time the endpoint was modified.

• #name ⇒ String

  The name of the endpoint.

• #replication_config ⇒ Types::ReplicationConfig

  Whether event replication was enabled or disabled for this endpoint.

• #role_arn ⇒ String

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

• #routing_config ⇒ Types::RoutingConfig

  The routing configuration of the endpoint.

• #state ⇒ String

  The current state of the endpoint.

• #state_reason ⇒ String

  The reason the endpoint is in its current state.

Instance Attribute Details

#arn ⇒ String

The ARN of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time the endpoint was created.

Returns:

• (Time)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_id ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_url ⇒ String

The URL of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#event_buses ⇒ Array<Types::EndpointEventBus>

The event buses being used by the endpoint.

Returns:

• (Array<Types::EndpointEventBus>)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The last time the endpoint was modified.

Returns:

• (Time)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#replication_config ⇒ Types::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.

Returns:

• (Types::ReplicationConfig)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#routing_config ⇒ Types::RoutingConfig

The routing configuration of the endpoint.

Returns:

• (Types::RoutingConfig)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

The reason the endpoint is in its current state.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2593

class Endpoint < Struct.new(
  :name,
  :description,
  :arn,
  :routing_config,
  :replication_config,
  :event_buses,
  :role_arn,
  :endpoint_id,
  :endpoint_url,
  :state,
  :state_reason,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end