Package software.amazon.awssdk.services.pipes.model

Class PipeTargetParameters

java.lang.Object
software.amazon.awssdk.services.pipes.model.PipeTargetParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PipeTargetParameters.Builder,PipeTargetParameters>
@Generated("software.amazon.awssdk:codegen") public final class PipeTargetParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PipeTargetParameters.Builder,PipeTargetParameters>

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:

  • Method Details

    • batchJobParameters

      public final PipeTargetBatchJobParameters batchJobParameters()

      The parameters for using an Batch job as a target.

      Returns:
      The parameters for using an Batch job as a target.

    • cloudWatchLogsParameters

      public final PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters()

      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.

    • ecsTaskParameters

      public final PipeTargetEcsTaskParameters ecsTaskParameters()

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

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

    • eventBridgeEventBusParameters

      public final PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters()

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

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

    • httpParameters

      public final PipeTargetHttpParameters httpParameters()

      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.

    • inputTemplate

      public final 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.

      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.

      To remove an input template, specify an empty string.

    • kinesisStreamParameters

      public final PipeTargetKinesisStreamParameters kinesisStreamParameters()

      The parameters for using a Kinesis stream as a target.

      Returns:
      The parameters for using a Kinesis stream as a target.

    • lambdaFunctionParameters

      public final PipeTargetLambdaFunctionParameters lambdaFunctionParameters()

      The parameters for using a Lambda function as a target.

      Returns:
      The parameters for using a Lambda function as a target.

    • redshiftDataParameters

      public final 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.

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

    • sageMakerPipelineParameters

      public final PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters()

      The parameters for using a SageMaker pipeline as a target.

      Returns:
      The parameters for using a SageMaker pipeline as a target.

    • sqsQueueParameters

      public final PipeTargetSqsQueueParameters sqsQueueParameters()

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

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

    • stepFunctionStateMachineParameters

      public final PipeTargetStateMachineParameters stepFunctionStateMachineParameters()

      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.

    • toBuilder

      public PipeTargetParameters.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PipeTargetParameters.Builder,PipeTargetParameters>
      Returns:
      a builder for type T

    • builder

      public static PipeTargetParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipeTargetParameters.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.