You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::PinpointSMSVoice::Types::EventDestinationDefinition

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

Overview

Note:

When making an API call, you may pass EventDestinationDefinition data as a hash:

{
  cloud_watch_logs_destination: {
    iam_role_arn: "String",
    log_group_arn: "String",
  },
  enabled: false,
  kinesis_firehose_destination: {
    delivery_stream_arn: "String",
    iam_role_arn: "String",
  },
  matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
  sns_destination: {
    topic_arn: "String",
  },
}

An object that defines a single event destination.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logs_destination ⇒ Types::CloudWatchLogsDestination

An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.

Returns:



314
315
316
317
318
319
320
321
 
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 314

class EventDestinationDefinition < Struct.new(
  :cloud_watch_logs_destination,
  :enabled,
  :kinesis_firehose_destination,
  :matching_event_types,
  :sns_destination)
  include Aws::Structure
end

#enabled ⇒ Boolean

Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination.

Returns:

  • (Boolean) 


314
315
316
317
318
319
320
321
 
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 314

class EventDestinationDefinition < Struct.new(
  :cloud_watch_logs_destination,
  :enabled,
  :kinesis_firehose_destination,
  :matching_event_types,
  :sns_destination)
  include Aws::Structure
end

#kinesis_firehose_destination ⇒ Types::KinesisFirehoseDestination

An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.

Returns:



314
315
316
317
318
319
320
321
 
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 314

class EventDestinationDefinition < Struct.new(
  :cloud_watch_logs_destination,
  :enabled,
  :kinesis_firehose_destination,
  :matching_event_types,
  :sns_destination)
  include Aws::Structure
end

#matching_event_types ⇒ Array<String>

An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.

Returns:

  • (Array<String>) 


314
315
316
317
318
319
320
321
 
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 314

class EventDestinationDefinition < Struct.new(
  :cloud_watch_logs_destination,
  :enabled,
  :kinesis_firehose_destination,
  :matching_event_types,
  :sns_destination)
  include Aws::Structure
end

#sns_destination ⇒ Types::SnsDestination

An object that contains information about an event destination that sends data to Amazon SNS.

Returns:



314
315
316
317
318
319
320
321
 
# File 'gems/aws-sdk-pinpointsmsvoice/lib/aws-sdk-pinpointsmsvoice/types.rb', line 314

class EventDestinationDefinition < Struct.new(
  :cloud_watch_logs_destination,
  :enabled,
  :kinesis_firehose_destination,
  :matching_event_types,
  :sns_destination)
  include Aws::Structure
end