PipeTargetParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pipes.model.PipeTargetParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipeTargetParameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The parameters required to set up a target for your pipe.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipeTargetParameters()

Constructors
Constructor and Description
`PipeTargetParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipeTargetParameters`	`clone()`
`boolean`	`equals(Object obj)`
`PipeTargetBatchJobParameters`	`getBatchJobParameters()` The parameters for using an Batch job as a target.
`PipeTargetCloudWatchLogsParameters`	`getCloudWatchLogsParameters()` The parameters for using an CloudWatch Logs log stream as a target.
`PipeTargetEcsTaskParameters`	`getEcsTaskParameters()` The parameters for using an Amazon ECS task as a target.
`PipeTargetEventBridgeEventBusParameters`	`getEventBridgeEventBusParameters()` The parameters for using an EventBridge event bus as a target.
`PipeTargetHttpParameters`	`getHttpParameters()` These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
`String`	`getInputTemplate()` Valid JSON text passed to the target.
`PipeTargetKinesisStreamParameters`	`getKinesisStreamParameters()` The parameters for using a Kinesis stream as a source.
`PipeTargetLambdaFunctionParameters`	`getLambdaFunctionParameters()` The parameters for using a Lambda function as a target.
`PipeTargetRedshiftDataParameters`	`getRedshiftDataParameters()` These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
`PipeTargetSageMakerPipelineParameters`	`getSageMakerPipelineParameters()` The parameters for using a SageMaker pipeline as a target.
`PipeTargetSqsQueueParameters`	`getSqsQueueParameters()` The parameters for using a Amazon SQS stream as a source.
`PipeTargetStateMachineParameters`	`getStepFunctionStateMachineParameters()` The parameters for using a Step Functions state machine as a target.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBatchJobParameters(PipeTargetBatchJobParameters batchJobParameters)` The parameters for using an Batch job as a target.
`void`	`setCloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters)` The parameters for using an CloudWatch Logs log stream as a target.
`void`	`setEcsTaskParameters(PipeTargetEcsTaskParameters ecsTaskParameters)` The parameters for using an Amazon ECS task as a target.
`void`	`setEventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters)` The parameters for using an EventBridge event bus as a target.
`void`	`setHttpParameters(PipeTargetHttpParameters httpParameters)` These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
`void`	`setInputTemplate(String inputTemplate)` Valid JSON text passed to the target.
`void`	`setKinesisStreamParameters(PipeTargetKinesisStreamParameters kinesisStreamParameters)` The parameters for using a Kinesis stream as a source.
`void`	`setLambdaFunctionParameters(PipeTargetLambdaFunctionParameters lambdaFunctionParameters)` The parameters for using a Lambda function as a target.
`void`	`setRedshiftDataParameters(PipeTargetRedshiftDataParameters redshiftDataParameters)` These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
`void`	`setSageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters)` The parameters for using a SageMaker pipeline as a target.
`void`	`setSqsQueueParameters(PipeTargetSqsQueueParameters sqsQueueParameters)` The parameters for using a Amazon SQS stream as a source.
`void`	`setStepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)` The parameters for using a Step Functions state machine as a target.
`String`	`toString()` Returns a string representation of this object.
`PipeTargetParameters`	`withBatchJobParameters(PipeTargetBatchJobParameters batchJobParameters)` The parameters for using an Batch job as a target.
`PipeTargetParameters`	`withCloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters)` The parameters for using an CloudWatch Logs log stream as a target.
`PipeTargetParameters`	`withEcsTaskParameters(PipeTargetEcsTaskParameters ecsTaskParameters)` The parameters for using an Amazon ECS task as a target.
`PipeTargetParameters`	`withEventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters)` The parameters for using an EventBridge event bus as a target.
`PipeTargetParameters`	`withHttpParameters(PipeTargetHttpParameters httpParameters)` These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
`PipeTargetParameters`	`withInputTemplate(String inputTemplate)` Valid JSON text passed to the target.
`PipeTargetParameters`	`withKinesisStreamParameters(PipeTargetKinesisStreamParameters kinesisStreamParameters)` The parameters for using a Kinesis stream as a source.
`PipeTargetParameters`	`withLambdaFunctionParameters(PipeTargetLambdaFunctionParameters lambdaFunctionParameters)` The parameters for using a Lambda function as a target.
`PipeTargetParameters`	`withRedshiftDataParameters(PipeTargetRedshiftDataParameters redshiftDataParameters)` These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
`PipeTargetParameters`	`withSageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters)` The parameters for using a SageMaker pipeline as a target.
`PipeTargetParameters`	`withSqsQueueParameters(PipeTargetSqsQueueParameters sqsQueueParameters)` The parameters for using a Amazon SQS stream as a source.
`PipeTargetParameters`	`withStepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)` The parameters for using a Step Functions state machine as a target.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PipeTargetParameters
```
public PipeTargetParameters()
```
- Method Detail
  - setBatchJobParameters
```
public void setBatchJobParameters(PipeTargetBatchJobParameters batchJobParameters)
```
    The parameters for using an Batch job as a target.
    
    Parameters:
    
    batchJobParameters - The parameters for using an Batch job as a target.
  - getBatchJobParameters
```
public PipeTargetBatchJobParameters getBatchJobParameters()
```
    The parameters for using an Batch job as a target.
    
    Returns:
    
    The parameters for using an Batch job as a target.
  - withBatchJobParameters
```
public PipeTargetParameters withBatchJobParameters(PipeTargetBatchJobParameters batchJobParameters)
```
    The parameters for using an Batch job as a target.
    
    Parameters:
    
    batchJobParameters - The parameters for using an Batch job as a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchLogsParameters
```
public void setCloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters)
```
    The parameters for using an CloudWatch Logs log stream as a target.
    
    Parameters:
    
    cloudWatchLogsParameters - The parameters for using an CloudWatch Logs log stream as a target.
  - getCloudWatchLogsParameters
```
public PipeTargetCloudWatchLogsParameters getCloudWatchLogsParameters()
```
    The parameters for using an CloudWatch Logs log stream as a target.
    
    Returns:
    
    The parameters for using an CloudWatch Logs log stream as a target.
  - withCloudWatchLogsParameters
```
public PipeTargetParameters withCloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters)
```
    The parameters for using an CloudWatch Logs log stream as a target.
    
    Parameters:
    
    cloudWatchLogsParameters - The parameters for using an CloudWatch Logs log stream as a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEcsTaskParameters
```
public void setEcsTaskParameters(PipeTargetEcsTaskParameters ecsTaskParameters)
```
    The parameters for using an Amazon ECS task as a target.
    
    Parameters:
    
    ecsTaskParameters - The parameters for using an Amazon ECS task as a target.
  - getEcsTaskParameters
```
public PipeTargetEcsTaskParameters getEcsTaskParameters()
```
    The parameters for using an Amazon ECS task as a target.
    
    Returns:
    
    The parameters for using an Amazon ECS task as a target.
  - withEcsTaskParameters
```
public PipeTargetParameters withEcsTaskParameters(PipeTargetEcsTaskParameters ecsTaskParameters)
```
    The parameters for using an Amazon ECS task as a target.
    
    Parameters:
    
    ecsTaskParameters - The parameters for using an Amazon ECS task as a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventBridgeEventBusParameters
```
public void setEventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters)
```
    The parameters for using an EventBridge event bus as a target.
    
    Parameters:
    
    eventBridgeEventBusParameters - The parameters for using an EventBridge event bus as a target.
  - getEventBridgeEventBusParameters
```
public PipeTargetEventBridgeEventBusParameters getEventBridgeEventBusParameters()
```
    The parameters for using an EventBridge event bus as a target.
    
    Returns:
    
    The parameters for using an EventBridge event bus as a target.
  - withEventBridgeEventBusParameters
```
public PipeTargetParameters withEventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters)
```
    The parameters for using an EventBridge event bus as a target.
    
    Parameters:
    
    eventBridgeEventBusParameters - The parameters for using an EventBridge event bus as a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHttpParameters
```
public void setHttpParameters(PipeTargetHttpParameters httpParameters)
```
    These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
    
    Parameters:
    
    httpParameters - These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
  - getHttpParameters
```
public PipeTargetHttpParameters getHttpParameters()
```
    These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
    
    Returns:
    
    These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
  - withHttpParameters
```
public PipeTargetParameters withHttpParameters(PipeTargetHttpParameters httpParameters)
```
    These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
    
    Parameters:
    
    httpParameters - These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputTemplate
```
public void setInputTemplate(String inputTemplate)
```
    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.
    
    Parameters:
    
    inputTemplate - 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.
  - getInputTemplate
```
public String getInputTemplate()
```
    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.
    
    Returns:
    
    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.
  - withInputTemplate
```
public PipeTargetParameters withInputTemplate(String inputTemplate)
```
    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.
    
    Parameters:
    
    inputTemplate - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKinesisStreamParameters
```
public void setKinesisStreamParameters(PipeTargetKinesisStreamParameters kinesisStreamParameters)
```
    The parameters for using a Kinesis stream as a source.
    
    Parameters:
    
    kinesisStreamParameters - The parameters for using a Kinesis stream as a source.
  - getKinesisStreamParameters
```
public PipeTargetKinesisStreamParameters getKinesisStreamParameters()
```
    The parameters for using a Kinesis stream as a source.
    
    Returns:
    
    The parameters for using a Kinesis stream as a source.
  - withKinesisStreamParameters
```
public PipeTargetParameters withKinesisStreamParameters(PipeTargetKinesisStreamParameters kinesisStreamParameters)
```
    The parameters for using a Kinesis stream as a source.
    
    Parameters:
    
    kinesisStreamParameters - The parameters for using a Kinesis stream as a source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLambdaFunctionParameters
```
public void setLambdaFunctionParameters(PipeTargetLambdaFunctionParameters lambdaFunctionParameters)
```
    The parameters for using a Lambda function as a target.
    
    Parameters:
    
    lambdaFunctionParameters - The parameters for using a Lambda function as a target.
  - getLambdaFunctionParameters
```
public PipeTargetLambdaFunctionParameters getLambdaFunctionParameters()
```
    The parameters for using a Lambda function as a target.
    
    Returns:
    
    The parameters for using a Lambda function as a target.
  - withLambdaFunctionParameters
```
public PipeTargetParameters withLambdaFunctionParameters(PipeTargetLambdaFunctionParameters lambdaFunctionParameters)
```
    The parameters for using a Lambda function as a target.
    
    Parameters:
    
    lambdaFunctionParameters - The parameters for using a Lambda function as a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRedshiftDataParameters
```
public void setRedshiftDataParameters(PipeTargetRedshiftDataParameters redshiftDataParameters)
```
    These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
    
    Parameters:
    
    redshiftDataParameters - These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
  - getRedshiftDataParameters
```
public PipeTargetRedshiftDataParameters getRedshiftDataParameters()
```
    These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
    
    Returns:
    
    These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
  - withRedshiftDataParameters
```
public PipeTargetParameters withRedshiftDataParameters(PipeTargetRedshiftDataParameters redshiftDataParameters)
```
    These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
    
    Parameters:
    
    redshiftDataParameters - These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSageMakerPipelineParameters
```
public void setSageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters)
```
    The parameters for using a SageMaker pipeline as a target.
    
    Parameters:
    
    sageMakerPipelineParameters - The parameters for using a SageMaker pipeline as a target.
  - getSageMakerPipelineParameters
```
public PipeTargetSageMakerPipelineParameters getSageMakerPipelineParameters()
```
    The parameters for using a SageMaker pipeline as a target.
    
    Returns:
    
    The parameters for using a SageMaker pipeline as a target.
  - withSageMakerPipelineParameters
```
public PipeTargetParameters withSageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters)
```
    The parameters for using a SageMaker pipeline as a target.
    
    Parameters:
    
    sageMakerPipelineParameters - The parameters for using a SageMaker pipeline as a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSqsQueueParameters
```
public void setSqsQueueParameters(PipeTargetSqsQueueParameters sqsQueueParameters)
```
    The parameters for using a Amazon SQS stream as a source.
    
    Parameters:
    
    sqsQueueParameters - The parameters for using a Amazon SQS stream as a source.
  - getSqsQueueParameters
```
public PipeTargetSqsQueueParameters getSqsQueueParameters()
```
    The parameters for using a Amazon SQS stream as a source.
    
    Returns:
    
    The parameters for using a Amazon SQS stream as a source.
  - withSqsQueueParameters
```
public PipeTargetParameters withSqsQueueParameters(PipeTargetSqsQueueParameters sqsQueueParameters)
```
    The parameters for using a Amazon SQS stream as a source.
    
    Parameters:
    
    sqsQueueParameters - The parameters for using a Amazon SQS stream as a source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStepFunctionStateMachineParameters
```
public void setStepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)
```
    The parameters for using a Step Functions state machine as a target.
    
    Parameters:
    
    stepFunctionStateMachineParameters - The parameters for using a Step Functions state machine as a target.
  - getStepFunctionStateMachineParameters
```
public PipeTargetStateMachineParameters getStepFunctionStateMachineParameters()
```
    The parameters for using a Step Functions state machine as a target.
    
    Returns:
    
    The parameters for using a Step Functions state machine as a target.
  - withStepFunctionStateMachineParameters
```
public PipeTargetParameters withStepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)
```
    The parameters for using a Step Functions state machine as a target.
    
    Parameters:
    
    stepFunctionStateMachineParameters - The parameters for using a Step Functions state machine as a target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PipeTargetParameters clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.564

Class PipeTargetParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipeTargetParameters

Method Detail

setBatchJobParameters

getBatchJobParameters

withBatchJobParameters

setCloudWatchLogsParameters

getCloudWatchLogsParameters

withCloudWatchLogsParameters

setEcsTaskParameters

getEcsTaskParameters

withEcsTaskParameters

setEventBridgeEventBusParameters

getEventBridgeEventBusParameters

withEventBridgeEventBusParameters

setHttpParameters

getHttpParameters

withHttpParameters

setInputTemplate

getInputTemplate

withInputTemplate

setKinesisStreamParameters

getKinesisStreamParameters

withKinesisStreamParameters

setLambdaFunctionParameters

getLambdaFunctionParameters

withLambdaFunctionParameters

setRedshiftDataParameters

getRedshiftDataParameters

withRedshiftDataParameters

setSageMakerPipelineParameters

getSageMakerPipelineParameters

withSageMakerPipelineParameters

setSqsQueueParameters

getSqsQueueParameters

withSqsQueueParameters

setStepFunctionStateMachineParameters

getStepFunctionStateMachineParameters

withStepFunctionStateMachineParameters

toString

equals

hashCode

clone

marshall