AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-pipes-targets-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

FirehoseTarget Class ​

An EventBridge Pipes target that sends messages to an Amazon Data Firehose delivery stream.

Stability
Experimental
Source
lib/firehose.ts

Example ​

ts
declare const sourceQueue: sqs.Queue;
declare const targetDeliveryStream: firehose.DeliveryStream;

const deliveryStreamTarget = new targets.FirehoseTarget(targetDeliveryStream);

const pipe = new pipes.Pipe(this, 'Pipe', {
  source: new SqsSource(sourceQueue),
  target: deliveryStreamTarget,
});
python
# source_queue: sqs.Queue
# target_delivery_stream: firehose.DeliveryStream


delivery_stream_target = targets.FirehoseTarget(target_delivery_stream)

pipe = pipes.Pipe(self, "Pipe",
    source=SqsSource(source_queue),
    target=delivery_stream_target
)
java
Queue sourceQueue;
DeliveryStream targetDeliveryStream;


FirehoseTarget deliveryStreamTarget = new FirehoseTarget(targetDeliveryStream);

Pipe pipe = Pipe.Builder.create(this, "Pipe")
        .source(new SqsSource(sourceQueue))
        .target(deliveryStreamTarget)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Pipes.Targets.Alpha
Queue sourceQueue;
DeliveryStream targetDeliveryStream;


var deliveryStreamTarget = new FirehoseTarget(targetDeliveryStream);

var pipe = new Pipe(this, "Pipe", new PipeProps {
    Source = new SqsSource(sourceQueue),
    Target = deliveryStreamTarget
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkpipestargetsalpha/v2
var sourceQueue Queue
var targetDeliveryStream DeliveryStream


deliveryStreamTarget := targets.NewFirehoseTarget(targetDeliveryStream)

pipe := pipes.NewPipe(this, jsii.String("Pipe"), &PipeProps{
	Source: awscdkpipessourcesalpha.NewSqsSource(sourceQueue),
	Target: deliveryStreamTarget,
})

Initializer ​

ts
new FirehoseTarget(deliveryStream: IDeliveryStream, parameters?: FirehoseTargetParameters)
python
FirehoseTarget(delivery_stream: IDeliveryStream, parameters: typing.Optional[FirehoseTargetParameters] = None)
java
new FirehoseTarget(IDeliveryStream deliveryStream, FirehoseTargetParameters parameters)
csharp
new FirehoseTarget(IDeliveryStream deliveryStream, FirehoseTargetParameters? parameters = null)
go
NewFirehoseTarget(DeliveryStream IDeliveryStream, Parameters FirehoseTargetParameters)

Properties ​

targetArnstringtarget_arnstrtargetArnStringTargetArnstringTargetArn*string#
The ARN of the target resource.

Methods ​

bind(pipe: IPipe): TargetConfigdef bind(self, pipe: IPipe) -> TargetConfigpublic TargetConfig bind(IPipe pipe)public TargetConfig Bind(IPipe pipe)func Bind(Pipe IPipe) TargetConfig#
Bind this target to a pipe.
grantPush(grantee: IRole): voiddef grant_push(self, grantee: IRole) -> Nonepublic void grantPush(IRole grantee)public void GrantPush(IRole grantee)func GrantPush(Grantee IRole)#
Grant the pipe role to push to the target.