Class: Aws::EventBridgeV2::Types::CreateSubscriberRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_configuration ⇒ Types::BatchConfiguration

Batching configuration for a subscriber.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  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) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#event_bus_arn ⇒ String

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

Returns:

  • (String) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  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:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#invoke_configuration ⇒ Types::InvokeConfiguration

Configuration for how the subscriber invokes its target.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#log_configuration ⇒ Types::LogConfiguration

Log configuration for a subscriber.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  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) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  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:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#point_in_time_configuration ⇒ Types::PointInTimeConfiguration

Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#retry_policy ⇒ Types::RetryPolicy

Retry policy for a subscriber.

Returns:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#starting_position ⇒ String

Starting position for a subscriber.

Returns:

  • (String) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  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) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags attached to a resource, as key-value pairs.

Returns:

  • (Hash<String,String>) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  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:



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  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) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 445

class CreateSubscriberRequest < Struct.new(
  :name,
  :event_bus_arn,
  :invoke_configuration,
  :description,
  :filter_configuration,
  :type,
  :starting_position,
  :point_in_time_configuration,
  :batch_configuration,
  :transformer,
  :retry_policy,
  :on_failure_configuration,
  :log_configuration,
  :state,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end