Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pipes.Types.PipeTargetParameters

Description

Synopsis

Documentation

data PipeTargetParameters Source #

The parameters required to set up a target for your pipe.

See: newPipeTargetParameters smart constructor.

Constructors

PipeTargetParameters'

Fields

batchJobParameters :: Maybe PipeTargetBatchJobParameters
The parameters for using an Batch job as a target.
cloudWatchLogsParameters :: Maybe PipeTargetCloudWatchLogsParameters
The parameters for using an CloudWatch Logs log stream as a target.
ecsTaskParameters :: Maybe PipeTargetEcsTaskParameters
The parameters for using an Amazon ECS task as a target.
eventBridgeEventBusParameters :: Maybe PipeTargetEventBridgeEventBusParameters
The parameters for using an EventBridge event bus as a target.
httpParameters :: Maybe PipeTargetHttpParameters
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
inputTemplate :: Maybe (Sensitive Text)
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.
kinesisStreamParameters :: Maybe PipeTargetKinesisStreamParameters
The parameters for using a Kinesis stream as a source.
lambdaFunctionParameters :: Maybe PipeTargetLambdaFunctionParameters
The parameters for using a Lambda function as a target.
redshiftDataParameters :: Maybe PipeTargetRedshiftDataParameters
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
sageMakerPipelineParameters :: Maybe PipeTargetSageMakerPipelineParameters
The parameters for using a SageMaker pipeline as a target.
sqsQueueParameters :: Maybe PipeTargetSqsQueueParameters
The parameters for using a Amazon SQS stream as a source.
stepFunctionStateMachineParameters :: Maybe PipeTargetStateMachineParameters
The parameters for using a Step Functions state machine as a target.

Instances

Instances details

FromJSON PipeTargetParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetParameters Methods parseJSON :: Value -> Parser PipeTargetParameters # parseJSONList :: Value -> Parser [PipeTargetParameters] #
ToJSON PipeTargetParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetParameters Methods toJSON :: PipeTargetParameters -> Value # toEncoding :: PipeTargetParameters -> Encoding # toJSONList :: [PipeTargetParameters] -> Value # toEncodingList :: [PipeTargetParameters] -> Encoding #
Generic PipeTargetParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetParameters Associated Types type Rep PipeTargetParameters :: Type -> Type # Methods from :: PipeTargetParameters -> Rep PipeTargetParameters x # to :: Rep PipeTargetParameters x -> PipeTargetParameters #
Show PipeTargetParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetParameters Methods showsPrec :: Int -> PipeTargetParameters -> ShowS # show :: PipeTargetParameters -> String # showList :: [PipeTargetParameters] -> ShowS #
NFData PipeTargetParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetParameters Methods rnf :: PipeTargetParameters -> () #
Eq PipeTargetParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetParameters Methods (==) :: PipeTargetParameters -> PipeTargetParameters -> Bool # (/=) :: PipeTargetParameters -> PipeTargetParameters -> Bool #
Hashable PipeTargetParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetParameters Methods hashWithSalt :: Int -> PipeTargetParameters -> Int # hash :: PipeTargetParameters -> Int #
type Rep PipeTargetParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetParameters type Rep PipeTargetParameters = D1 ('MetaData "PipeTargetParameters" "Amazonka.Pipes.Types.PipeTargetParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeTargetParameters'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "batchJobParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetBatchJobParameters)) :: (S1 ('MetaSel ('Just "cloudWatchLogsParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetCloudWatchLogsParameters)) :: S1 ('MetaSel ('Just "ecsTaskParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetEcsTaskParameters)))) :: (S1 ('MetaSel ('Just "eventBridgeEventBusParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetEventBridgeEventBusParameters)) :: (S1 ('MetaSel ('Just "httpParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetHttpParameters)) :: S1 ('MetaSel ('Just "inputTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) :: ((S1 ('MetaSel ('Just "kinesisStreamParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetKinesisStreamParameters)) :: (S1 ('MetaSel ('Just "lambdaFunctionParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetLambdaFunctionParameters)) :: S1 ('MetaSel ('Just "redshiftDataParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetRedshiftDataParameters)))) :: (S1 ('MetaSel ('Just "sageMakerPipelineParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetSageMakerPipelineParameters)) :: (S1 ('MetaSel ('Just "sqsQueueParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetSqsQueueParameters)) :*: S1 ('MetaSel ('Just "stepFunctionStateMachineParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetStateMachineParameters)))))))

