interface HttpEndpointConfig
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.KinesisFirehose.HttpEndpointConfig |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#HttpEndpointConfig |
 Java | software.amazon.awscdk.services.kinesisfirehose.HttpEndpointConfig |
 Python | aws_cdk.aws_kinesisfirehose.HttpEndpointConfig |
 TypeScript (source) | aws-cdk-lib » aws_kinesisfirehose » HttpEndpointConfig |
Describes the configuration of the Http endpoint to which Kinesis Firehose delivers data.
Example
declare const endpointConfig: firehose.HttpEndpointConfig;
const httpDestination = new firehose.HttpEndpoint({
endpointConfig,
});
Properties
| Name | Type | Description |
|---|---|---|
| url | string | The URL of the Http endpoint selected as the destination. |
| access | Secret | The access key used to authenticate with the Http endpoint. |
| name? | string | The name of the Http endpoint selected as the destination. |
| secret? | ISecret | A Secrets Manager secret used to authenticate with the Http endpoint. |
url
Type:
string
The URL of the Http endpoint selected as the destination.
accessKey?
Type:
Secret
(optional, default: none; authentication uses secret if provided, otherwise no access key)
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.
name?
Type:
string
(optional, default: None)
The name of the Http endpoint selected as the destination.
secret?
Type:
ISecret
(optional, default: none; accessKey is used if provided)
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.