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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pipes/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.

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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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.

Returns:

  • (String) 


2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

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

#kinesis_stream_parameters ⇒ Types::PipeTargetKinesisStreamParameters

The parameters for using a Kinesis stream as a target.

Returns:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

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

#lambda_function_parameters ⇒ Types::PipeTargetLambdaFunctionParameters

The parameters for using a Lambda function as a target.

Returns:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

class PipeTargetParameters < Struct.new(
  :batch_job_parameters,
  :cloud_watch_logs_parameters,
  :ecs_task_parameters,
  :event_bridge_event_bus_parameters,
  :http_parameters,
  :input_template,
  :kinesis_stream_parameters,
  :lambda_function_parameters,
  :redshift_data_parameters,
  :sage_maker_pipeline_parameters,
  :sqs_queue_parameters,
  :step_function_state_machine_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:



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2371

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