Class: AWSCDK::Pipes::CfnPipe::PipeTargetParametersProperty

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(batch_job_parameters: nil, cloud_watch_logs_parameters: nil, ecs_task_parameters: nil, event_bridge_event_bus_parameters: nil, http_parameters: nil, input_template: nil, kinesis_stream_parameters: nil, lambda_function_parameters: nil, redshift_data_parameters: nil, sage_maker_pipeline_parameters: nil, sqs_queue_parameters: nil, step_function_state_machine_parameters: nil, timestream_parameters: nil) ⇒ PipeTargetParametersProperty

Returns a new instance of PipeTargetParametersProperty.

Parameters:



3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
 
# File 'pipes/cfn_pipe.rb', line 3536

def initialize(batch_job_parameters: nil, cloud_watch_logs_parameters: nil, ecs_task_parameters: nil, event_bridge_event_bus_parameters: nil, http_parameters: nil, input_template: nil, kinesis_stream_parameters: nil, lambda_function_parameters: nil, redshift_data_parameters: nil, sage_maker_pipeline_parameters: nil, sqs_queue_parameters: nil, step_function_state_machine_parameters: nil, timestream_parameters: nil)
  @batch_job_parameters = batch_job_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetBatchJobParametersProperty.new(**batch_job_parameters.transform_keys(&:to_sym)) : batch_job_parameters
  Jsii::Type.check_type(@batch_job_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRCYXRjaEpvYlBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "batchJobParameters") unless @batch_job_parameters.nil?
  @cloud_watch_logs_parameters = cloud_watch_logs_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetCloudWatchLogsParametersProperty.new(**cloud_watch_logs_parameters.transform_keys(&:to_sym)) : cloud_watch_logs_parameters
  Jsii::Type.check_type(@cloud_watch_logs_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRDbG91ZFdhdGNoTG9nc1BhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "cloudWatchLogsParameters") unless @cloud_watch_logs_parameters.nil?
  @ecs_task_parameters = ecs_task_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetECSTaskParametersProperty.new(**ecs_task_parameters.transform_keys(&:to_sym)) : ecs_task_parameters
  Jsii::Type.check_type(@ecs_task_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRFY3NUYXNrUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "ecsTaskParameters") unless @ecs_task_parameters.nil?
  @event_bridge_event_bus_parameters = event_bridge_event_bus_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetEventBridgeEventBusParametersProperty.new(**event_bridge_event_bus_parameters.transform_keys(&:to_sym)) : event_bridge_event_bus_parameters
  Jsii::Type.check_type(@event_bridge_event_bus_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRFdmVudEJyaWRnZUV2ZW50QnVzUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "eventBridgeEventBusParameters") unless @event_bridge_event_bus_parameters.nil?
  @http_parameters = http_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetHttpParametersProperty.new(**http_parameters.transform_keys(&:to_sym)) : http_parameters
  Jsii::Type.check_type(@http_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRIdHRwUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "httpParameters") unless @http_parameters.nil?
  @input_template = input_template
  Jsii::Type.check_type(@input_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputTemplate") unless @input_template.nil?
  @kinesis_stream_parameters = kinesis_stream_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetKinesisStreamParametersProperty.new(**kinesis_stream_parameters.transform_keys(&:to_sym)) : kinesis_stream_parameters
  Jsii::Type.check_type(@kinesis_stream_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRLaW5lc2lzU3RyZWFtUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "kinesisStreamParameters") unless @kinesis_stream_parameters.nil?
  @lambda_function_parameters = lambda_function_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetLambdaFunctionParametersProperty.new(**lambda_function_parameters.transform_keys(&:to_sym)) : lambda_function_parameters
  Jsii::Type.check_type(@lambda_function_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRMYW1iZGFGdW5jdGlvblBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "lambdaFunctionParameters") unless @lambda_function_parameters.nil?
  @redshift_data_parameters = redshift_data_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetRedshiftDataParametersProperty.new(**redshift_data_parameters.transform_keys(&:to_sym)) : redshift_data_parameters
  Jsii::Type.check_type(@redshift_data_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRSZWRzaGlmdERhdGFQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "redshiftDataParameters") unless @redshift_data_parameters.nil?
  @sage_maker_pipeline_parameters = sage_maker_pipeline_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetSageMakerPipelineParametersProperty.new(**sage_maker_pipeline_parameters.transform_keys(&:to_sym)) : sage_maker_pipeline_parameters
  Jsii::Type.check_type(@sage_maker_pipeline_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRTYWdlTWFrZXJQaXBlbGluZVBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "sageMakerPipelineParameters") unless @sage_maker_pipeline_parameters.nil?
  @sqs_queue_parameters = sqs_queue_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetSQSQueueParametersProperty.new(**sqs_queue_parameters.transform_keys(&:to_sym)) : sqs_queue_parameters
  Jsii::Type.check_type(@sqs_queue_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRTcXNRdWV1ZVBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "sqsQueueParameters") unless @sqs_queue_parameters.nil?
  @step_function_state_machine_parameters = step_function_state_machine_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetStateMachineParametersProperty.new(**step_function_state_machine_parameters.transform_keys(&:to_sym)) : step_function_state_machine_parameters
  Jsii::Type.check_type(@step_function_state_machine_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRTdGF0ZU1hY2hpbmVQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "stepFunctionStateMachineParameters") unless @step_function_state_machine_parameters.nil?
  @timestream_parameters = timestream_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetTimestreamParametersProperty.new(**timestream_parameters.transform_keys(&:to_sym)) : timestream_parameters
  Jsii::Type.check_type(@timestream_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRUaW1lc3RyZWFtUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "timestreamParameters") unless @timestream_parameters.nil?
end

Instance Attribute Details

#batch_job_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The parameters for using an AWS Batch job as a target.

Returns:

See Also:



3569
3570
3571
 
# File 'pipes/cfn_pipe.rb', line 3569

def batch_job_parameters
  @batch_job_parameters
end

#cloud_watch_logs_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



3574
3575
3576
 
# File 'pipes/cfn_pipe.rb', line 3574

def cloud_watch_logs_parameters
  @cloud_watch_logs_parameters
end

#ecs_task_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



3579
3580
3581
 
# File 'pipes/cfn_pipe.rb', line 3579

def ecs_task_parameters
  @ecs_task_parameters
end

#event_bridge_event_bus_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



3584
3585
3586
 
# File 'pipes/cfn_pipe.rb', line 3584

def event_bridge_event_bus_parameters
  @event_bridge_event_bus_parameters
end

#http_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



3589
3590
3591
 
# File 'pipes/cfn_pipe.rb', line 3589

def http_parameters
  @http_parameters
end

#input_template ⇒ String? (readonly)

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, nil)

