Class: Aws::EventBridgeV2::Types::SubscriberSummary

Inherits:

Struct

• Object
• Struct
• Aws::EventBridgeV2::Types::SubscriberSummary

Defined in:

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

Overview

Summary of a subscriber, as returned by ListSubscribers.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  The time the subscriber was created.

• #event_bus_arn ⇒ String

  The Amazon Resource Name (ARN) that uniquely identifies an event bus.

• #last_modified_time ⇒ Time

  The time the subscriber was last modified.

• #name ⇒ String

  Name of a subscriber.

• #revoked ⇒ Boolean

  True when the bus owner has revoked this subscriber.

• #state ⇒ String

  Customer-controlled run state of a subscriber, set on create or update.

• #subscriber_account_id ⇒ String

  AWS Account Id.

• #subscriber_arn ⇒ String

  The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

• #target_arn ⇒ String

  ARN of the target a subscriber invokes.

• #type ⇒ String

  Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Instance Attribute Details

#creation_time ⇒ Time

The time the subscriber was created.

Returns:

• (Time)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#event_bus_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The time the subscriber was last modified.

Returns:

• (Time)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#revoked ⇒ Boolean

True when the bus owner has revoked this subscriber. Present only when true, so a bus owner listing subscribers sees at a glance which ones they revoked. See DescribeSubscriberResponse$Revoked.

Returns:

• (Boolean)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_account_id ⇒ String

AWS Account Id.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#target_arn ⇒ String

ARN of the target a subscriber invokes. The resource grammar is service-neutral because target services use different separators and the USI form omits region and account.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 2684

class SubscriberSummary < Struct.new(
  :subscriber_arn,
  :name,
  :event_bus_arn,
  :target_arn,
  :type,
  :revoked,
  :state,
  :creation_time,
  :last_modified_time,
  :subscriber_account_id)
  SENSITIVE = []
  include Aws::Structure
end