Class: Aws::EventBridgeV2::Types::InvokeConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::EventBridgeV2::Types::InvokeConfiguration

Defined in:

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

Overview

Configuration for how the subscriber invokes its target.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]

Instance Attribute Summary

• #event_bus_v2_parameters ⇒ Types::EventBusV2Parameters

  Parameters for forwarding events to another EventBridge event bus.

• #http_parameters ⇒ Types::HttpParameters

  HTTP invocation parameters for subscribers (API Gateway / API Destination).

• #kinesis_parameters ⇒ Types::KinesisParameters

  Kinesis Data Streams invocation parameters for subscribers.

• #lambda_parameters ⇒ Types::LambdaParameters

  Lambda invocation parameters for subscribers.

• #role_arn ⇒ String

  IAM role the service assumes to invoke the target.

• #sns_parameters ⇒ Types::SnsParameters

  SNS invocation parameters for subscribers.

• #sqs_parameters ⇒ Types::SqsParameters

  SQS invocation parameters for subscribers.

• #step_functions_parameters ⇒ Types::StepFunctionsParameters

  Step Functions invocation parameters for subscribers.

• #target_arn ⇒ String

  ARN of the target a subscriber invokes.

• #universal_target_parameters ⇒ Types::UniversalTargetParameters

  Parameters for USI (Universal Service Integration) targets.

Instance Attribute Details

#event_bus_v2_parameters ⇒ Types::EventBusV2Parameters

Parameters for forwarding events to another EventBridge event bus.

Returns:

• (Types::EventBusV2Parameters)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end

#http_parameters ⇒ Types::HttpParameters

HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.

Returns:

• (Types::HttpParameters)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end

#kinesis_parameters ⇒ Types::KinesisParameters

Kinesis Data Streams invocation parameters for subscribers. Values are forwarded to the Kinesis PutRecords API. All scalar values accept a literal or a JSONata expression (e.g. "$events.Data.partitionKey %").

Returns:

• (Types::KinesisParameters)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end

#lambda_parameters ⇒ Types::LambdaParameters

Lambda invocation parameters for subscribers. Values are forwarded to the Lambda Invoke API. Every string member accepts a literal or a JSONata expression (e.g. "$events.Data.qualifier %").

Returns:

• (Types::LambdaParameters)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end

#role_arn ⇒ String

IAM role the service assumes to invoke the target. Must belong to the calling account.

Returns:

• (String)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end

#sns_parameters ⇒ Types::SnsParameters

SNS invocation parameters for subscribers. Values are forwarded to the SNS PublishBatch API. All scalar values accept a literal or a JSONata expression (e.g. "$events.Data.groupId %").

Returns:

• (Types::SnsParameters)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end

#sqs_parameters ⇒ Types::SqsParameters

SQS invocation parameters for subscribers. Values are forwarded to the SQS SendMessageBatch API. All scalar values accept a literal or a JSONata expression (e.g. "$events.Data.groupId %").

Returns:

• (Types::SqsParameters)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end

#step_functions_parameters ⇒ Types::StepFunctionsParameters

Step Functions invocation parameters for subscribers. Values are forwarded to the Step Functions StartExecution or StartSyncExecution API. Every string member accepts a literal or a JSONata expression (e.g. "$events.Data.executionName %").

Returns:

• (Types::StepFunctionsParameters)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  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 1458

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end

#universal_target_parameters ⇒ Types::UniversalTargetParameters

Parameters for USI (Universal Service Integration) targets. Used when TargetArn is in the format arn:aws:events:::aws-sdk:service:apiAction

Returns:

• (Types::UniversalTargetParameters)

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

class InvokeConfiguration < Struct.new(
  :role_arn,
  :lambda_parameters,
  :sqs_parameters,
  :sns_parameters,
  :kinesis_parameters,
  :step_functions_parameters,
  :http_parameters,
  :universal_target_parameters,
  :event_bus_v2_parameters,
  :target_arn)
  SENSITIVE = [:lambda_parameters, :sqs_parameters, :sns_parameters, :kinesis_parameters, :step_functions_parameters, :http_parameters, :universal_target_parameters, :event_bus_v2_parameters]
  include Aws::Structure
end