See Also:



3598
3599
3600
 
# File 'pipes/cfn_pipe.rb', line 3598

def input_template
  @input_template
end

#kinesis_stream_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The parameters for using a Kinesis stream as a target.

Returns:

See Also:



3603
3604
3605
 
# File 'pipes/cfn_pipe.rb', line 3603

def kinesis_stream_parameters
  @kinesis_stream_parameters
end

#lambda_function_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The parameters for using a Lambda function as a target.

Returns:

See Also:



3608
3609
3610
 
# File 'pipes/cfn_pipe.rb', line 3608

def lambda_function_parameters
  @lambda_function_parameters
end

#redshift_data_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



3613
3614
3615
 
# File 'pipes/cfn_pipe.rb', line 3613

def redshift_data_parameters
  @redshift_data_parameters
end

#sage_maker_pipeline_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The parameters for using a SageMaker AI pipeline as a target.

Returns:

See Also:



3618
3619
3620
 
# File 'pipes/cfn_pipe.rb', line 3618

def sage_maker_pipeline_parameters
  @sage_maker_pipeline_parameters
end

#sqs_queue_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



3623
3624
3625
 
# File 'pipes/cfn_pipe.rb', line 3623

def sqs_queue_parameters
  @sqs_queue_parameters
end

#step_function_state_machine_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



3628
3629
3630
 
# File 'pipes/cfn_pipe.rb', line 3628

def step_function_state_machine_parameters
  @step_function_state_machine_parameters
end

#timestream_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



3633
3634
3635
 
# File 'pipes/cfn_pipe.rb', line 3633

def timestream_parameters
  @timestream_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
 
# File 'pipes/cfn_pipe.rb', line 3635

def self.jsii_properties
  {
    :batch_job_parameters => "batchJobParameters",
    :cloud_watch_logs_parameters => "cloudWatchLogsParameters",
    :ecs_task_parameters => "ecsTaskParameters",
    :event_bridge_event_bus_parameters => "eventBridgeEventBusParameters",
    :http_parameters => "httpParameters",
    :input_template => "inputTemplate",
    :kinesis_stream_parameters => "kinesisStreamParameters",
    :lambda_function_parameters => "lambdaFunctionParameters",
    :redshift_data_parameters => "redshiftDataParameters",
    :sage_maker_pipeline_parameters => "sageMakerPipelineParameters",
    :sqs_queue_parameters => "sqsQueueParameters",
    :step_function_state_machine_parameters => "stepFunctionStateMachineParameters",
    :timestream_parameters => "timestreamParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'pipes/cfn_pipe.rb', line 3653

def to_jsii
  result = {}
  result.merge!({
    "batchJobParameters" => @batch_job_parameters,
    "cloudWatchLogsParameters" => @cloud_watch_logs_parameters,
    "ecsTaskParameters" => @ecs_task_parameters,
    "eventBridgeEventBusParameters" => @event_bridge_event_bus_parameters,
    "httpParameters" => @http_parameters,
    "inputTemplate" => @input_template,
    "kinesisStreamParameters" => @kinesis_stream_parameters,
    "lambdaFunctionParameters" => @lambda_function_parameters,
    "redshiftDataParameters" => @redshift_data_parameters,
    "sageMakerPipelineParameters" => @sage_maker_pipeline_parameters,
    "sqsQueueParameters" => @sqs_queue_parameters,
    "stepFunctionStateMachineParameters" => @step_function_state_machine_parameters,
    "timestreamParameters" => @timestream_parameters,
  })
  result.compact
end