Package software.amazon.awscdk.services.apigateway

Class FirehoseLogDestination

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.FirehoseLogDestination

All Implemented Interfaces:

IAccessLogDestination, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:39:57.315Z")
@Stability(Stable)
public class FirehoseLogDestination
extends software.amazon.jsii.JsiiObject
implements IAccessLogDestination

Use a Firehose delivery stream as a custom access log destination for API Gateway.

Example:

 Bucket destinationBucket = new Bucket(this, "Bucket");
 Role deliveryStreamRole = Role.Builder.create(this, "Role")
         .assumedBy(new ServicePrincipal("firehose.amazonaws.com"))
         .build();
 CfnDeliveryStream stream = CfnDeliveryStream.Builder.create(this, "MyStream")
         .deliveryStreamName("amazon-apigateway-delivery-stream")
         .s3DestinationConfiguration(S3DestinationConfigurationProperty.builder()
                 .bucketArn(destinationBucket.getBucketArn())
                 .roleArn(deliveryStreamRole.getRoleArn())
                 .build())
         .build();
 RestApi api = RestApi.Builder.create(this, "books")
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(new FirehoseLogDestination(stream))
                 .accessLogFormat(AccessLogFormat.jsonWithStandardFields())
                 .build())
         .build();
 

Nested Class Summary

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.apigateway.IAccessLogDestination

IAccessLogDestination.Jsii$Default, IAccessLogDestination.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	FirehoseLogDestination(CfnDeliveryStream stream)
protected	FirehoseLogDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	FirehoseLogDestination(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
AccessLogDestinationConfig	bind(IStageRef stage)	Binds this destination to the Firehose delivery stream.

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

FirehoseLogDestination

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

FirehoseLogDestination

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

FirehoseLogDestination

@Stability(Stable)
public FirehoseLogDestination(@NotNull
 CfnDeliveryStream stream)

Parameters:

stream - This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public AccessLogDestinationConfig bind(@NotNull
 IStageRef stage)

Binds this destination to the Firehose delivery stream.

Specified by:

bind in interface IAccessLogDestination

Parameters:

stage - This parameter is required.