FirehoseLogsDelivery

class aws_cdk.mixins_preview.aws_logs.FirehoseLogsDelivery(stream, *, output_format=None, mandatory_fields=None, provided_fields=None)

Bases: object

(experimental) Delivers vended logs to a Firehose Delivery Stream.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import aws_logs as logs
from aws_cdk.interfaces import aws_kinesisfirehose as interfaces_kinesisfirehose

# delivery_stream_ref: interfaces_kinesisfirehose.IDeliveryStreamRef

firehose_logs_delivery = logs.FirehoseLogsDelivery(delivery_stream_ref,
    mandatory_fields=["mandatoryFields"],
    output_format="outputFormat",
    provided_fields=["providedFields"]
)

(experimental) Creates a new Firehose delivery.

Parameters:

  • stream (IDeliveryStreamRef) –

    • The Kinesis Data Firehose delivery stream.

  • output_format (Optional[str]) – (experimental) Format of the logs that are sent to the delivery destination specified.

  • mandatory_fields (Optional[Sequence[str]]) – (experimental) Any recordFields that a mandatory to be included in a log delivery of a certain log type. Default: - log type has no mandatory fields

  • provided_fields (Optional[Sequence[str]]) – (experimental) RecordFields the user has defined to be used in log delivery.

Stability:

experimental

Methods

bind(scope, log_type, source_resource_arn)

(experimental) Binds Firehose Delivery Stream to a source resource for the purposes of log delivery and creates a delivery source, a delivery destination, and a connection between them.

Parameters:

  • scope (IConstruct)

  • log_type (str)

  • source_resource_arn (str)

Stability:

experimental

Return type:

ILogsDeliveryConfig