Class: Aws::EventBridgeV2::Types::UpdateSubscriberRequest

Inherits:

Struct

• Object
• Struct
• Aws::EventBridgeV2::Types::UpdateSubscriberRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #batch_configuration ⇒ Types::BatchConfiguration

  Batching configuration for a subscriber.

• #description ⇒ String

  Free-text description.

• #filter_configuration ⇒ Types::FilterConfiguration

  Configuration for filtering events delivered to a subscriber.

• #invoke_configuration ⇒ Types::UpdateInvokeConfiguration

  Update-able configuration for how the subscriber invokes its target.

• #log_configuration ⇒ Types::LogConfiguration

  Log configuration for a subscriber.

• #on_failure_configuration ⇒ Types::OnFailureConfiguration

  On-failure configuration: where a failed delivery is sent.

• #resume_position ⇒ String

  Position from which delivery resumes when a subscriber is unpaused.

• #retry_policy ⇒ Types::RetryPolicy

  Retry policy for a subscriber.

• #state ⇒ String

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

• #subscriber_arn ⇒ String

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

• #transformer ⇒ Types::Transformer

  Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.

Instance Attribute Details

#batch_configuration ⇒ Types::BatchConfiguration

Batching configuration for a subscriber.

Returns:

• (Types::BatchConfiguration)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

Returns:

• (String)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#filter_configuration ⇒ Types::FilterConfiguration

Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty FilterConfiguration:{} clears the existing filter. Any non-empty shape (including {Language:X} without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.

Returns:

• (Types::FilterConfiguration)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#invoke_configuration ⇒ Types::UpdateInvokeConfiguration

Update-able configuration for how the subscriber invokes its target.

Returns:

• (Types::UpdateInvokeConfiguration)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#log_configuration ⇒ Types::LogConfiguration

Log configuration for a subscriber.

Returns:

• (Types::LogConfiguration)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#on_failure_configuration ⇒ Types::OnFailureConfiguration

On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.

Returns:

• (Types::OnFailureConfiguration)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resume_position ⇒ String

Position from which delivery resumes when a subscriber is unpaused. Honored only on an UpdateSubscriber call that transitions State from STOPPED to RUNNING (unpause); ignored on any other call and not accepted on Create. Defaults to LAST_PROCESSED when omitted.

Returns:

• (String)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#retry_policy ⇒ Types::RetryPolicy

Retry policy for a subscriber.

Returns:

• (Types::RetryPolicy)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  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 3111

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  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 3111

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#transformer ⇒ Types::Transformer

Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.

Returns:

• (Types::Transformer)

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

class UpdateSubscriberRequest < Struct.new(
  :subscriber_arn,
  :description,
  :state,
  :resume_position,
  :invoke_configuration,
  :filter_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end