newPipeTargetParameters :: PipeTargetParameters Source #

Create a value of PipeTargetParameters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:batchJobParameters:PipeTargetParameters', pipeTargetParameters_batchJobParameters - The parameters for using an Batch job as a target.

$sel:cloudWatchLogsParameters:PipeTargetParameters', pipeTargetParameters_cloudWatchLogsParameters - The parameters for using an CloudWatch Logs log stream as a target.

$sel:ecsTaskParameters:PipeTargetParameters', pipeTargetParameters_ecsTaskParameters - The parameters for using an Amazon ECS task as a target.

$sel:eventBridgeEventBusParameters:PipeTargetParameters', pipeTargetParameters_eventBridgeEventBusParameters - The parameters for using an EventBridge event bus as a target.

$sel:httpParameters:PipeTargetParameters', pipeTargetParameters_httpParameters - These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

$sel:inputTemplate:PipeTargetParameters', pipeTargetParameters_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.

$sel:kinesisStreamParameters:PipeTargetParameters', pipeTargetParameters_kinesisStreamParameters - The parameters for using a Kinesis stream as a source.

$sel:lambdaFunctionParameters:PipeTargetParameters', pipeTargetParameters_lambdaFunctionParameters - The parameters for using a Lambda function as a target.

$sel:redshiftDataParameters:PipeTargetParameters', pipeTargetParameters_redshiftDataParameters - These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.

$sel:sageMakerPipelineParameters:PipeTargetParameters', pipeTargetParameters_sageMakerPipelineParameters - The parameters for using a SageMaker pipeline as a target.

$sel:sqsQueueParameters:PipeTargetParameters', pipeTargetParameters_sqsQueueParameters - The parameters for using a Amazon SQS stream as a source.

$sel:stepFunctionStateMachineParameters:PipeTargetParameters', pipeTargetParameters_stepFunctionStateMachineParameters - The parameters for using a Step Functions state machine as a target.

pipeTargetParameters_batchJobParameters :: Lens' PipeTargetParameters (Maybe PipeTargetBatchJobParameters) Source #

The parameters for using an Batch job as a target.

pipeTargetParameters_cloudWatchLogsParameters :: Lens' PipeTargetParameters (Maybe PipeTargetCloudWatchLogsParameters) Source #

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

pipeTargetParameters_ecsTaskParameters :: Lens' PipeTargetParameters (Maybe PipeTargetEcsTaskParameters) Source #

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

pipeTargetParameters_eventBridgeEventBusParameters :: Lens' PipeTargetParameters (Maybe PipeTargetEventBridgeEventBusParameters) Source #

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

pipeTargetParameters_httpParameters :: Lens' PipeTargetParameters (Maybe PipeTargetHttpParameters) Source #

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

pipeTargetParameters_inputTemplate :: Lens' PipeTargetParameters (Maybe Text) Source #

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.

pipeTargetParameters_kinesisStreamParameters :: Lens' PipeTargetParameters (Maybe PipeTargetKinesisStreamParameters) Source #

The parameters for using a Kinesis stream as a source.

pipeTargetParameters_lambdaFunctionParameters :: Lens' PipeTargetParameters (Maybe PipeTargetLambdaFunctionParameters) Source #

The parameters for using a Lambda function as a target.

pipeTargetParameters_redshiftDataParameters :: Lens' PipeTargetParameters (Maybe PipeTargetRedshiftDataParameters) Source #

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

pipeTargetParameters_sageMakerPipelineParameters :: Lens' PipeTargetParameters (Maybe PipeTargetSageMakerPipelineParameters) Source #

The parameters for using a SageMaker pipeline as a target.

pipeTargetParameters_sqsQueueParameters :: Lens' PipeTargetParameters (Maybe PipeTargetSqsQueueParameters) Source #

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

pipeTargetParameters_stepFunctionStateMachineParameters :: Lens' PipeTargetParameters (Maybe PipeTargetStateMachineParameters) Source #

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