Package software.amazon.awscdk.services.kinesisfirehose

Interface HttpEndpointConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpEndpointConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-08-13T16:20:08.546Z")
@Stability(Stable)
public interface HttpEndpointConfig
extends software.amazon.jsii.JsiiSerializable

Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data.

Example:

 HttpEndpointConfig endpointConfig;
 HttpEndpoint httpDestination = HttpEndpoint.Builder.create()
         .endpointConfig(endpointConfig)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpEndpointConfig.Builder	A builder for HttpEndpointConfig
static final class	HttpEndpointConfig.Jsii$Proxy	An implementation for HttpEndpointConfig

Method Summary

Modifier and Type	Method	Description
static HttpEndpointConfig.Builder	builder()
default SecretValue	getAccessKey()	The access key used to authenticate with the Http endpoint.
default String	getName()	The name of the Http endpoint selected as the destination.
default ISecret	getSecret()	A Secrets Manager secret used to authenticate with the Http endpoint.
String	getUrl()	The URL of the Http endpoint selected as the destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUrl

@Stability(Stable)
@NotNull
String getUrl()

The URL of the Http endpoint selected as the destination.

getAccessKey

@Stability(Stable)
@Nullable
default SecretValue getAccessKey()

The access key used to authenticate with the Http endpoint.

Used only when secret is not set. If both accessKey and secret are provided, secret (AWS Secrets Manager) takes precedence and this value is ignored. The access key is rendered into the CloudFormation template.

Default: - none; authentication uses `secret` if provided, otherwise no access key

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the Http endpoint selected as the destination.

Default: - None

getSecret

@Stability(Stable)
@Nullable
default ISecret getSecret()

A Secrets Manager secret used to authenticate with the Http endpoint.

When set, Firehose retrieves the credential from AWS Secrets Manager, and this takes precedence over accessKey.

Default: - none; `accessKey` is used if provided

builder

@Stability(Stable)
static HttpEndpointConfig.Builder builder()

Returns:

a HttpEndpointConfig.Builder of HttpEndpointConfig