HttpEndpointConfig

class aws_cdk.aws_kinesisfirehose.HttpEndpointConfig(*, url, access_key=None, name=None, secret=None)

Bases: object

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

Parameters:

url (str) – The URL of the Http endpoint selected as the destination.
access_key (Optional[SecretValue]) – 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
name (Optional[str]) – The name of the Http endpoint selected as the destination. Default: - None
secret (Optional[ISecret]) – 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

ExampleMetadata:

infused

Example:

# endpoint_config: firehose.HttpEndpointConfig

http_destination = firehose.HttpEndpoint(
    endpoint_config=endpoint_config
)

Attributes

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.

Default:

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

name

The name of the Http endpoint selected as the destination.

Default:

None

secret

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

url: The URL of the Http endpoint selected as the destination.