Package software.amazon.awscdk.services.pipes.targets.alpha

Class ApiGatewayTarget

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.pipes.targets.alpha.ApiGatewayTarget

All Implemented Interfaces:

ITarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:50.509Z")
@Stability(Experimental)
public class ApiGatewayTarget
extends software.amazon.jsii.JsiiObject
implements ITarget

(experimental) An EventBridge Pipes target that sends messages to an EventBridge API destination.

Example:

 Queue sourceQueue;
 Function fn = Function.Builder.create(this, "MyFunc")
         .handler("index.handler")
         .runtime(Runtime.NODEJS_LATEST)
         .code(Code.fromInline("exports.handler = e => {}"))
         .build();
 LambdaRestApi restApi = LambdaRestApi.Builder.create(this, "MyRestAPI").handler(fn).build();
 ApiGatewayTarget apiTarget = new ApiGatewayTarget(restApi);
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(new SqsSource(sourceQueue))
         .target(apiTarget)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ApiGatewayTarget.Builder	(experimental) A fluent builder for ApiGatewayTarget.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.pipes.alpha.ITarget

ITarget.Jsii$Default, ITarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	ApiGatewayTarget(IRestApi restApi)
	ApiGatewayTarget(IRestApi restApi, ApiGatewayTargetParameters parameters)
protected	ApiGatewayTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiGatewayTarget(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
TargetConfig	bind(IPipe pipe)	(experimental) Bind this target to a pipe.
String	getTargetArn()	(experimental) The ARN of the target resource.
void	grantPush(IRole grantee)	(experimental) Grant the pipe role to push to the target.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ApiGatewayTarget

protected ApiGatewayTarget(software.amazon.jsii.JsiiObjectRef objRef)

ApiGatewayTarget

protected ApiGatewayTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ApiGatewayTarget

@Stability(Experimental)
public ApiGatewayTarget(@NotNull
 IRestApi restApi,
 @Nullable
 ApiGatewayTargetParameters parameters)

Parameters:

restApi - This parameter is required.

parameters -

ApiGatewayTarget

@Stability(Experimental)
public ApiGatewayTarget(@NotNull
 IRestApi restApi)

Parameters:

restApi - This parameter is required.

Method Details

bind

@Stability(Experimental)
@NotNull
public TargetConfig bind(@NotNull
 IPipe pipe)

(experimental) Bind this target to a pipe.

Specified by:

bind in interface ITarget

Parameters:

pipe - This parameter is required.

grantPush

@Stability(Experimental)
public void grantPush(@NotNull
 IRole grantee)

(experimental) Grant the pipe role to push to the target.

Specified by:

grantPush in interface ITarget

Parameters:

grantee - This parameter is required.

getTargetArn

@Stability(Experimental)
@NotNull
public String getTargetArn()

(experimental) The ARN of the target resource.

Specified by:

getTargetArn in interface ITarget