Skip to content
v2.275.0

HttpEndpointConfig Struct ​

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

Example ​

ts
declare const endpointConfig: firehose.HttpEndpointConfig;
const httpDestination = new firehose.HttpEndpoint({
  endpointConfig,
});

Properties ​

accessKeyoptionalSecretValueaccess_keyoptionalSecretValueaccessKeyoptionalSecretValueAccessKeyoptionalSecretValueAccessKeyoptionalSecretValue#
The access key used to authenticate with the Http endpoint.

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

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.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string= None#
The name of the Http endpoint selected as the destination.
secretoptionalISecretsecretoptionalISecretsecretoptionalISecretSecretoptionalISecretSecretoptionalISecret#
A Secrets Manager secret used to authenticate with the Http endpoint.

Default: none; accessKey is used if provided

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

urlstringurlstrurlStringUrlstringUrl*stringrequired#
The URL of the Http endpoint selected as the destination.