@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.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
Constructor and Description |
---|
PipeTargetParameters() |
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 target.
|
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 BatchExecuteStatement.
|
PipeTargetSageMakerPipelineParameters |
getSageMakerPipelineParameters()
The parameters for using a SageMaker pipeline as a target.
|
PipeTargetSqsQueueParameters |
getSqsQueueParameters()
The parameters for using a Amazon SQS stream as a target.
|
PipeTargetStateMachineParameters |
getStepFunctionStateMachineParameters()
The parameters for using a Step Functions state machine as a target.
|
PipeTargetTimestreamParameters |
getTimestreamParameters()
The parameters for using a Timestream for LiveAnalytics table 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 target.
|
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 BatchExecuteStatement.
|
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 target.
|
void |
setStepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)
The parameters for using a Step Functions state machine as a target.
|
void |
setTimestreamParameters(PipeTargetTimestreamParameters timestreamParameters)
The parameters for using a Timestream for LiveAnalytics table 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 target.
|
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 BatchExecuteStatement.
|
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 target.
|
PipeTargetParameters |
withStepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)
The parameters for using a Step Functions state machine as a target.
|
PipeTargetParameters |
withTimestreamParameters(PipeTargetTimestreamParameters timestreamParameters)
The parameters for using a Timestream for LiveAnalytics table as a target.
|
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.
To remove an input template, specify an empty 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.
To remove an input template, specify an empty string.
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.
To remove an input template, specify an empty string.
To remove an input template, specify an empty string.
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.
To remove an input template, specify an empty 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.
To remove an input template, specify an empty string.
public void setLambdaFunctionParameters(PipeTargetLambdaFunctionParameters lambdaFunctionParameters)
The parameters for using a Lambda function as a target.
lambdaFunctionParameters
- The parameters for using a Lambda function as a target.public PipeTargetLambdaFunctionParameters getLambdaFunctionParameters()
The parameters for using a Lambda function as a target.
public PipeTargetParameters withLambdaFunctionParameters(PipeTargetLambdaFunctionParameters lambdaFunctionParameters)
The parameters for using a Lambda function as a target.
lambdaFunctionParameters
- The parameters for using a Lambda function as a target.public void setStepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)
The parameters for using a Step Functions state machine as a target.
stepFunctionStateMachineParameters
- The parameters for using a Step Functions state machine as a target.public PipeTargetStateMachineParameters getStepFunctionStateMachineParameters()
The parameters for using a Step Functions state machine as a target.
public PipeTargetParameters withStepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)
The parameters for using a Step Functions state machine as a target.
stepFunctionStateMachineParameters
- The parameters for using a Step Functions state machine as a target.public void setKinesisStreamParameters(PipeTargetKinesisStreamParameters kinesisStreamParameters)
The parameters for using a Kinesis stream as a target.
kinesisStreamParameters
- The parameters for using a Kinesis stream as a target.public PipeTargetKinesisStreamParameters getKinesisStreamParameters()
The parameters for using a Kinesis stream as a target.
public PipeTargetParameters withKinesisStreamParameters(PipeTargetKinesisStreamParameters kinesisStreamParameters)
The parameters for using a Kinesis stream as a target.
kinesisStreamParameters
- The parameters for using a Kinesis stream as a target.public void setEcsTaskParameters(PipeTargetEcsTaskParameters ecsTaskParameters)
The parameters for using an Amazon ECS task as a target.
ecsTaskParameters
- The parameters for using an Amazon ECS task as a target.public PipeTargetEcsTaskParameters getEcsTaskParameters()
The parameters for using an Amazon ECS task as a target.
public PipeTargetParameters withEcsTaskParameters(PipeTargetEcsTaskParameters ecsTaskParameters)
The parameters for using an Amazon ECS task as a target.
ecsTaskParameters
- The parameters for using an Amazon ECS task as a target.public void setBatchJobParameters(PipeTargetBatchJobParameters batchJobParameters)
The parameters for using an Batch job as a target.
batchJobParameters
- The parameters for using an Batch job as a target.public PipeTargetBatchJobParameters getBatchJobParameters()
The parameters for using an Batch job as a target.
public PipeTargetParameters withBatchJobParameters(PipeTargetBatchJobParameters batchJobParameters)
The parameters for using an Batch job as a target.
batchJobParameters
- The parameters for using an Batch job as a target.public void setSqsQueueParameters(PipeTargetSqsQueueParameters sqsQueueParameters)
The parameters for using a Amazon SQS stream as a target.
sqsQueueParameters
- The parameters for using a Amazon SQS stream as a target.public PipeTargetSqsQueueParameters getSqsQueueParameters()
The parameters for using a Amazon SQS stream as a target.
public PipeTargetParameters withSqsQueueParameters(PipeTargetSqsQueueParameters sqsQueueParameters)
The parameters for using a Amazon SQS stream as a target.
sqsQueueParameters
- The parameters for using a Amazon SQS stream as a target.public void setHttpParameters(PipeTargetHttpParameters httpParameters)
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
httpParameters
- These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge
ApiDestinations.public PipeTargetHttpParameters getHttpParameters()
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
public PipeTargetParameters withHttpParameters(PipeTargetHttpParameters httpParameters)
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
httpParameters
- These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge
ApiDestinations.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 BatchExecuteStatement.
redshiftDataParameters
- These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon
Redshift Data API BatchExecuteStatement.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 BatchExecuteStatement.
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 BatchExecuteStatement.
redshiftDataParameters
- These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon
Redshift Data API BatchExecuteStatement.public void setSageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters)
The parameters for using a SageMaker pipeline as a target.
sageMakerPipelineParameters
- The parameters for using a SageMaker pipeline as a target.public PipeTargetSageMakerPipelineParameters getSageMakerPipelineParameters()
The parameters for using a SageMaker pipeline as a target.
public PipeTargetParameters withSageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters)
The parameters for using a SageMaker pipeline as a target.
sageMakerPipelineParameters
- The parameters for using a SageMaker pipeline as a target.public void setEventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters)
The parameters for using an EventBridge event bus as a target.
eventBridgeEventBusParameters
- The parameters for using an EventBridge event bus as a target.public PipeTargetEventBridgeEventBusParameters getEventBridgeEventBusParameters()
The parameters for using an EventBridge event bus as a target.
public PipeTargetParameters withEventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters)
The parameters for using an EventBridge event bus as a target.
eventBridgeEventBusParameters
- The parameters for using an EventBridge event bus as a target.public void setCloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters)
The parameters for using an CloudWatch Logs log stream as a target.
cloudWatchLogsParameters
- The parameters for using an CloudWatch Logs log stream as a target.public PipeTargetCloudWatchLogsParameters getCloudWatchLogsParameters()
The parameters for using an CloudWatch Logs log stream as a target.
public PipeTargetParameters withCloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters)
The parameters for using an CloudWatch Logs log stream as a target.
cloudWatchLogsParameters
- The parameters for using an CloudWatch Logs log stream as a target.public void setTimestreamParameters(PipeTargetTimestreamParameters timestreamParameters)
The parameters for using a Timestream for LiveAnalytics table as a target.
timestreamParameters
- The parameters for using a Timestream for LiveAnalytics table as a target.public PipeTargetTimestreamParameters getTimestreamParameters()
The parameters for using a Timestream for LiveAnalytics table as a target.
public PipeTargetParameters withTimestreamParameters(PipeTargetTimestreamParameters timestreamParameters)
The parameters for using a Timestream for LiveAnalytics table as a target.
timestreamParameters
- The parameters for using a Timestream for LiveAnalytics table as a target.public String toString()
toString
in class Object
Object.toString()
public PipeTargetParameters clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.