Class: Aws::Pipes::Types::PipeTargetParameters

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pipes/types.rb

Overview

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see [Target parameters] in the *Amazon EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html

See Also:

Constant Summary collapse

SENSITIVE = 
[:input_template]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_job_parameters ⇒ Types::PipeTargetBatchJobParameters

The parameters for using an Batch job as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#cloud_watch_logs_parameters ⇒ Types::PipeTargetCloudWatchLogsParameters

The parameters for using an CloudWatch Logs log stream as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#ecs_task_parameters ⇒ Types::PipeTargetEcsTaskParameters

The parameters for using an Amazon ECS task as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#event_bridge_event_bus_parameters ⇒ Types::PipeTargetEventBridgeEventBusParameters

The parameters for using an EventBridge event bus as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#http_parameters ⇒ Types::PipeTargetHttpParameters

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#input_template ⇒ String

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format].

To remove an input template, specify an empty string.

[1]: www.rfc-editor.org/rfc/rfc7159.txt

Returns:

  • (String) 


2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#kinesis_stream_parameters ⇒ Types::PipeTargetKinesisStreamParameters

The parameters for using a Kinesis stream as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#lambda_function_parameters ⇒ Types::PipeTargetLambdaFunctionParameters

The parameters for using a Lambda function as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#redshift_data_parameters ⇒ Types::PipeTargetRedshiftDataParameters

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#sage_maker_pipeline_parameters ⇒ Types::PipeTargetSageMakerPipelineParameters

The parameters for using a SageMaker pipeline as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#sqs_queue_parameters ⇒ Types::PipeTargetSqsQueueParameters

The parameters for using a Amazon SQS stream as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#step_function_state_machine_parameters ⇒ Types::PipeTargetStateMachineParameters

The parameters for using a Step Functions state machine as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end

#timestream_parameters ⇒ Types::PipeTargetTimestreamParameters

The parameters for using a Timestream for LiveAnalytics table as a target.

Returns:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/aws-sdk-pipes/types.rb', line 2512

class PipeTargetParameters < Struct.new(
  :input_template,
  :lambda_function_parameters,
  :step_function_state_machine_parameters,
  :kinesis_stream_parameters,
  :ecs_task_parameters,
  :batch_job_parameters,
  :sqs_queue_parameters,
  :http_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :event_bridge_event_bus_parameters,
  :cloud_watch_logs_parameters,
  :timestream_parameters)
  SENSITIVE = [:input_template]
  include Aws::Structure
end